* The code sample given for the NAME section is incomplete because the actual content sample is not given.
* Additionally, the description assumes that the item described is a command, which need not be the case.
* The command makewhatis is not present on my system; the documented tool to create the whatis database is called mandb.
* The reference to man(7) in man-pages(7) with respect to the NAME section should be replaced by lexgrog(1), since it is the authoritative page for whatis.
* The description on .SH NAME in man(7) should either copy the relevant paragraph of lexgrog(1) or refer to it.
Please fix,
Chris
Is:
The only mandatory heading is NAME, which should be the first section and be fol‐
lowed on the next line by a one line description of the program:
.SH NAME
It is extremely important that this format is followed, and that there is a back‐
slash before the single dash which follows the command name. This syntax is used
by the makewhatis(8) program to create a database of short command descriptions
for the whatis(1) and apropos(1) commands.
Let:
The only mandatory heading is NAME, which should be the first section and be fol‐
lowed on the next line by a one line description of the program:
.SH NAME
item \- description
It is extremely important that this format is followed, and that there is a back‐
slash before the single dash which follows the item name. This syntax is used
by the mandb(8) program to create a database of short command descriptions
for the whatis(1) and apropos(1) commands.
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
