LDP: Update original to LDP v3.79

[linuxjm/LDP_man-pages.git] / original / man7 / man.7

diff --git a/original/man7/man.7 b/original/man7/man.7
index fd544eb..b76d883 100644 (file)
--- a/original/man7/man.7
+++ b/original/man7/man.7
@@ -1,6 +1,7 @@
 .\" (C) Copyright 1992-1999 Rickard E. Faith and David A. Wheeler
 .\" (faith@cs.unc.edu and dwheeler@ida.org)
 .\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
 .\" preserved on all copies.
@@ -20,6 +21,7 @@
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
 .\" Modified Sun Jul 25 11:06:05 1993 by Rik Faith (faith@cs.unc.edu)
 .\" Modified Sat Jun  8 00:39:52 1996 by aeb
@@ -29,7 +31,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 2012-08-05 "Linux" "Linux Programmer's Manual"
 .SH NAME
 man \- macros to format man pages
 .SH SYNOPSIS
@@ -82,7 +84,8 @@ that is, lines that start with \fB.\\"\fP) should be
 .I "title section date source manual"
 .sp
 .RE
-For details of the arguments that should be supplied to the \fBTH\fP
+For details of the arguments that should be supplied to the
+.B TH
 command, see
 .BR man-pages (7).
 .PP
@@ -102,22 +105,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).
@@ -169,7 +176,7 @@ command can be used to specify a word in bold followed by a mark of
 punctuation in Roman.
 If no arguments are given, the command is applied to the following line
 of text.
-.SS "Other Macros and Strings"
+.SS Other macros and strings
 .PP
 Below are other relevant macros and predefined strings.
 Unless noted otherwise, all macros
@@ -189,7 +196,7 @@ By default a given indent is measured in ens;
 try to use ens or ems as units for
 indents, since these will automatically adjust to font size changes.
 The other key macro definitions are:
-.SS "Normal Paragraphs"
+.SS Normal paragraphs
 .TP 9m
 .B \&.LP
 Same as
@@ -203,7 +210,7 @@ Same as
 .TP
 .B \&.PP
 Begin a new paragraph and reset prevailing indent.
-.SS "Relative Margin Indent"
+.SS Relative margin indent
 .TP 9m
 .BI \&.RS " i"
 Start relative margin indent: moves the left margin
@@ -219,7 +226,7 @@ indented until the corresponding
 .B \&.RE
 End relative margin indent and
 restores the previous value of the prevailing indent.
-.SS "Indented Paragraph Macros"
+.SS Indented paragraph macros
 .TP 9m
 .BI \&.HP " i"
 Begin paragraph with a hanging indent
@@ -253,7 +260,7 @@ The tag is given on the next line, but
 its results are like those of the
 .B \&.IP
 command.
-.SS "Hypertext Link Macros"
+.SS Hypertext link macros
 (Feature supported with
 .B groff
 only.)
@@ -329,7 +336,7 @@ A number of other link macros are available.
 See
 .BR groff_www (7)
 for more details.
-.SS "Miscellaneous Macros"
+.SS Miscellaneous macros
 .TP 9m
 .B \&.DT
 Reset tabs to default tab values (every 0.5 inches);
@@ -346,7 +353,7 @@ Subheading
 (like
 .BR \&.SH ,
 but used for a subsection inside a section).
-.SS "Predefined Strings"
+.SS Predefined strings
 The
 .B man
 package has the following predefined strings:
@@ -360,7 +367,7 @@ Trademark Symbol: \*(Tm
 Left angled double quote: \*(lq
 .IP \e*(rq
 Right angled double quote: \*(rq
-.SS "Safe Subset"
+.SS Safe subset
 Although technically
 .B man
 is a troff macro package, in reality a large number of other tools
@@ -479,8 +486,10 @@ You can also use the new
 .B URL
 macro to identify links to related information.
 If you include URLs, use the full URL
-(e.g., <http://www.kernelnotes.org>) to ensure that tools
-can automatically find the URLs.
+(e.g.,
+.UR http://www.kernelnotes.org
+.UE )
+to ensure that tools can automatically find the URLs.
 .PP
 Tools processing these files should open the file and examine the first
 nonwhitespace character.
@@ -548,9 +557,10 @@ is not implemented.
 .\" .IP \(em
 .\" David A. Wheeler (dwheeler@ida.org) heavily modified this
 .\" manual page, such as adding detailed information on sections and macros.
-.SH "SEE ALSO"
+.SH SEE ALSO
 .BR apropos (1),
 .BR groff (1),
+.BR lexgrog (1),
 .BR man (1),
 .BR man2html (1),
 .BR whatis (1),
@@ -559,3 +569,12 @@ is not implemented.
 .BR man-pages (7),
 .BR mdoc (7),
 .BR mdoc.samples (7)
+.SH COLOPHON
+This page is part of release 3.79 of the Linux
+.I man-pages
+project.
+A description of the project,
+information about reporting bugs,
+and the latest version of this page,
+can be found at
+\%http://www.kernel.org/doc/man\-pages/.