diff options
Diffstat (limited to 'man7/man-pages.7')
-rw-r--r-- | man7/man-pages.7 | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/man7/man-pages.7 b/man7/man-pages.7 index c7251d134..e27f281ab 100644 --- a/man7/man-pages.7 +++ b/man7/man-pages.7 @@ -60,7 +60,7 @@ other things. .TP .B 8 System management commands Commands like -.BR mount (8), +.MR mount 8 , many of which only root can execute. .\" .TP .\" .B 9 Kernel routines @@ -74,7 +74,7 @@ many of which only root can execute. New manual pages should be marked up using the .B groff an.tmac package described in -.BR man (7). +.MR man 7 . This choice is mainly for consistency: the vast majority of existing Linux manual pages are marked up using these macros. .SS Conventions for source file layout @@ -180,7 +180,7 @@ the above sections. The name of this manual page. .IP See -.BR man (7) +.MR man 7 for important details of the line(s) that should follow the \fB.SH NAME\fP command. All words in this line (including the word immediately @@ -213,7 +213,7 @@ directives, followed by the function declaration. Where a feature test macro must be defined in order to obtain the declaration of a function (or a variable) from a header file, then the SYNOPSIS should indicate this, as described in -.BR feature_test_macros (7). +.MR feature_test_macros 7 . .\" FIXME . Say something here about compiler options .TP .B CONFIGURATION @@ -338,7 +338,7 @@ as the base. .B ATTRIBUTES A summary of various attributes of the function(s) documented on this page. See -.BR attributes (7) +.MR attributes 7 for further details. .TP .B VERSIONS @@ -351,7 +351,7 @@ or command described by the manual page. .IP The preferred terms to use for the various standards are listed as headings in -.BR standards (7). +.MR standards 7 . .IP This section should note the current standards to which the API conforms to. .IP @@ -383,7 +383,7 @@ and library functions that have been added to glibc since glibc 2.1 (i.e., changes since glibc 2.0). .IP The -.BR syscalls (2) +.MR syscalls 2 manual page also provides information about kernel versions in which various system calls first appeared. .P @@ -490,7 +490,7 @@ may be added in the following cases: .IP \[bu] 3 to separate long lists of function prototypes into related groups (see for example -.BR list (3)); +.MR list 3 ); .IP \[bu] in other cases that may improve readability. .P @@ -602,7 +602,7 @@ Any reference to the subject of the current manual page should be written with the name in bold followed by a pair of parentheses in Roman (normal) font. For example, in the -.BR fcntl (2) +.MR fcntl 2 man page, references to the subject of the page would be written as: .BR fcntl (). The preferred way to write this in the source file is: @@ -659,7 +659,7 @@ to be consistent with arrays. .B 1 When it represents fields of a file, to be consistent with tools like -.BR cut (1). +.MR cut 1 . .PD .RE .TP @@ -751,7 +751,7 @@ should be written with the name in bold, followed by the section number, formatted in Roman (normal) font, without any separating spaces (e.g., -.BR intro (2)). +.MR intro 2 ). The preferred way to write this in the source file is: .P .EX @@ -759,7 +759,7 @@ The preferred way to write this in the source file is: .EE .P (Including the section number in cross references lets tools like -.BR man2html (1) +.MR man2html 1 create properly hyperlinked pages.) .P Control characters should be written in bold face, @@ -974,7 +974,7 @@ For hyperlinks, use the .IR .UR / .UE macro pair (see -.BR groff_man (7)). +.MR groff_man 7 ). This produces proper hyperlinks that can be used in a web browser, when rendering a page with, say: .P @@ -1065,7 +1065,7 @@ and the former is probably what you want. .SS Generating optimal glyphs Where a real minus character is required (e.g., for numbers such as \-1, for man page cross references such as -.BR utf\-8 (7), +.MR utf\-8 7 , or when writing options that have a leading dash, such as in .IR "ls\ \-l"), use the following form in the man page source: @@ -1207,21 +1207,21 @@ Boldface the user input text, to distinguish it from output produced by the system. .P For some examples of what example programs should look like, see -.BR wait (2) +.MR wait 2 and -.BR pipe (2). +.MR pipe 2 . .SH EXAMPLES For canonical examples of how man pages in the .I man-pages package should look, see -.BR pipe (2) +.MR pipe 2 and -.BR fcntl (2). +.MR fcntl 2 . .SH SEE ALSO -.BR man (1), -.BR man2html (1), -.BR attributes (7), -.BR groff (7), -.BR groff_man (7), -.BR man (7), -.BR mdoc (7) +.MR man 1 , +.MR man2html 1 , +.MR attributes 7 , +.MR groff 7 , +.MR groff_man 7 , +.MR man 7 , +.MR mdoc 7 |