summary refs log tree commit diff
path: root/pamfile.html
diff options
context:
space:
mode:
authoresr <esr@9d0c8265-081b-0410-96cb-a4ca84ce46f8>2007-01-30 00:58:04 +0000
committeresr <esr@9d0c8265-081b-0410-96cb-a4ca84ce46f8>2007-01-30 00:58:04 +0000
commitfdbf040027bc4aa775c3dc5df17a9ef7f8c628ed (patch)
treeee8912f31981ebd0280cc7b936a1ebf37712ed07 /pamfile.html
parent08aa778e94e16817ed35b74a85d77526d0f378e3 (diff)
downloadnetpbm-mirror-fdbf040027bc4aa775c3dc5df17a9ef7f8c628ed.tar.gz
netpbm-mirror-fdbf040027bc4aa775c3dc5df17a9ef7f8c628ed.tar.xz
netpbm-mirror-fdbf040027bc4aa775c3dc5df17a9ef7f8c628ed.zip
This commit fixes makeman and the HTML sources so that they generate
manual pages that pass strict validation with doclifter.  

The required changes are widely scattered but relatively minor.  Most
are just tweaks to command-invocation syntax descriptions.  One large class of 
these simply moves running text out of SYNOPSIS sections into OPTIONS
sections. Another thing I had to do frequently was regroup syntax description 
so that plain-text tokens (e.g. filenames without surrounding [] or trailing
...) are on the same line with syntactic specials such as [ | ] { } ...

(Both these changes accommodate the limits of mechanical markup parsers
Even doclifter's, which is quite sophisticated and knows how to detect 
some natural-language patterns, has trouble telling some simple forms of 
command synopses from running text and will sometimes try to parse text
commentary as command syntax, with unhappy results.)

This commit also adds (to buildtools/Makefile.manpages) install and
uninstall productions that distribution packagers can use to install
the generated manual pages in /usr/share/man.

I fixed a few spelling and usage bobbles I found along the way.



git-svn-id: http://svn.code.sf.net/p/netpbm/code/userguide@218 9d0c8265-081b-0410-96cb-a4ca84ce46f8
Diffstat (limited to 'pamfile.html')
-rw-r--r--pamfile.html11
1 files changed, 5 insertions, 6 deletions
diff --git a/pamfile.html b/pamfile.html
index f78ba740..16c39d33 100644
--- a/pamfile.html
+++ b/pamfile.html
@@ -20,12 +20,6 @@ pamfile - describe a Netpbm (PAM or PNM) file
 
 [<I>file</i> ...]
 
-<P>Minimum unique abbreviation of option is acceptable.  You may use
-double hyphens instead of single hyphen to denote options.  You may use
-white space in place of the equals sign to separate an option name
-from its value.
-
-
 <H2 id="description">DESCRIPTION</H2>
 
 <p>This program is part of <a href="index.html">Netpbm</a>.
@@ -34,6 +28,11 @@ from its value.
 out short descriptions of the image type, size, etc.  This is partly
 for use in shell scripts, so the format is not particularly pretty.
 
+<P>Minimum unique abbreviations of options are acceptable.  You may use
+double hyphens instead of single hyphen to denote options.  You may use
+white space in place of the equals sign to separate an option name
+from its value.
+
 <p>By default, <b>pamfile</b> reads only the header of the input file.
 If that file is a pipe, that might cause problems for the process that is
 feeding the pipe.  In that case, see the <b>-allimages</b> option.