diff options
Diffstat (limited to 'man7/man.7')
| -rw-r--r-- | man7/man.7 | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/man7/man.7 b/man7/man.7 index fd544eb687..f928de35d6 100644 --- a/man7/man.7 +++ b/man7/man.7 @@ -29,7 +29,7 @@ .\" Modified Tue Jul 27 20:12:02 2004 by Colin Watson <cjwatson@debian.org> .\" 2007-05-30, mtk: various rewrites and moved much text to new man-pages.7. .\" -.TH MAN 7 2007-05-30 "Linux" "Linux Programmer's Manual" +.TH MAN 7 2011-10-05 "Linux" "Linux Programmer's Manual" .SH NAME man \- macros to format man pages .SH SYNOPSIS @@ -102,22 +102,26 @@ followed by the heading name. .\" then place the heading in double quotes. The only mandatory heading is NAME, which should be the first section and -be followed on the next line by a one line description of the program: +be followed on the next line by a one-line description of the program: .RS .sp \&.SH NAME .br +item \\- description .sp .RE It is extremely important that this format is followed, and that there is a -backslash before the single dash which follows the command name. +backslash before the single dash which follows the item name. This syntax is used by the -.BR makewhatis (8) -program to create a database of short command descriptions for the +.BR mandb (8) +program to create a database of short descriptions for the .BR whatis (1) and .BR apropos (1) commands. +(See +.BR lexgrog (1) +for further details on the syntax of the NAME section.) .PP For a list of other sections that might appear in a manual page, see .BR man-pages (7). @@ -551,6 +555,7 @@ is not implemented. .SH "SEE ALSO" .BR apropos (1), .BR groff (1), +.BR lexgrog (1), .BR man (1), .BR man2html (1), .BR whatis (1), |