summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorP. J. McDermott <pjm@nac.net>2012-03-21 02:42:43 (EDT)
committer P. J. McDermott <pjm@nac.net>2012-03-21 02:42:43 (EDT)
commit2972d2b74512aa3ec50d6db24392ab150d7f2d06 (patch)
tree79a0370bd88b9e83abed65ae76ae61bcb228f67c /man
parent9f73d6a876b548a4c3d27f8d6e56efa4d411c0ef (diff)
Improve format of and use macros in manual pages.
Diffstat (limited to 'man')
-rw-r--r--man/oh-applypatches.1.in11
-rw-r--r--man/oh-buildopk.1.in9
-rw-r--r--man/oh-copyconfig.1.in13
-rw-r--r--man/oh-gencontrol.1.in9
-rw-r--r--man/oh-installdocs.1.in8
-rw-r--r--man/oh-installfiles.1.in12
-rw-r--r--man/oh-strip.1.in9
-rw-r--r--man/opkbuild.1.in9
8 files changed, 68 insertions, 12 deletions
diff --git a/man/oh-applypatches.1.in b/man/oh-applypatches.1.in
index e952150..997075b 100644
--- a/man/oh-applypatches.1.in
+++ b/man/oh-applypatches.1.in
@@ -1,13 +1,20 @@
.\" Author: Patrick "P. J." McDermott
-.TH oh-applypatches 1 "2012-01-25" "opkhelper-0.1.0" "opkg Build Helper Tools"
+
+.TH oh-applypatches 1 \
+"2012-03-21" "@@PACKAGE@@-@@VERSION@@" "opkg Build Helper Tools"
+
.SH NAME
oh-applypatches \- Apply patches to source code.
+
.SH SYNOPSIS
.B oh-applypatches
+
.SH DESCRIPTION
.B oh-applypatches
applies to software source code any patch files found in the source package's
-`patches' directory. Patch files are applied in alphabetical order by name.
+.I patches
+directory. Patch files are applied in alphabetical order by name.
+
.SH COPYRIGHT
Copyright (C) 2012 Patrick "P. J." McDermott
.sp
diff --git a/man/oh-buildopk.1.in b/man/oh-buildopk.1.in
index 69cb47b..92b1b6e 100644
--- a/man/oh-buildopk.1.in
+++ b/man/oh-buildopk.1.in
@@ -1,18 +1,25 @@
.\" Author: Patrick "P. J." McDermott
-.TH oh-buildopk 1 "2012-01-20" "opkhelper-0.1.0" "opkg Build Helper Tools"
+
+.TH oh-buildopk 1 \
+"2012-03-21" "@@PACKAGE@@-@@VERSION@@" "opkg Build Helper Tools"
+
.SH NAME
oh-buildopk \- Pack binary package files into an opk file.
+
.SH SYNOPSIS
.B oh-buildopk
.BR -s \ |
.IR pkgname ...
+
.SH DESCRIPTION
.B oh-buildopk
packs files in a binary package staging area into an opk file.
+
.SH OPTIONS
.TP
.B \-s
Build an opk file for the binary package that contains source packaging.
+
.SH COPYRIGHT
Copyright (C) 2012 Patrick "P. J." McDermott
.sp
diff --git a/man/oh-copyconfig.1.in b/man/oh-copyconfig.1.in
index 1a3a14d..5185eaa 100644
--- a/man/oh-copyconfig.1.in
+++ b/man/oh-copyconfig.1.in
@@ -1,13 +1,20 @@
.\" Author: Patrick "P. J." McDermott
-.TH oh-copyconfig 1 "2012-01-29" "opkhelper-0.1.0" "opkg Build Helper Tools"
+
+.TH oh-copyconfig 1 \
+"2012-03-21" "@@PACKAGE@@-@@VERSION@@" "opkg Build Helper Tools"
+
.SH NAME
oh-copyconfig \- Copy build-time or run-time platform configuration files.
+
.SH SYNOPSIS
.B oh-copyconfig
+
.SH DESCRIPTION
.B oh-copyconfig
-reads the `config' file in the source package and copies all listed platform
-configuration files.
+reads the
+.I config
+file in the source package and copies all listed platform configuration files.
+
.SH COPYRIGHT
Copyright (C) 2012 Patrick "P. J." McDermott
.sp
diff --git a/man/oh-gencontrol.1.in b/man/oh-gencontrol.1.in
index 9159c13..4b6d859 100644
--- a/man/oh-gencontrol.1.in
+++ b/man/oh-gencontrol.1.in
@@ -1,20 +1,27 @@
.\" Author: Patrick "P. J." McDermott
-.TH oh-gencontrol 1 "2012-01-21" "opkhelper-0.1.0" "opkg Build Helper Tools"
+
+.TH oh-gencontrol 1 \
+"2012-03-21" "@@PACKAGE@@-@@VERSION@@" "opkg Build Helper Tools"
+
.SH NAME
oh-gencontrol \- Generates a control directory with a control file and scripts.
+
.SH SYNOPSIS
.B oh-gencontrol
.BR -s \ |
.IR pkgname ...
+
.SH DESCRIPTION
.B oh-gencontrol
makes a control directory for a package and populates it with the package's
maintainer scripts and a generated control file.
+
.SH OPTIONS
.TP
.B \-s
Generate a control directory for the binary package that contains source
packaging.
+
.SH COPYRIGHT
Copyright (C) 2012 Patrick "P. J." McDermott
.sp
diff --git a/man/oh-installdocs.1.in b/man/oh-installdocs.1.in
index ed21653..2282da1 100644
--- a/man/oh-installdocs.1.in
+++ b/man/oh-installdocs.1.in
@@ -1,11 +1,16 @@
.\" Author: Patrick "P. J." McDermott
-.TH oh-installdocs 1 "2012-01-30" "opkhelper-0.1.0" "opkg Build Helper Tools"
+
+.TH oh-installdocs 1 \
+"2012-03-21" "@@PACKAGE@@-@@VERSION@@" "opkg Build Helper Tools"
+
.SH NAME
oh-installdocs \- Install package documentation into a binary package staging
area.
+
.SH SYNOPSIS
.B oh-installdocs
.IR providing_pkg
+
.SH DESCRIPTION
.B oh-installdocs
copies package documentation files from the source package directory to the
@@ -13,6 +18,7 @@ staging area of the providing binary package and makes links in all other binary
packages to the provided documentation files. The providing binary package
should be depended on by all other binary packages built by the same source
package.
+
.SH COPYRIGHT
Copyright (C) 2012 Patrick "P. J." McDermott
.sp
diff --git a/man/oh-installfiles.1.in b/man/oh-installfiles.1.in
index 67bd5ce..e5f405b 100644
--- a/man/oh-installfiles.1.in
+++ b/man/oh-installfiles.1.in
@@ -1,14 +1,22 @@
.\" Author: Patrick "P. J." McDermott
-.TH oh-installfiles 1 "2012-01-20" "opkhelper-0.1.0" "opkg Build Helper Tools"
+
+.TH oh-installfiles 1 \
+"2012-03-21" "@@PACKAGE@@-@@VERSION@@" "opkg Build Helper Tools"
+
.SH NAME
oh-installfiles \- Install files into a binary package staging area.
+
.SH SYNOPSIS
.B oh-installfiles
.IR pkgname ...
+
.SH DESCRIPTION
.B oh-installfiles
moves files from the source package installation directory to a binary package
-staging area, based on the patterns in the binary package's `install' file.
+staging area, based on the patterns in the binary package's
+.I install
+file.
+
.SH COPYRIGHT
Copyright (C) 2012 Patrick "P. J." McDermott
.sp
diff --git a/man/oh-strip.1.in b/man/oh-strip.1.in
index a3e01ef..355ead6 100644
--- a/man/oh-strip.1.in
+++ b/man/oh-strip.1.in
@@ -1,16 +1,22 @@
.\" Author: Patrick "P. J." McDermott
-.TH oh-strip 1 "2012-01-20" "opkhelper-0.1.0" "opkg Build Helper Tools"
+
+.TH oh-strip 1 \
+"2012-03-21" "@@PACKAGE@@-@@VERSION@@" "opkg Build Helper Tools"
+
.SH NAME
oh-strip \- Strip binary objects of symbols.
+
.SH SYNOPSIS
.B oh-strip
.RB [ -g ]
.RB [ -l ]
.IR binaryfile ...
+
.SH DESCRIPTION
.B oh-strip
strips binary object files of symbols, optionally first copying debugging
symbols into a debugging object file.
+
.SH OPTIONS
.TP
.B \-g
@@ -22,6 +28,7 @@ to the debugging object file.
Treat
.I binaryfile
as a library.
+
.SH COPYRIGHT
Copyright (C) 2012 Patrick "P. J." McDermott
.sp
diff --git a/man/opkbuild.1.in b/man/opkbuild.1.in
index 6853013..557cbe0 100644
--- a/man/opkbuild.1.in
+++ b/man/opkbuild.1.in
@@ -1,7 +1,11 @@
.\" Author: Patrick "P. J." McDermott
-.TH opkbuild 1 "2012-02-03" "opkhelper-0.1.0" "opkg Build Helper Tools"
+
+.TH opkbuild 1 \
+"2012-03-21" "@@PACKAGE@@-@@VERSION@@" "opkg Build Helper Tools"
+
.SH NAME
opkbuild \- Build opkg packages.
+
.SH SYNOPSIS
.B opkbuild
.RB [ -r
@@ -11,9 +15,11 @@ opkbuild \- Build opkg packages.
.RB [ -s
.IR status-override ]
.RB [ -d ]
+
.SH DESCRIPTION
.B opkbuild
builds binary packages from a source package.
+
.SH OPTIONS
.TP
.BI \-r \ assume-uid0-cmd
@@ -36,6 +42,7 @@ for the syntax of this file.
.TP
.BI \-d
Start a debugging shell if the package build fails.
+
.SH COPYRIGHT
Copyright (C) 2012 Patrick "P. J." McDermott
.sp