.\" Copyright (c) 1990, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
+.\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
+.\" %%%LICENSE_END
.\"
.\" @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93
.\" $Id: mdoc.samples.7,v 1.17 1998/12/03 03:38:45 jkoshy Exp $
.\" times and is guaranteed to give a worst case performance
.\" for an already extremely slow package.
.\"
+.\" String \*(Pu was not defined, probably means punctuation
+.ds Pu "[ .,:;()[]?! ]
.Dd December 30, 1993
.Os
.Dt MDOC.SAMPLES 7
make up the
.Em "page structure domain"
which consists of macros for titles, section headers, displays
-and lists. Essentially items which affect the physical position
+and lists.
+Essentially items which affect the physical position
of text on a formatted page.
In addition to the page structure domain, there are two more domains,
the manual domain and the general text domain.
.Ql \e
with
.Ql \ee
-(e.g.
+(e.g.,
.Ql \een )
to preserve
the backslash.
.\" PS1 UNIX Programmer's Supplementary Documents
.Pp
.Bl -column SMM -offset indent -compact
-.It Li AMD UNIX Ancestral Manual Documents
-.It Li SMM UNIX System Manager's Manual
-.It Li URM UNIX Reference Manual
-.It Li PRM UNIX Programmer's Manual
+.It Li "AMD UNIX Ancestral Manual Documents"
+.It Li "SMM UNIX System Manager's Manual"
+.It Li "URM UNIX Reference Manual"
+.It Li "PRM UNIX Programmer's Manual"
.El
.Pp
The default volume labeling is
of the form addr1[,addr2[,addr3]].
.Pp
.Dl Usage: .Ad address ... \*(Pu
-.Bl -tag -width ".Ad f1 , f2 , f3 :" -compact -offset 14n
+.Bl -tag -width "\&.Ad f1 , f2 , f3 :" -compact -offset 14n
.It Li \&.Ad addr1
.Ad addr1
.It Li \&.Ad addr1\ .
to be punctuation.
.Pp
.Dl Usage: .An author_name \*(Pu
-.Bl -tag -width ".An Joe Author ) ) ," -compact -offset 14n
+.Bl -tag -width "\&.An Joe Author ) ) ," -compact -offset 14n
.It Li \&.An Joe\ Author
.An Joe Author
.It Li \&.An Joe\ Author\ ,
a command-line argument is referenced.
.Pp
.Dl Usage: .Ar argument ... \*(Pu
-.Bl -tag -width ".Ar file1 file2" -compact -offset 15n
+.Bl -tag -width "\&.Ar file1 file2" -compact -offset 15n
.It Li \&.Ar
.Ar
.It Li \&.Ar file1
If
.Ql \&.Ar
is called without arguments
-.Ql Ar
+.Ql \&Ar
is assumed.
The
.Ql \&.Ar
.Ql \&.Dv .
.Pp
.Dl Usage: .Dv defined_variable ... \*(Pu
-.Bl -tag -width ".Dv MAXHOSTNAMELEN" -compact -offset 14n
+.Bl -tag -width "\&.Dv MAXHOSTNAMELEN" -compact -offset 14n
.It Li ".Dv MAXHOSTNAMELEN"
.Dv MAXHOSTNAMELEN
.It Li ".Dv TIOCGPGRP )"
a section two manual page.
.Pp
.Dl Usage: .Er ERRNOTYPE ... \*(Pu
-.Bl -tag -width ".Bq Er ENOTDIR" -compact -offset 14n
+.Bl -tag -width "\&.Bq Er ENOTDIR" -compact -offset 14n
.It Li \&.Er ENOENT
.Er ENOENT
.It Li \&.Er ENOENT\ )\ ;
macro specifies an environment variable.
.Pp
.Dl Usage: .Ev argument ... \*(Pu
-.Bl -tag -width ".Ev PRINTER ) ) ," -compact -offset 14n
+.Bl -tag -width "\&.Ev PRINTER ) ) ," -compact -offset 14n
.It Li \&.Ev DISPLAY
.Ev DISPLAY
.It Li \&.Ev PATH\ .
may also be used to refer to structure members.
.Pp
.Dl Usage: .Fa function_argument ... \*(Pu
-.Bl -tag -width ".Fa d_namlen\ )\ )\ ," -compact -offset 14n
+.Bl -tag -width "\&.Fa d_namlen\ )\ )\ ," -compact -offset 14n
.It Li \&.Fa d_namlen\ )\ )\ ,
.Fa d_namlen ) ) ,
.It Li \&.Fa iov_len
macro is identical, but without the dash.
.Pp
.Dl Usage: .Fl argument ... \*(Pu
-.Bl -tag -width ".Fl \-s \-t \-v" -compact -offset 14n
+.Bl -tag -width "\&.Fl \-s \-t \-v" -compact -offset 14n
.It Li \&.Fl
.Fl
.It Li \&.Fl cfv
.Bd -literal
Usage: .Fn [type] function [[type] parameters ... \*(Pu]
.Ed
-.Bl -tag -width ".Fn _int align_ _const * char *sptrsxx" -compact
+.Bl -tag -width "\&.Fn _int align_ _const * char *sptrsxx" -compact
.It Li "\&.Fn getchar"
.Fn getchar
.It Li "\&.Fn strlen ) ,"
macro designates an interactive or internal command.
.Pp
.Dl Usage: .Ic argument ... \*(Pu
-.Bl -tag -width ".Ic setenv , unsetenvxx" -compact -offset 14n
+.Bl -tag -width "\&.Ic setenv , unsetenvxx" -compact -offset 14n
.It Li \&.Ic :wq
.Ic :wq
.It Li \&.Ic do while {...}
it can not recall the first argument it was invoked with.
.Pp
.Dl Usage: .Nm argument ... \*(Pu
-.Bl -tag -width ".Nm mdoc.sample" -compact -offset 14n
+.Bl -tag -width "\&.Nm mdoc.sample" -compact -offset 14n
.It Li \&.Nm mdoc.sample
.Nm mdoc.sample
.It Li \&.Nm \e-mdoc
may be used across one or more lines.
.Pp
.Dl Usage: .Op options ... \*(Pu
-.Bl -tag -width ".Op Fl c Ar objfil Op Ar corfil ," -compact -offset indent
+.Bl -tag -width "\&.Op Fl c Ar objfil Op Ar corfil ," -compact -offset indent
.It Li \&.Op
.Op
.It Li ".Op Fl k"
macro formats pathnames or filenames.
.Pp
.Dl Usage: .Pa pathname \*(Pu
-.Bl -tag -width ".Pa /tmp/fooXXXXX ) ." -compact -offset 14n
+.Bl -tag -width "\&.Pa /tmp/fooXXXXX ) ." -compact -offset 14n
.It Li \&.Pa /usr/share
.Pa /usr/share
.It Li \&.Pa /tmp/fooXXXXX\ )\ .
Generic variable reference:
.Pp
.Dl Usage: .Va variable ... \*(Pu
-.Bl -tag -width ".Va char s ] ) ) ," -compact -offset 14n
+.Bl -tag -width "\&.Va char s ] ) ) ," -compact -offset 14n
.It Li \&.Va count
.Va count
.It Li \&.Va settimer ,
remaining arguments are assumed to be punctuation.
.Pp
.Dl Usage: .Xr man_page [1,...,8] \*(Pu
-.Bl -tag -width ".Xr mdoc 7 ) ) ," -compact -offset 14n
+.Bl -tag -width "\&.Xr mdoc 7 ) ) ," -compact -offset 14n
.It Li \&.Xr mdoc
.Xr mdoc
.It Li \&.Xr mdoc\ ,
.Bd -literal -offset indent -compact
Usage: .At [v6 | v7 | 32v | V.1 | V.4] ... \*(Pu
.Ed
-.Bl -tag -width ".At v6 ) ," -compact -offset 14n
+.Bl -tag -width "\&.At v6 ) ," -compact -offset 14n
.It Li ".At"
.At
.It Li ".At v6 ."
It accepts at most two arguments.
.Ss BSD Macro
.Dl Usage: .Bx [Version/release] ... \*(Pu
-.Bl -tag -width ".Bx 4.3 ) ," -compact -offset 14n
+.Bl -tag -width "\&.Bx 4.3 ) ," -compact -offset 14n
.It Li ".Bx"
.Bx
.It Li ".Bx 4.3 ."
.Bd -literal -offset indent -compact
Usage: .Fx Version.release ... \*(Pu
.Ed
-.Bl -tag -width ".Fx 2.2 ) ," -compact -offset 14n
+.Bl -tag -width "\&.Fx 2.2 ) ," -compact -offset 14n
.It Li ".Fx 2.2 ."
.Fx 2.2 .
.El
It accepts at most two arguments.
.Ss UNIX Macro
.Dl Usage: .Ux ... \*(Pu
-.Bl -tag -width ".Ux 4.3 ) ," -compact -offset 14n
+.Bl -tag -width "\&.Ux 4.3 ) ," -compact -offset 14n
.It Li ".Ux"
.Ux
.El
.Pp
.ne 4
Examples of quoting:
-.Bl -tag -width ".Aq Pa ctype.h ) ,xxxxxxxx" -compact -offset indent
+.Bl -tag -width "\&.Aq Pa ctype.h ) ,xxxxxxxx" -compact -offset indent
.It Li \&.Aq
.Aq
.It Li \&.Aq \&Ar ctype.h\ )\ ,
macro eliminates unwanted spaces in between macro requests.
It is useful for old style argument lists where there is no space
between the flag and argument:
-.Bl -tag -width ".Op Fl I Ns Ar directoryxx" -offset indent
+.Bl -tag -width "\&.Op Fl I Ns Ar directoryxx" -offset indent
.It Li ".Op Fl I Ns Ar directory"
produces
.Op Fl I Ns Ar directory
.Ql \&.Rv -std atexit
will generate the following text:
.Pp
-.\" fake chapter 3 to avoid error message from Rv
-.ds cH 3
+.\" fake section 3 to avoid error message from Rv
+.\".ds cH 3
+.ds section 3
.Rv -std atexit
.\" and back to 7 again
-.ds cH 7
+.\".ds cH 7
+.ds section 7
.Pp
The
.Fl std
all upper case words longer than two characters.
.Pp
.Dl Usage: .Tn symbol ... \*(Pu
-.Bl -tag -width ".Tn ASCII" -compact -offset 14n
+.Bl -tag -width "\&.Tn ASCII" -compact -offset 14n
.It Li \&.Tn DEC
.Tn DEC
.It Li \&.Tn ASCII
.Ql \&.Sh
macro can take up to nine arguments.
It is parsed and but is not callable.
-.Bl -tag -width ".Sh SYNOPSIS"
+.Bl -tag -width "\&.Sh SYNOPSIS"
.It \&.Sh NAME
The
.Ql \&.Sh NAME
configuration device usage macro.
Several other macros may be necessary to produce
the synopsis line as shown below:
+.El
.Pp
.Bd -filled -offset indent
.Nm cat
.Sx PREDEFINED STRINGS
for a usable \*(Ba
character in other situations.
+.Bl -tag
.It \&.Sh DESCRIPTION
In most cases the first text in the
.Sx DESCRIPTION
The display-type must be one of the following four types and
may have an offset specifier for indentation:
.Ql \&.Bd .
+.El
.Pp
.Bl -tag -width "file file_name " -compact
.It Fl ragged
work and perhaps may never do the right thing by
.Xr troff .
.El
-.El
.It ".Ed"
End-display.
.El
The usual font for emphasis is italic.
.Pp
.Dl Usage: .Em argument ... \*(Pu
-.Bl -tag -width ".Em vide infra ) ) ," -compact -offset 14n
+.Bl -tag -width "\&.Em vide infra ) ) ," -compact -offset 14n
.It Li ".Em does not"
.Em does not
.It Li ".Em exceed 1024 ."
would be typed.
.Pp
.Dl Usage: .Li argument ... \*(Pu
-.Bl -tag -width ".Li cntrl-D ) ," -compact -offset 14n
+.Bl -tag -width "\&.Li cntrl-D ) ," -compact -offset 14n
.It Li \&.Li \een
.Li \en
.It Li \&.Li M1 M2 M3\ ;
either the symbolic sense or the traditional English usage.
.Pp
.Dl Usage: .Sy symbol ... \*(Pu
-.Bl -tag -width ".Sy Important Noticex" -compact -offset 14n
+.Bl -tag -width "\&.Sy Important Noticex" -compact -offset 14n
.It Li \&.Sy Important Notice
.Sy Important Notice
-.El
.Pp
The
.Ql \&.Sy
Arguments to
.Ql \&.Sy
may be quoted.
+.El
.It Li \&.Bf
Begin font mode.
The
\&Lastly item three goes here.
\&.El
.Ed
+.El
.Pp
The results:
.Pp
Bullet two here.
.El
.Pp
+.Bl -ohang -compact
.It Fl tag
.It Fl diag
.It Fl hang
.Em tagged .
This
list was constructed with the
-.Ql Fl ohang
+.Ql \&Fl ohang
list-type.
The
.Ql \&.It
macro is parsed only for the inset, hang
and tag list-types and is not callable.
Here is an example of inset labels:
+.El
.Bl -inset -offset indent
.It Em Tag
The tagged list (also called a tagged paragraph) is the
again, the width is set to the constant width of the string
given.
.El
-.El
.Pp
If a width is not specified for the tag list type, the first
time
.Xr groff_mdoc 7 ,
.Xr mdoc 7
.Sh COLOPHON
-This page is part of release 3.35 of the Linux
+This page is part of release 3.50 of the Linux
.Em man-pages
project.
A description of the project,
and information about reporting bugs,
can be found at
-http://man7.org/linux/man-pages/.
+http://www.kernel.org/doc/man-pages/.
OSDN Git Service
