man: minor fixes
* bin/man/spot-x.x, bin/man/dstar2tgba.x, bin/spot-x.cc: Cosmetics changes. * bin/man/README: New file.
This commit is contained in:
parent
54e25e38d1
commit
17f91132f9
4 changed files with 38 additions and 14 deletions
14
bin/man/README
Normal file
14
bin/man/README
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
To help with keeping man pages in sync with the binaries, the man page
|
||||
for PROGRAM is automatically generated from two sources:
|
||||
1. the --help output of bin/PROGRAM,
|
||||
2. the bin/man/PROGRAM.x file
|
||||
|
||||
The tool help2man is responsible for doing this conversion.
|
||||
|
||||
The PROGRAM.x file has [sections] headers to indicate sections. The
|
||||
rest of the file uses groff macros for man pages. For detail on this
|
||||
syntax, run "man groff_man".
|
||||
|
||||
Note that some of the standard sections will be forced to the top or
|
||||
bottom of the manpage by help2man, the rest will appear as ordered in
|
||||
PROGRAM.x.
|
||||
Loading…
Add table
Add a link
Reference in a new issue