.Dx (DragonFly) macro-ized man pages
Aaron Malone
aaron at munge.net
Wed Feb 25 15:18:18 PST 2004
Here is a big batch of man pages updated to include .Dx where we mean
DragonFly, and .Fx where we mean FreeBSD. The patch to add the .Dx macro is
part of this diff. One file (gnu/usr.bin/groff/tmac/groff_mdoc.man) will
need to be added to the repo.
Below are some random notes I thought might be significant; however, after
going through all those man pages, I don't know that my brain works well
enough for me to trust its judgment. ;)
I tried to keep my changes as accurate and unintrusive as possible; thus there
are references to, say, "DragonFly/FreeBSD" on pages talking about whether or
not interesting NIS features work with certain server OSes.
I'm sure this isn't complete yet -- my major criterion was looking for .Fx
macros, and I did run across a few naughty man pages that used 'FreeBSD' when
they meant .Fx. Haven't looked exhaustively for those yet.
notes:
pcvt.4: Ick. Added a note saying to pretend that you're using FreeBSD for
the purposes of this page.
drivers.conf.5: left untouched, since the install system is not finalized.
ssh{,d}_config.5: updated VersionAddendum to reflect reality; also updated
this in the actual config files. These need to be updated on openssh
releases.
development.7: left untouched. Perhaps better to do a custom rewrite;
Matt wrote the original anyway. :)
picobsd.8: left untouched; I haven't the slightest idea how much of this
is true for us.
sysinstall.8: left untouched; see drivers.conf note above. :)
--
Aaron Malone
aaron at xxxxxxxxx
Index: crypto/openssh/ssh_config
===================================================================
RCS file: /home/dcvs/src/crypto/openssh/ssh_config,v
retrieving revision 1.2
diff -u -u -r1.2 ssh_config
--- crypto/openssh/ssh_config 17 Jun 2003 04:24:36 -0000 1.2
+++ crypto/openssh/ssh_config 25 Feb 2004 21:46:28 -0000
@@ -36,4 +36,4 @@
# Cipher 3des
# Ciphers aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,aes192-cbc,aes256-cbc
# EscapeChar ~
-# VersionAddendum FreeBSD-20030201
+# VersionAddendum DragonFly-20030916B
Index: crypto/openssh/ssh_config.5
===================================================================
RCS file: /home/dcvs/src/crypto/openssh/ssh_config.5,v
retrieving revision 1.2
diff -u -u -r1.2 ssh_config.5
--- crypto/openssh/ssh_config.5 17 Jun 2003 04:24:36 -0000 1.2
+++ crypto/openssh/ssh_config.5 25 Feb 2004 21:46:31 -0000
@@ -617,7 +617,7 @@
Specifies a string to append to the regular version string to identify
OS- or site-specific modifications.
The default is
-.Dq FreeBSD-20030201 .
+.Dq DragonFly-20030916B .
.It Cm XAuthLocation
Specifies the full pathname of the
.Xr xauth 1
Index: crypto/openssh/sshd_config
===================================================================
RCS file: /home/dcvs/src/crypto/openssh/sshd_config,v
retrieving revision 1.2
diff -u -u -r1.2 sshd_config
--- crypto/openssh/sshd_config 17 Jun 2003 04:24:36 -0000 1.2
+++ crypto/openssh/sshd_config 25 Feb 2004 21:46:34 -0000
@@ -15,7 +15,7 @@
# Note that some of FreeBSD's defaults differ from OpenBSD's, and
# FreeBSD has a few additional options.
-#VersionAddendum FreeBSD-20030201
+#VersionAddendum DragonFly-20030916B
#Port 22
#Protocol 2,1
Index: crypto/openssh/sshd_config.5
===================================================================
RCS file: /home/dcvs/src/crypto/openssh/sshd_config.5,v
retrieving revision 1.2
diff -u -u -r1.2 sshd_config.5
--- crypto/openssh/sshd_config.5 17 Jun 2003 04:24:36 -0000 1.2
+++ crypto/openssh/sshd_config.5 25 Feb 2004 21:46:36 -0000
@@ -129,7 +129,7 @@
.It Cm ChallengeResponseAuthentication
Specifies whether challenge-response authentication is allowed.
Specifically, in
-.Fx ,
+.Dx ,
this controls the use of PAM (see
.Xr pam 3 )
for authentication.
@@ -648,7 +648,7 @@
Specifies a string to append to the regular version string to identify
OS- or site-specific modifications.
The default is
-.Dq FreeBSD-20030201 .
+.Dq DragonFly-20030916B .
.It Cm X11DisplayOffset
Specifies the first display number available for
.Nm sshd Ns 's
Index: gnu/usr.bin/groff/tmac/doc-common
===================================================================
RCS file: /home/dcvs/src/gnu/usr.bin/groff/tmac/doc-common,v
retrieving revision 1.1
diff -u -u -r1.1 doc-common
--- gnu/usr.bin/groff/tmac/doc-common 3 Feb 2004 08:37:33 -0000 1.1
+++ gnu/usr.bin/groff/tmac/doc-common 18 Feb 2004 20:12:59 -0000
@@ -80,6 +80,7 @@
.nr Dq 12n
.nr Ds 6n\" many manpages still use this as a -width value
.nr Dv 12n
+.nr Dx 1
.nr Ec 3
.nr Ef 8n\" ?
.nr Ek 8n\" ?
@@ -453,6 +454,14 @@
. el \
. tm mdoc warning: .Os: Unknown BSD version `\$2' (#\n[.c])
. \}\}
+. el \{ .ie "\$1"FreeBSD" \{\
+. ds doc-operating-system FreeBSD
+. if \A\$2 \{\
+. ie d doc-operating-system-FreeBSD-\$2 \
+. as doc-operating-system \~\*[doc-operating-system-FreeBSD-\$2]
+. el \
+. tm mdoc warning: .Os: Unknown FreeBSD version `\$2' (#\n[.c])
+. \}\}
. el \{ .ie "\$1"DragonFly" \{\
. ds doc-operating-system DragonFly
. if \A\$2 \{\
Index: gnu/usr.bin/groff/tmac/doc-syms
===================================================================
RCS file: /home/dcvs/src/gnu/usr.bin/groff/tmac/doc-syms,v
retrieving revision 1.1
diff -u -u -r1.1 doc-syms
--- gnu/usr.bin/groff/tmac/doc-syms 3 Feb 2004 08:37:33 -0000 1.1
+++ gnu/usr.bin/groff/tmac/doc-syms 18 Feb 2004 20:12:59 -0000
@@ -262,7 +262,7 @@
.
.
.\" NS Fx user macro
-.\" NS print DragonFly
+.\" NS print FreeBSD
.\" NS
.\" NS modifies:
.\" NS doc-arg-ptr
@@ -284,7 +284,7 @@
. ds doc-str-Fx \f[\n[doc-curr-font]]\s[\n[doc-curr-size]u]
.
. \" default value if no argument
-. ds doc-str-Fx1 \*[doc-Tn-font-size]\%DragonFly\*[doc-str-Fx]
+. ds doc-str-Fx1 \*[doc-Tn-font-size]\%FreeBSD\*[doc-str-Fx]
.
. if !\n[doc-arg-limit] \
. if \n[.$] \{\
@@ -296,10 +296,10 @@
. nr doc-arg-ptr +1
. ie (\n[doc-type\n[doc-arg-ptr]] == 2) \{\
. ie \A\*[doc-arg\n[doc-arg-ptr]] \{\
-. ie d doc-operating-system-DragonFly-\*[doc-arg\n[doc-arg-ptr]] \
-. as doc-str-Fx1 \~\*[doc-operating-system-DragonFly-\*[doc-arg\n[doc-arg-ptr]]]
+. ie d doc-operating-system-FreeBSD-\*[doc-arg\n[doc-arg-ptr]] \
+. as doc-str-Fx1 \~\*[doc-operating-system-FreeBSD-\*[doc-arg\n[doc-arg-ptr]]]
. el \{\
-. tmc mdoc warning: .Fx: Unknown DragonFly version
+. tmc mdoc warning: .Fx: Unknown FreeBSD version
. tm1 " `\*[doc-arg\n[doc-arg-ptr]]' (#\n[.c])
. as doc-str-Fx1 \~\*[doc-arg\n[doc-arg-ptr]]
. \}\}
@@ -325,6 +325,70 @@
..
.
.
+.\" NS Dx user macro
+.\" NS print DragonFly
+.\" NS
+.\" NS modifies:
+.\" NS doc-arg-ptr
+.\" NS doc-curr-font
+.\" NS doc-curr-size
+.\" NS doc-macro-name
+.\" NS
+.\" NS local variable:
+.\" NS doc-str-Dx
+.\" NS doc-str-Dx1
+.\" NS
+.\" NS width register `Dx' defined in doc-common
+.
+.\" we use the doc-operating-system-DragonFly-* strings defined in doc-common
+.
+.de Dx
+. nr doc-curr-font \n[.f]
+. nr doc-curr-size \n[.ps]
+. ds doc-str-Dx \f[\n[doc-curr-font]]\s[\n[doc-curr-size]u]
+.
+. \" default value if no argument
+. ds doc-str-Dx1 \*[doc-Tn-font-size]\%DragonFly\*[doc-str-Dx]
+.
+. if !\n[doc-arg-limit] \
+. if \n[.$] \{\
+. ds doc-macro-name Dx
+. doc-parse-args \$@
+. \}
+.
+. if (\n[doc-arg-limit] > \n[doc-arg-ptr]) \{\
+. nr doc-arg-ptr +1
+. ie (\n[doc-type\n[doc-arg-ptr]] == 2) \{\
+. ie \A\*[doc-arg\n[doc-arg-ptr]] \{\
+. ie d doc-operating-system-DragonFly-\*[doc-arg\n[doc-arg-ptr]] \
+. as doc-str-Dx1 \~\*[doc-operating-system-DragonFly-\*[doc-arg\n[doc-arg-ptr]]]
+. el \{\
+. tmc mdoc warning: .Dx: Unknown DragonFly version
+. tm1 " `\*[doc-arg\n[doc-arg-ptr]]' (#\n[.c])
+. as doc-str-Dx1 \~\*[doc-arg\n[doc-arg-ptr]]
+. \}\}
+. el \
+. as doc-str-Dx1 \~\*[doc-arg\n[doc-arg-ptr]]
+. \}
+. el \
+. nr doc-arg-ptr -1
+. \}
+.
+. \" replace current argument with result
+. ds doc-arg\n[doc-arg-ptr] "\*[doc-str-Dx1]
+. nr doc-type\n[doc-arg-ptr] 2
+. ds doc-space\n[doc-arg-ptr] "\*[doc-space]
+.
+. \" recompute space vector for remaining arguments
+. nr doc-num-args (\n[doc-arg-limit] - \n[doc-arg-ptr])
+. nr doc-arg-limit \n[doc-arg-ptr]
+. if \n[doc-num-args] \
+. doc-parse-space-vector
+.
+. doc-print-recursive
+..
+.
+.
.\" NS Nx user macro
.\" NS print NetBSD
.\" NS
Index: gnu/usr.bin/groff/tmac/groff_mdoc.man
===================================================================
RCS file: gnu/usr.bin/groff/tmac/groff_mdoc.man
diff -N gnu/usr.bin/groff/tmac/groff_mdoc.man
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ gnu/usr.bin/groff/tmac/groff_mdoc.man 25 Feb 2004 22:17:54 -0000
@@ -0,0 +1,4068 @@
+.\" groff_mdoc.man
+.\"
+.\" A complete reference of the mdoc macro package for GNU troff.
+.\"
+.\" Based on NetBSD's mdoc.samples.7, version 1.21.
+.\"
+.\"
+.\" Warning: You can't format this file with the old mdoc macros!
+.\"
+.\"
+.\" Copyright (c) 1990, 1993
+.\" The Regents of the University of California. All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\" must display the following acknowledgement:
+.\" This product includes software developed by the University of
+.\" California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\" may be used to endorse or promote products derived from this software
+.\" without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" 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.
+.\"
+.\" @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93
+.\"
+.\" This reference invokes every macro in the package several
+.\" times and is guaranteed to give a worst case performance
+.\" for an already extremely slow package.
+.\"
+.
+.Dd October 07, 2002
+.Os
+.Dt GROFF_MDOC 7
+.
+.
+.Sh NAME
+.
+.Nm groff_mdoc
+.Nd reference for groff's mdoc implementation
+.
+.
+.Sh SYNOPSIS
+.
+.Nm groff Fl m Ns Cm doc Ar
+.
+.
+.Sh DESCRIPTION
+.
+A complete reference for writing
+.Ux
+manual pages with the
+.Nm \-mdoc
+macro package; a
+.Em content Ns -based
+and
+.Em domain Ns -based
+formatting package for
+.Tn GNU
+.Xr troff 1 .
+Its predecessor, the
+.Xr \-man 7
+package, addressed page layout leaving the manipulation of fonts and other
+typesetting details to the individual author.
+In
+.Nm \-mdoc ,
+page layout macros 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 of text on a
+formatted page.
+In addition to the page structure domain, there are two more domains, the
+.Em manual
+domain and the
+.Em general
+text domain.
+The general text domain is defined as macros which perform tasks such as
+quoting or emphasizing pieces of text.
+The manual domain is defined as macros that are a subset of the day to day
+informal language used to describe commands, routines and related
+.Ux
+files.
+Macros in the manual domain handle command names, command line arguments and
+options, function names, function parameters, pathnames, variables, cross
+references to other manual pages, and so on.
+These domain items have value for both the author and the future user of the
+manual page.
+Hopefully, the consistency gained across the manual set will provide easier
+translation to future documentation tools.
+.Pp
+Throughout the
+.Ux
+manual pages, a manual entry is simply referred to as a man page, regardless
+of actual length and without sexist intention.
+.
+.
+.Sh "GETTING STARTED"
+.
+The material presented in the remainder of this document is outlined
+as follows:
+.
+.Bl -enum -width 3n -offset indent
+. It
+. Tn "TROFF IDIOSYNCRASIES"
+.
+. Bl -tag -width 2n -compact
+. It "Macro Usage"
+. It "Passing Space Characters in an Argument"
+. It "Trailing Blank Space Characters"
+. It "Escaping Special Characters"
+. It "Other Possible Pitfalls"
+. El
+.
+. It
+. Tn "A MANUAL PAGE TEMPLATE"
+.
+. It
+. Tn "CONVENTIONS"
+.
+. It
+. Tn "TITLE MACROS"
+.
+. It
+. Tn "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
+.
+. Bl -tag -width 2n -compact
+. It "What's in a Name" Ns ...
+. It "General Syntax"
+. El
+.
+. It
+. Tn "MANUAL DOMAIN"
+.
+. Bl -tag -width 2n -compact
+. It "Addresses"
+. It "Author Name"
+. It "Arguments"
+. It "Configuration Declarations (Section Four Only)"
+. It "Command Modifiers"
+. It "Defined Variables"
+. It "Errno's"
+. It "Environment Variables"
+. It "Flags"
+. It "Function Declarations"
+. It "Function Types"
+. It "Functions (Library Routines)"
+. It "Function Arguments"
+. It "Return Values"
+. It "Exit Status"
+. \" .It "Header File (including source code)"
+. It "Interactive Commands"
+. It "Library Names"
+. It "Literals"
+. It "Names"
+. It "Options"
+. It "Pathnames"
+. It "Standards"
+. It "Variable Types"
+. It "Variables"
+. It "Manual Page Cross References"
+. El
+.
+. It
+. Tn "GENERAL TEXT DOMAIN"
+.
+. Bl -tag -width 2n -compact
+. It "AT&T Macro"
+. It "BSD Macro"
+. It "NetBSD Macro"
+. It "FreeBSD Macro"
+. It "DragonFly Macro"
+. It "OpenBSD Macro"
+. It "BSD/OS Macro"
+. It "UNIX Macro"
+. It "Emphasis Macro"
+. It "Font Mode"
+. It "Enclosure and Quoting Macros"
+. It "No-Op or Normal Text Macro"
+. It "No-Space Macro"
+. It "Section Cross References"
+. It "Symbolics"
+. It "Mathematical Symbols"
+. It "References and Citations"
+. It "Trade Names (or Acronyms and Type Names)"
+. It "Extended Arguments"
+. El
+.
+. It
+. Tn "PAGE STRUCTURE DOMAIN"
+.
+. Bl -tag -width 2n -compact
+. It "Section Headers"
+. It "Subsection Headers"
+. It "Paragraphs and Line Spacing"
+. It "Keeps"
+. It "Examples and Displays"
+. It "Lists and Columns"
+. El
+.
+. It
+. Tn "MISCELLANEOUS MACROS"
+.
+. It
+. Tn "PREDEFINED STRINGS"
+.
+. It
+. Tn "DIAGNOSTICS"
+.
+. It
+. Tn "FORMATTING WITH GROFF, TROFF, AND NROFF"
+.
+. It
+. Tn "FILES"
+.
+. It
+. Tn "SEE ALSO"
+.
+. It
+. Tn "BUGS"
+.El
+.
+.\" XXX
+.if t \
+. ne 7
+.
+.
+.Sh "TROFF IDIOSYNCRASIES"
+.
+The
+.Nm \-mdoc
+package attempts to simplify the process of writing a man page.
+Theoretically, one should not have to learn the tricky details of
+.Tn GNU
+.Xr troff 1
+to use
+.Nm \-mdoc ;
+however, there are a few limitations which are unavoidable and best gotten
+out of the way.
+And, too, be forewarned, this package is
+.Em not
+fast.
+.
+.Ss "Macro Usage"
+.
+As in
+.Tn GNU
+.Xr troff 1 ,
+a macro is called by placing a
+.Ql .\&
+(dot character) at the beginning of a line followed by the two-character
+(or three-character) name for the macro.
+There can be space or tab characters between the dot and the macro name.
+Arguments may follow the macro separated by spaces (but
+.Em no
+tabs).
+It is the dot character at the beginning of the line which causes
+.Tn GNU
+.Xr troff 1
+to interpret the next two (or more) characters as a macro name.
+A single starting dot followed by nothing is ignored.
+To place a
+.Ql .\&
+(dot character) at the beginning of an input line in some context other than
+a macro invocation, precede the
+.Ql .\&
+(dot) with the
+.Ql \e&
+escape sequence which translates literally to a zero-width space, and is
+never displayed in the output.
+.Pp
+In general,
+.Tn GNU
+.Xr troff 1
+macros accept an unlimited number of arguments (contrary to other versions
+of troff which can't handle more than nine arguments).
+In limited cases, arguments may be continued or extended on the next
+line (See
+.Sx Extended Arguments
+below).
+Almost all macros handle quoted arguments (see
+.Sx Passing Space Characters in an Argument
+below).
+.Pp
+Most of the
+.Nm \-mdoc
+general text domain and manual domain macros are special in that their
+argument lists are
+.Em parsed
+for callable macro names.
+This means an argument on the argument list which matches a general text or
+manual domain macro name (and which is defined to be callable) will be
+executed or called when it is processed.
+In this case the argument, although the name of a macro, is not preceded by
+a
+.Ql .\&
+(dot).
+This makes it possible to nest macros; for example the option macro,
+.Ql .Op ,
+may
+.Em call
+the flag and argument macros,
+.Ql \&Fl
+and
+.Ql \&Ar ,
+to specify an optional flag with an argument:
+.
+.Bl -tag -width ".Op Fl s Ar bytes" -offset indent
+.It Op Fl s Ar bytes
+is produced by
+.Ql ".Op Fl s Ar bytes"
+.El
+.
+.Pp
+To prevent a string from being interpreted as a macro name, precede the
+string with the escape sequence
+.Ql \e& :
+.
+.Bl -tag -width ".Op \&Fl s \&Ar bytes" -offset indent
+.It Op \&Fl s \&Ar bytes
+is produced by
+.Ql ".Op \e&Fl s \e&Ar bytes"
+.El
+.
+.Pp
+Here the strings
+.Ql \&Fl
+and
+.Ql \&Ar
+are not interpreted as macros.
+Macros whose argument lists are parsed for callable arguments are referred
+to as
+.Em parsed
+and macros which may be called from an argument list are referred to as
+.Em callable
+throughout this document.
+This is a technical
+.Em faux pas
+as almost all of the macros in
+.Nm \-mdoc
+are parsed, but as it was cumbersome to constantly refer to macros as
+being callable and being able to call other macros, the term parsed
+has been used.
+.
+.Pp
+In the following, we call an
+.Nm \-mdoc
+macro which starts a line (with a leading dot) a
+.Em command
+if this distinction is necessary.
+.
+.Ss "Passing Space Characters in an Argument"
+.
+Sometimes it is desirable to give as an argument a string containing one or
+more blank space characters, say, to specify arguments to commands which
+expect particular arrangement of items in the argument list.
+Additionally, it makes
+.Nm \-mdoc
+working faster.
+For example, the function command
+.Ql .Fn
+expects the first argument to be the name of a function and any remaining
+arguments to be function parameters.
+As
+.Tn ANSI\~C
+stipulates the declaration of function parameters in the parenthesized
+parameter list, each parameter is guaranteed to be at minimum a two word
+string.
+For example,
+.Fa int foo .
+.Pp
+There are two possible ways to pass an argument which contains
+an embedded space.
+One way of passing a string containing blank spaces is to use the hard or
+unpaddable space character
+.Ql \e\ ,
+that is, a blank space preceded by the escape character
+.Ql \e .
+This method may be used with any macro but has the side effect of
+interfering with the adjustment of text over the length of a line.
+.Xr Troff
+sees the hard space as if it were any other printable character and cannot
+split the string into blank or newline separated pieces as one would expect.
+This method is useful for strings which are not expected to overlap a line
+boundary.
+An alternative is to use
+.Ql \e~ ,
+a paddable (i.e.\& stretchable), unbreakable space (this is a
+.Tn GNU
+.Xr troff 1
+extension).
+The second method is to enclose the string with double quotes.
+.Pp
+For example:
+.
+.Bl -tag -width ".Fn fetch char\ *str" -offset indent
+.It Fn fetch char\ *str
+is created by
+.Ql ".Fn fetch char\e *str"
+.It Fn fetch "char *str"
+can also be created by
+.Ql ".Fn fetch \*[q]char *str\*[q]"
+.El
+.
+.Pp
+If the
+.Ql \e
+before the space in the first example
+or double quotes in the second example
+were omitted,
+.Ql .Fn
+would see three arguments, and the result would be:
+.Pp
+.Dl Fn fetch char *str
+.Pp
+.\" For an example of what happens when the parameter list overlaps a newline
+.\" boundary, see the
+.\" .Sx BUGS
+.\" section.
+.
+.Ss "Trailing Blank Space Characters"
+.
+.Xr Troff
+can be confused by blank space characters at the end of a line.
+It is a wise preventive measure to globally remove all blank spaces
+from
+.Ao blank-space Ac Ns Ao end-of-line Ac
+character sequences.
+Should the need arise to use a blank character at the end of a line, it
+may be forced with an unpaddable space and the
+.Ql \e&
+escape character.
+For example,
+.Ql string\e\ \e& .
+.
+.Ss "Escaping Special Characters"
+.
+Special characters like the newline character
+.Ql \en
+are handled by replacing the
+.Ql \e
+with
+.Ql \ee
+(e.g.\&
+.Ql \een )
+to preserve the backslash.
+.
+.Ss "Other Possible Pitfalls"
+.
+A warning is emitted when an empty input line is found outside of displays
+(see below).
+Use
+.Ql .sp
+instead.
+(Well, it is even better to use
+.Nm \-mdoc
+macros to avoid the usage of low-level commands.)
+.Pp
+Leading spaces will cause a break and are output directly.
+Avoid this behaviour if possible.
+Similarly, do not use more than one space character between words in an
+ordinary text line; contrary to other text formatters, they are
+.Em not
+replaced with a single space.
+.Pp
+You can't pass
+.Ql \*[q]
+directly as an argument.
+Use
+.Ql \e*[q]
+(or
+.Ql \e*q )
+instead.
+.Pp
+By default,
+.Xr troff 1
+inserts two space characters after a punctuation mark closing a sentence;
+characters like
+.Ql \&)
+or
+.Ql \&'
+are treated transparently, not influencing the sentence-ending behaviour.
+To change this, insert
+.Ql \e&
+before or after the dot:
+.
+.Bd -literal -offset indent
+The
+\&.Ql .
+character.
+\&.Pp
+The
+\&.Ql \e&.
+character.
+\&.Pp
+\&.No test .
+test
+\&.Pp
+\&.No test.
+test
+.Ed
+.Pp
+.
+gives
+.
+.Bd -filled -offset indent
+The
+.Ql .
+character
+.Pp
+The
+.Ql \&.
+character.
+.Pp
+.No test .
+test
+.Pp
+.No test.
+test
+.Ed
+.Pp
+.
+As can be seen in the first and third line,
+.Nm \-mdoc
+handles punctuation characters specially in macro arguments.
+This will be explained in section
+.Sx General Syntax
+below.
+In the same way, you have to protect trailing full stops of abbreviations
+with a trailing zero-width space:
+.Ql e.g.\e& .
+.Pp
+A comment in the source file of a man page can be either started with
+.Ql .\e"
+on a single line,
+.Ql \e"
+after some input, or
+.Ql \e#
+anywhere (the latter is a
+.Tn GNU
+.Xr troff 1
+extension); the rest of such a line is ignored.
+.
+.
+.Sh "A MANUAL PAGE TEMPLATE"
+.
+The body of a man page is easily constructed from a basic template:
+.
+.Bd -literal -offset indent
+\&.\e" The following commands are required for all man pages.
+\&.Dd Month day, year
+\&.Os [OPERATING_SYSTEM] [version/release]
+\&.Dt DOCUMENT_TITLE [section number] [architecture/volume]
+\&.Sh NAME
+\&.Nm name
+\&.Nd one line description of name
+\&.\e" This next command is for sections 2 and 3 only.
+\&.\e" .Sh LIBRARY
+\&.Sh SYNOPSIS
+\&.Sh DESCRIPTION
+\&.\e" The following commands should be uncommented and
+\&.\e" used where appropriate.
+\&.\e" .Sh IMPLEMENTATION NOTES
+\&.\e" This next command is for sections 2, 3 and 9 function
+\&.\e" return values only.
+\&.\e" .Sh RETURN VALUES
+\&.\e" This next command is for sections 1, 6, 7 and 8 only.
+\&.\e" .Sh ENVIRONMENT
+\&.\e" .Sh FILES
+\&.\e" .Sh EXAMPLES
+\&.\e" This next command is for sections 1, 6, 7, 8 and 9 only
+\&.\e" (command return values (to shell) and
+\&.\e" fprintf/stderr type diagnostics).
+\&.\e" .Sh DIAGNOSTICS
+\&.\e" .Sh COMPATIBILITY
+\&.\e" This next command is for sections 2, 3 and 9 error
+\&.\e" and signal handling only.
+\&.\e" .Sh ERRORS
+\&.\e" .Sh SEE ALSO
+\&.\e" .Sh STANDARDS
+\&.\e" .Sh HISTORY
+\&.\e" .Sh AUTHORS
+\&.\e" .Sh BUGS
+.Ed
+.Pp
+.
+The first items in the template are the commands
+.Ql .Dd ,
+.Ql .Os ,
+and
+.Ql .Dt ;
+the document date, the operating system the man page or subject source is
+developed or modified for, and the man page title (in
+.Em upper case )
+along with the section of the manual the page belongs in.
+These commands identify the page and are discussed below in
+.Sx TITLE MACROS .
+.Pp
+The remaining items in the template are section headers
+.Pf ( Li .Sh ) ;
+of which
+.Sx NAME ,
+.Sx SYNOPSIS ,
+and
+.Sx DESCRIPTION
+are mandatory.
+The headers are discussed in
+.Sx "PAGE STRUCTURE DOMAIN" ,
+after presentation of
+.Sx "MANUAL DOMAIN" .
+Several content macros are used to demonstrate page layout macros; reading
+about content macros before page layout macros is recommended.
+.
+.
+.Sh CONVENTIONS
+.
+In the description of all macros below, optional arguments are put into
+brackets.
+An ellipsis
+.Pf ( Sq ... )
+represents zero or more additional arguments.
+Alternative values for a parameter are separated with
+.Ql | .
+If there are alternative values for a mandatory parameter, braces are used
+(together with
+.Ql | )
+to enclose the value set.
+Meta-variables are specified within angles.
+.Pp
+Example:
+.
+.Bl -tag -width 6n -offset indent
+.It Li .Xx Xo
+.Aq foo
+.Brq bar1 | bar2
+.Op \-test1 Op \-test2 | \-test3
+.No ...
+.Xc
+.El
+.
+.Pp
+Except stated explicitly, all macros are parsed and callable.
+.Pp
+Note that a macro takes effect up to the next nested macro.
+For example,
+.Ql ".Ic foo Aq bar"
+doesn't produce
+.Sq Ic "foo <bar>"
+but
+.Sq Ic foo Aq bar .
+Consequently, a warning message is emitted for most commands if the first
+argument is a macro itself since it cancels the effect of the calling
+command completely.
+Another consequence is that quoting macros never insert literal quotes;
+.Sq Ic "foo <bar>"
+has been produced by
+.Ql ".Ic \*[q]foo <bar>\*[q]" .
+.Pp
+Most macros have a default width value which can be used to specify a label
+width
+.Pf ( Fl width )
+or offset
+.Pf ( Fl offset )
+for the
+.Ql .Bl
+and
+.Ql .Bd
+macros.
+It is recommended not to use this rather obscure feature to avoid
+dependencies on local modifications of the
+.Nm \-mdoc
+package.
+.
+.
+.Sh "TITLE MACROS"
+The title macros are part of the page structure domain but are presented
+first and separately for someone who wishes to start writing a man page
+yesterday.
+Three header macros designate the document title or manual page title, the
+operating system, and the date of authorship.
+These macros are called once at the very beginning of the document and are
+used to construct headers and footers only.
+.
+.Bl -tag -width 6n
+.It Li .Dt Xo
+.Op Aq document title
+.Op Aq section number
+.Op Aq volume
+.Xc
+The document title is the subject of the man page and must be in
+.Tn CAPITALS
+due to troff limitations.
+If omitted,
+.Sq Tn UNTITLED
+is used.
+The section number may be a number in the range
+.No 1,\~ Ns ... Ns ,\~9
+or
+.Ql unass ,
+.Ql draft ,
+or
+.Ql paper .
+If it is specified, and no volume name is given, a default volume name is
+used.
+.
+.Pp
+Under
+.Tn \*[operating-system] ,
+the following sections are defined:
+.Pp
+.Bl -column LOCAL -offset indent -compact
+.It Li 1 Ta "\*[volume-operating-system] \*[volume-ds-1]"
+.It Li 2 Ta "\*[volume-operating-system] \*[volume-ds-2]"
+.It Li 3 Ta "\*[volume-operating-system] \*[volume-ds-3]"
+.It Li 4 Ta "\*[volume-operating-system] \*[volume-ds-4]"
+.It Li 5 Ta "\*[volume-operating-system] \*[volume-ds-5]"
+.It Li 6 Ta "\*[volume-operating-system] \*[volume-ds-6]"
+.It Li 7 Ta "\*[volume-operating-system] \*[volume-ds-7]"
+.It Li 8 Ta "\*[volume-operating-system] \*[volume-ds-8]"
+.It Li 9 Ta "\*[volume-operating-system] \*[volume-ds-9]"
+.El
+.Pp
+.
+A volume name may be arbitrary or one of the following:
+.
+.Pp
+.Bl -column LOCAL -offset indent -compact
+.It Li USD Ta "\*[volume-ds-USD]"
+.It Li PS1 Ta "\*[volume-ds-PS1]"
+.It Li AMD Ta "\*[volume-ds-AMD]"
+.It Li SMM Ta "\*[volume-ds-SMM]"
+.It Li URM Ta "\*[volume-ds-URM]"
+.It Li PRM Ta "\*[volume-ds-PRM]"
+.It Li KM Ta "\*[volume-ds-KM]"
+.It Li IND Ta "\*[volume-ds-IND]"
+.It Li LOCAL Ta "\*[volume-ds-LOCAL]"
+.It Li CON Ta "\*[volume-ds-CON]"
+.El
+.Pp
+.
+For compatibility,
+.Ql MMI
+can be used for
+.Ql IND ,
+and
+.Ql LOC
+for
+.Ql LOCAL .
+Values from the previous table will specify a new volume name.
+If the third parameter is a keyword designating a computer architecture,
+its value is prepended to the default volume name as specified by the
+second parameter.
+By default, the following architecture keywords are defined:
+.
+\# we use `No' to avoid hyphenation
+.Bd -ragged -offset indent
+.No alpha , amiga , arc , arm26 , arm32 , atari , bebox , cobalt , evbsh3 ,
+.No hp300 , hpcmips , i386 , luna68k , m68k , mac68k , macppc , mips ,
+.No mmeye , mvme68k , news68k , newsmips , next68k , ofppc , pc532 , pmax ,
+.No powerpc , prep , sgimips , sh3 , sparc , sparc64 , sun3 , tahoe , vax ,
+.No x68k
+.Ed
+.Pp
+.
+In the following examples, the left (which is identical to the right) and
+the middle part of the manual page header strings are shown.
+.
+.Bd -ragged
+.Bl -tag -width ".Li .Dt\ FOO\ 2\ i386" -compact -offset indent
+.It Li ".Dt FOO 7"
+.Ql FOO(7)
+.Ql \*[volume-operating-system] \*[volume-ds-7]
+.It Li ".Dt FOO 2 i386"
+.Ql FOO(2)
+.Ql \*[volume-operating-system]/\*[volume-as-i386] \*[volume-ds-2]
+.It Li ".Dt FOO \*[q]\*[q] bar"
+.Ql FOO
+.Ql bar
+.El
+.Ed
+.Pp
+.
+Local, OS-specific additions might be found in the file
+.Pa mdoc.local ;
+look for strings named
+.Ql volume-ds-XXX
+(for the former type) and
+.Ql volume-as-XXX
+(for the latter type);
+.Ql XXX
+then denotes the keyword to be used with the
+.Ql .Dt
+macro.
+.Pp
+This macro is neither callable nor parsed.
+.
+.It Li .Os Xo
+.Op Aq operating system
+.Op Aq release
+.Xc
+If the first parameter is empty,
+the default
+.Sq Tn "\*[operating-system]"
+is used.
+This may be overridden in the local configuration file,
+.Pa mdoc.local .
+In general, the name of the operating system should be the common acronym,
+e.g.\&
+.Tn BSD
+or
+.Tn ATT .
+The release should be the standard release nomenclature for the system
+specified.
+In the following table, the possible second arguments for some predefined
+operating systems are listed.
+Similar to
+.Ql .Dt ,
+local additions might be defined in
+.Pa mdoc.local ;
+look for strings named
+.Ql operating-system-XXX-YYY ,
+where
+.Ql XXX
+is the acronym for the operating system and
+.Ql YYY
+the release ID.
+.
+.Bd -ragged -compact
+.Bl -tag -width ".No FreeBSD" -offset indent
+.It ATT
+7th, 7, III, 3, V, V.2, V.3, V.4
+.It BSD
+3, 4, 4.1, 4.2, 4.3, 4.3t, 4.3T, 4.3r, 4.3R, 4.4
+.It NetBSD
+0.8, 0.8a, 0.9, 0.9a, 1.0, 1.0a, 1.1, 1.2, 1.2a, 1.2b, 1.2c, 1.2d, 1.2e,
+1.3, 1.3a, 1.4, 1.5, 1.6
+.It FreeBSD
+1.0, 1.1, 1.1.5, 1.1.5.1, 2.0, 2.0.5, 2.1, 2.1.5, 2.1.6, 2.1.7, 2.2, 2.2.1,
+2.2.2, 2.2.5, 2.2.6, 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, 4.1,
+4.2, 4.3, 4.4, 4.5, 5.0
+.It DragonFly
+1.0
+.El
+.Ed
+.Pp
+.
+For
+.Tn ATT ,
+an unknown second parameter will be replaced with the string
+.Tn UNIX ;
+for the other predefined acronyms it will be ignored and a warning message
+emitted.
+Unrecognized arguments are displayed as given in the page footer.
+For instance, a typical footer might be:
+.Pp
+.Dl .Os BSD 4.3
+.Pp
+giving
+.Ql 4.3\~Berkeley Distribution ,
+or for a locally produced set
+.Pp
+.Dl .Os CS Department
+.Pp
+which will produce
+.Ql CS\~Department .
+.Pp
+If the
+.Ql .Os
+macro is not present, the bottom left corner of the manual page will be
+ugly.
+.Pp
+This macro is neither callable nor parsed.
+.
+.It Li .Dd Oo
+.Aq month
+.Aq day ,
+.Aq year
+.Oc
+If
+.Ql Dd
+has no arguments,
+.Ql Epoch
+is used for the date string.
+If it has exactly three arguments, they are concatenated, separated with
+unbreakable space:
+.Pp
+.Dl .Dd January 25, 2001
+.Pp
+Otherwise, the current date is used, ignoring the parameters.
+.Pp
+This macro is neither callable nor parsed.
+.El
+.
+.
+.Sh "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS"
+.
+.Ss "What's in a Name" Ns ...
+.
+The manual domain macro names are derived from the day to day informal
+language used to describe commands, subroutines and related files.
+Slightly different variations of this language are used to describe the
+three different aspects of writing a man page.
+First, there is the description of
+.Nm \-mdoc
+macro command usage.
+Second is the description of a
+.Ux
+command
+.Em with
+.Nm \-mdoc
+macros, and third, the description of a command to a user in the verbal
+sense; that is, discussion of a command in the text of a man page.
+.Pp
+In the first case,
+.Xr troff 1
+macros are themselves a type of command; the general syntax for a troff
+command is:
+.
+.Bd -filled -offset indent
+.Li ".Xx argument1 argument2" ...
+.Ed
+.Pp
+.
+.Ql .Xx
+is a macro command, and anything following it are arguments to
+be processed.
+In the second case, the description of a
+.Ux
+command using the content macros is a bit more involved; a typical
+.Sx SYNOPSIS
+command line might be displayed as:
+.
+.Bd -filled -offset indent
+.Nm filter
+.Op Fl flag
+.Ao Ar infile Ac Ao Ar outfile Ac
+.Ed
+.Pp
+.
+Here,
+.Nm filter
+is the command name and the
+bracketed string
+.Fl flag
+is a
+.Em flag
+argument designated as optional by the option brackets.
+In
+.Nm \-mdoc
+terms,
+.Ao Ar infile Ac
+and
+.Ao Ar outfile Ac
+are called
+.Em meta arguments ;
+in this example, the user has to replace the meta expressions given in angle
+brackets with real file names.
+Note that in this document meta arguments are used to describe
+.Nm \-mdoc
+commands; in most man pages, meta variables are not specifically written
+with angle brackets.
+The macros which formatted the above example:
+.
+.Bd -literal -offset indent
+\&.Nm filter
+\&.Op Fl flag
+\&.Ao Ar infile Ac Ao Ar outfile Ac
+.Ed
+.Pp
+.
+In the third case, discussion of commands and command syntax includes both
+examples above, but may add more detail.
+The arguments
+.Ao Ar infile Ac
+and
+.Ao Ar outfile Ac
+from the example above might be referred to as
+.Em operands
+or
+.Em file arguments .
+Some command line argument lists are quite long:
+.
+.Bd -ragged
+.Bl -tag -width ".Nm make" -offset indent -compact
+.It Nm make
+.Op Fl eiknqrstv
+.Op Fl D Ar variable
+.Op Fl d Ar flags
+.Op Fl f Ar makefile
+.Op Fl I Ar directory
+.Op Fl j Ar max_jobs
+.Op Ar variable Ns = Ns Ar value
+.Bk
+.Op Ar target ...
+.Ek
+.El
+.Ed
+.Pp
+.
+Here one might talk about the command
+.Nm make
+and qualify the argument,
+.Ar makefile ,
+as an argument to the flag,
+.Fl f ,
+or discuss the optional file operand
+.Ar target .
+In the verbal context, such detail can prevent confusion, however the
+.Nm \-mdoc
+package does not have a macro for an argument
+.Em to
+a flag.
+Instead the
+.Ql \&Ar
+argument macro is used for an operand or file argument like
+.Ar target
+as well as an argument to a flag like
+.Ar variable .
+The make command line was produced from:
+.
+.Bd -literal -offset indent
+\&.Nm make
+\&.Op Fl eiknqrstv
+\&.Op Fl D Ar variable
+\&.Op Fl d Ar flags
+\&.Op Fl f Ar makefile
+\&.Op Fl I Ar directory
+\&.Op Fl j Ar max_jobs
+\&.Op Ar variable Ns = Ns Ar value
+\&.Bk
+\&.Op Ar target ...
+\&.Ek
+.Ed
+.Pp
+.
+The
+.Ql .Bk
+and
+.Ql .Ek
+macros are explained in
+.Sx Keeps .
+.
+.Ss "General Syntax"
+.
+The manual domain and general text domain macros share a similar syntax with
+a few minor deviations; most notably,
+.Ql .Ar ,
+.Ql .Fl ,
+.Ql .Nm ,
+and
+.Ql .Pa
+differ only when called without arguments; and
+.Ql .Fn
+and
+.Ql .Xr
+impose an order on their argument lists.
+All content macros are capable of recognizing and properly handling
+punctuation, provided each punctuation character is separated by a leading
+space.
+If a command is given:
+.Pp
+.Dl \&.Ar sptr, ptr),
+.Pp
+The result is:
+.Pp
+.Dl Ar sptr, ptr),
+.Pp
+The punctuation is not recognized and all is output in the
+font used by
+.Ql .Ar .
+If the punctuation is separated by a leading white space:
+.Pp
+.Dl \&.Ar "sptr , ptr ) ,"
+.Pp
+The result is:
+.Pp
+.Dl Ar sptr , ptr ) ,
+.Pp
+The punctuation is now recognized and output in the default font
+distinguishing it from the argument strings.
+To remove the special meaning from a punctuation character escape it with
+.Ql \e& .
+.Pp
+.Xr Troff
+is limited as a macro language, and has difficulty when presented with a
+string containing a member of the mathematical, logical or quotation set:
+.
+.Bd -literal -offset indent-two
+{+,\-,/,*,%,<,>,<=,>=,=,==,&,`,',"}
+.Ed
+.Pp
+.
+The problem is that
+.Xr troff
+may assume it is supposed to actually perform the operation or evaluation
+suggested by the characters.
+To prevent the accidental evaluation of these characters, escape them with
+.Ql \e& .
+Typical syntax is shown in the first content macro displayed below,
+.Ql .Ad .
+.
+.
+.Sh "MANUAL DOMAIN"
+.
+.Ss Addresses
+.
+The address macro identifies an address construct.
+.Pp
+.Dl Usage: .Ad Ao address Ac ...
+.Pp
+.Bl -tag -width ".Li .Ad\ f1\ ,\ f2\ ,\ f3\ :" -compact -offset 15n
+.It Li ".Ad addr1"
+.Ad addr1
+.It Li ".Ad addr1 ."
+.Ad addr1 .
+.It Li ".Ad addr1 , file2"
+.Ad addr1 , file2
+.It Li ".Ad f1 , f2 , f3 :"
+.Ad f1 , f2 , f3 :
+.It Li ".Ad addr ) ) ,"
+.Ad addr ) ) ,
+.El
+.Pp
+.
+The default width is 12n.
+.
+.Ss "Author Name"
+.
+The
+.Ql .An
+macro is used to specify the name of the author of the item being
+documented, or the name of the author of the actual manual page.
+.Pp
+.Dl Usage: .An Ao author name Ac ...
+.Pp
+.Bl -tag -width ".Li .An\ \*[q]Joe\ Author\*[q]\ )\ )\ ," -offset 15n
+.It Li ".An \*[q]Joe Author\*[q]"
+.An "Joe Author"
+.It Li ".An \*[q]Joe Author\*[q] ,"
+.An "Joe Author" ,
+.It Li ".An \*[q]Joe Author\*[q] Aq nobody at xxxxxxxxxxx"
+.An "Joe Author" Aq nobody at xxxxxxxxxxx
+.It Li ".An \*[q]Joe Author\*[q] ) ) ,"
+.An "Joe Author" ) ) ,
+.El
+.Pp
+.
+The default width is 12n.
+.Pp
+In the
+.Sx AUTHORS
+section, the
+.Ql .An
+command causes a line break allowing each new name to appear on its own
+line.
+If this is not desirable,
+.
+.Bd -literal -offset indent
+\&.An -nosplit
+.Ed
+.Pp
+.
+call will turn this off.
+To turn splitting back on, write
+.
+.Bd -literal -offset indent
+\&.An -split
+.Ed
+.
+.Ss "Arguments"
+.
+The
+.Li .Ar
+argument macro may be used whenever an argument is referenced.
+If called without arguments, the
+.Sq Ar
+string is output.
+.Pp
+.Dl Usage: .Ar Oo Ao argument Ac Oc ...
+.Pp
+.Bl -tag -width ".Li .Ar\ file1\ file2" -compact -offset 15n
+.It Li .Ar
+.Ar
+.It Li ".Ar file1"
+.Ar file1
+.It Li ".Ar file1 ."
+.Ar file1 .
+.It Li ".Ar file1 file2"
+.Ar file1 file2
+.It Li ".Ar f1 f2 f3 :"
+.Ar f1 f2 f3 :
+.It Li ".Ar file ) ) ,"
+.Ar file ) ) ,
+.El
+.Pp
+.
+The default width is 12n.
+.
+.Ss "Configuration Declaration (Section Four Only)"
+.
+The
+.Ql .Cd
+macro is used to demonstrate a
+.Xr config 8
+declaration for a device interface in a section four manual.
+.Pp
+.Dl Usage: .Cd Ao argument Ac ...
+.Pp
+.Bl -tag -width ".Li .Cd\ Xdevice\ le0\ at\ scode?X" -offset 15n
+.It Li ".Cd \*[q]device le0 at scode?\*[q]"
+.Cd "device le0 at scode?"
+.El
+.Pp
+In the
+.Sx SYNOPSIS
+section a
+.Ql .Cd
+command causes a line break before and after its arguments are printed.
+.Pp
+.
+The default width is 12n.
+.
+.Ss "Command Modifiers"
+.
+The command modifier is identical to the
+.Ql .Fl
+(flag) command with the exception that the
+.Ql .Cm
+macro does not assert a dash in front of every argument.
+Traditionally flags are marked by the preceding dash, however, some commands
+or subsets of commands do not use them.
+Command modifiers may also be specified in conjunction with interactive
+commands such as editor commands.
+See
+.Sx Flags .
+.Pp
+The default width is 10n.
+.
+.Ss "Defined Variables"
+.
+A variable (or constant) which is defined in an include file
+is specified by the macro
+.Ql .Dv .
+.Pp
+.Dl Usage: .Dv Ao defined variable Ac ...
+.Pp
+.Bl -tag -width ".Li .Dv\ MAXHOSTNAMELEN" -compact -offset 15n
+.It Li ".Dv MAXHOSTNAMELEN"
+.Dv MAXHOSTNAMELEN
+.It Li ".Dv TIOCGPGRP )"
+.Dv TIOCGPGRP )
+.El
+.Pp
+.
+The default width is 12n.
+.
+.Ss Errno's
+.
+The
+.Ql .Er
+errno macro specifies the error return value for section 2, 3, and\~9 library
+routines.
+The second example below shows
+.Ql .Er
+used with the
+.Ql .Bq
+general text domain macro, as it would be used in a section two manual page.
+.Pp
+.Dl Usage: .Er Ao errno type Ac ...
+.Pp
+.Bl -tag -width ".Li .Bq\ Er\ ENOTDIR" -compact -offset 15n
+.It Li ".Er ENOENT"
+.Er ENOENT
+.It Li ".Er ENOENT ) ;"
+.Er ENOENT ) ;
+.It Li ".Bq Er ENOTDIR"
+.Bq Er ENOTDIR
+.El
+.Pp
+.
+The default width is 17n.
+.
+.Ss "Environment Variables"
+.
+The
+.Ql .Ev
+macro specifies an environment variable.
+.Pp
+.Dl Usage: .Ev Ao argument Ac ...
+.Pp
+.Bl -tag -width ".Li .Ev\ PRINTER\ )\ )\ ," -compact -offset 15n
+.It Li ".Ev DISPLAY"
+.Ev DISPLAY
+.It Li ".Ev PATH ."
+.Ev PATH .
+.It Li ".Ev PRINTER ) ) ,"
+.Ev PRINTER ) ) ,
+.El
+.Pp
+.
+The default width is 15n.
+.
+.Ss Flags
+.
+The
+.Ql .Fl
+macro handles command line flags.
+It prepends a dash,
+.Ql \- ,
+to the flag.
+For interactive command flags, which are not prepended with a dash, the
+.Ql .Cm
+(command modifier)
+macro is identical, but without the dash.
+.Pp
+.Dl Usage: .Fl Ao argument Ac ...
+.Pp
+.Bl -tag -width ".Li .Fl\ xyz\ )\ ," -compact -offset 15n
+.It Li .Fl
+.Fl
+.It Li ".Fl cfv"
+.Fl cfv
+.It Li ".Fl cfv ."
+.Fl cfv .
+.It Li ".Cm cfv ."
+.Cm cfv .
+.It Li ".Fl s v t"
+.Fl s v t
+.It Li ".Fl \- ,"
+.Fl \- ,
+.It Li ".Fl xyz ) ,"
+.Fl xyz ) ,
+.It Li ".Fl |"
+.Fl |
+.El
+.Pp
+The
+.Ql .Fl
+macro without any arguments results in a dash representing stdin/stdout.
+Note that giving
+.Ql .Fl
+a single dash will result in two dashes.
+.Pp
+The default width is 12n.
+.
+.Ss "Function Declarations"
+.
+The
+.Ql .Fd
+macro is used in the
+.Sx SYNOPSIS
+section with section two or three functions.
+It is neither callable nor parsed.
+.Pp
+.Dl Usage: .Fd Ao argument Ac ...
+.Pp
+.Bl -tag -width ".Li .Fd\ X#include\ <sys/types.h>X" -compact -offset 15n
+.It Li ".Fd \*[q]#include <sys/types.h>\*[q]"
+.Fd "#include <sys/types.h>"
+.El
+.Pp
+In the
+.Sx SYNOPSIS
+section a
+.Ql .Fd
+command causes a line break if a function has already been presented and a
+break has not occurred.
+This leaves a nice vertical space in between the previous function call and
+the declaration for the next function.
+.
+.Pp
+The
+.Ql .In
+.Li ( #include
+statement)
+macro is the short form of the above example.
+It specifies the C\~header file as being included in a C\~program.
+It also causes a line break, and is neither callable nor parsed.
+.Pp
+.Dl Usage: .In Ao header file Ac
+.Pp
+.Bl -tag -width ".Li .In\ stdio.h" -compact -offset 15n
+.It Li ".In stdio.h"
+.In stdio.h
+.El
+.
+.Ss "Function Types"
+.
+This macro is intended for the
+.Sx SYNOPSIS
+section.
+It may be used anywhere else in the man page without problems, but its main
+purpose is to present the function type in kernel normal form for the
+.Sx SYNOPSIS
+of sections two and three (it causes a line break, allowing the function
+name to appear on the next line).
+.Pp
+.Dl Usage: .Ft Ao type Ac ...
+.Pp
+.Bl -tag -width ".Li .Ft\ struct\ stat" -compact -offset 15n
+.It Li ".Ft struct stat"
+.Ft struct stat
+.El
+.
+.Ss "Functions (Library Routines)"
+.
+The
+.Ql .Fn
+macro is modeled on
+.Tn ANSI\~C
+conventions.
+.Pp
+.Dl Usage: .Fn Ao function Ac Oo Ao parameter Ac Oc ...
+.Pp
+.Bl -tag -width ".Li .Fn\ align\ Xchar\ *ptrX\ ," -compact -offset 15n
+.It Li ".Fn getchar"
+.Fn getchar
+.It Li ".Fn strlen ) ,"
+.Fn strlen ) ,
+.It Li ".Fn align \*[q]char *ptr\*[q] ,"
+.Fn align "char *ptr" ,
+.El
+.Pp
+Note that any call to another macro signals the end of the
+.Ql .Fn
+call (it will insert a closing parenthesis at that point).
+.Pp
+For functions with many parameters (which is rare), the macros
+.Ql .Fo
+(function open)
+and
+.Ql .Fc
+(function close)
+may be used with
+.Ql .Fa
+(function argument).
+.Pp
+Example:
+.
+.Bd -literal -offset indent
+\&.Ft int
+\&.Fo res_mkquery
+\&.Fa "int op"
+\&.Fa "char *dname"
+\&.Fa "int class"
+\&.Fa "int type"
+\&.Fa "char *data"
+\&.Fa "int datalen"
+\&.Fa "struct rrec *newrr"
+\&.Fa "char *buf"
+\&.Fa "int buflen"
+\&.Fc
+.Ed
+.Pp
+.
+Produces:
+.
+.Bd -ragged -offset indent
+.Ft int
+.Fo res_mkquery
+.Fa "int op"
+.Fa "char *dname"
+.Fa "int class"
+.Fa "int type"
+.Fa "char *data"
+.Fa "int datalen"
+.Fa "struct rrec *newrr"
+.Fa "char *buf"
+.Fa "int buflen"
+.Fc
+.Ed
+.Pp
+.
+In the
+.Sx SYNOPSIS
+section, the function will always begin at the beginning of line.
+If there is more than one function presented in the
+.Sx SYNOPSIS
+section and a function type has not been given, a line break will occur,
+leaving a nice vertical space between the current function name and the one
+prior.
+.Pp
+The default width values of
+.Ql .Fn
+and
+.Ql .Fo
+are 12n and 16n, respectively.
+.
+.Ss "Function Arguments"
+.
+The
+.Ql .Fa
+macro is used to refer to function arguments (parameters) outside of the
+.Sx SYNOPSIS
+section of the manual or inside the
+.Sx SYNOPSIS
+section if the enclosure macros
+.Ql .Fo
+and
+.Ql .Fc
+instead of
+.Ql .Fn
+are used.
+.Ql .Fa
+may also be used to refer to structure members.
+.Pp
+.Dl Usage: .Fa Ao function argument Ac ...
+.Pp
+.Bl -tag -width ".Li .Fa\ d_namlen\ )\ )\ ," -compact -offset 15n
+.It Li ".Fa d_namlen ) ) ,"
+.Fa d_namlen ) ) ,
+.It Li ".Fa iov_len"
+.Fa iov_len
+.El
+.Pp
+.
+The default width is 12n.
+.
+.Ss "Return Values"
+.
+The
+.Ql .Rv
+macro generates text for use in the
+.Sx RETURN VALUES
+section.
+.Pp
+.Dl Usage: .Rv Oo -std Oc Op Ao function Ac ...
+.Pp
+For example,
+.Ql ".Rv -std atexit"
+produces:
+.
+.Bd -ragged -offset -indent
+\# a small hack to suppress a warning message
+.ds section-old "\*[section]
+.ds section 3
+.Rv -std atexit
+.ds section "\*[section-old]
+.Ed
+.Pp
+.
+The
+.Fl std
+option is valid only for manual page sections\~2 and\~3.
+Currently, this macro does nothing if used without the
+.Fl std
+flag.
+.
+.Ss "Exit Status"
+.
+The
+.Ql .Ex
+macro generates text for use in the
+.Sx DIAGNOSTICS
+section.
+.Pp
+.Dl Usage: .Ex Oo -std Oc Op Ao utility Ac ...
+.Pp
+For example,
+.Ql ".Ex -std cat"
+produces:
+.
+.Bd -ragged -offset -indent
+\# a small hack to suppress a warning message
+.ds section-old "\*[section]
+.ds section 1
+.Ex -std cat
+.ds section "\*[section-old]
+.Ed
+.Pp
+.
+The
+.Fl std
+option is valid only for manual page sections 1, 6 and\~8.
+Currently, this macro does nothing if used without the
+.Fl std
+flag.
+.
+.Ss "Interactive Commands"
+.
+The
+.Ql .Ic
+macro designates an interactive or internal command.
+.Pp
+.Dl Usage: .Ic Ao argument Ac ...
+.Pp
+.Bl -tag -width ".Li .Ic\ setenv\ ,\ unsetenv" -compact -offset 15n
+.It Li ".Ic :wq"
+.Ic :wq
+.It Li ".Ic \*[q]do while {...}\*[q]"
+.Ic "do while {...}"
+.It Li ".Ic setenv , unsetenv"
+.Ic setenv , unsetenv
+.El
+.Pp
+.
+The default width is 12n.
+.
+.Ss "Library Names"
+.
+The
+.Ql .Lb
+macro is used to specify the library where a particular function is compiled
+in.
+.Pp
+.Dl Usage: .Lb Ao argument Ac ...
+.Pp
+Available arguments to
+.Ql .Lb
+and their results are:
+.
+.Pp
+.Bl -tag -width ".Li libossaudio" -compact -offset indent
+.It Li libarm32
+.Lb libarm32
+.It Li libc
+.Lb libc
+.It Li libcompat
+.Lb libcompat
+.It Li libcrypt
+.Lb libcrypt
+.It Li libcurses
+.Lb libcurses
+.It Li libedit
+.Lb libedit
+.It Li libi386
+.Lb libi386
+.It Li libipsec
+.Lb libipsec
+.It Li libkvm
+.Lb libkvm
+.It Li libm
+.Lb libm
+.It Li libmenu
+.Lb libmenu
+.It Li libossaudio
+.Lb libossaudio
+.It Li libposix
+.Lb libposix
+.It Li libresolv
+.Lb libresolv
+.It Li libtermcap
+.Lb libtermcap
+.It Li libutil
+.Lb libutil
+.It Li libz
+.Lb libz
+.El
+.Pp
+.
+Local, OS-specific additions might be found in the file
+.Pa mdoc.local ;
+look for strings named
+.Ql str-Lb-XXX .
+.Ql XXX
+then denotes the keyword to be used with the
+.Ql .Lb
+macro.
+.
+.Ss Literals
+.
+The
+.Ql .Li
+literal macro may be used for special characters, variable constants, etc.\&
+-- anything which should be displayed as it would be typed.
+.Pp
+.Dl Usage: .Li Ao argument Ac ...
+.Pp
+.Bl -tag -width ".Li .Li\ cntrl-D\ )\ ," -compact -offset 15n
+.It Li ".Li \een"
+.Li \en
+.It Li ".Li M1 M2 M3 ;"
+.Li M1 M2 M3 ;
+.It Li ".Li cntrl-D ) ,"
+.Li cntrl-D ) ,
+.It Li ".Li 1024 ..."
+.Li 1024 ...
+.El
+.Pp
+.
+The default width is 16n.
+.
+.Ss Names
+.
+The
+.Ql .Nm
+macro is used for the document title or subject name.
+It has the peculiarity of remembering the first argument it was called with,
+which should always be the subject name of the page.
+When called without arguments,
+.Ql .Nm
+regurgitates this initial name for the sole purpose of making less work for
+the author.
+Note: A section two or three document function name is addressed with the
+.Ql .Nm
+in the
+.Sx NAME
+section, and with
+.Ql .Fn
+in the
+.Sx SYNOPSIS
+and remaining sections.
+For interactive commands, such as the
+.Ql while
+command keyword in
+.Xr csh 1 ,
+the
+.Ql .Ic
+macro should be used.
+While
+.Ql .Ic
+is nearly identical
+to
+.Ql .Nm ,
+it can not recall the first argument it was invoked with.
+.Pp
+.Dl Usage: .Nm Oo Ao argument Ac Oc ...
+.Pp
+.Bl -tag -width ".Li .Nm\ groff_mdoc" -compact -offset 15n
+.It Li ".Nm groff_mdoc"
+.Nm groff_mdoc
+.It Li ".Nm \e-mdoc"
+.Nm \-mdoc
+.It Li ".Nm foo ) ) ,"
+.Nm foo ) ) ,
+.It Li ".Nm :"
+.Nm :
+.El
+.Pp
+.
+The default width is 10n.
+.
+.Ss Options
+.
+The
+.Ql .Op
+macro places option brackets around any remaining arguments on the
+command line, and places any trailing punctuation outside the brackets.
+The macros
+.Ql .Oo
+and
+.Ql .Oc
+(which produce an opening and a closing option bracket respectively) may be used
+across one or more lines or to specify the exact position of the closing
+parenthesis.
+.Pp
+.Dl Usage: .Op Oo Ao option Ac Oc ...
+.Pp
+.Bl -tag -width ".Li .Op\ Fl\ c\ Ar\ objfil\ Op\ Ar\ corfil\ ," -compact -offset 15n
+.It Li .Op
+.Op
+.It Li ".Op Fl k"
+.Op Fl k
+.It Li ".Op Fl k ) ."
+.Op Fl k ) .
+.It Li ".Op Fl k Ar kookfile"
+.Op Fl k Ar kookfile
+.It Li ".Op Fl k Ar kookfile ,"
+.Op Fl k Ar kookfile ,
+.It Li ".Op Ar objfil Op Ar corfil"
+.Op Ar objfil Op Ar corfil
+.It Li ".Op Fl c Ar objfil Op Ar corfil ,"
+.Op Fl c Ar objfil Op Ar corfil ,
+.It Li ".Op word1 word2"
+.It Li ".Li .Op Oo Ao option Ac Oc ..."
+.Li .Op Oo Ao options Ac Oc ...
+.El
+.Pp
+Here a typical example of the
+.Ql .Oo
+and
+.Ql .Oc
+macros:
+.
+.Bd -literal -offset indent
+\&.Oo
+\&.Op Fl k Ar kilobytes
+\&.Op Fl i Ar interval
+\&.Op Fl c Ar count
+\&.Oc
+.Ed
+.Pp
+.
+Produces:
+.
+.Bd -filled -offset indent
+.Oo
+.Op Fl k Ar kilobytes
+.Op Fl i Ar interval
+.Op Fl c Ar count
+.Oc
+.Ed
+.Pp
+.
+The default width values of
+.Ql .Op
+and
+.Ql .Oo
+are 14n and 10n, respectively.
+.
+.Ss Pathnames
+.
+The
+.Ql .Pa
+macro formats path or file names.
+If called without arguments, the
+.Sq Pa
+string is output, which represents the current user's home directory.
+.Pp
+.Dl Usage: .Pa Oo Ao pathname Ac Oc ...
+.Pp
+.Bl -tag -width ".Li .Pa\ /tmp/fooXXXXX\ )\ ." -compact -offset 15n
+.It Li .Pa
+.Pa
+.It Li ".Pa /usr/share"
+.Pa /usr/share
+.It Li ".Pa /tmp/fooXXXXX ) ."
+.Pa /tmp/fooXXXXX ) .
+.El
+.Pp
+.
+The default width is 32n.
+.
+.Ss Standards
+.
+The
+.Ql .St
+macro replaces standard abbreviations with their formal names.
+.Pp
+.Dl Usage: .St Ao abbreviation Ac ...
+.Pp
+Available pairs for
+.Dq Abbreviation/Formal Name
+are:
+.
+.Pp
+.Tn ANSI/ISO C
+.Pp
+.Bl -tag -width ".Li -iso9945-1-90" -compact -offset indent
+.It Li -ansiC
+.St -ansiC
+.It Li -ansiC-89
+.St -ansiC-89
+.It Li -isoC
+.St -isoC
+.It Li -isoC-99
+.St -isoC-99
+.El
+.Pp
+.
+.Tn POSIX
+Part 1: System API
+.Pp
+.Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
+.It Li -iso9945-1-90
+.St -iso9945-1-90
+.It Li -iso9945-1-96
+.St -iso9945-1-96
+.It Li -p1003.1
+.St -p1003.1
+.It Li -p1003.1-88
+.St -p1003.1-88
+.It Li -p1003.1-90
+.St -p1003.1-90
+.It Li -p1003.1-96
+.St -p1003.1-96
+.It Li -p1003.1b-93
+.St -p1003.1b-93
+.It Li -p1003.1c-95
+.St -p1003.1c-95
+.It Li -p1003.1g-2000
+.St -p1003.1g-2000
+.It Li -p1003.1i-95
+.St -p1003.1i-95
+.El
+.Pp
+.
+.Tn POSIX
+Part 2: Shell and Utilities
+.Pp
+.Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
+.It Li -iso9945-2-93
+.St -iso9945-2-93
+.It Li -p1003.2
+.St -p1003.2
+.It Li -p1003.2-92
+.St -p1003.2-92
+.It Li -p1003.2a-92
+.St -p1003.2a-92
+.El
+.Pp
+.
+X/Open
+.Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
+.Pp
+.It Li -susv2
+.St -susv2
+.It Li -svid4
+.St -svid4
+.It Li -xbd5
+.St -xbd5
+.It Li -xcu5
+.St -xcu5
+.It Li -xcurses4.2
+.St -xcurses4.2
+.It Li -xns5
+.St -xns5
+.It Li -xns5.2
+.St -xns5.2
+.It Li -xpg3
+.St -xpg3
+.It Li -xpg4
+.St -xpg4
+.It Li -xpg4.2
+.St -xpg4.2
+.It Li -xsh5
+.St -xsh5
+.El
+.Pp
+.
+Miscellaneous
+.Pp
+.Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
+.It Li -ieee754
+.St -ieee754
+.It Li -iso8802-3
+.St -iso8802-3
+.El
+.
+.Ss "Variable Types"
+.
+The
+.Ql .Vt
+macro may be used whenever a type is referenced.
+In the
+.Sx SYNOPSIS
+section, it causes a line break (useful for old style variable declarations).
+.Pp
+.Dl Usage: .Vt Ao type Ac ...
+.Pp
+.Bl -tag -width ".Li .Vt\ extern\ char\ *optarg\ ;" -compact -offset 15n
+.It Li ".Vt extern char *optarg ;"
+.Vt extern char *optarg ;
+.It Li ".Vt FILE *"
+.Vt FILE *
+.El
+.
+.Ss Variables
+.
+Generic variable reference.
+.Pp
+.Dl Usage: .Va Ao variable Ac ...
+.Pp
+.Bl -tag -width ".Li .Va\ Xchar\ sX\ ]\ )\ )\ ," -compact -offset 15n
+.It Li ".Va count"
+.Va count
+.It Li ".Va settimer ,"
+.Va settimer ,
+.It Li ".Va \*[q]int *prt\*[q] ) :"
+.Va "int *prt" ) :
+.It Li ".Va \*[q]char s\*[q] ] ) ) ,"
+.Va "char s" ] ) ) ,
+.El
+.Pp
+.
+The default width is 12n.
+.
+.Ss "Manual Page Cross References"
+.
+The
+.Ql .Xr
+macro expects the first argument to be a manual page name.
+The optional second argument, if a string (defining the manual section), is
+put into parentheses.
+.Pp
+.Dl Usage: .Xr Ao man page name Ac Oo Ao section Ac Oc ...
+.Pp
+.Bl -tag -width ".Li .Xr\ xinit\ 1x\ ;" -compact -offset 15n
+.It Li ".Xr mdoc"
+.Xr mdoc
+.It Li ".Xr mdoc ,"
+.Xr mdoc ,
+.It Li ".Xr mdoc 7"
+.Xr mdoc 7
+.It Li ".Xr xinit 1x ;"
+.Xr xinit 1x ;
+.El
+.Pp
+.
+The default width is 10n.
+.
+.
+.Sh "GENERAL TEXT DOMAIN"
+.
+.Ss "AT&T Macro"
+.
+.Pp
+.Dl Usage: .At Oo Ao version Ac Oc ...
+.Pp
+.Bl -tag -width ".Li .At\ v6\ ." -compact -offset 15n
+.It Li .At
+.At
+.It Li ".At v6 ."
+.At v6 .
+.El
+.Pp
+The following values for
+.Ao version Ac
+are possible:
+.Pp
+.Dl 32v, v1, v2, v3, v4, v5, v6, v7, V, V.1, V.2, V.3, V.4
+.
+.Ss "BSD Macro"
+.
+.Pp
+.Dl "Usage: .Bx" Bro -alpha | -beta | -devel Brc ...
+.Dl " .Bx" Oo Ao version Ac Oo Ao release Ac Oc Oc ...
+.Pp
+.Bl -tag -width ".Li .Bx\ -devel" -compact -offset 15n
+.It Li .Bx
+.Bx
+.It Li ".Bx 4.3 ."
+.Bx 4.3 .
+.It Li ".Bx \-devel"
+.Bx -devel
+.El
+.Pp
+.Ao version Ac
+will be prepended to the string
+.Sq Bx .
+The following values for
+.Ao release Ac
+are possible:
+.Pp
+.Dl Reno, reno, Tahoe, tahoe, Lite, lite, Lite2, lite2
+.
+.Ss "NetBSD Macro"
+.
+.Pp
+.Dl Usage: .Nx Oo Ao version Ac Oc ...
+.Pp
+.Bl -tag -width ".Li .Nx\ 1.4\ ." -compact -offset 15n
+.It Li .Nx
+.Nx
+.It Li ".Nx 1.4 ."
+.Nx 1.4 .
+.El
+.Pp
+For possible values of
+.Ao version Ac
+see the description of the
+.Ql .Os
+command above in section
+.Sx "TITLE MACROS" .
+.
+.Ss "FreeBSD Macro"
+.
+.Pp
+.Dl Usage: .Fx Oo Ao version Ac Oc ...
+.Pp
+.Bl -tag -width ".Li .Fx\ 2.2\ ." -compact -offset 15n
+.It Li .Fx
+.Fx
+.It Li ".Fx 2.2 ."
+.Fx 2.2 .
+.El
+.Pp
+For possible values of
+.Ao version Ac
+see the description of the
+.Ql .Os
+command above in section
+.Sx "TITLE MACROS" .
+.
+.Ss "DragonFly Macro"
+.
+.Pp
+.Dl Usage: .Dx Oo Ao version Ac Oc ...
+.Pp
+.Bl -tag -width ".Li .Dx\ 1.0\ ." -compact -offset 15n
+.It Li .Dx
+.Dx
+.It Li ".Dx 1.0 ."
+.Dx 1.0 .
+.El
+.Pp
+For possible values of
+.Ao version Ac
+see the description of the
+.Ql .Os
+command above in section
+.Sx "TITLE MACROS" .
+.
+.Ss "OpenBSD Macro"
+.
+.Pp
+.Dl Usage: .Ox Oo Ao version Ac Oc ...
+.Pp
+.Bl -tag -width ".Li .Ox\ 1.0" -compact -offset 15n
+.It Li ".Ox 1.0"
+.Ox 1.0
+.El
+.
+.Ss "BSD/OS Macro"
+.
+.Pp
+.Dl Usage: .Bsx Oo Ao version Ac Oc ...
+.Pp
+.Bl -tag -width ".Li .Bsx\ 1.0" -compact -offset 15n
+.It Li ".Bsx 1.0"
+.Bsx 1.0
+.El
+.
+.Ss "UNIX Macro"
+.
+.Pp
+.Dl Usage: .Ux ...
+.Pp
+.Bl -tag -width ".Li .Ux" -compact -offset 15n
+.It Li .Ux
+.Ux
+.El
+.
+.Ss "Emphasis Macro"
+.
+Text may be stressed or emphasized with the
+.Ql .Em
+macro.
+The usual font for emphasis is italic.
+.Pp
+.Dl Usage: .Em Ao argument Ac ...
+.Pp
+.Bl -tag -width ".Li .Em\ vide\ infra\ )\ )\ ," -compact -offset 15n
+.It Li ".Em does not"
+.Em does not
+.It Li ".Em exceed 1024 ."
+.Em exceed 1024 .
+.It Li ".Em vide infra ) ) ,"
+.Em vide infra ) ) ,
+.El
+.Pp
+.
+The default width is 10n.
+.
+.Ss "Font Mode"
+.
+The
+.Ql .Bf
+font mode must be ended with the
+.Ql .Ef
+macro (the latter takes no arguments).
+Font modes may be nested within other font modes.
+.Pp
+.Ql .Bf
+has the following syntax:
+.Pp
+.Dl .Bf Ao font mode Ac
+.Pp
+.Ao font mode Ac
+must be one of the following three types:
+.Pp
+.Bl -tag -width ".Sy \&Sy | Fl symbolic" -compact -offset indent
+.It Sy \&Em | Fl emphasis
+Same as if the
+.Ql .Em
+macro was used for the entire block of text.
+.It Sy \&Li | Fl literal
+Same as if the
+.Ql .Li
+macro was used for the entire block of text.
+.It Sy \&Sy | Fl symbolic
+Same as if the
+.Ql .Sy
+macro was used for the entire block of text.
+.El
+.Pp
+Both macros are neither callable nor parsed.
+.
+.Ss "Enclosure and Quoting Macros"
+.
+The concept of enclosure is similar to quoting.
+The object being to enclose one or more strings between a pair of characters
+like quotes or parentheses.
+The terms quoting and enclosure are used interchangeably throughout this
+document.
+Most of the one-line enclosure macros end in small letter
+.Ql q
+to give a hint of quoting, but there are a few irregularities.
+For each enclosure macro there is also a pair of open and close macros which
+end in small letters
+.Ql o
+and
+.Ql c
+respectively.
+.Pp
+\# XXX
+.if t \
+. ne 10
+.
+.Bd -filled -offset 4n
+.Bl -column "quote" "close" "open" "Angle Bracket Enclosure" "`string' or string"
+.Em Quote Ta Em Open Ta Em Close Ta Em Function Ta Em Result
+.No .Aq Ta .Ao Ta .Ac Ta "Angle Bracket Enclosure" Ta Ao string Ac
+.No .Bq Ta .Bo Ta .Bc Ta "Bracket Enclosure" Ta Bo string Bc
+.No .Brq Ta .Bro Ta .Brc Ta "Brace Enclosure" Ta Bro string Brc
+.No .Dq Ta .Do Ta .Dc Ta "Double Quote" Ta Do string Dc
+.No .Eq Ta .Eo Ta .Ec Ta "Enclose String (in XX)" Ta XXstringXX
+.No .Pq Ta .Po Ta .Pc Ta "Parenthesis Enclosure" Ta Po string Pc
+.No .Ql Ta Ta Ta "Quoted Literal" Ta So string Sc or Li string
+.No .Qq Ta .Qo Ta .Qc Ta "Straight Double Quote" Ta Qo string Qc
+.No .Sq Ta .So Ta .Sc Ta "Single Quote" Ta So string Sc
+.El
+.Ed
+.Pp
+All macros ending with
+.Sq q
+and
+.Sq o
+have a default width value of 12n.
+.
+.Bl -tag -width ".Li .Ec , .Eo"
+.It Li .Eo , .Ec
+These macros expect the first argument to be the opening and closing strings
+respectively.
+.It Li .Es , .En
+Due to the nine-argument limit in the original troff program two other
+macros have been implemented which are now rather obsolete:
+.Ql .Es
+takes the first and second parameter as the left and right enclosure string,
+which are then used to enclose the arguments of
+.Ql .En .
+The default width value is 12n for both macros.
+.It Li .Eq
+The first and second arguments of this macro are the opening and
+closing strings respectively, followed by the arguments to be enclosed.
+.It Li .Ql
+The quoted literal macro behaves differently in troff and nroff mode.
+If formatted with
+.Xr nroff ,
+a quoted literal is always quoted.
+If formatted with troff, an item is only quoted if the width of the item is
+less than three constant width characters.
+This is to make short strings more visible where the font change to literal
+(constant width) is less noticeable.
+.Pp
+The default width is 16n.
+.It Li .Pf
+The prefix macro suppresses the whitespace between its first and second
+argument:
+.
+.Bl -tag -width ".Li .Pf\ (\ Fa\ name2" -offset indent
+.It Li ".Pf ( Fa name2"
+.Pf ( Fa name2
+.El
+.Pp
+.
+The default width is 12n.
+.Pp
+The
+.Ql .Ns
+macro (see below) performs the analogous suffix function.
+.It Li .Ap
+The
+.Ql .Ap
+macro inserts an apostrophe and exits any special text modes, continuing in
+.Ql .No
+mode.
+.El
+.Pp
+.
+Examples of quoting:
+.
+.Pp
+.Bl -tag -width ".Li .Bq\ Em\ Greek\ ,\ French\ ." -compact -offset indent
+.It Li .Aq
+.Aq
+.It Li ".Aq Pa ctype.h ) ,"
+.Aq Pa ctype.h ) ,
+.It Li .Bq
+.Bq
+.It Li ".Bq Em Greek , French ."
+.Bq Em Greek , French .
+.It Li .Dq
+.Dq
+.It Li ".Dq string abc ."
+.Dq string abc .
+.It Li ".Dq \'^[A-Z]\'"
+.Dq \'^[A-Z]\'
+.It Li ".Ql man mdoc"
+.Ql man mdoc
+.It Li .Qq
+.Qq
+.It Li ".Qq string ) ,"
+.Qq string ) ,
+.It Li ".Qq string Ns ),"
+.Qq string Ns ),
+.It Li .Sq
+.Sq
+.It Li ".Sq string"
+.Sq string
+.It Li ".Em or Ap ing"
+.Em or Ap ing
+.El
+.Pp
+.
+For a good example of nested enclosure macros, see the
+.Ql .Op
+option macro.
+It was created from the same underlying enclosure macros as those presented
+in the list above.
+The
+.Ql .Xo
+and
+.Ql .Xc
+extended argument list macros are discussed below.
+.
+.Ss "No-Op or Normal Text Macro"
+.
+The
+.Ql .No
+macro can be used in a macro command line for parameters which should
+.Em not
+be formatted.
+Be careful to add
+.Ql \e&
+to the word
+.Ql \&No
+if you really want that English word (and not the macro) as a parameter.
+.Pp
+.Dl Usage: .No Ao argument Ac ...
+.Pp
+.Bl -tag -width ".Li .No\ test\ Ta\ with\ Ta\ tabs" -compact -offset 15n
+.It Li ".No test Ta with Ta tabs"
+.No test Ta with Ta tabs
+.El
+.Pp
+.
+The default width is 12n.
+.
+.Ss "No-Space Macro"
+.
+The
+.Ql .Ns
+macro suppresses insertion of a space between the current position and its
+first parameter.
+For example, it is useful for old style argument lists where there is no
+space between the flag and argument:
+.Pp
+.Dl "Usage:" ... Ao argument Ac \&Ns Oo Ao argument Ac Oc ...
+.Dl " " .Ns Ao argument Ac ...
+.Pp
+.Bl -tag -width ".Li .Op\ Fl\ I\ Ns\ Ar\ directory" -compact -offset 15n
+.It Li ".Op Fl I Ns Ar directory"
+.Op Fl I Ns Ar directory
+.El
+.Pp
+Note: The
+.Ql .Ns
+macro always invokes the
+.Ql .No
+macro after eliminating the space unless another macro name follows it.
+If used as a command (i.e., the second form above in the
+.Sq Usage
+line),
+.Ql .Ns
+is identical to
+.Ql .No .
+.
+.Ss "Section Cross References"
+.
+The
+.Ql .Sx
+macro designates a reference to a section header within the same document.
+.Pp
+.Dl Usage: .Sx Ao section reference Ac ...
+.Pp
+.Bl -tag -width ".Li .Sx\ FILES" -offset 15n
+.It Li ".Sx FILES"
+.Sx FILES
+.El
+.Pp
+.
+The default width is 16n.
+.
+.Ss Symbolics
+.
+The symbolic emphasis macro is generally a boldface macro in either the
+symbolic sense or the traditional English usage.
+.Pp
+.Dl Usage: .Sy Ao symbol Ac ...
+.Pp
+.Bl -tag -width ".Li .Sy\ Important\ Notice" -compact -offset 15n
+.It Li ".Sy Important Notice"
+.Sy Important Notice
+.El
+.Pp
+.
+The default width is 6n.
+.
+.Ss Mathematical Symbols
+.
+Use this macro for mathematical symbols and similar things.
+.Pp
+.Dl Usage: .Ms Ao math symbol Ac ...
+.Pp
+.Bl -tag -width ".Li .Ms\ sigma" -compact -offset 15n
+.It Li ".Ms sigma"
+.Ms sigma
+.El
+.Pp
+.
+The default width is 6n.
+.
+.Ss "References and Citations"
+.
+The following macros make a modest attempt to handle references.
+At best, the macros make it convenient to manually drop in a subset of
+.Xr refer 1
+style references.
+.Pp
+.Bl -tag -width 6n -offset indent -compact
+.It Li .Rs
+Reference start (does not take arguments).
+Causes a line break in the
+.Sx "SEE ALSO"
+section and begins collection of reference information until the reference
+end macro is read.
+.It Li .Re
+Reference end (does not take arguments).
+The reference is printed.
+.It Li .%A
+Reference author name; one name per invocation.
+.It Li .%B
+Book title.
+.It Li .%C
+City/place (not implemented yet).
+.It Li .%D
+Date.
+.It Li .%I
+Issuer/publisher name.
+.It Li .%J
+Journal name.
+.It Li .%N
+Issue number.
+.It Li .%O
+Optional information.
+.It Li .%P
+Page number.
+.It Li .%Q
+Corporate or foreign author.
+.It Li .%R
+Report name.
+.It Li .%T
+Title of article.
+.It Li .%V
+Volume.
+.El
+.Pp
+Macros beginning with
+.Ql %
+are not callable but accept multiple arguments in the usual way.
+Only the
+.Ql .Tn
+macro is handled properly as a parameter; other macros will cause strange
+output.
+.Ql .%B
+and
+.Ql .%T
+can be used outside of the
+.Ql .Rs/.Re
+environment.
+.Pp
+Example:
+.
+.Bd -literal -offset indent
+\&.Rs
+\&.%A "Matthew Bar"
+\&.%A "John Foo"
+\&.%T "Implementation Notes on foobar(1)"
+\&.%R "Technical Report ABC-DE-12-345"
+\&.%Q "Drofnats College, Nowhere"
+\&.%D "April 1991"
+\&.Re
+.Ed
+.Pp
+produces
+.
+.Bd -ragged -offset indent
+.Rs
+.%A "Matthew Bar"
+.%A "John Foo"
+.%T "Implementation Notes on foobar(1)"
+.%R "Technical Report ABC-DE-12-345"
+.%Q "Drofnats College, Nowhere"
+.%D "April 1991"
+.Re
+.Ed
+.
+.Ss "Trade Names (or Acronyms and Type Names)"
+.
+The trade name macro prints its arguments in a smaller font.
+Its intended use is to imitate a small caps fonts for uppercase acronyms.
+.Pp
+.Dl Usage: .Tn Ao symbol Ac ...
+.Pp
+.Bl -tag -width ".Li .Tn\ ASCII" -compact -offset 15n
+.It Li ".Tn DEC"
+.Tn DEC
+.It Li ".Tn ASCII"
+.Tn ASCII
+.El
+.Pp
+.
+The default width is 10n.
+.
+.Ss "Extended Arguments"
+.
+The
+.Li .Xo
+and
+.Li .Xc
+macros allow one to extend an argument list on a macro boundary for the
+.Ql .It
+macro (see below).
+Note that
+.Li .Xo
+and
+.Li .Xc
+are implemented similarly to all other macros opening and closing an
+enclosure (without inserting characters, of course).
+This means that the following is true for those macros also.
+.Pp
+Here is an example of
+.Ql .Xo
+using the space mode macro to turn spacing off:
+.
+.Bd -literal -offset indent
+\&.Sm off
+\&.It Xo Sy I Ar operation
+\&.No \een Ar count No \een
+\&.Xc
+\&.Sm on
+.Ed
+.Pp
+.
+produces
+.
+.Bd -filled -offset indent
+.Bl -tag -compact
+.Sm off
+.It Xo Sy I Ar operation
+.No \en Ar count No \en
+.Xc
+.Sm on
+.El
+.Ed
+.Pp
+.
+Another one:
+.
+.Bd -literal -offset indent
+\&.Sm off
+\&.It Cm S No / Ar old_pattern Xo
+\&.No / Ar new_pattern
+\&.No / Op Cm g
+\&.Xc
+\&.Sm on
+.Ed
+.Pp
+.
+produces
+.
+.Bd -filled -offset indent
+.Bl -tag -compact
+.Sm off
+.It Cm S No \&/ Ar old_pattern Xo
+.No \&/ Ar new_pattern
+.No \&/ Op Cm g
+.Xc
+.Sm on
+.El
+.Ed
+.Pp
+.
+Another example of
+.Ql .Xo
+and enclosure macros: Test the value of a variable.
+.
+.Bd -literal -offset indent
+\&.It Xo
+\&.Ic .ifndef
+\&.Oo \e&! Oc Ns Ar variable Oo
+\&.Ar operator variable ...
+\&.Oc Xc
+.Ed
+.Pp
+.
+produces
+.
+.Bd -filled -offset indent
+.Bl -tag -width flag -compact
+.It Xo
+.Ic .ifndef
+.Oo \&! Oc Ns Ar variable Oo
+.Ar operator variable ...
+.Oc Xc
+.El
+.Ed
+.Pp
+.
+.
+.Sh "PAGE STRUCTURE DOMAIN"
+.
+.Ss "Section Headers"
+.
+The following
+.Ql .Sh
+section header macros are required in every man page.
+The remaining section headers are recommended at the discretion of the
+author writing the manual page.
+The
+.Ql .Sh
+macro is parsed but not generally callable.
+It can be used as an argument in a call to
+.Ql .Sh
+only; it then reactivates the default font for
+.Ql .Sh .
+.Pp
+The default width is 8n.
+.
+.Bl -tag -width ".Li .Sh\ RETURN\ VALUES"
+.It Li ".Sh NAME"
+The
+.Ql ".Sh NAME"
+macro is mandatory.
+If not specified, headers, footers and page layout defaults will not be set
+and things will be rather unpleasant.
+The
+.Sx NAME
+section consists of at least three items.
+The first is the
+.Ql .Nm
+name macro naming the subject of the man page.
+The second is the name description macro,
+.Ql .Nd ,
+which separates the subject name from the third item, which is the
+description.
+The description should be the most terse and lucid possible, as the space
+available is small.
+.Pp
+.Ql .Nd
+first prints
+.Ql - ,
+then all its arguments.
+.
+.It Li ".Sh LIBRARY"
+This section is for section two and three function calls.
+It should consist of a single
+.Ql .Lb
+macro call;
+see
+.Sx "Library Names" .
+.
+.It Li ".Sh SYNOPSIS"
+The
+.Sx SYNOPSIS
+section describes the typical usage of the subject of a man page.
+The macros required are either
+.Ql .Nm ,
+.Ql .Cd ,
+or
+.Ql .Fn
+(and possibly
+.Ql .Fo ,
+.Ql .Fc ,
+.Ql .Fd ,
+and
+.Ql .Ft ) .
+The function name macro
+.Ql .Fn
+is required for manual page sections\~2 and\~3; the command and general name
+macro
+.Ql .Nm
+is required for sections 1, 5, 6, 7, and\~8.
+Section\~4 manuals require a
+.Ql .Nm ,
+.Ql .Fd
+or a
+.Ql .Cd
+configuration device usage macro.
+Several other macros may be necessary to produce the synopsis line as shown
+below:
+.
+.Bd -filled -offset indent
+.Nm cat
+.Op Fl benstuv
+.Op Fl
+.Ar
+.Ed
+.Pp
+.
+The following macros were used:
+.Pp
+.Dl ".Nm cat"
+.Dl ".Op Fl benstuv"
+.Dl ".Op Fl"
+.Dl .Ar
+.
+.It Li ".Sh DESCRIPTION"
+In most cases the first text in the
+.Sx DESCRIPTION
+section is a brief paragraph on the command, function or file, followed by a
+lexical list of options and respective explanations.
+To create such a list, the
+.Ql .Bl
+(begin list),
+.Ql .It
+(list item) and
+.Ql .El
+(end list)
+macros are used (see
+.Sx Lists and Columns
+below).
+.
+.It Li ".Sh IMPLEMENTATION NOTES"
+Implementation specific information should be placed here.
+.
+.It Li ".Sh RETURN VALUES"
+Sections 2, 3 and\~9 function return values should go here.
+The
+.Ql .Rv
+macro may be used to generate text for use in the
+.Sx RETURN VALUES
+section for most section 2 and 3 library functions;
+see
+.Sx "Return Values" .
+.El
+.Pp
+.
+The following
+.Ql .Sh
+section headers are part of the preferred manual page layout and must be
+used appropriately to maintain consistency.
+They are listed in the order in which they would be used.
+.
+.Bl -tag -width ".Li .Sh\ COMPATIBILITY"
+.It Li ".Sh ENVIRONMENT"
+The
+.Sx ENVIRONMENT
+section should reveal any related environment variables and clues to their
+behavior and/or usage.
+.
+.It Li ".Sh FILES"
+Files which are used or created by the man page subject should be listed via
+the
+.Ql .Pa
+macro in the
+.Sx FILES
+section.
+.
+.It Li ".Sh EXAMPLES"
+There are several ways to create examples.
+See the
+section below for details.
+.
+.It Li ".Sh DIAGNOSTICS"
+Diagnostic messages from a command should be placed in this section.
+The
+.Ql .Ex
+macro may be used to generate text for use in the
+.Sx DIAGNOSTICS
+section for most section 1, 6 and\~8 commands;
+see
+.Sx "Exit Status" .
+.
+.It Li ".Sh COMPATIBILITY"
+Known compatibility issues (e.g. deprecated options or parameters)
+should be listed here.
+.
+.It Li ".Sh ERRORS"
+Specific error handling, especially from library functions (man page
+sections 2, 3, and\~9) should go here.
+The
+.Ql .Er
+macro is used to specify an error (errno).
+.
+.It Li ".Sh SEE ALSO"
+References to other material on the man page topic and cross references to
+other relevant man pages should be placed in the
+.Sx "SEE ALSO"
+section.
+Cross references are specified using the
+.Ql .Xr
+macro.
+Currently
+.Xr refer 1
+style references are not accommodated.
+.Pp
+It is recommended that the cross references are sorted on the section
+number, then alphabetically on the names within a section, and placed
+in that order and comma separated.
+Example:
+.Pp
+.Xr ls 1 ,
+.Xr ps 1 ,
+.Xr group 5 ,
+.Xr passwd 5
+.
+.It Li ".Sh STANDARDS"
+If the command, library function or file adheres to a specific
+implementation such as
+.St -p1003.2
+or
+.St -ansiC
+this should be noted here.
+If the command does not adhere to any standard, its history should be noted
+in the
+.Sx HISTORY
+section.
+.
+.It Li ".Sh HISTORY"
+Any command which does not adhere to any specific standards should be
+outlined historically in this section.
+.
+.It Li ".Sh AUTHORS"
+Credits should be placed here.
+The
+.Ql .An
+macro should be used to specify the name(s) of the person(s).
+.
+.It Li ".Sh BUGS"
+Blatant problems with the topic go here.
+.El
+.Pp
+.
+User-specified
+.Ql .Sh
+sections may be added; for example, this section was set with:
+.
+.Bd -literal -offset 15n
+\&.Sh "PAGE STRUCTURE DOMAIN"
+.Ed
+.
+.Ss "Subsection Headers"
+.
+Subsection headers have exactly the same syntax as section headers:
+.Ql .Ss
+is parsed but not generally callable.
+It can be used as an argument in a call to
+.Ql .Ss
+only; it then reactivates the default font for
+.Ql .Ss .
+.Pp
+The default width is 8n.
+.
+.Ss "Paragraphs and Line Spacing"
+.
+.Bl -tag -width ".Li .Pp"
+.It Li .Pp
+The
+.Ql .Pp
+paragraph command may be used to specify a line space where necessary.
+The macro is not necessary after a
+.Ql .Sh
+or
+.Ql .Ss
+macro or before a
+.Ql .Bl
+or
+.Ql .Bd
+macro (which both assert a vertical distance unless the
+.Fl compact
+flag is given).
+.Pp
+The macro is neither callable nor parsed and takes no arguments; an
+alternative name is
+.Ql .Lp .
+.El
+.
+.\" XXX
+.
+.\" This worked with version one, need to redo for version three
+.\" .Pp
+.\" .Ds I
+.\" .Cw (ax+bx+c) \ is\ produced\ by\ \&
+.\" .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
+.\" .Cl Cx \t\t
+.\" .Li \&.Cx\ (
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Va ax
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Sy \+
+.\" .Cx
+.\" .Cl Cx \&(\&
+.\" .Va ax
+.\" .Cx +
+.\" .Va by
+.\" .Cx +
+.\" .Va c )
+.\" .Cx \t
+.\" .Em is produced by
+.\" .Cx \t
+.\" .Li \&.Va by
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Sy \+
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Va c )
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Cx
+.\" .Cx
+.\" .Cw
+.\" .De
+.\" .Pp
+.\" This example shows the same equation in a different format.
+.\" The spaces
+.\" around the
+.\" .Li \&+
+.\" signs were forced with
+.\" .Li \e :
+.\" .Pp
+.\" .Ds I
+.\" .Cw (ax\ +\ bx\ +\ c) \ is\ produced\ by\ \&
+.\" .\".Cw (ax+bx+c) \&.Va_by_) \&_and_\& \&[?/]m_b1_e1_f1[?/]\&
+.\" .Cl Cx \t\t
+.\" .Li \&.Cx\ (
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Va a
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Sy x
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Cx \e\ +\e\ \e&
+.\" .Cx
+.\" .Cl Cx \&(\&
+.\" .Va a
+.\" .Sy x
+.\" .Cx \ +\ \&
+.\" .Va b
+.\" .Sy y
+.\" .Cx \ +\ \&
+.\" .Va c )
+.\" .Cx \t
+.\" .Em is produced by
+.\" .Cl Cx \t\t
+.\" .Li \&.Va b
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Sy y
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Cx \e\ +\e\ \e&
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Va c )
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Cx
+.\" .Cx
+.\" .Cw
+.\" .De
+.\" .Pp
+.\" The incantation below was
+.\" lifted from the
+.\" .Xr adb 1
+.\" manual page:
+.\" .Pp
+.\" .Ds I
+.\" .Cw \&[?/]m_b1_e1_f1[?/]\& is\ produced\ by
+.\" .Cl Cx \t\t
+.\" .Li \&.Cx Op Sy ?/
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Nm m
+.\" .Cx
+.\" .Cl Cx Op Sy ?/
+.\" .Nm m
+.\" .Ad \ b1 e1 f1
+.\" .Op Sy ?/
+.\" .Cx \t
+.\" .Em is produced by
+.\" .Cx \t
+.\" .Li \&.Ar \e\ b1 e1 f1
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Op Sy ?/
+.\" .Cx
+.\" .Cl Cx \t\t
+.\" .Li \&.Cx
+.\" .Cx
+.\" .Cw
+.\" .De
+.\" .Pp
+.
+.Ss Keeps
+.
+The only keep that is implemented at this time is for words.
+The macros are
+.Ql .Bk
+(begin keep)
+and
+.Ql .Ek
+(end keep).
+The only option that
+.Ql .Bk
+accepts currently is
+.Fl words
+(this is also the default if no option is given) which is useful for
+preventing line breaks in the middle of options.
+In the example for the make command line arguments (see
+.Sx What's in a Name ) ,
+the keep prevented
+.Xr nroff
+from placing up the flag and the argument on separate lines.
+.Pp
+Both macros are neither callable nor parsed.
+.Pp
+More work needs to be done with the keep macros; specifically, a
+.Fl line
+option should be added.
+.
+.Ss "Examples and Displays"
+.
+There are seven types of displays.
+.Pp
+.Bl -tag -width ".Li .D1"
+.It Li .D1
+(This is D-one.)
+Display one line of indented text.
+This macro is parsed but not callable.
+.Pp
+.D1 Fl ldghfstru
+.Pp
+The above was produced by:
+.Li ".D1 Fl ldghfstru" .
+.
+.It Li .Dl
+(This is D-ell.)
+Display one line of indented
+.Em literal
+text.
+The
+.Ql .Dl
+example macro has been used throughout this file.
+It allows the indentation (display) of one line of text.
+Its default font is set to constant width (literal).
+.Ql .Dl
+is parsed but not callable.
+.Pp
+.Dl % ls -ldg /usr/local/bin
+.Pp
+The above was produced by:
+.Li ".Dl % ls -ldg /usr/local/bin" .
+.
+.It Li .Bd
+Begin display.
+The
+.Ql .Bd
+display must be ended with the
+.Ql .Ed
+macro.
+It has the following syntax:
+.Pp
+.Bl -tag -width ".Li .Bd" -offset indent
+.It Li .Bd Xo
+.Bro \-literal | \-filled | \-unfilled | \-ragged | \-centered Brc
+.Oo \-offset Ao string Ac Oc Oo \-file Ao file name Ac Oc Oo \-compact Oc Xc
+.El
+.Pp
+.
+.Bl -tag -width ".Fl file Ao Ar file name Ac " -compact
+.It Fl ragged
+Fill, but do not adjust the right margin (only left-justify).
+.It Fl centered
+Center lines between the current left and right margin.
+Note that each single line is centered.
+.It Fl unfilled
+Do not fill; display a block of text as typed, using line breaks as
+specified by the user.
+This can produce overlong lines without warning messages.
+.It Fl filled
+Display a filled block.
+The block of text is formatted (i.e., the text is justified on both the left
+and right side).
+.It Fl literal
+Display block with literal font (usually fixed-width).
+Useful for source code or simple tabbed or spaced text.
+.It Fl file Ao Ar file name Ac
+The file whose name follows the
+.Fl file
+flag is read and displayed before any data enclosed with
+.Ql .Bd
+and
+.Ql .Ed ,
+using the selected display type.
+Any
+.Xr troff/ Ns Nm \-mdoc
+commands in the file will be processed.
+.It Fl offset Ao Ar string Ac
+If
+.Fl offset
+is specified with one of the following strings, the string is interpreted to
+indicate the level of indentation for the forthcoming block of text:
+.
+.Pp
+.Bl -tag -width ".Ar indent-two" -compact
+.It Ar left
+Align block on the current left margin; this is the default mode of
+.Ql .Bd .
+.It Ar center
+Supposedly center the block.
+At this time unfortunately, the block merely gets left aligned about an
+imaginary center margin.
+.It Ar indent
+Indent by one default indent value or tab.
+The default indent value is also used for the
+.Ql .D1
+and
+.Ql .Dl
+macros, so one is guaranteed the two types of displays will line up.
+The indentation value is normally set to\~6n or about two thirds of an inch
+(six constant width characters).
+.It Ar indent-two
+Indent two times the default indent value.
+.It Ar right
+This
+.Em left
+aligns the block about two inches from the right side of the page.
+This macro needs work and perhaps may never do the right thing within
+.Xr troff .
+.El
+.Pp
+.
+If
+.Ao string Ac
+is a valid numeric expression instead
+.Pf ( Em with a scale indicator other than
+.Sq Em u ) ,
+use that value for indentation.
+The most useful scale indicators are
+.Sq m
+and
+.Sq n ,
+specifying the so-called
+.Em \&Em
+and
+.Em "En square" .
+This is approximately the width of the letters
+.Sq m
+and
+.Sq n
+respectively
+of the current font (for nroff output, both scale indicators give the same
+values).
+If
+.Ao string Ac
+isn't a numeric expression, it is tested whether it is an
+.Nm \-mdoc
+macro name, and the default offset value associated with this macro is used.
+Finally, if all tests fail,
+the width of
+.Ao string Ac
+(typeset with a fixed-width font) is taken as the offset.
+.It Fl compact
+Suppress insertion of vertical space before begin of display.
+.El
+.
+.It Li .Ed
+End display (takes no arguments).
+.El
+.
+.Ss "Lists and Columns"
+.
+There are several types of lists which may be initiated with the
+.Ql .Bl
+begin-list macro.
+Items within the list are specified with the
+.Ql .It
+item macro, and each list must end with the
+.Ql .El
+macro.
+Lists may be nested within themselves and within displays.
+The use of columns inside of lists or lists inside of columns is unproven.
+.Pp
+In addition, several list attributes may be specified such as the width of a
+tag, the list offset, and compactness (blank lines between items allowed or
+disallowed).
+Most of this document has been formatted with a tag style list
+.Pf ( Fl tag ) .
+.Pp
+It has the following syntax forms:
+.
+.Pp
+.Bl -tag -width ".Li .Bl" -offset indent -compact
+.It Li .Bl Xo
+.Bro \-hang | \-ohang | \-tag | \-diag | \-inset Brc
+.Oo \-width Ao string Ac Oc
+.Oo \-offset Ao string Ac Oc Oo \-compact Oc Xc
+.It Li .Bl Xo
+.No \-column Oo \-offset Ao string Ac Oc
+.Ao string1 Ac Ao string2 Ac ... Xc
+.It Li .Bl Xo
+.Bro \-item | \-enum Oo \-nested Oc | \-bullet | \-hyphen | \-dash Brc
+.Oo \-offset Ao string Ac Oc Oo \-compact Oc Xc
+.El
+.Pp
+.
+And now a detailed description of the list types.
+.
+.Pp
+.Bl -tag -width ".Fl column" -compact
+.It Fl bullet
+A bullet list.
+.
+.Bd -literal -offset indent
+\&.Bl -bullet -offset indent -compact
+\&.It
+Bullet one goes here.
+\&.It
+Bullet two here.
+\&.El
+.Ed
+.Pp
+.
+Produces:
+.
+.Pp
+.Bl -bullet -offset indent -compact
+.It
+Bullet one goes here.
+.It
+Bullet two here.
+.El
+.Pp
+.
+.It Fl dash No ( or Fl hyphen )
+A dash list.
+.
+.Bd -literal -offset indent
+\&.Bl -dash -offset indent -compact
+\&.It
+Dash one goes here.
+\&.It
+Dash two here.
+\&.El
+.Ed
+.Pp
+.
+Produces:
+.
+.Pp
+.Bl -dash -offset indent -compact
+.It
+Dash one goes here.
+.It
+Dash two here.
+.El
+.Pp
+.
+.It Fl enum
+An enumerated list.
+.
+.Bd -literal -offset indent
+\&.Bl -enum -offset indent -compact
+\&.It
+Item one goes here.
+\&.It
+And item two here.
+\&.El
+.Ed
+.Pp
+.
+The result:
+.
+.Pp
+.Bl -enum -offset indent -compact
+.It
+Item one goes here.
+.It
+And item two here.
+.El
+.Pp
+.
+If you want to nest enumerated lists, use the
+.Fl nested
+flag (starting with the second-level list):
+.
+.Bd -literal -offset indent
+\&.Bl -enum -offset indent -compact
+\&.It
+Item one goes here
+\&.Bl -enum -nested -compact
+\&.It
+Item two goes here.
+\&.It
+And item three here.
+\&.El
+\&.It
+And item four here.
+\&.El
+.Ed
+.Pp
+.
+Result:
+.
+.Pp
+.Bl -enum -offset indent -compact
+.It
+Item one goes here.
+.Bl -enum -nested -compact
+.It
+Item two goes here.
+.It
+And item three here.
+.El
+.It
+And item four here.
+.El
+.Pp
+.
+.It Fl item
+A list of type
+.Fl item
+without list markers.
+.
+.Bd -literal -offset indent
+\&.Bl -item -offset indent
+\&.It
+Item one goes here.
+Item one goes here.
+Item one goes here.
+\&.It
+Item two here.
+Item two here.
+Item two here.
+\&.El
+.Ed
+.Pp
+.
+Produces:
+.
+.Pp
+.Bl -item -offset indent
+.It
+Item one goes here.
+Item one goes here.
+Item one goes here.
+.It
+Item two here.
+Item two here.
+Item two here.
+.El
+.Pp
+.
+.It Fl tag
+A list with tags.
+Use
+.Fl width
+to specify the tag width.
+.
+.Pp
+.Bl -tag -width "PPID" -compact -offset indent
+.It SL
+sleep time of the process (seconds blocked)
+.It PAGEIN
+number of disk
+.Tn I/O Ns 's
+resulting from references by the process
+to pages not loaded in core.
+.It UID
+numerical user-id of process owner
+.It PPID
+numerical id of parent of process priority
+(non-positive when in non-interruptible wait)
+.El
+.Pp
+.
+The raw text:
+.
+.Bd -literal -offset indent
+\&.Bl -tag -width "PPID" -compact -offset indent
+\&.It SL
+sleep time of the process (seconds blocked)
+\&.It PAGEIN
+number of disk
+\&.Tn I/O Ns 's
+resulting from references by the process
+to pages not loaded in core.
+\&.It UID
+numerical user-id of process owner
+\&.It PPID
+numerical id of parent of process priority
+(non-positive when in non-interruptible wait)
+\&.El
+.Ed
+.Pp
+.
+.It Fl diag
+Diag lists create section four diagnostic lists and are similar to inset
+lists except callable macros are ignored.
+The
+.Fl width
+flag is not meaningful in this context.
+.Pp
+Example:
+.
+.Bd -literal -offset indent
+\&.Bl -diag
+\&.It You can't use Sy here.
+The message says all.
+\&.El
+.Ed
+.Pp
+.
+produces
+.
+.Bl -diag
+.It You can't use Sy here.
+The message says all.
+.El
+.Pp
+.
+.It Fl hang
+A list with hanging tags.
+.
+.Bl -hang -offset indent
+.It Em Hanged
+labels appear similar to tagged lists when the
+label is smaller than the label width.
+.It Em Longer hanged list labels
+blend into the paragraph unlike
+tagged paragraph labels.
+.El
+.Pp
+And the unformatted text which created it:
+.
+.Bd -literal -offset indent
+\&.Bl -hang -offset indent
+\&.It Em Hanged
+labels appear similar to tagged lists when the
+label is smaller than the label width.
+\&.It Em Longer hanged list labels
+blend into the paragraph unlike
+tagged paragraph labels.
+\&.El
+.Ed
+.Pp
+.
+.It Fl ohang
+Lists with overhanging tags do not use indentation for the items; tags are
+written to a separate line.
+.Pp
+.Bl -ohang -offset indent
+.It Sy SL
+sleep time of the process (seconds blocked)
+.It Sy PAGEIN
+number of disk
+.Tn I/O Ns 's
+resulting from references by the process
+to pages not loaded in core.
+.It Sy UID
+numerical user-id of process owner
+.It Sy PPID
+numerical id of parent of process priority
+(non-positive when in non-interruptible wait)
+.El
+.Pp
+.
+The raw text:
+.
+.Bd -literal -offset indent
+\&.Bl -ohang -offset indent
+\&.It Sy SL
+sleep time of the process (seconds blocked)
+\&.It Sy PAGEIN
+number of disk
+\&.Tn I/O Ns 's
+resulting from references by the process
+to pages not loaded in core.
+\&.It Sy UID
+numerical user-id of process owner
+\&.It Sy PPID
+numerical id of parent of process priority
+(non-positive when in non-interruptible wait)
+\&.El
+.Ed
+.Pp
+.
+.It Fl inset
+Here is an example of inset labels:
+.Bl -inset -offset indent
+.It Em Tag
+The tagged list (also called a tagged paragraph)
+is the most common type of list used in the
+Berkeley manuals.
+Use a
+.Fl width
+attribute as described below.
+.It Em Diag
+Diag lists create section four diagnostic lists
+and are similar to inset lists except callable
+macros are ignored.
+.It Em Hang
+Hanged labels are a matter of taste.
+.It Em Ohang
+Overhanging labels are nice when space is constrained.
+.It Em Inset
+Inset labels are useful for controlling blocks of
+paragraphs and are valuable for converting
+.Nm \-mdoc
+manuals to other formats.
+.El
+.Pp
+Here is the source text which produced the above example:
+.
+.Bd -literal -offset indent
+\&.Bl -inset -offset indent
+\&.It Em Tag
+The tagged list (also called a tagged paragraph)
+is the most common type of list used in the
+Berkeley manuals.
+\&.It Em Diag
+Diag lists create section four diagnostic lists
+and are similar to inset lists except callable
+macros are ignored.
+\&.It Em Hang
+Hanged labels are a matter of taste.
+\&.It Em Ohang
+Overhanging labels are nice when space is constrained.
+\&.It Em Inset
+Inset labels are useful for controlling blocks of
+paragraphs and are valuable for converting
+\&.Nm \-mdoc
+manuals to other formats.
+\&.El
+.Ed
+.Pp
+.
+.It Fl column
+This list type generates multiple columns.
+The number of columns and the width of each column is determined by the
+arguments to the
+.Fl column
+list,
+.Aq Ar string1 ,
+.Aq Ar string2 ,
+etc.
+If
+.Aq Ar stringN
+starts with a
+.Ql .\&
+(dot) immediately followed by a valid
+.Nm \-mdoc
+macro name, interpret
+.Aq Ar stringN
+and use the width of the result.
+Otherwise, the width of
+.Aq Ar stringN
+(typeset with a fixed-width font) is taken as the
+.Ar N Ns th
+column width.
+.Pp
+Each
+.Ql .It
+argument is parsed to make a row, each column within the row is a separate
+argument separated by a tab or the
+.Ql .Ta
+macro.
+.Pp
+The table:
+.
+.Bl -column -offset indent ".Sy String" ".Sy Nroff" ".Sy Troff"
+.It Sy String Ta Sy Nroff Ta Sy Troff
+.It Li <= Ta <= Ta \*(<=
+.It Li >= Ta >= Ta \*(>=
+.El
+.Pp
+.
+was produced by:
+.
+.Bd -literal
+\&.Bl -column -offset indent ".Sy String" ".Sy Nroff" ".Sy Troff"
+\&.It Sy String Ta Sy Nroff Ta Sy Troff
+\&.It Li <= Ta <= Ta \e*(<=
+\&.It Li >= Ta >= Ta \e*(>=
+\&.El
+.Ed
+.El
+.Pp
+.
+Other keywords:
+.
+.Bl -tag -width ".Fl indent Ao Ar string Ac"
+.It Fl width Ao Ar string Ac
+If
+.Aq Ar string
+starts with a
+.Ql .\&
+(dot) immediately followed by a valid
+.Nm \-mdoc
+macro name, interpret
+.Aq Ar string
+and use the width of the result.
+Almost all lists in this document use this option.
+.Pp
+Example:
+.
+.Bd -literal -offset indent
+\&.Bl -tag -width ".Fl test Ao Ar string Ac"
+\&.It Fl test Ao Ar string Ac
+This is a longer sentence to show how the
+\&.Fl width
+flag works in combination with a tag list.
+\&.El
+.Ed
+.Pp
+.
+gives:
+.
+.Bl -tag -width ".Fl test Ao Ar string Ac"
+.It Fl test Ao Ar string Ac
+This is a longer sentence to show how the
+.Fl width
+flag works in combination with a tag list.
+.El
+.Pp
+.
+(Note that the current state of
+.Nm \-mdoc
+is saved before
+.Aq Ar string
+is interpreted; afterwards, all variables are restored again.
+However, boxes (used for enclosures) can't be saved in
+.Tn GNU
+.Xr troff 1 ;
+as a consequence, arguments must always be
+.Em balanced
+to avoid nasty errors.
+For example, do not write
+.Ql ".Ao Ar string"
+but
+.Ql ".Ao Ar string Xc"
+instead if you really need only an opening angle bracket.)
+.Pp
+Otherwise, if
+.Aq Ar string
+is a valid numeric expression
+.Em ( with a scale indicator other than
+.Sq Em u ) ,
+use that value for indentation.
+The most useful scale indicators are
+.Sq m
+and
+.Sq n ,
+specifying the so-called
+.Em \&Em
+and
+.Em "En square" .
+This is approximately the width of the letters
+.Sq m
+and
+.Sq n
+respectively
+of the current font (for nroff output, both scale indicators give the same
+values).
+If
+.Aq Ar string
+isn't a numeric expression, it is tested whether it is an
+.Nm \-mdoc
+macro name, and the default width value associated with this macro is used.
+Finally, if all tests fail,
+the width of
+.Aq Ar string
+(typeset with a fixed-width font) is taken as the width.
+.Pp
+If a width is not specified for the tag list type, every time
+.Ql .It
+is invoked, an attempt is made to determine an appropriate width.
+If the first argument to
+.Ql .It
+is a callable macro, the default width for that macro will be used;
+otherwise, the default width of
+.Ql .No
+is used.
+.It Fl offset Ao Ar string Ac
+If
+.Aq Ar string
+is
+.Ar indent ,
+a default indent value (normally set to\~6n, similar to the value used in
+.Ql .Dl
+or
+.Ql .Bd )
+is used.
+If
+.Aq Ar string
+is a valid numeric expression instead
+.Pf ( Em with a scale indicator other than
+.Sq Em u ) ,
+use that value for indentation.
+The most useful scale indicators are
+.Sq m
+and
+.Sq n ,
+specifying the so-called
+.Em \&Em
+and
+.Em "En square" .
+This is approximately the width of the letters
+.Sq m
+and
+.Sq n
+respectively
+of the current font (for nroff output, both scale indicators give the same
+values).
+If
+.Aq Ar string
+isn't a numeric expression, it is tested whether it is an
+.Nm \-mdoc
+macro name, and the default offset value associated with this macro is used.
+Finally, if all tests fail,
+the width of
+.Aq Ar string
+(typeset with a fixed-width font) is taken as the offset.
+.It Fl compact
+Suppress insertion of vertical space before the list and between list items.
+.El
+.
+.
+.Sh "MISCELLANEOUS MACROS"
+.
+Here a list of the remaining macros which do not fit well into one of the
+above sections.
+We couldn't find real examples for the following macros:
+.Ql .Me
+and
+.Ql .Ot .
+They are documented here for completeness \- if you know how to use them
+properly please send a mail to
+.Mt bug-groff at xxxxxxx
+(including an example).
+.
+.Bl -tag -width ".Li .Bt"
+.It Li .Bt
+prints
+.
+.Bd -ragged -offset indent
+.Bt
+.Ed
+.Pp
+It is neither callable nor parsed and takes no arguments.
+.
+.It Li .Fr
+.Pp
+.Dl Usage: .Fr Ao function return value Ac ...
+.Pp
+It allows a break right before the return value (usually a single digit)
+which is bad typographical behaviour.
+Use
+.Ql \e~
+to tie the return value to the previous word.
+.
+.It Li .Hf
+Use this macro to include a (header) file literally.
+It first prints
+.Ql File:
+followed by the file name, then the contents of
+.Ao file Ac .
+.Pp
+.Dl Usage: .Hf Ao file Ac
+.Pp
+It is neither callable nor parsed.
+.
+.It Li .Lk
+To be written.
+.
+.It Li .Me
+Exact usage unknown.
+The documentation in the
+.Nm \-mdoc
+source file describes it as a macro for
+.Dq "menu entries" .
+.Pp
+Its default width is 6n.
+.
+.It Li .Mt
+To be written.
+.
+.It Li .Ot
+Exact usage unknown.
+The documentation in the
+.Nm \-mdoc
+source file describes it as
+.Dq old function type (fortran) .
+.
+.It Li .Sm
+Activate (toggle) space mode.
+.Pp
+.Dl Usage: .Sm Oo on | off Oc ...
+.Pp
+If space mode is off, no spaces between macro arguments are inserted.
+If called without a parameter (or if the next parameter is neither
+.Ql on
+nor
+.Ql off ,
+.Ql .Sm
+toggles space mode.
+.
+.It Li .Ud
+prints
+.
+.Bd -ragged -offset indent
+.Ud
+.Ed
+.Pp
+It is neither callable nor parsed and takes no arguments.
+.El
+.
+.
+.Sh "PREDEFINED STRINGS"
+.
+The following strings are predefined:
+.Pp
+.Bl -column String infinity "Troff " "straight double quote" -offset indent
+.It Sy String Ta Sy Nroff Ta Sy Troff Ta Sy Meaning
+.It Li <= Ta <= Ta \*[<=] Ta "less equal"
+.It Li >= Ta >= Ta \*[>=] Ta "greater equal"
+.It Li Rq Ta '' Ta \*[Rq] Ta "right double quote"
+.It Li Lq Ta `` Ta \*[Lq] Ta "left double quote"
+.It Li ua Ta ^ Ta \*[ua] Ta "upwards arrow"
+.It Li aa Ta \' Ta \*[aa] Ta "acute accent"
+.It Li ga Ta \` Ta \*[ga] Ta "grave accent"
+.It Li q Ta \&" Ta \*[q] Ta "straight double quote"
+.It Li Pi Ta pi Ta \*[Pi] Ta "greek pi"
+.It Li Ne Ta != Ta \*[Ne] Ta "not equal"
+.It Li Le Ta <= Ta \*[Le] Ta "less equal"
+.It Li Ge Ta >= Ta \*[Ge] Ta "greater equal"
+.It Li Lt Ta < Ta \*[Lt] Ta "less than"
+.It Li Gt Ta > Ta \*[Gt] Ta "greater than"
+.It Li Pm Ta +\- Ta \*[Pm] Ta "plus minus"
+.It Li If Ta infinity Ta \*[If] Ta "infinity"
+.It Li Am Ta \*[Am] Ta \*[Am] Ta "ampersand"
+.It Li Na Ta \*[Na] Ta \*[Na] Ta "not a number"
+.It Li Ba Ta \*[Ba] Ta \*[Ba] Ta "vertical bar"
+.El
+.Pp
+The names of the columns
+.Sy Nroff
+and
+.Sy Troff
+are a bit misleading;
+.Sy Nroff
+shows the
+.Tn ASCII
+representation, while
+.Sy Troff
+gives the best glyph form available.
+For example, a Unicode enabled
+.Tn TTY Ns - Ns
+device will have proper glyph representations for all strings, whereas the
+enhancement for a Latin1
+.Tn TTY Ns - Ns
+device is only the plus-minus sign.
+.Pp
+String names which consist of two characters can be written as
+.Ql \e*(xx ;
+string names which consist of one character can be written as
+.Ql \e*x .
+A generic syntax for a string name of any length is
+.Ql \e*[xxx]
+(this is a
+.Tn GNU
+.Xr troff 1
+extension).
+.
+.
+\#
+\#=====================================================================
+\#
+.Sh DIAGNOSTICS
+.
+The debugging macro
+.Ql .Db
+available in previous versions of
+.Nm \-mdoc
+has been removed since
+.Tn GNU
+.Xr troff 1
+provides better facilities to check parameters; additionally, many error and
+warning messages have been added to this macro package, making it both more
+robust and verbose.
+.Pp
+The only remaining debugging macro is
+.Ql .Rd
+which yields a register dump of all global registers and strings.
+A normal user will never need it.
+.
+.
+.Sh "FORMATTING WITH GROFF, TROFF, AND NROFF"
+.
+By default, the package inhibits page breaks, headers, and footers if
+displayed with a
+.Tn TTY
+device like
+.Sq latin1
+or
+.Sq unicode
+to make the manual more efficient for viewing on-line.
+This behaviour can be changed (e.g.\& to create a hardcopy of the
+.Tn TTY
+output) by setting the register
+.Ql cR
+to zero while calling
+.Xr groff :
+.Pp
+.Dl groff -Tlatin1 -rcR=0 -mdoc foo.man > foo.txt
+.Pp
+For double-sided printing, set register
+.Ql D
+to\~1:
+.Pp
+.Dl groff -Tps -rD1 -mdoc foo.man > foo.ps
+.Pp
+To change the document font size to 11pt or 12pt, set register
+.Ql S
+accordingly:
+.Pp
+.Dl groff -Tdvi -rS11 -mdoc foo.man > foo.dvi
+.Pp
+Register
+.Ql S
+is ignored for
+.Tn TTY
+devices.
+.Pp
+The line and title length can be changed by setting the registers
+.Ql LL
+and
+.Ql LT ,
+respectively:
+.Pp
+.Dl groff -Tutf8 -rLL=100n -rLT=100n -mdoc foo.man | less
+.Pp
+If not set, both registers default to 78n for TTY devices and 6.5i
+otherwise.
+.
+.
+.Sh FILES
+.
+.Bl -tag -width mdoc/doc-ditroff -compact
+.It Pa doc.tmac
+The main manual macro package.
+.It Pa mdoc.tmac
+A wrapper file to call
+.Pa doc.tmac .
+.It Pa mdoc/doc-common
+Common strings, definitions, stuff related typographic output.
+.It Pa mdoc/doc-nroff
+Definitions used for a
+.Tn TTY
+output device.
+.It Pa mdoc/doc-ditroff
+Definitions used for all other devices.
+.It Pa mdoc.local
+Local additions and customizations.
+.It Pa andoc.tmac
+This file checks whether the
+.Nm \-mdoc
+or the
+.Nm \-man
+package should be used.
+.El
+.
+.
+.Sh "SEE ALSO"
+.
+.Xr groff 1 ,
+.Xr man 1 ,
+.Xr troff 1 ,
+.Xr groff_man 7
+.
+.
+.Sh BUGS
+.
+Section 3f has not been added to the header routines.
+.Pp
+.Ql \&.Nm
+font should be changed in
+.Sx NAME
+section.
+.Pp
+.Ql \&.Fn
+needs to have a check to prevent splitting up
+if the line length is too short.
+Occasionally it
+separates the last parenthesis, and sometimes
+looks ridiculous if a line is in fill mode.
+.Pp
+The list and display macros do not do any keeps
+and certainly should be able to.
+.\" Note what happens if the parameter list overlaps a newline
+.\" boundary.
+.\" to make sure a line boundary is crossed:
+.\" .Bd -literal
+.\" \&.Fn struct\e\ dictionarytable\e\ *dictionarylookup struct\e\ dictionarytable\e\ *tab[]
+.\" .Ed
+.\" .Pp
+.\" produces, nudge nudge,
+.\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
+.\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] ,
+.\" nudge
+.\" .Fn struct\ dictionarytable\ *dictionarylookup char\ *h struct\ dictionarytable\ *tab[] .
+.\" .Pp
+.\" If double quotes are used, for example:
+.\" .Bd -literal
+.\" \&.Fn \*qstruct dictionarytable *dictionarylookup\*q \*qchar *h\*q \*qstruct dictionarytable *tab[]\*q
+.\" .Ed
+.\" .Pp
+.\" produces, nudge nudge,
+.\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
+.\" nudge
+.\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" ,
+.\" nudge
+.\" .Fn "struct dictionarytable *dictionarylookup" "char *h" "struct dictionarytable *tab[]" .
+.\" .Pp
+.\" Not a pretty sight...
+.\" In a paragraph, a long parameter containing unpaddable spaces as
+.\" in the former example will cause
+.\" .Xr troff
+.\" to break the line and spread
+.\" the remaining words out.
+.\" The latter example will adjust nicely to
+.\" justified margins, but may break in between an argument and its
+.\" declaration.
+.\" In
+.\" .Xr nroff
+.\" the right margin adjustment is normally ragged and the problem is
+.\" not as severe.
+.
+.\" Local Variables:
+.\" mode: nroff
+.\" End:
Index: gnu/usr.bin/tar/tar.1
===================================================================
RCS file: /home/dcvs/src/gnu/usr.bin/tar/tar.1,v
retrieving revision 1.2
diff -u -u -r1.2 tar.1
--- gnu/usr.bin/tar/tar.1 17 Jun 2003 04:25:49 -0000 1.2
+++ gnu/usr.bin/tar/tar.1 18 Feb 2004 21:36:40 -0000
@@ -498,7 +498,7 @@
The
.Fl y
is a
-.Fx
+.Dx
localism.
The GNU
.Nm
Index: lib/libc/gen/clock.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/gen/clock.3,v
retrieving revision 1.2
diff -u -u -r1.2 clock.3
--- lib/libc/gen/clock.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libc/gen/clock.3 25 Feb 2004 20:29:38 -0000
@@ -75,7 +75,7 @@
requires
.Dv CLOCKS_PER_SEC
to be defined as one million.
-.Fx
+.Dx
does not conform to this requirement;
changing the value would introduce binary incompatibility
and one million is still inadequate on modern processors.
Index: lib/libc/gen/getosreldate.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/gen/getosreldate.3,v
retrieving revision 1.3
diff -u -u -r1.3 getosreldate.3
--- lib/libc/gen/getosreldate.3 3 Feb 2004 07:34:07 -0000 1.3
+++ lib/libc/gen/getosreldate.3 25 Feb 2004 20:34:51 -0000
@@ -48,7 +48,7 @@
The
.Fn getrelosdate
function should return a 32-bit integer showing the version of
-.Fx
+.Dx
that a program was compiled on, and maybe running on (if 2.0 or better).
Definitions of the values can be found on the porters handbook
which is usually installed at
Index: lib/libc/gen/getpeereid.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/gen/getpeereid.3,v
retrieving revision 1.2
diff -u -u -r1.2 getpeereid.3
--- lib/libc/gen/getpeereid.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libc/gen/getpeereid.3 25 Feb 2004 20:35:31 -0000
@@ -87,7 +87,7 @@
Likewise, the client can verify the credentials of the server.
.Sh IMPLEMENTATION NOTES
On
-.Fx ,
+.Dx ,
.Fn getpeereid
is implemented in terms of the
.Dv LOCAL_PEERCRED
Index: lib/libc/gen/getprogname.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/gen/getprogname.3,v
retrieving revision 1.2
diff -u -u -r1.2 getprogname.3
--- lib/libc/gen/getprogname.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libc/gen/getprogname.3 25 Feb 2004 20:36:02 -0000
@@ -71,7 +71,7 @@
it should not be modified for the rest of the program's lifetime.
.Pp
In
-.Fx ,
+.Dx ,
the name of the program is set by the start-up code that is run before
.Fn main ;
thus,
Index: lib/libc/gen/msgrcv.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/gen/msgrcv.3,v
retrieving revision 1.2
diff -u -u -r1.2 msgrcv.3
--- lib/libc/gen/msgrcv.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libc/gen/msgrcv.3 25 Feb 2004 20:39:15 -0000
@@ -215,7 +215,7 @@
.Xr msgget 3 ,
.Xr msgsnd 3
.Sh BUGS
-.Tn NetBSD
+.Tn Nx Ns , Dx Ns ,
and
.Fx
do not define the
Index: lib/libc/gen/msgsnd.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/gen/msgsnd.3,v
retrieving revision 1.2
diff -u -u -r1.2 msgsnd.3
--- lib/libc/gen/msgsnd.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libc/gen/msgsnd.3 25 Feb 2004 20:38:21 -0000
@@ -157,7 +157,7 @@
The system call was interrupted by the delivery of a signal.
.El
.Sh BUGS
-.Nx
+.Nx Ns , Dx Ns ,
and
.Fx
do not define the
Index: lib/libc/gen/shm_open.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/gen/shm_open.3,v
retrieving revision 1.2
diff -u -u -r1.2 shm_open.3
--- lib/libc/gen/shm_open.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libc/gen/shm_open.3 25 Feb 2004 20:43:11 -0000
@@ -59,7 +59,7 @@
.Fa path .
.Pp
In the
-.Fx
+.Dx
implementation,
.Tn POSIX
shared memory objects are implemented as ordinary files.
@@ -84,7 +84,7 @@
(which is not defined for shared memory objects).
.Pp
In addition, the
-.Fx
+.Dx
implementation causes
.Fn mmap
of a descriptor returned by
Index: lib/libc/gen/siginterrupt.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/gen/siginterrupt.3,v
retrieving revision 1.2
diff -u -u -r1.2 siginterrupt.3
--- lib/libc/gen/siginterrupt.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libc/gen/siginterrupt.3 25 Feb 2004 20:44:25 -0000
@@ -59,7 +59,7 @@
and is the default behaviour for
.Xr signal 3
on
-.Fx .
+.Dx .
.Pp
If the flag is true (1),
then restarting of system calls is disabled.
Index: lib/libc/gen/signal.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/gen/signal.3,v
retrieving revision 1.3
diff -u -u -r1.3 signal.3
--- lib/libc/gen/signal.3 24 Oct 2003 17:14:11 -0000 1.3
+++ lib/libc/gen/signal.3 25 Feb 2004 20:44:16 -0000
@@ -49,7 +49,7 @@
.Fn signal "int sig" "void \*(lp*func\*(rp\*(lpint\*(rp\*(rp\*(rp\*(lpint"
.Pp
or in
-.Fx Ns 's
+.Dx Ns 's
equivalent but easier to read typedef'd version:
.Ft typedef "void \*(lp*sig_t\*(rp \*(lpint\*(rp" ;
.Ft sig_t
Index: lib/libc/gen/ucontext.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/gen/ucontext.3,v
retrieving revision 1.2
diff -u -u -r1.2 ucontext.3
--- lib/libc/gen/ucontext.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libc/gen/ucontext.3 25 Feb 2004 20:45:45 -0000
@@ -93,4 +93,4 @@
and
.Fn swapcontext
functions are not yet implemented in this version of
-.Fx .
+.Dx .
Index: lib/libc/stdio/fclose.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/stdio/fclose.3,v
retrieving revision 1.2
diff -u -u -r1.2 fclose.3
--- lib/libc/stdio/fclose.3 17 Jun 2003 04:26:45 -0000 1.2
+++ lib/libc/stdio/fclose.3 25 Feb 2004 20:31:07 -0000
@@ -83,7 +83,7 @@
violation.
This is intentional - it makes it easier to make sure programs written
under
-.Fx
+.Dx
are bug free.
This behaviour is an implementation detail, and programs should not
rely upon it.
Index: lib/libc/stdlib/getenv.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/stdlib/getenv.3,v
retrieving revision 1.3
diff -u -u -r1.3 getenv.3
--- lib/libc/stdlib/getenv.3 10 Nov 2003 19:48:53 -0000 1.3
+++ lib/libc/stdlib/getenv.3 25 Feb 2004 20:32:36 -0000
@@ -152,7 +152,7 @@
to the same
.Ar name
will result in a memory leak. The
-.Fx
+.Dx
semantics for these functions
(namely, that the contents of
.Ar value
Index: lib/libc/stdlib/malloc.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/stdlib/malloc.3,v
retrieving revision 1.2
diff -u -u -r1.2 malloc.3
--- lib/libc/stdlib/malloc.3 17 Jun 2003 04:26:46 -0000 1.2
+++ lib/libc/stdlib/malloc.3 25 Feb 2004 20:27:54 -0000
@@ -131,7 +131,7 @@
function call is identical to the realloc function call, except that it
will free the passed pointer when the requested memory cannot be allocated.
This is a
-.Fx
+.Fx / Dx
specific API designed to ease the problems with traditional coding styles
for realloc causing memory leaks in libraries.
.Pp
Index: lib/libc/string/strstr.3
===================================================================
RCS file: /home/dcvs/src/lib/libc/string/strstr.3,v
retrieving revision 1.2
diff -u -u -r1.2 strstr.3
--- lib/libc/string/strstr.3 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libc/string/strstr.3 25 Feb 2004 20:45:09 -0000
@@ -85,7 +85,7 @@
Since the
.Fn strnstr
function is a
-.Fx
+.Fx / Dx
specific API, it should only be used when portability is not a concern.
.Sh RETURN VALUES
If
Index: lib/libc/sys/aio_waitcomplete.2
===================================================================
RCS file: /home/dcvs/src/lib/libc/sys/aio_waitcomplete.2,v
retrieving revision 1.2
diff -u -u -r1.2 aio_waitcomplete.2
--- lib/libc/sys/aio_waitcomplete.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libc/sys/aio_waitcomplete.2 18 Feb 2004 22:09:29 -0000
@@ -122,9 +122,10 @@
.Sh STANDARDS
The
.Fn aio_waitcomplete
-function is a
-.Fx Ns -specific
-extension.
+function is specific to
+.Fx
+and
+.Dx .
.Sh HISTORY
The
.Fn aio_waitcomplete
Index: lib/libc/sys/chmod.2
===================================================================
RCS file: /home/dcvs/src/lib/libc/sys/chmod.2,v
retrieving revision 1.2
diff -u -u -r1.2 chmod.2
--- lib/libc/sys/chmod.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libc/sys/chmod.2 18 Feb 2004 22:11:30 -0000
@@ -109,7 +109,7 @@
.Ed
.Pp
The
-.Fx
+.Dx
VM system totally ignores the sticky bit
.Pq Dv ISVTX
for executables.
Index: lib/libc/sys/minherit.2
===================================================================
RCS file: /home/dcvs/src/lib/libc/sys/minherit.2,v
retrieving revision 1.2
diff -u -u -r1.2 minherit.2
--- lib/libc/sys/minherit.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libc/sys/minherit.2 18 Feb 2004 22:17:45 -0000
@@ -56,7 +56,7 @@
Not all implementations will guarantee that the inheritance characteristic
can be set on a page basis;
the granularity of changes may be as large as an entire region.
-.Fx
+.Dx
is capable of adjusting inheritance characteristics on a page basis.
Inheritance only effects children created by
.Fn fork .
Index: lib/libc/sys/mmap.2
===================================================================
RCS file: /home/dcvs/src/lib/libc/sys/mmap.2,v
retrieving revision 1.2
diff -u -u -r1.2 mmap.2
--- lib/libc/sys/mmap.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libc/sys/mmap.2 18 Feb 2004 22:19:05 -0000
@@ -335,14 +335,14 @@
The limit is imposed for a variety of reasons.
Most of them have to do
with
-.Fx
+.Dx
not wanting to use 64 bit offsets in the VM system due to
the extreme performance penalty.
So
-.Fx
+.Dx
uses 32bit page indexes and
this gives
-.Fx
+.Dx
a maximum of 8TB filesizes.
It's actually bugs in
the filesystem code that causes the limit to be further restricted to
Index: lib/libc/sys/ntp_adjtime.2
===================================================================
RCS file: /home/dcvs/src/lib/libc/sys/ntp_adjtime.2,v
retrieving revision 1.2
diff -u -u -r1.2 ntp_adjtime.2
--- lib/libc/sys/ntp_adjtime.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libc/sys/ntp_adjtime.2 18 Feb 2004 22:20:27 -0000
@@ -53,7 +53,7 @@
word.
.Pp
In the
-.Fx
+.Dx
kernel, the
.Fn ntp_adjtime
and
Index: lib/libc/sys/ptrace.2
===================================================================
RCS file: /home/dcvs/src/lib/libc/sys/ptrace.2,v
retrieving revision 1.2
diff -u -u -r1.2 ptrace.2
--- lib/libc/sys/ptrace.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libc/sys/ptrace.2 18 Feb 2004 22:20:57 -0000
@@ -73,7 +73,7 @@
reads from the instruction space and
.Dv PT_READ_D
reads from the data space. In the current
-.Fx
+.Dx
implementation, these
two requests are completely identical. The
.Fa addr
Index: lib/libc/sys/rfork.2
===================================================================
RCS file: /home/dcvs/src/lib/libc/sys/rfork.2,v
retrieving revision 1.2
diff -u -u -r1.2 rfork.2
--- lib/libc/sys/rfork.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libc/sys/rfork.2 18 Feb 2004 22:22:13 -0000
@@ -153,7 +153,7 @@
.Xr vfork 2 ,
.Xr rfork_thread 3
.Sh BUGS
-.Fx
+.Dx
does not yet implement a native
.Fn clone
library call, and the current pthreads implementation does not use
Index: lib/libc/sys/rtprio.2
===================================================================
RCS file: /home/dcvs/src/lib/libc/sys/rtprio.2,v
retrieving revision 1.2
diff -u -u -r1.2 rtprio.2
--- lib/libc/sys/rtprio.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libc/sys/rtprio.2 18 Feb 2004 22:22:48 -0000
@@ -104,9 +104,7 @@
.An -nosplit
The original author was
.An Henrik Vestergaard Draboel Aq hvd at xxxxxxxxxxxxx .
-This implementation in
-.Fx
-was substantially rewritten by
+This implementation was substantially rewritten by
.An David Greenman .
.Sh SEE ALSO
.Xr nice 1 ,
Index: lib/libc/sys/sendfile.2
===================================================================
RCS file: /home/dcvs/src/lib/libc/sys/sendfile.2,v
retrieving revision 1.2
diff -u -u -r1.2 sendfile.2
--- lib/libc/sys/sendfile.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libc/sys/sendfile.2 18 Feb 2004 22:23:15 -0000
@@ -101,7 +101,7 @@
is returned.
.Sh IMPLEMENTATION NOTES
The
-.Fx
+.Dx
implementation of
.Fn sendfile
is "zero-copy", meaning that it has been optimized so that copying of the file data is avoided.
Index: lib/libc/sys/setresuid.2
===================================================================
RCS file: /home/dcvs/src/lib/libc/sys/setresuid.2,v
retrieving revision 1.2
diff -u -u -r1.2 setresuid.2
--- lib/libc/sys/setresuid.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libc/sys/setresuid.2 18 Feb 2004 22:23:59 -0000
@@ -75,7 +75,7 @@
.Sh STANDARDS
These system calls are not available on many platforms.
They exist in
-.Fx
+.Dx
to support Linux binaries linked against GNU libc2.
.Sh HISTORY
These system calls first appeared in HP-UX.
Index: lib/libc/sys/sigaction.2
===================================================================
RCS file: /home/dcvs/src/lib/libc/sys/sigaction.2,v
retrieving revision 1.2
diff -u -u -r1.2 sigaction.2
--- lib/libc/sys/sigaction.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libc/sys/sigaction.2 18 Feb 2004 22:24:32 -0000
@@ -458,13 +458,13 @@
member of
.Dv struct sigaction .
In practice,
-.Fx
+.Dx
always sends the three arguments of the latter and since the ANSI C
prototype is a subset, both will work.
The
.Dv sa_handler
member declaration in
-.Fx
+.Dx
include files is that of ANSI C (as required by POSIX),
so a function pointer of a
.Bx Ns -style
Index: lib/libc_r/man/pthread_condattr.3
===================================================================
RCS file: /home/dcvs/src/lib/libc_r/man/pthread_condattr.3,v
retrieving revision 1.2
diff -u -u -r1.2 pthread_condattr.3
--- lib/libc_r/man/pthread_condattr.3 17 Jun 2003 04:26:48 -0000 1.2
+++ lib/libc_r/man/pthread_condattr.3 25 Feb 2004 20:42:18 -0000
@@ -45,7 +45,7 @@
.Sh DESCRIPTION
Condition attribute objects are used to specify parameters to
.Fn pthread_cond_init .
-.Fx Ns 's
+.Dx Ns 's
implementation of conditions does not support any non-default
attributes, so these functions are not very useful, though they are required to
to be present by
Index: lib/libcr/gen/clock.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/gen/clock.3,v
retrieving revision 1.2
diff -u -u -r1.2 clock.3
--- lib/libcr/gen/clock.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libcr/gen/clock.3 25 Feb 2004 20:29:42 -0000
@@ -75,7 +75,7 @@
requires
.Dv CLOCKS_PER_SEC
to be defined as one million.
-.Fx
+.Dx
does not conform to this requirement;
changing the value would introduce binary incompatibility
and one million is still inadequate on modern processors.
Index: lib/libcr/gen/getosreldate.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/gen/getosreldate.3,v
retrieving revision 1.3
diff -u -u -r1.3 getosreldate.3
--- lib/libcr/gen/getosreldate.3 3 Feb 2004 07:34:10 -0000 1.3
+++ lib/libcr/gen/getosreldate.3 25 Feb 2004 20:34:54 -0000
@@ -48,7 +48,7 @@
The
.Fn getrelosdate
function should return a 32-bit integer showing the version of
-.Fx
+.Dx
that a program was compiled on, and maybe running on (if 2.0 or better).
Definitions of the values can be found on the porters handbook
which is usually installed at
Index: lib/libcr/gen/getpeereid.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/gen/getpeereid.3,v
retrieving revision 1.2
diff -u -u -r1.2 getpeereid.3
--- lib/libcr/gen/getpeereid.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libcr/gen/getpeereid.3 25 Feb 2004 20:35:34 -0000
@@ -87,7 +87,7 @@
Likewise, the client can verify the credentials of the server.
.Sh IMPLEMENTATION NOTES
On
-.Fx ,
+.Dx ,
.Fn getpeereid
is implemented in terms of the
.Dv LOCAL_PEERCRED
Index: lib/libcr/gen/getprogname.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/gen/getprogname.3,v
retrieving revision 1.2
diff -u -u -r1.2 getprogname.3
--- lib/libcr/gen/getprogname.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libcr/gen/getprogname.3 25 Feb 2004 20:36:07 -0000
@@ -71,7 +71,7 @@
it should not be modified for the rest of the program's lifetime.
.Pp
In
-.Fx ,
+.Dx ,
the name of the program is set by the start-up code that is run before
.Fn main ;
thus,
Index: lib/libcr/gen/msgrcv.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/gen/msgrcv.3,v
retrieving revision 1.2
diff -u -u -r1.2 msgrcv.3
--- lib/libcr/gen/msgrcv.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libcr/gen/msgrcv.3 25 Feb 2004 20:39:53 -0000
@@ -215,7 +215,7 @@
.Xr msgget 3 ,
.Xr msgsnd 3
.Sh BUGS
-.Tn NetBSD
+.Tn Nx Ns , Dx Ns ,
and
.Fx
do not define the
Index: lib/libcr/gen/msgsnd.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/gen/msgsnd.3,v
retrieving revision 1.2
diff -u -u -r1.2 msgsnd.3
--- lib/libcr/gen/msgsnd.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libcr/gen/msgsnd.3 25 Feb 2004 20:40:03 -0000
@@ -157,7 +157,7 @@
The system call was interrupted by the delivery of a signal.
.El
.Sh BUGS
-.Nx
+.Nx Ns , Dx Ns ,
and
.Fx
do not define the
Index: lib/libcr/gen/shm_open.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/gen/shm_open.3,v
retrieving revision 1.2
diff -u -u -r1.2 shm_open.3
--- lib/libcr/gen/shm_open.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libcr/gen/shm_open.3 25 Feb 2004 20:43:19 -0000
@@ -59,7 +59,7 @@
.Fa path .
.Pp
In the
-.Fx
+.Dx
implementation,
.Tn POSIX
shared memory objects are implemented as ordinary files.
@@ -84,7 +84,7 @@
(which is not defined for shared memory objects).
.Pp
In addition, the
-.Fx
+.Dx
implementation causes
.Fn mmap
of a descriptor returned by
Index: lib/libcr/gen/siginterrupt.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/gen/siginterrupt.3,v
retrieving revision 1.2
diff -u -u -r1.2 siginterrupt.3
--- lib/libcr/gen/siginterrupt.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libcr/gen/siginterrupt.3 25 Feb 2004 20:44:28 -0000
@@ -59,7 +59,7 @@
and is the default behaviour for
.Xr signal 3
on
-.Fx .
+.Dx .
.Pp
If the flag is true (1),
then restarting of system calls is disabled.
Index: lib/libcr/gen/signal.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/gen/signal.3,v
retrieving revision 1.3
diff -u -u -r1.3 signal.3
--- lib/libcr/gen/signal.3 24 Oct 2003 17:14:13 -0000 1.3
+++ lib/libcr/gen/signal.3 25 Feb 2004 20:44:19 -0000
@@ -49,7 +49,7 @@
.Fn signal "int sig" "void \*(lp*func\*(rp\*(lpint\*(rp\*(rp\*(rp\*(lpint"
.Pp
or in
-.Fx Ns 's
+.Dx Ns 's
equivalent but easier to read typedef'd version:
.Ft typedef "void \*(lp*sig_t\*(rp \*(lpint\*(rp" ;
.Ft sig_t
Index: lib/libcr/gen/ucontext.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/gen/ucontext.3,v
retrieving revision 1.2
diff -u -u -r1.2 ucontext.3
--- lib/libcr/gen/ucontext.3 17 Jun 2003 04:26:42 -0000 1.2
+++ lib/libcr/gen/ucontext.3 25 Feb 2004 20:45:47 -0000
@@ -93,4 +93,4 @@
and
.Fn swapcontext
functions are not yet implemented in this version of
-.Fx .
+.Dx .
Index: lib/libcr/stdio/fclose.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/stdio/fclose.3,v
retrieving revision 1.2
diff -u -u -r1.2 fclose.3
--- lib/libcr/stdio/fclose.3 17 Jun 2003 04:26:45 -0000 1.2
+++ lib/libcr/stdio/fclose.3 25 Feb 2004 20:31:12 -0000
@@ -83,7 +83,7 @@
violation.
This is intentional - it makes it easier to make sure programs written
under
-.Fx
+.Dx
are bug free.
This behaviour is an implementation detail, and programs should not
rely upon it.
Index: lib/libcr/stdlib/getenv.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/stdlib/getenv.3,v
retrieving revision 1.3
diff -u -u -r1.3 getenv.3
--- lib/libcr/stdlib/getenv.3 8 Dec 2003 13:56:35 -0000 1.3
+++ lib/libcr/stdlib/getenv.3 25 Feb 2004 20:32:40 -0000
@@ -152,7 +152,7 @@
to the same
.Ar name
will result in a memory leak. The
-.Fx
+.Dx
semantics for these functions
(namely, that the contents of
.Ar value
Index: lib/libcr/stdlib/malloc.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/stdlib/malloc.3,v
retrieving revision 1.2
diff -u -u -r1.2 malloc.3
--- lib/libcr/stdlib/malloc.3 17 Jun 2003 04:26:46 -0000 1.2
+++ lib/libcr/stdlib/malloc.3 25 Feb 2004 20:28:49 -0000
@@ -131,7 +131,7 @@
function call is identical to the realloc function call, except that it
will free the passed pointer when the requested memory cannot be allocated.
This is a
-.Fx
+.Fx / Dx
specific API designed to ease the problems with traditional coding styles
for realloc causing memory leaks in libraries.
.Pp
Index: lib/libcr/string/strstr.3
===================================================================
RCS file: /home/dcvs/src/lib/libcr/string/strstr.3,v
retrieving revision 1.2
diff -u -u -r1.2 strstr.3
--- lib/libcr/string/strstr.3 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libcr/string/strstr.3 25 Feb 2004 20:45:12 -0000
@@ -85,7 +85,7 @@
Since the
.Fn strnstr
function is a
-.Fx
+.Fx / Dx
specific API, it should only be used when portability is not a concern.
.Sh RETURN VALUES
If
Index: lib/libcr/sys/aio_waitcomplete.2
===================================================================
RCS file: /home/dcvs/src/lib/libcr/sys/aio_waitcomplete.2,v
retrieving revision 1.2
diff -u -u -r1.2 aio_waitcomplete.2
--- lib/libcr/sys/aio_waitcomplete.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libcr/sys/aio_waitcomplete.2 18 Feb 2004 22:10:58 -0000
@@ -122,9 +122,10 @@
.Sh STANDARDS
The
.Fn aio_waitcomplete
-function is a
-.Fx Ns -specific
-extension.
+function is specific to
+.Fx
+and
+.Dx .
.Sh HISTORY
The
.Fn aio_waitcomplete
Index: lib/libcr/sys/chmod.2
RCS file: /home/dcvs/src/lib/libcr/sys/chmod.2,v
retrieving revision 1.2
diff -u -u -r1.2 chmod.2
--- lib/libcr/sys/chmod.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libcr/sys/chmod.2 18 Feb 2004 22:11:38 -0000
@@ -109,7 +109,7 @@
.Ed
.Pp
The
-.Fx
+.Dx
VM system totally ignores the sticky bit
.Pq Dv ISVTX
for executables.
Index: lib/libcr/sys/minherit.2
===================================================================
RCS file: /home/dcvs/src/lib/libcr/sys/minherit.2,v
retrieving revision 1.2
diff -u -u -r1.2 minherit.2
--- lib/libcr/sys/minherit.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libcr/sys/minherit.2 18 Feb 2004 22:17:54 -0000
@@ -56,7 +56,7 @@
Not all implementations will guarantee that the inheritance characteristic
can be set on a page basis;
the granularity of changes may be as large as an entire region.
-.Fx
+.Dx
is capable of adjusting inheritance characteristics on a page basis.
Inheritance only effects children created by
.Fn fork .
Index: lib/libcr/sys/mmap.2
===================================================================
RCS file: /home/dcvs/src/lib/libcr/sys/mmap.2,v
retrieving revision 1.2
diff -u -u -r1.2 mmap.2
--- lib/libcr/sys/mmap.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libcr/sys/mmap.2 18 Feb 2004 22:19:12 -0000
@@ -335,14 +335,14 @@
The limit is imposed for a variety of reasons.
Most of them have to do
with
-.Fx
+.Dx
not wanting to use 64 bit offsets in the VM system due to
the extreme performance penalty.
So
-.Fx
+.Dx
uses 32bit page indexes and
this gives
-.Fx
+.Dx
a maximum of 8TB filesizes.
It's actually bugs in
the filesystem code that causes the limit to be further restricted to
Index: lib/libcr/sys/ntp_adjtime.2
===================================================================
RCS file: /home/dcvs/src/lib/libcr/sys/ntp_adjtime.2,v
retrieving revision 1.2
diff -u -u -r1.2 ntp_adjtime.2
--- lib/libcr/sys/ntp_adjtime.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libcr/sys/ntp_adjtime.2 18 Feb 2004 22:20:32 -0000
@@ -53,7 +53,7 @@
word.
.Pp
In the
-.Fx
+.Dx
kernel, the
.Fn ntp_adjtime
and
Index: lib/libcr/sys/ptrace.2
===================================================================
RCS file: /home/dcvs/src/lib/libcr/sys/ptrace.2,v
retrieving revision 1.2
diff -u -u -r1.2 ptrace.2
--- lib/libcr/sys/ptrace.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libcr/sys/ptrace.2 18 Feb 2004 22:21:01 -0000
@@ -73,7 +73,7 @@
reads from the instruction space and
.Dv PT_READ_D
reads from the data space. In the current
-.Fx
+.Dx
implementation, these
two requests are completely identical. The
.Fa addr
Index: lib/libcr/sys/rfork.2
===================================================================
RCS file: /home/dcvs/src/lib/libcr/sys/rfork.2,v
retrieving revision 1.2
diff -u -u -r1.2 rfork.2
--- lib/libcr/sys/rfork.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libcr/sys/rfork.2 18 Feb 2004 22:22:16 -0000
@@ -153,7 +153,7 @@
.Xr vfork 2 ,
.Xr rfork_thread 3
.Sh BUGS
-.Fx
+.Dx
does not yet implement a native
.Fn clone
library call, and the current pthreads implementation does not use
Index: lib/libcr/sys/rtprio.2
===================================================================
RCS file: /home/dcvs/src/lib/libcr/sys/rtprio.2,v
retrieving revision 1.2
diff -u -u -r1.2 rtprio.2
--- lib/libcr/sys/rtprio.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libcr/sys/rtprio.2 18 Feb 2004 22:22:54 -0000
@@ -104,9 +104,7 @@
.An -nosplit
The original author was
.An Henrik Vestergaard Draboel Aq hvd at xxxxxxxxxxxxx .
-This implementation in
-.Fx
-was substantially rewritten by
+This implementation was substantially rewritten by
.An David Greenman .
.Sh SEE ALSO
.Xr nice 1 ,
Index: lib/libcr/sys/sendfile.2
===================================================================
RCS file: /home/dcvs/src/lib/libcr/sys/sendfile.2,v
retrieving revision 1.2
diff -u -u -r1.2 sendfile.2
--- lib/libcr/sys/sendfile.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libcr/sys/sendfile.2 18 Feb 2004 22:23:22 -0000
@@ -101,7 +101,7 @@
is returned.
.Sh IMPLEMENTATION NOTES
The
-.Fx
+.Dx
implementation of
.Fn sendfile
is "zero-copy", meaning that it has been optimized so that copying of the file data is avoided.
Index: lib/libcr/sys/setresuid.2
===================================================================
RCS file: /home/dcvs/src/lib/libcr/sys/setresuid.2,v
retrieving revision 1.2
diff -u -u -r1.2 setresuid.2
--- lib/libcr/sys/setresuid.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libcr/sys/setresuid.2 18 Feb 2004 22:24:02 -0000
@@ -75,7 +75,7 @@
.Sh STANDARDS
These system calls are not available on many platforms.
They exist in
-.Fx
+.Dx
to support Linux binaries linked against GNU libc2.
.Sh HISTORY
These system calls first appeared in HP-UX.
Index: lib/libcr/sys/sigaction.2
===================================================================
RCS file: /home/dcvs/src/lib/libcr/sys/sigaction.2,v
retrieving revision 1.2
diff -u -u -r1.2 sigaction.2
--- lib/libcr/sys/sigaction.2 17 Jun 2003 04:26:47 -0000 1.2
+++ lib/libcr/sys/sigaction.2 18 Feb 2004 22:24:37 -0000
@@ -458,13 +458,13 @@
member of
.Dv struct sigaction .
In practice,
-.Fx
+.Dx
always sends the three arguments of the latter and since the ANSI C
prototype is a subset, both will work.
The
.Dv sa_handler
member declaration in
-.Fx
+.Dx
include files is that of ANSI C (as required by POSIX),
so a function pointer of a
.Bx Ns -style
Index: lib/libdisk/libdisk.3
===================================================================
RCS file: /home/dcvs/src/lib/libdisk/libdisk.3,v
retrieving revision 1.2
diff -u -u -r1.2 libdisk.3
--- lib/libdisk/libdisk.3 17 Jun 2003 04:26:49 -0000 1.2
+++ lib/libdisk/libdisk.3 25 Feb 2004 20:11:06 -0000
@@ -196,7 +196,7 @@
This is the active slice in the MBR.
.It CHUNK_FORCE_ALL
Force a dedicated disk for
-.Fx ,
+.Dx / Fx ,
bypassing all BIOS geometry considerations.
.El
.Pp
@@ -243,7 +243,7 @@
.Pp
.Fn All_FreeBSD
makes one
-.Fx
+.Fx / Dx
chunk covering the entire disk; if
.Ql force_all
is set, bypass all BIOS geometry considerations.
Index: lib/libposix1e/acl.3
===================================================================
RCS file: /home/dcvs/src/lib/libposix1e/acl.3,v
retrieving revision 1.2
diff -u -u -r1.2 acl.3
--- lib/libposix1e/acl.3 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libposix1e/acl.3 25 Feb 2004 20:20:34 -0000
@@ -39,7 +39,7 @@
.In sys/acl.h
.Sh DESCRIPTION
As shipped,
-.Fx 4.0
+.Dx
permits file systems to export
Access Control Lists via the VFS, and provides a library for userland
access to and manipulation of these ACLs, but support for ACLs is not
@@ -55,7 +55,7 @@
POSIX.1e describes a set of ACL manipulation routines to manage the
contents of ACLs, as well as their relationships with files. This
manipulation library is not currently implemented in
-.Fx ,
+.Dx ,
although
a third party library was under development at the time this document
was written. There is a general consensus that the POSIX.1e manipulation
@@ -143,7 +143,7 @@
routines may change over time, and as such are not documented. They are
not intended to be called directly without going through the library.
.Sh IMPLEMENTATION NOTES
-.Fx Ns 's
+.Dx Ns 's
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh ENVIRONMENT
@@ -153,7 +153,7 @@
and labels necessary for mandatory access control. POSIX.2c describes
a set of userland utilities for manipulating these labels. These userland
utilities are not bundled with
-.Fx 4.0
+.Dx
so as to discourage their
use in the short term.
.\" .Sh FILES
Index: lib/libposix1e/acl_delete.3
===================================================================
RCS file: /home/dcvs/src/lib/libposix1e/acl_delete.3,v
retrieving revision 1.2
diff -u -u -r1.2 acl_delete.3
--- lib/libposix1e/acl_delete.3 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libposix1e/acl_delete.3 25 Feb 2004 20:20:59 -0000
@@ -58,7 +58,7 @@
allow deleting of arbitrary ACL types from a file/directory by either path
name, or by file descriptor.
.Sh IMPLEMENTATION NOTES
-.Fx Ns 's
+.Dx Ns 's
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
Index: lib/libposix1e/acl_dup.3
===================================================================
RCS file: /home/dcvs/src/lib/libposix1e/acl_dup.3,v
retrieving revision 1.2
diff -u -u -r1.2 acl_dup.3
--- lib/libposix1e/acl_dup.3 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libposix1e/acl_dup.3 25 Feb 2004 20:21:03 -0000
@@ -56,7 +56,7 @@
.Va acl
shall continue to refer to the ACL.
.Sh IMPLEMENTATION NOTES
-.Fx Ns 's
+.Dx Ns 's
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
Index: lib/libposix1e/acl_free.3
===================================================================
RCS file: /home/dcvs/src/lib/libposix1e/acl_free.3,v
retrieving revision 1.2
diff -u -u -r1.2 acl_free.3
--- lib/libposix1e/acl_free.3 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libposix1e/acl_free.3 25 Feb 2004 20:21:09 -0000
@@ -47,7 +47,7 @@
or
.Xr acl_from_text 3 .
.Sh IMPLEMENTATION NOTES
-.Fx Ns 's
+.Dx Ns 's
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
Index: lib/libposix1e/acl_from_text.3
===================================================================
RCS file: /home/dcvs/src/lib/libposix1e/acl_from_text.3,v
retrieving revision 1.2
diff -u -u -r1.2 acl_from_text.3
--- lib/libposix1e/acl_from_text.3 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libposix1e/acl_from_text.3 25 Feb 2004 20:21:17 -0000
@@ -54,7 +54,7 @@
.Va (void *)acl_t
as an argument.
.Sh IMPLEMENTATION NOTES
-.Fx Ns 's
+.Dx Ns 's
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
Index: lib/libposix1e/acl_get.3
===================================================================
RCS file: /home/dcvs/src/lib/libposix1e/acl_get.3,v
retrieving revision 1.2
diff -u -u -r1.2 acl_get.3
--- lib/libposix1e/acl_get.3 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libposix1e/acl_get.3 25 Feb 2004 20:21:20 -0000
@@ -77,7 +77,7 @@
The ACL in the working storage shall not participate in any access control
decisions.
.Sh IMPLEMENTATION NOTES
-.Fx Ns 's
+.Dx Ns 's
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
Index: lib/libposix1e/acl_init.3
===================================================================
RCS file: /home/dcvs/src/lib/libposix1e/acl_init.3,v
retrieving revision 1.2
diff -u -u -r1.2 acl_init.3
--- lib/libposix1e/acl_init.3 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libposix1e/acl_init.3 25 Feb 2004 20:21:23 -0000
@@ -58,7 +58,7 @@
.Va (void*)acl_t
as an argument.
.Sh IMPLEMENTATION NOTES
-.Fx Ns 's
+.Dx Ns 's
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
Index: lib/libposix1e/acl_set.3
===================================================================
RCS file: /home/dcvs/src/lib/libposix1e/acl_set.3,v
retrieving revision 1.2
diff -u -u -r1.2 acl_set.3
--- lib/libposix1e/acl_set.3 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libposix1e/acl_set.3 25 Feb 2004 20:21:28 -0000
@@ -64,7 +64,7 @@
.Fn acl_set_fd_np
allows the setting of ACLs of any type.
.Sh IMPLEMENTATION NOTES
-.Fx Ns 's
+.Dx Ns 's
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
Index: lib/libposix1e/acl_to_text.3
===================================================================
RCS file: /home/dcvs/src/lib/libposix1e/acl_to_text.3,v
retrieving revision 1.2
diff -u -u -r1.2 acl_to_text.3
--- lib/libposix1e/acl_to_text.3 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libposix1e/acl_to_text.3 25 Feb 2004 20:21:32 -0000
@@ -61,7 +61,7 @@
.Va (void*)char
as an argument.
.Sh IMPLEMENTATION NOTES
-.Fx Ns 's
+.Dx Ns 's
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
Index: lib/libposix1e/acl_valid.3
===================================================================
RCS file: /home/dcvs/src/lib/libposix1e/acl_valid.3,v
retrieving revision 1.2
diff -u -u -r1.2 acl_valid.3
--- lib/libposix1e/acl_valid.3 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libposix1e/acl_valid.3 25 Feb 2004 20:21:41 -0000
@@ -81,7 +81,7 @@
function may reorder the ACL for the purposes of verification; the
non-portable validation functions will not.
.Sh IMPLEMENTATION NOTES
-.Fx Ns 's
+.Dx Ns 's
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
Index: lib/libposix1e/posix1e.3
===================================================================
RCS file: /home/dcvs/src/lib/libposix1e/posix1e.3,v
retrieving revision 1.2
diff -u -u -r1.2 posix1e.3
--- lib/libposix1e/posix1e.3 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libposix1e/posix1e.3 25 Feb 2004 20:23:46 -0000
@@ -44,14 +44,14 @@
The IEEE POSIX.1e specification never left draft form, but the interfaces
it describes are now widely used despite inherent limitations. Currently,
only a few of the interfaces and features are implemented in
-.Fx ,
+.Dx ,
although efforts are underway to complete the integration at this time.
.Pp
POSIX.1e describes five security extensions to the base POSIX.1 API:
Access Control Lists (ACLs), Auditing, Capabilities, Mandatory Access
Control, and Information Flow Labels. Of these, the ACL interfaces are
currently included with
-.Fx ,
+.Dx ,
Auditing, Capabilities, and Mandatory
Access Control are in the wings, and Information Flow Labels are not on
the calendar.
@@ -59,7 +59,7 @@
POSIX.1e defines both syntax and semantics for these features, but fairly
substantial changes are required to implement these features in the
operating system. As shipped,
-.Fx 4.0
+.Dx
permits file systems to export
Access Control Lists via the VFS, and provides a library for userland
access to and manipulation of these ACLs, but support for ACLs is not
@@ -73,7 +73,7 @@
.Pp
http://www.watson.org/fbsd-hardening/posix1e/
.Sh IMPLEMENTATION NOTES
-.Fx Ns 's
+.Dx Ns 's
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh ENVIRONMENT
@@ -83,7 +83,7 @@
and labels necessary for mandatory access control. POSIX.2c describes
a set of userland utilities for manipulating these labels. These userland
utilities are not bundled with
-.Fx 4.0
+.Dx
so as to discourage their
use in the short term.
.Sh FILES
Index: lib/libskey/skey.1
===================================================================
RCS file: /home/dcvs/src/lib/libskey/skey.1,v
retrieving revision 1.2
diff -u -u -r1.2 skey.1
--- lib/libskey/skey.1 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libskey/skey.1 18 Feb 2004 21:34:39 -0000
@@ -74,7 +74,7 @@
use are available.
.Pp
Under
-.Fx ,
+.Dx ,
you can control, with
.Pa /etc/skey.access ,
from which hosts and/or networks the use of
Index: lib/libutil/login.conf.5
===================================================================
RCS file: /home/dcvs/src/lib/libutil/login.conf.5,v
retrieving revision 1.2
diff -u -u -r1.2 login.conf.5
--- lib/libutil/login.conf.5 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libutil/login.conf.5 25 Feb 2004 21:34:15 -0000
@@ -50,7 +50,7 @@
"root" if it exists, or "default" if not.
.Pp
In
-.Fx ,
+.Dx ,
users may individually create a file called
.Pa .login_conf
in their home directory using the same format, consisting of a single
@@ -227,7 +227,7 @@
changed passwords will use.
Valid values include "des", "md5" and "blf".
NIS clients using a
-.No non- Ns Fx
+.No non- Ns Dx Ns / Ns Fx
NIS server should probably use "des".
.It "passwd_prompt string The password prompt presented by
.Xr login 1
Index: lib/libutil/login_cap.3
===================================================================
RCS file: /home/dcvs/src/lib/libutil/login_cap.3,v
retrieving revision 1.2
diff -u -u -r1.2 login_cap.3
--- lib/libutil/login_cap.3 17 Jun 2003 04:26:51 -0000 1.2
+++ lib/libutil/login_cap.3 25 Feb 2004 20:17:01 -0000
@@ -318,7 +318,7 @@
Time values are normally used for setting resource, accounting and
session limits.
If supported by the operating system and compiler (which is true of
-.Fx ) ,
+.Dx ) ,
the value returned is a quad (long long), of type
.Em rlim_t .
A value "inf" or "infinity" may be used to express an infinite
Index: lib/libvgl/vgl.3
===================================================================
RCS file: /home/dcvs/src/lib/libvgl/vgl.3,v
retrieving revision 1.2
diff -u -u -r1.2 vgl.3
--- lib/libvgl/vgl.3 17 Jun 2003 04:26:52 -0000 1.2
+++ lib/libvgl/vgl.3 25 Feb 2004 20:14:53 -0000
@@ -140,7 +140,7 @@
functions to do various graphic operations.
There is also support for a
mouse via the standard mouse system in
-.Fx ,
+.Dx ,
see
.Xr mouse 4 ,
including the ability to transparently have a mouse pointer superimposed on
Index: libexec/mknetid/mknetid.8
===================================================================
RCS file: /home/dcvs/src/libexec/mknetid/mknetid.8,v
retrieving revision 1.2
diff -u -u -r1.2 mknetid.8
--- libexec/mknetid/mknetid.8 17 Jun 2003 04:27:07 -0000 1.2
+++ libexec/mknetid/mknetid.8 25 Feb 2004 22:47:01 -0000
@@ -112,7 +112,7 @@
until
.Tn Secure RPC
support is added to
-.Fx .
+.Dx .
.It Fl d Ar domain
By default, the
.Nm
Index: libexec/rpc.rquotad/rpc.rquotad.8
===================================================================
RCS file: /home/dcvs/src/libexec/rpc.rquotad/rpc.rquotad.8,v
retrieving revision 1.2
diff -u -u -r1.2 rpc.rquotad.8
--- libexec/rpc.rquotad/rpc.rquotad.8 17 Jun 2003 04:27:07 -0000 1.2
+++ libexec/rpc.rquotad/rpc.rquotad.8 25 Feb 2004 22:56:47 -0000
@@ -56,7 +56,8 @@
protocol defined in
.Pa /usr/include/rpcsvc/rquota.x .
.Sh BUGS
-.Bx 4.4
+.Bx 4.4 Ns ,
+.Dx Ns ,
and
.Fx
support group quotas but the rquota protocol does not.
Index: libexec/ypxfr/ypxfr.8
===================================================================
RCS file: /home/dcvs/src/libexec/ypxfr/ypxfr.8,v
retrieving revision 1.2
diff -u -u -r1.2 ypxfr.8
--- libexec/ypxfr/ypxfr.8 17 Jun 2003 04:27:08 -0000 1.2
+++ libexec/ypxfr/ypxfr.8 25 Feb 2004 23:04:15 -0000
@@ -58,7 +58,7 @@
server to another using
.Tn NIS
services. In
-.Fx ,
+.Dx ,
.Nm
is generally invoked by
.Xr ypserv 8
@@ -146,12 +146,12 @@
facility.
.Sh NOTES
The
-.Fx
+.Dx
version of
.Nm
has support for a special map transfer protocol which works in
conjunction with the
-.Fx
+.Dx
.Xr rpc.ypxfrd 8
server. This protocol allows it to transfer raw map database files from
the
@@ -172,21 +172,21 @@
and creating new maps instead.
.Pp
Note that while the
-.Fx
+.Dx
ypxfrd protocol is conceptually similar
to the SunOS ypxfrd protocol,
the
-.Fx
+.Dx
protocol is not compatible with
Sun's, therefore it will not work with Sun's ypxfrd server.
-.Fx
+.Dx
slave systems can still transfer maps from any
-.No non- Ns Fx
+.No non- Ns Dx Ns / Ns Fx
.Tn NIS
server,
however they will only be able to take advantage of the faster protocol
if the master server is also running
-.Fx .
+.Dx .
.Sh OPTIONS
The following options and flags are supported by
.Nm :
Index: sbin/adjkerntz/adjkerntz.8
===================================================================
RCS file: /home/dcvs/src/sbin/adjkerntz/adjkerntz.8,v
retrieving revision 1.2
diff -u -u -r1.2 adjkerntz.8
--- sbin/adjkerntz/adjkerntz.8 17 Jun 2003 04:27:32 -0000 1.2
+++ sbin/adjkerntz/adjkerntz.8 25 Feb 2004 22:33:09 -0000
@@ -50,7 +50,7 @@
The main purpose of this thing is not general fixing of
initially broken MS-DOS file timestamp idea but keeping
the same timestamps between
-.Fx
+.Dx
MS-DOS file system
and MS-DOS operating system installed on the same
machine.
Index: sbin/atacontrol/atacontrol.8
===================================================================
RCS file: /home/dcvs/src/sbin/atacontrol/atacontrol.8,v
retrieving revision 1.2
diff -u -u -r1.2 atacontrol.8
--- sbin/atacontrol/atacontrol.8 17 Jun 2003 04:27:32 -0000 1.2
+++ sbin/atacontrol/atacontrol.8 25 Feb 2004 22:33:39 -0000
@@ -77,7 +77,7 @@
The
.Nm
utility is a control program that provides the user access and control to the
-.Fx
+.Dx
.Xr ata 4
subsystem.
.Pp
Index: sbin/camcontrol/camcontrol.8
===================================================================
RCS file: /home/dcvs/src/sbin/camcontrol/camcontrol.8,v
retrieving revision 1.2
diff -u -u -r1.2 camcontrol.8
--- sbin/camcontrol/camcontrol.8 17 Jun 2003 04:27:32 -0000 1.2
+++ sbin/camcontrol/camcontrol.8 25 Feb 2004 22:36:15 -0000
@@ -143,7 +143,7 @@
The
.Nm
utility is designed to provide a way for users to access and control the
-.Fx
+.Dx
CAM subsystem.
.Pp
The
Index: sbin/disklabel/disklabel.8
===================================================================
RCS file: /home/dcvs/src/sbin/disklabel/disklabel.8,v
retrieving revision 1.2
diff -u -u -r1.2 disklabel.8
--- sbin/disklabel/disklabel.8 17 Jun 2003 04:27:32 -0000 1.2
+++ sbin/disklabel/disklabel.8 25 Feb 2004 22:38:08 -0000
@@ -245,7 +245,7 @@
.Pp
PC-based systems have special requirements in order for the BIOS to properly
recognize a
-.Fx
+.Dx
disklabel. Older systems may require what is known as a
.Dq dangerously dedicated
disklabel, which creates a fake DOS partition to work around problems older
@@ -254,7 +254,7 @@
to create a normal DOS partition using
.Ar fdisk
and then create a
-.Fx
+.Dx
disklabel within that slice. This is described
later on in this page.
.Pp
@@ -349,7 +349,7 @@
Making a slice bootable can be tricky. If you are using a normal DOS
slice you typically install (or leave) a standard MBR on the base disk and
then install the
-.Fx
+.Dx
bootblocks in the slice.
.Pp
.Nm
@@ -460,7 +460,7 @@
To initialize a disk from scratch the following sequence is recommended.
Please note that this will wipe everything that was previously on the disk,
including any
-.No non- Ns Fx
+.No non- Ns Dx
slices.
.Bl -enum
.It
@@ -475,7 +475,7 @@
Use
.Nm
to define partitions on
-.Fx
+.Dx
slices created in the previous step.
.It
Finally use
@@ -582,7 +582,7 @@
.Cm badsect .
.Cm removable
is set for removable media drives, but no current
-.Fx
+.Dx
driver evaluates this
flag.
.Cm ecc
Index: sbin/dump/dump.8
===================================================================
RCS file: /home/dcvs/src/sbin/dump/dump.8,v
retrieving revision 1.2
diff -u -u -r1.2 dump.8
--- sbin/dump/dump.8 17 Jun 2003 04:27:32 -0000 1.2
+++ sbin/dump/dump.8 25 Feb 2004 22:38:37 -0000
@@ -469,8 +469,8 @@
.Nm
utility cannot do remote backups without being run as root, due to its
security history.
-This will be fixed in a later version of
-.Fx .
+This may be fixed in a later version of
+.Dx .
Presently, it works if you set it setuid (like it used to be), but this
might constitute a security risk.
.Sh HISTORY
Index: sbin/i386/fdisk/fdisk.8
===================================================================
RCS file: /home/dcvs/src/sbin/i386/fdisk/fdisk.8,v
retrieving revision 1.4
diff -u -u -r1.4 fdisk.8
--- sbin/i386/fdisk/fdisk.8 3 Feb 2004 08:43:41 -0000 1.4
+++ sbin/i386/fdisk/fdisk.8 25 Feb 2004 22:40:02 -0000
@@ -42,7 +42,7 @@
.Em active .
.Sh DESCRIPTION
The
-.Fx
+.Dx
program,
.Nm ,
serves a similar purpose to the DOS program. The first form is used to
@@ -101,7 +101,7 @@
.It Fl I
Initialize the contents of sector 0
for one
-.Fx
+.Dx
slice covering the entire disk.
.It Fl s
Print summary information and exit.
@@ -177,7 +177,7 @@
.Bl -tag -width "cyl, sector and head"
.It Em "sysid"
is used to label the slice.
-.Fx
+.Dx
reserves the
magic number 165 decimal (A5 in hex).
.It Em start No and Em size
@@ -245,7 +245,7 @@
.Fl i
flag is used to "initialize" sector 0;
it will set up the last BIOS slice to use the whole disk for
-.Fx
+.Dx
and make it active.
.Sh NOTES
The automatic calculation of starting cylinder etc. uses
@@ -260,7 +260,7 @@
.Pp
If you hand craft your disk layout,
please make sure that the
-.Fx
+.Dx
slice starts on a cylinder boundary.
A number of decisions made later may assume this.
(This might not be necessary later.)
@@ -330,7 +330,7 @@
.Pp
The number of cylinders should be less than or equal to 1024, but this
is not enforced, although a warning will be printed. Note that bootable
-.Fx
+.Dx
slices (the "/" filesystem) must lie completely within the
first 1024 cylinders; if this is not true, booting may fail.
Non-bootable slices do not have this restriction.
@@ -374,7 +374,7 @@
The
.Ar type
is 165 for
-.Fx
+.Dx
slices. Specifying a slice type of zero is
the same as clearing the slice and marking it as unused; however,
dummy values (such as "0") must still be specified for
@@ -392,7 +392,7 @@
.Ed
.Pp
Example: to set slice 1 to a
-.Fx
+.Dx
slice, starting at sector 1
for 2503871 sectors (note: these numbers will be rounded upwards and
downwards to correspond to head and cylinder boundaries):
@@ -431,7 +431,7 @@
The entire program should be made more user-friendly.
.Pp
Most users new to
-.Fx
+.Dx
do not understand the difference between
.Ar slice
and
@@ -439,7 +439,7 @@
causing difficulty to adjust.
.Pp
You cannot use this command to completely dedicate a disk to
-.Fx .
+.Dx .
The
.Xr disklabel 8
command must be used for this.
Index: sbin/i386/nextboot/nextboot.8
===================================================================
RCS file: /home/dcvs/src/sbin/i386/nextboot/nextboot.8,v
retrieving revision 1.2
diff -u -u -r1.2 nextboot.8
--- sbin/i386/nextboot/nextboot.8 17 Jun 2003 04:27:33 -0000 1.2
+++ sbin/i386/nextboot/nextboot.8 25 Feb 2004 22:51:42 -0000
@@ -16,7 +16,7 @@
.Ar filename
.Sh DESCRIPTION
The
-.Fx
+.Dx
program
.Nm
controls the actions of the boot blocks at the time of the next boot.
Index: sbin/ifconfig/ifconfig.8
===================================================================
RCS file: /home/dcvs/src/sbin/ifconfig/ifconfig.8,v
retrieving revision 1.2
diff -u -u -r1.2 ifconfig.8
--- sbin/ifconfig/ifconfig.8 17 Jun 2003 04:27:33 -0000 1.2
+++ sbin/ifconfig/ifconfig.8 25 Feb 2004 22:42:45 -0000
@@ -477,7 +477,7 @@
.Ar startnet Ns - Ns Ar endnet .
Appletalk uses this scheme instead of
netmasks though
-.Fx
+.Dx
implements it internally as a set of netmasks.
.It Cm remove
Another name for the
@@ -607,7 +607,7 @@
In particular, the
.Tn Windows
drivers do this mapping differently to
-.Fx .
+.Dx .
A key may be cleared by setting it to
.Ql - .
If WEP is supported then there are at least four keys.
Index: sbin/ipfw/ipfw.8
===================================================================
RCS file: /home/dcvs/src/sbin/ipfw/ipfw.8,v
retrieving revision 1.2
diff -u -u -r1.2 ipfw.8
--- sbin/ipfw/ipfw.8 17 Jun 2003 04:27:33 -0000 1.2
+++ sbin/ipfw/ipfw.8 25 Feb 2004 22:43:30 -0000
@@ -72,7 +72,7 @@
firewall and the
.Xr dummynet 4
traffic shaper in
-.Fx .
+.Dx .
.Pp
.Bd -ragged -offset XXXX
.Em NOTE:
Index: sbin/mknod/mknod.8
===================================================================
RCS file: /home/dcvs/src/sbin/mknod/mknod.8,v
retrieving revision 1.2
diff -u -u -r1.2 mknod.8
--- sbin/mknod/mknod.8 17 Jun 2003 04:27:33 -0000 1.2
+++ sbin/mknod/mknod.8 25 Feb 2004 22:47:24 -0000
@@ -117,7 +117,7 @@
The
.Xr chown 8 Ns - Ns
like functionality is specific to
-.Fx
+.Dx / Fx
and was added so that
.Pa /dev/MAKEDEV
would not depend on
Index: sbin/mount_nwfs/mount_nwfs.8
===================================================================
RCS file: /home/dcvs/src/sbin/mount_nwfs/mount_nwfs.8,v
retrieving revision 1.2
diff -u -u -r1.2 mount_nwfs.8
--- sbin/mount_nwfs/mount_nwfs.8 17 Jun 2003 04:27:33 -0000 1.2
+++ sbin/mount_nwfs/mount_nwfs.8 25 Feb 2004 22:48:23 -0000
@@ -144,7 +144,7 @@
Select a
.Ar scheme
used to convert file names between NetWare and
-.Fx .
+.Dx .
Supported conversion schemes are:
.Bl -tag -width ".Cm koi2cp866"
.It Cm asis
Index: sbin/mountd/netgroup.5
===================================================================
RCS file: /home/dcvs/src/sbin/mountd/netgroup.5,v
retrieving revision 1.2
diff -u -u -r1.2 netgroup.5
--- sbin/mountd/netgroup.5 17 Jun 2003 04:27:34 -0000 1.2
+++ sbin/mountd/netgroup.5 25 Feb 2004 21:35:54 -0000
@@ -86,7 +86,7 @@
.Pa /etc/netgroup
files are ignored.
With
-.Fx ,
+.Dx ,
.Nm Ns s
can be used with either
.Tn NIS
@@ -107,7 +107,7 @@
.Fn innetgr 3
lookups to be done quickly.
The
-.Fx
+.Dx
.Nm
system can interact with the
.Tn NIS
Index: sbin/natd/natd.8
===================================================================
RCS file: /home/dcvs/src/sbin/natd/natd.8,v
retrieving revision 1.2
diff -u -u -r1.2 natd.8
--- sbin/natd/natd.8 17 Jun 2003 04:27:34 -0000 1.2
+++ sbin/natd/natd.8 25 Feb 2004 22:51:04 -0000
@@ -41,7 +41,7 @@
with
.Xr divert 4
sockets under
-.Fx .
+.Dx .
It is intended for use with NICs - if you want to do NAT on a PPP link,
use the
.Fl nat
Index: sbin/nos-tun/nos-tun.8
===================================================================
RCS file: /home/dcvs/src/sbin/nos-tun/nos-tun.8,v
retrieving revision 1.2
diff -u -u -r1.2 nos-tun.8
--- sbin/nos-tun/nos-tun.8 17 Jun 2003 04:27:34 -0000 1.2
+++ sbin/nos-tun/nos-tun.8 25 Feb 2004 22:52:16 -0000
@@ -52,7 +52,7 @@
.Dq 255.255.255.252
on the cisco. This is because the tunnel is a point-to-point interface
in the
-.Fx
+.Dx
end, a concept cisco doesn't really implement.
.Pp
.Ar Protocol number
@@ -65,7 +65,7 @@
address set on the remote end.
.Sh EXAMPLES
This end, a
-.Fx
+.Dx
box on address 192.168.59.34:
.Bd -literal -offset indent
nos-tun -t /dev/tun0 -s 192.168.61.1 -d 192.168.61.2 192.168.56.45
Index: sbin/reboot/boot_i386.8
===================================================================
RCS file: /home/dcvs/src/sbin/reboot/boot_i386.8,v
retrieving revision 1.2
diff -u -u -r1.2 boot_i386.8
--- sbin/reboot/boot_i386.8 17 Jun 2003 04:27:34 -0000 1.2
+++ sbin/reboot/boot_i386.8 25 Feb 2004 22:35:03 -0000
@@ -92,7 +92,7 @@
After the boot blocks have been loaded,
you should see a prompt similar to the following:
.Bd -literal
->> FreeBSD/i386 BOOT
+>> BSD/i386 BOOT
Default: 0:ad(0,a)/kernel
boot:
.Ed
@@ -157,7 +157,7 @@
any slice can be booted from, with the default being the active slice
or, otherwise, the first
-.Fx
+.Dx
slice.
.It Ar filename
The pathname of the file to boot (relative to the root directory
Index: sbin/vinum/vinum.8
===================================================================
RCS file: /home/dcvs/src/sbin/vinum/vinum.8,v
retrieving revision 1.2
diff -u -u -r1.2 vinum.8
--- sbin/vinum/vinum.8 17 Jun 2003 04:27:35 -0000 1.2
+++ sbin/vinum/vinum.8 25 Feb 2004 22:59:40 -0000
@@ -2261,7 +2261,7 @@
.Nm .
.Pp
The
-.Fx
+.Dx
block I/O system issues requests of between .5kB and 128 kB; a
typical mix is somewhere round 8 kB. You can't stop any striping system from
breaking a request into two physical requests, and if you make the stripe small
@@ -2270,7 +2270,7 @@
magnitude greater increase in latency.
.Pp
With modern disk sizes and the
-.Fx
+.Dx
I/O system, you can expect to have a
reasonably small number of fragmented requests with a stripe size between 256 kB
and 512 kB; with correct RAID implementations there is no obvious reason not to
Index: share/man/man3/pthread.3
===================================================================
RCS file: /home/dcvs/src/share/man/man3/pthread.3,v
retrieving revision 1.2
diff -u -u -r1.2 pthread.3
--- share/man/man3/pthread.3 17 Jun 2003 04:36:58 -0000 1.2
+++ share/man/man3/pthread.3 25 Feb 2004 20:40:57 -0000
@@ -431,7 +431,7 @@
.El
.Sh INSTALLATION
The current
-.Fx
+.Dx
POSIX thread implementation is built in the library
.Fa libc_r
which contains both thread-safe libc functions and the thread functions.
@@ -447,7 +447,7 @@
.Xr make 1 .
.Pp
A
-.Fx
+.Fx / Dx
specific option has been added to gcc to make linking
threaded processes simple.
.Fa gcc -pthread
Index: share/man/man4/bridge.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/bridge.4,v
retrieving revision 1.2
diff -u -u -r1.2 bridge.4
--- share/man/man4/bridge.4 17 Jun 2003 04:36:58 -0000 1.2
+++ share/man/man4/bridge.4 25 Feb 2004 20:56:45 -0000
@@ -12,13 +12,13 @@
.Cd "options BRIDGE"
.Cd kldload /modules/bridge.ko
.Sh DESCRIPTION
-.Fx
+.Dx
supports bridging on Ethernet-type interfaces, including VLANs.
Bridging support can be either compiled into the kernel, or loaded
at runtime as a kernel module.
.Pp
A single
-.Fx
+.Dx
host can do bridging on independent sets of interfaces,
which are called
.Ar clusters .
@@ -33,7 +33,9 @@
the IEEE 802.1q VLAN-id.
.Pp
By putting both physical and logical (vlanX) interfaces
-in the same cluster, a FreeBSD box can also implement what in
+in the same cluster, a
+.Dx
+box can also implement what in
commercial terms is called a "trunk" interface. This means packets
coming from one of the interfaces in the cluster,
will appear
Index: share/man/man4/ch.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/ch.4,v
retrieving revision 1.3
diff -u -u -r1.3 ch.4
--- share/man/man4/ch.4 7 Sep 2003 17:04:00 -0000 1.3
+++ share/man/man4/ch.4 25 Feb 2004 20:57:39 -0000
@@ -55,14 +55,7 @@
type devices will be 'attached' to the
.Nm
driver.
-In
-.Fx
-releases prior to 2.1, the first found will be attached as
-.Em ch0
-and the next,
-.Em ch1
-etc.
-Beginning in 2.1 it is possible to specify what ch unit a device should
+It is possible to specify what ch unit a device should
come on line as; refer to
.Xr scsi 4
for details on kernel configuration.
Index: share/man/man4/da.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/da.4,v
retrieving revision 1.2
diff -u -u -r1.2 da.4
--- share/man/man4/da.4 17 Jun 2003 04:36:58 -0000 1.2
+++ share/man/man4/da.4 25 Feb 2004 20:58:31 -0000
@@ -61,14 +61,14 @@
One layer, called the
.Dq slice layer ,
is used to separate the
-.Fx
+.Dx
areas of the disk from areas used by other operating systems.
The second layer is the native
.Bx 4.4
partitioning scheme,
.Xr disklabel 5 ,
which is used to subdivide the
-.Fx
+.Dx
slices into areas for individual filesystems and swap spaces.
For more information, see
.Xr fdisk 8
@@ -78,10 +78,10 @@
.Pp
If an uninitialized disk is opened, the slice table will be
initialized with a fictitious
-.Fx
+.Dx
slice spanning the entire disk. Similarly, if an uninitialized
(or
-.No non- Ns Fx )
+.No non- Ns Dx )
slice is opened, its disklabel will be initialized with parameters returned
by the drive and a single
.Sq Li c
@@ -227,7 +227,7 @@
disk unit
.Ar u ,
first
-.Fx
+.Dx
slice, partition
.Ar p
.It Pa /dev/rda Ns Ar u Ns Ar p
@@ -236,7 +236,7 @@
disk unit
.Ar u ,
first
-.Fx
+.Dx
slice, partition
.Ar p
.Sm off
Index: share/man/man4/dc.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/dc.4,v
retrieving revision 1.2
diff -u -u -r1.2 dc.4
--- share/man/man4/dc.4 17 Jun 2003 04:36:58 -0000 1.2
+++ share/man/man4/dc.4 25 Feb 2004 20:58:48 -0000
@@ -254,7 +254,7 @@
Note that this condition only occurs when warm booting from another
operating system.
If you power down your system prior to booting
-.Fx ,
+.Dx ,
the card should be configured correctly.
.El
.Sh SEE ALSO
Index: share/man/man4/divert.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/divert.4,v
retrieving revision 1.2
diff -u -u -r1.2 divert.4
--- share/man/man4/divert.4 17 Jun 2003 04:36:58 -0000 1.2
+++ share/man/man4/divert.4 25 Feb 2004 20:59:06 -0000
@@ -28,7 +28,7 @@
re-enter kernel IP packet processing.
.Pp
Divert sockets are normally used in conjunction with
-.Fx Ns 's
+.Dx Ns 's
packet filtering implementation and the
.Xr ipfw 8
program.
Index: share/man/man4/ed.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/ed.4,v
retrieving revision 1.2
diff -u -u -r1.2 ed.4
--- share/man/man4/ed.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/ed.4 25 Feb 2004 20:59:27 -0000
@@ -91,7 +91,7 @@
faster than a machine on the other end can handle (as evidenced by severe packet
lossage).
Some
-.No ( non- Ns Fx
+.No ( non- Ns Dx
:-)) machines have terrible ethernet performance
and simply can't cope with 1100K+ data rates.
Use of this flag also provides
Index: share/man/man4/em.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/em.4,v
retrieving revision 1.2
diff -u -u -r1.2 em.4
--- share/man/man4/em.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/em.4 25 Feb 2004 20:59:58 -0000
@@ -37,7 +37,7 @@
.Os
.Sh NAME
.Nm em
-.Nd "Intel(R) PRO/1000 gigabit Ethernet driver for the FreeBSD operating system"
+.Nd "Intel(R) PRO/1000 gigabit Ethernet driver"
.Sh SYNOPSIS
.Cd "device em"
.Sh DESCRIPTION
@@ -54,7 +54,7 @@
For questions related to hardware requirements,
refer to the documentation supplied with your Intel PRO/1000 adapter.
All hardware requirements listed apply to use with
-.Fx .
+.Dx .
.Pp
Support for Jumbo Frames is provided via the interface MTU setting.
Selecting an MTU larger than 1500 bytes with the
Index: share/man/man4/firewire.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/firewire.4,v
retrieving revision 1.3
diff -u -u -r1.3 firewire.4
--- share/man/man4/firewire.4 30 Jan 2004 22:38:47 -0000 1.3
+++ share/man/man4/firewire.4 25 Feb 2004 21:01:23 -0000
@@ -47,7 +47,7 @@
.Pp
.In dev/firewire/firewire.h
.Sh DESCRIPTION
-.Fx
+.Dx
provides machine-independent bus support and raw drivers for
.Nm
interfaces.
Index: share/man/man4/fpa.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/fpa.4,v
retrieving revision 1.2
diff -u -u -r1.2 fpa.4
--- share/man/man4/fpa.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/fpa.4 25 Feb 2004 21:00:36 -0000
@@ -16,7 +16,7 @@
.Cd "device fpa"
.Cd "device fea"
.Pp
-.Fx
+.Fx / Dx
only:
.Cd "pseudo-device fddi"
.Sh DESCRIPTION
Index: share/man/man4/iir.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/iir.4,v
retrieving revision 1.2
diff -u -u -r1.2 iir.4
--- share/man/man4/iir.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/iir.4 25 Feb 2004 21:07:06 -0000
@@ -66,7 +66,7 @@
.An Mike Smith Aq msith at xxxxxxxxxxx .
.Sh BUGS
During a
-.Fx
+.Dx
install, the
.Nm
controller appears to correctly probe, but finds no disk devices.
Index: share/man/man4/ips.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/ips.4,v
retrieving revision 1.1
diff -u -u -r1.1 ips.4
--- share/man/man4/ips.4 15 Jan 2004 15:41:23 -0000 1.1
+++ share/man/man4/ips.4 25 Feb 2004 21:08:54 -0000
@@ -83,7 +83,7 @@
.Tn IBM
.Tn ISPR
utility and are independent of
-.Fx .
+.Dx .
.Pp
.Bl -diag
.It ips%d: failed to get adapter configuration data from device
@@ -159,7 +159,7 @@
Unlike many of the other
.Tn SCSI
devices in
-.Fx ,
+.Dx ,
the
.Nm
driver does not use the
Index: share/man/man4/kame.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/kame.4,v
retrieving revision 1.2
diff -u -u -r1.2 kame.4
--- share/man/man4/kame.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/kame.4 25 Feb 2004 21:10:09 -0000
@@ -43,7 +43,7 @@
.Pq Bx
derived system such as
.Bsx ,
-.Fx ,
+.Fx / Dx Ns ,
.Nx
and
.Ox
@@ -57,7 +57,7 @@
Following are some of highlights of this implementation.
.Pp
Note: features not yet integrated into
-.Fx
+.Fx / Dx
are marked with the
.Pq -
sign.
@@ -94,7 +94,7 @@
.Pq Xr ptrconfig 8 .
.Xr ptrconfig 8
is not yet integrated into
-.Fx .
+.Fx / Dx .
.\"
.Ss IPsec and tunnelling
.Xr gifconfig 8 ,
Index: share/man/man4/kld.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/kld.4,v
retrieving revision 1.2
diff -u -u -r1.2 kld.4
--- share/man/man4/kld.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/kld.4 25 Feb 2004 21:11:12 -0000
@@ -51,7 +51,7 @@
unloading.
.Pp
The
-.Fx
+.Dx
system makes extensive use of loadable kernel modules, and provides loadable
versions of most filesystems, the
.Tn NFS
Index: share/man/man4/lp.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/lp.4,v
retrieving revision 1.2
diff -u -u -r1.2 lp.4
--- share/man/man4/lp.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/lp.4 25 Feb 2004 21:12:04 -0000
@@ -79,7 +79,7 @@
.Bl -tag -width Fl
.It Fl link0
(default) Use
-.Fx
+.Dx
mode (LPIP). This is the simpler of the two modes
and therefore slightly more efficient.
.It Cm link0
@@ -112,7 +112,7 @@
The connections are symmetric, and provide 5 lines in each direction (four
data plus one handshake). The two modes use the same wiring, but make a
different choice of which line to use as handshake.
-.Ss FreeBSD LPIP mode
+.Ss Dx LPIP mode
The signal lines are used as follows:
.Bl -tag -width dataxxxx(Pinxx)
.It Em Data0 (Pin 2)
@@ -192,7 +192,8 @@
.Bd -literal
Length (least significant byte)
Length (most significant byte)
-12 bytes of supposed MAC addresses (ignored by FreeBSD).
+12 bytes of supposed MAC addresses (ignored by
+.Dx Ns ).
Fixed byte 0x08
Fixed byte 0x00
<IP datagram>
@@ -204,7 +205,7 @@
.Pp
The checksum is a simple arithmetic sum of all the bytes (again, including
the header but not checksum or length bytes).
-.Fx
+.Dx
calculates
outgoing checksums, but does not validate incoming ones.
.Pp
Index: share/man/man4/pcic.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/pcic.4,v
retrieving revision 1.2
diff -u -u -r1.2 pcic.4
--- share/man/man4/pcic.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/pcic.4 25 Feb 2004 21:12:56 -0000
@@ -206,7 +206,7 @@
A value of 2 means route via PCI.
This is ignored for the ISA device.
Many older laptops do not have PCI BIOS implementations that
-.Fx
+.Dx
can use to route interrupts properly.
These laptops may need to set this to 1 and
.Va hw.pcic.irq
Index: share/man/man4/pcn.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/pcn.4,v
retrieving revision 1.2
diff -u -u -r1.2 pcn.4
--- share/man/man4/pcn.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/pcn.4 25 Feb 2004 21:13:12 -0000
@@ -136,7 +136,7 @@
Note that this condition only occurs when warm booting from another
operating system.
If you power down your system prior to booting
-.Fx ,
+.Dx ,
the card should be configured correctly.
.El
.Sh SEE ALSO
Index: share/man/man4/pcvt.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/pcvt.4,v
retrieving revision 1.2
diff -u -u -r1.2 pcvt.4
--- share/man/man4/pcvt.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/pcvt.4 25 Feb 2004 21:20:53 -0000
@@ -40,7 +40,7 @@
.\"
.Dd January 9, 2000
.Dt PCVT 4
-.Os FreeBSD
+.Os
.Sh NAME
.Nm pcvt ,
.Nm vt
@@ -148,6 +148,12 @@
.Em SHIFT-PageDown
it is possible to scroll the screen back and forward.
.Ss Configuration
+.Em Note
+to
+.Dx
+users: for the purposes of the following documentation, pretend you're
+using a FreeBSD system, pending possible implemention changes.
+.Pp
The
.Nm
console driver is currently available for the Intel-based BSD operating
Index: share/man/man4/polling.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/polling.4,v
retrieving revision 1.2
diff -u -u -r1.2 polling.4
--- share/man/man4/polling.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/polling.4 25 Feb 2004 21:21:34 -0000
@@ -40,7 +40,7 @@
The duration of the interrupt handler is potentially unbounded
unless the device driver has been programmed with real-time
concerns in mind (which is generally not the case for
-.Fx
+.Dx
drivers).
Furthermore, under heavy traffic, the system might be
persistently processing interrupts without being able to
Index: share/man/man4/psm.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/psm.4,v
retrieving revision 1.2
diff -u -u -r1.2 psm.4
--- share/man/man4/psm.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/psm.4 25 Feb 2004 21:22:03 -0000
@@ -298,7 +298,7 @@
.Nm
driver won't reset the pointing device when initializing the device.
If the
-.Fx
+.Dx
kernel
is started after another OS has run, the pointing device will inherit
settings from the previous OS.
Index: share/man/man4/rl.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/rl.4,v
retrieving revision 1.2
diff -u -u -r1.2 rl.4
--- share/man/man4/rl.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/rl.4 25 Feb 2004 21:22:36 -0000
@@ -157,7 +157,7 @@
Note that this condition only occurs when warm booting from another
operating system.
If you power down your system prior to booting
-.Fx ,
+.Dx ,
the card should be configured correctly.
.El
.Sh SEE ALSO
Index: share/man/man4/route.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/route.4,v
retrieving revision 1.2
diff -u -u -r1.2 route.4
--- share/man/man4/route.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/route.4 25 Feb 2004 21:23:11 -0000
@@ -48,7 +48,7 @@
.Ft int
.Fn socket PF_ROUTE SOCK_RAW "int family"
.Sh DESCRIPTION
-.Fx
+.Dx
provides some packet routing facilities.
The kernel maintains a routing information database, which
is used in selecting the appropriate network interface when
Index: share/man/man4/sf.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/sf.4,v
retrieving revision 1.2
diff -u -u -r1.2 sf.4
--- share/man/man4/sf.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/sf.4 25 Feb 2004 21:23:58 -0000
@@ -135,7 +135,7 @@
the BIOS has been configured for a "Plug and Play" operating system.
The "Plug and Play OS" setting int he BIOS should be set to "no" or
"off" in order for PCI devices to work properly with
-.Fx .
+.Dx .
.It "sf%d: couldn't map ports"
A fatal initialization error has occurred.
This may
@@ -143,7 +143,7 @@
the BIOS has been configured for a "Plug and Play" operating system.
The "Plug and Play OS" setting int he BIOS should be set to "no" or
"off" in order for PCI devices to work properly with
-.Fx .
+.Dx .
.It "sf%d: couldn't map interrupt"
A fatal initialization error has occurred.
.It "sf%d: no memory for softc struct!"
Index: share/man/man4/si.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/si.4,v
retrieving revision 1.2
diff -u -u -r1.2 si.4
--- share/man/man4/si.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/si.4 25 Feb 2004 21:24:20 -0000
@@ -89,7 +89,7 @@
cua/callout port (bit 7=1).
.Pp
Bit 8 through 15 (on
-.Fx )
+.Dx )
are unavailable as they are a shadow of the
major device number.
.Pp
Index: share/man/man4/sis.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/sis.4,v
retrieving revision 1.2
diff -u -u -r1.2 sis.4
--- share/man/man4/sis.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/sis.4 25 Feb 2004 21:24:36 -0000
@@ -145,7 +145,7 @@
Note that this condition only occurs when warm booting from another
operating system.
If you power down your system prior to booting
-.Fx ,
+.Dx ,
the card should be configured correctly.
.El
.Sh SEE ALSO
Index: share/man/man4/ste.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/ste.4,v
retrieving revision 1.3
diff -u -u -r1.3 ste.4
--- share/man/man4/ste.4 31 Jan 2004 01:09:19 -0000 1.3
+++ share/man/man4/ste.4 25 Feb 2004 21:24:46 -0000
@@ -137,7 +137,7 @@
Note that this condition only occurs when warm booting from another
operating system.
If you power down your system prior to booting
-.Fx ,
+.Dx ,
the card should be configured correctly.
.El
.Sh SEE ALSO
Index: share/man/man4/usb.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/usb.4,v
retrieving revision 1.2
diff -u -u -r1.2 usb.4
--- share/man/man4/usb.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/usb.4 25 Feb 2004 21:25:38 -0000
@@ -40,7 +40,7 @@
.In dev/usb/usb.h
.In dev/usb/usbhid.h
.Sh DESCRIPTION
-.Fx
+.Dx
provides machine-independent bus support and drivers for
.Tn USB
devices.
Index: share/man/man4/vinum.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/vinum.4,v
retrieving revision 1.3
diff -u -u -r1.3 vinum.4
--- share/man/man4/vinum.4 19 Nov 2003 00:51:38 -0000 1.3
+++ share/man/man4/vinum.4 25 Feb 2004 21:26:33 -0000
@@ -203,7 +203,7 @@
.Sh RUNNING VINUM
.Nm
is part of the base
-.Fx
+.Dx
system. It does not require installation.
To start it, start the
.Nm
Index: share/man/man4/vlan.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/vlan.4,v
retrieving revision 1.2
diff -u -u -r1.2 vlan.4
--- share/man/man4/vlan.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/vlan.4 25 Feb 2004 21:26:51 -0000
@@ -87,7 +87,7 @@
.Ss "Selecting the Right Network Interface Card to Run VLANs Through"
By now, the only NICs that have both hardware support and proper
driver hooks for the 802.1Q VLAN technology in
-.Fx
+.Dx
are
.Xr bge 4 ,
.Xr em 4 ,
@@ -98,7 +98,7 @@
.Xr txp 4 .
.Pp
The rest of the ethernet NICs supported by
-.Fx
+.Dx
can run
VLANs using software emulation in the
.Nm
Index: share/man/man4/vpo.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/vpo.4,v
retrieving revision 1.3
diff -u -u -r1.3 vpo.4
--- share/man/man4/vpo.4 31 Jan 2004 01:09:19 -0000 1.3
+++ share/man/man4/vpo.4 25 Feb 2004 21:08:00 -0000
@@ -51,11 +51,11 @@
transfering data.
.Pp
DOS and
-.Fx
+.Dx / Fx
filesystems are supported.
When mounting a DOS filesystem or
formating a
-.Fx
+.Dx / Fx
filesystem, check the slice of the disk with the
.Xr fdisk 8
utility.
Index: share/man/man4/vr.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/vr.4,v
retrieving revision 1.2
diff -u -u -r1.2 vr.4
--- share/man/man4/vr.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/vr.4 25 Feb 2004 21:27:04 -0000
@@ -145,7 +145,7 @@
Note that this condition only occurs when warm booting from another
operating system.
If you power down your system prior to booting
-.Fx ,
+.Dx ,
the card should be configured correctly.
.El
.Sh SEE ALSO
Index: share/man/man4/wb.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/wb.4,v
retrieving revision 1.2
diff -u -u -r1.2 wb.4
--- share/man/man4/wb.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/wb.4 25 Feb 2004 21:27:45 -0000
@@ -145,7 +145,7 @@
Note that this condition only occurs when warm booting from another
operating system.
If you power down your system prior to booting
-.Fx ,
+.Dx ,
the card should be configured correctly.
.El
.Sh SEE ALSO
Index: share/man/man4/xl.4
===================================================================
RCS file: /home/dcvs/src/share/man/man4/xl.4,v
retrieving revision 1.2
diff -u -u -r1.2 xl.4
--- share/man/man4/xl.4 17 Jun 2003 04:36:59 -0000 1.2
+++ share/man/man4/xl.4 25 Feb 2004 21:27:20 -0000
@@ -169,7 +169,7 @@
Note that this condition only occurs when warm booting from another
operating system.
If you power down your system prior to booting
-.Fx ,
+.Dx ,
the card should be configured correctly.
.It "xl%d: WARNING: no media options bits set in the media options register!"
This warning may appear when using the driver on some Dell Latitude
Index: share/man/man5/core.5
===================================================================
RCS file: /home/dcvs/src/share/man/man5/core.5,v
retrieving revision 1.2
diff -u -u -r1.2 core.5
--- share/man/man5/core.5 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man5/core.5 25 Feb 2004 21:29:31 -0000
@@ -79,7 +79,7 @@
The name defaults to
.Em \&%N.core ,
yielding the traditional
-.Fx
+.Dx
behaviour.
.Pp
By default, a process that changes user or group credentials whether
Index: share/man/man5/dir.5
===================================================================
RCS file: /home/dcvs/src/share/man/man5/dir.5,v
retrieving revision 1.3
diff -u -u -r1.3 dir.5
--- share/man/man5/dir.5 9 Nov 2003 02:34:03 -0000 1.3
+++ share/man/man5/dir.5 25 Feb 2004 21:30:21 -0000
@@ -152,7 +152,7 @@
.Xr inode 5
.Sh BUGS
The usage of the member d_type of struct dirent is unportable as it is
-.Fx Ns -specific .
+.Dx Ns / Ns Fx Ns -specific .
It also may fail on certain filesystems, for example the cd9660 filesystem.
.Sh HISTORY
A
Index: share/man/man5/group.5
===================================================================
RCS file: /home/dcvs/src/share/man/man5/group.5,v
retrieving revision 1.2
diff -u -u -r1.2 group.5
--- share/man/man5/group.5 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man5/group.5 25 Feb 2004 21:31:47 -0000
@@ -145,7 +145,7 @@
.Fx 3.0 .
Older binaries that are statically linked, depend on old
shared libraries, or
-.No non- Ns Fx
+.No non- Ns Dx
binaries in compatibility mode
may still have this limits.
.Sh FILES
Index: share/man/man5/host.conf.5
===================================================================
RCS file: /home/dcvs/src/share/man/man5/host.conf.5,v
retrieving revision 1.2
diff -u -u -r1.2 host.conf.5
--- share/man/man5/host.conf.5 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man5/host.conf.5 25 Feb 2004 21:32:05 -0000
@@ -39,7 +39,7 @@
The
.Nm
file holds part of the configuration for the resolver of
-.Fx .
+.Dx .
It describes what services (eg. DNS or
.Xr yp 8 )
the C library resolving routines
Index: share/man/man5/link.5
===================================================================
RCS file: /home/dcvs/src/share/man/man5/link.5,v
retrieving revision 1.2
diff -u -u -r1.2 link.5
--- share/man/man5/link.5 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man5/link.5 25 Feb 2004 21:32:50 -0000
@@ -500,7 +500,7 @@
.Dq Pa /dev/zero
used to get demand paged zeroed pages.
On
-.Fx
+.Dx
systems it contains -1.
.It Fa crt_ldfd
Contains an open file descriptor that was used by crt0 to load
Index: share/man/man5/make.conf.5
===================================================================
RCS file: /home/dcvs/src/share/man/man5/make.conf.5,v
retrieving revision 1.5
diff -u -u -r1.5 make.conf.5
--- share/man/man5/make.conf.5 5 Aug 2003 07:45:43 -0000 1.5
+++ share/man/man5/make.conf.5 25 Feb 2004 21:35:04 -0000
@@ -35,7 +35,7 @@
The file
.Nm
contains settings that control the compilation of the
-.Fx
+.Dx
sources
and ported applications.
The file
Index: share/man/man5/msdos.5
===================================================================
RCS file: /home/dcvs/src/share/man/man5/msdos.5,v
retrieving revision 1.2
diff -u -u -r1.2 msdos.5
--- share/man/man5/msdos.5 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man5/msdos.5 25 Feb 2004 21:35:28 -0000
@@ -24,7 +24,7 @@
The
.Nm
file system driver will permit the
-.Fx
+.Dx
kernel to read and write
.Nm
based file systems.
@@ -66,7 +66,7 @@
See
.Xr hier 7
for more information on
-.Fx
+.Dx
directory layout.
.Sh SEE ALSO
.Xr mount 2 ,
Index: share/man/man5/passwd.5
===================================================================
RCS file: /home/dcvs/src/share/man/man5/passwd.5,v
retrieving revision 1.2
diff -u -u -r1.2 passwd.5
--- share/man/man5/passwd.5 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man5/passwd.5 25 Feb 2004 21:40:10 -0000
@@ -197,7 +197,7 @@
.Sh YP/NIS INTERACTION
.Ss Enabling access to NIS passwd data
The system administrator can configure
-.Tn FreeBSD
+.Dx
to use NIS/YP for
its password information by adding special records to the
.Pa /etc/master.passwd
@@ -228,7 +228,7 @@
will tell the
.Xr getpwent 3
routines in
-.Tn FreeBSD Ns 's
+.Dx Ns 's
standard C library to begin using the NIS passwd maps
for lookups.
.Pp
@@ -400,7 +400,7 @@
it need not be modified again unless new netgroups are created.
.Sh NOTES
.Ss Shadow passwords through NIS
-.Tn FreeBSD
+.Dx
uses a shadow password scheme: users' encrypted passwords
are stored only in
.Pa /etc/master.passwd
@@ -414,16 +414,16 @@
NIS does not support a standard means of
password shadowing, which implies that placing your password data
into the NIS passwd maps totally defeats the security of
-.Tn FreeBSD Ns 's
+.Dx
password shadowing system.
.Pp
-.Tn FreeBSD
+.Dx
provides a few special features to help get around this
problem.
It is possible to implement password shadowing between
-.Tn FreeBSD
+.Fx / Dx
NIS clients and
-.Tn FreeBSD
+.Fx / Dx
NIS servers.
The
.Xr getpwent 3
@@ -435,14 +435,14 @@
.Pa /etc/master.passwd
file.
If the maps exist,
-.Tn FreeBSD
+.Dx
will attempt to use them for user
authentication instead of the standard
.Pa passwd.byname
and
.Pa passwd.byuid
maps.
-.Tn FreeBSD Ns 's
+.Dx Ns 's
.Xr ypserv 8
will also check client requests to make sure they originate on a
privileged port.
@@ -460,7 +460,7 @@
maps which contain no password information.
.Pp
Note that this feature cannot be used in an environment with
-.No non- Ns Tn FreeBSD
+.No non- Ns Tn Fx Ns / Ns Dx
systems.
Note also that a truly determined user with
unrestricted access to your network could still compromise the
@@ -470,7 +470,7 @@
Unlike
.Tn SunOS
and other operating systems that use Sun's NIS code,
-.Tn FreeBSD
+.Dx
allows the user to override
.Pa all
of the fields in a user's NIS
@@ -499,7 +499,7 @@
.Ed
This often leads to new
-.Tn FreeBSD
+.Dx
administrators choosing NIS entries for their
.Pa master.passwd
files that look like this:
@@ -516,7 +516,7 @@
.Pa master.passwd
.Sy FILE!!
The first tells
-.Tn FreeBSD
+.Dx
to remap all passwords to
.Ql \&*
(which
@@ -564,7 +564,7 @@
instead of simple wildcards, other combinations could be achieved.)
.Pp
By contrast,
-.Fx
+.Dx
does not have a single
.Tn ASCII
password file: it
@@ -579,7 +579,7 @@
and
.Fn getpwuid
functions in
-.Tn FreeBSD
+.Dx
are designed to do direct queries to the
hash database rather than a linear search.
This approach is faster
@@ -591,7 +591,7 @@
.Tn SunOS .
.Pp
Instead,
-.Tn FreeBSD
+.Dx
groups all the NIS override entries together
and constructs a filter out of them.
Each NIS password entry
@@ -614,7 +614,7 @@
file, since doing otherwise would lead to unpredictable behavior.
.Pp
The end result is that
-.Tn FreeBSD Ns 's
+.Dx Ns 's
provides a very close approximation
of
.Tn SunOS Ns 's
@@ -639,7 +639,7 @@
.Pp
In 99% of all
-.Tn FreeBSD
+.Dx
configurations, NIS client behavior will be
indistinguishable from that of
.Tn SunOS
@@ -648,7 +648,7 @@
so, users should be aware of these architectural differences.
.Pp
.Ss Using groups instead of netgroups for NIS overrides
-.Tn FreeBSD
+.Dx
offers the capability to do override matching based on
user groups rather than netgroups.
If, for example, an NIS entry
@@ -665,9 +665,9 @@
will try to match users against the normal
.Ql operator
group instead.
-.Ss Changes in behavior from older versions of FreeBSD
+.Ss Changes in behavior from older versions of Dx
There have been several bug fixes and improvements in
-.Tn FreeBSD Ns 's
+.Dx Ns 's
NIS/YP handling, some of which have caused changes in behavior.
While the behavior changes are generally positive, it is important
that users and system administrators be aware of them:
@@ -692,7 +692,7 @@
.Fx 2.0.5 ,
netgroup overrides did not work at
all, largely because
-.Tn FreeBSD
+.Dx
did not have support for reading
netgroups through NIS.
Again, this has been fixed, and
@@ -701,7 +701,7 @@
and similar NIS-capable
systems.
.It
-.Tn FreeBSD
+.Dx
now has NIS server capabilities and supports the use
of
.Pa master.passwd
@@ -710,7 +710,7 @@
maps.
This means that you can specify change, expiration and class
information through NIS, provided you use a
-.Tn FreeBSD
+.Fx or Dx
system as
the NIS server.
.El
@@ -749,12 +749,12 @@
shadow passwords with the
.Pa master.passwd
maps and
-.Tn FreeBSD Ns 's
+.Dx Ns 's
.Xr ypserv 8
server.
.Pp
Unless you're using
-.Tn FreeBSD Ns 's
+.Dx Ns 's
.Xr ypserv 8 ,
which supports the use of
.Pa master.passwd
@@ -763,7 +763,7 @@
which means that site-wide values for user login class, password
expiration date, and other fields present in the current format
will not be available when a
-.Tn FreeBSD
+.Dx
system is used as a client with
a standard NIS server.
.Sh COMPATIBILITY
Index: share/man/man5/rc.conf.5
===================================================================
RCS file: /home/dcvs/src/share/man/man5/rc.conf.5,v
retrieving revision 1.4
diff -u -u -r1.4 rc.conf.5
--- share/man/man5/rc.conf.5 9 Nov 2003 07:31:29 -0000 1.4
+++ share/man/man5/rc.conf.5 25 Feb 2004 21:40:57 -0000
@@ -1573,7 +1573,7 @@
.Dq Li YES ,
run the IPv6 multicast routing daemon.
Note that no IPv6 multicast routing daemon is included in the
-.Fx
+.Dx
base system but
.Xr pim6dd 8
can be installed from the
Index: share/man/man7/build.7
===================================================================
RCS file: /home/dcvs/src/share/man/man7/build.7,v
retrieving revision 1.2
diff -u -u -r1.2 build.7
--- share/man/man7/build.7 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man7/build.7 25 Feb 2004 21:48:26 -0000
@@ -33,7 +33,7 @@
.Nd information on how to build the system
.Sh DESCRIPTION
The source for the
-.Fx
+.Dx
system and applications are contained in three different directories,
normally
.Pa /usr/src ,
Index: share/man/man7/clocks.7
===================================================================
RCS file: /home/dcvs/src/share/man/man7/clocks.7,v
retrieving revision 1.2
diff -u -u -r1.2 clocks.7
--- share/man/man7/clocks.7 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man7/clocks.7 25 Feb 2004 21:48:49 -0000
@@ -61,7 +61,7 @@
may be floating point. Don't use
.Fn clock
in new programs under
-.Fx .
+.Dx .
It is feeble compared with
.Xr getrusage 2 .
It is provided for ANSI conformance. It is implemented by calling
@@ -82,7 +82,7 @@
Don't use
.Xr times 3
in new programs under
-.Fx .
+.Dx .
It is feeble compared with
.Xr gettimeofday 2
together with
Index: share/man/man7/firewall.7
===================================================================
RCS file: /home/dcvs/src/share/man/man7/firewall.7,v
retrieving revision 1.2
diff -u -u -r1.2 firewall.7
--- share/man/man7/firewall.7 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man7/firewall.7 25 Feb 2004 21:52:00 -0000
@@ -10,7 +10,7 @@
.Os
.Sh NAME
.Nm firewall
-.Nd simple firewalls under FreeBSD
+.Nd simple firewalls under DragonFly
.Sh FIREWALL BASICS
A Firewall is most commonly used to protect an internal network
from an outside network by preventing the outside network from
@@ -20,7 +20,7 @@
file sharing) within LAN segments.
.Pp
The
-.Fx
+.Dx
firewalling system also has the capability to limit bandwidth using
.Xr dummynet 4 .
This feature can be useful when you need to guarantee a certain
@@ -34,7 +34,7 @@
charges from your provider.
.Pp
Finally,
-.Fx
+.Dx
firewalls may be used to divert packets or change the next-hop
address for packets to help route them to the correct destination.
Packet diversion is most often used to support NAT (network
@@ -66,7 +66,7 @@
.Em /etc/rc.conf
(see below), the ipfw kernel module will be loaded automatically. However,
if you are paranoid you can compile IPFW directly into the
-.Fx
+.Dx
kernel by using the
.Sy IPFIREWALL
option set. If compiled in the kernel defaults its firewall to deny all
@@ -89,7 +89,7 @@
may open a small window of opportunity during booting where your
firewall passes all packets. Still, it's a good option to use
while getting up to speed with
-.Fx
+.Dx
firewalling. Get rid of it once you understand how it all works
to close the loophole, though. There is a third option called
.Sy IPDIVERT
Index: share/man/man7/hier.7
===================================================================
RCS file: /home/dcvs/src/share/man/man7/hier.7,v
retrieving revision 1.3
diff -u -u -r1.3 hier.7
--- share/man/man7/hier.7 5 Aug 2003 07:45:43 -0000 1.3
+++ share/man/man7/hier.7 25 Feb 2004 21:53:37 -0000
@@ -159,7 +159,7 @@
.El
.It Pa dev/
C include files for programming various
-.Fx
+.Dx
devices
.Bl -tag -width "cd9660/" -compact
.It Pa ppbus/
@@ -570,7 +570,7 @@
source code for files in /usr/libexec
.It Pa release/
files required to produce a
-.Fx
+.Dx
release
.It Pa sbin/
source code for files in /sbin
@@ -582,7 +582,7 @@
kernel source code
.It Pa tools/
tools used for maintenance and testing of
-.Fx
+.Dx
.It Pa usr.bin/
source code for files in /usr/bin
.It Pa usr.sbin/
@@ -740,7 +740,7 @@
.El
.Sh NOTES
This manual page documents the default
-.Fx
+.Dx
filesystem layout, but
the actual hierarchy on a given system is defined at the system
administrator's discretion.
Index: share/man/man7/release.7
===================================================================
RCS file: /home/dcvs/src/share/man/man7/release.7,v
retrieving revision 1.2
diff -u -u -r1.2 release.7
--- share/man/man7/release.7 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man7/release.7 25 Feb 2004 21:55:12 -0000
@@ -32,10 +32,10 @@
.Nm release
.Nd "release building infrastructure"
.Sh DESCRIPTION
-.Fx
+.Dx
provides a complete build environment suitable for users to make
full releases of the
-.Fx
+.Dx
operating system.
All of the tools necessary to build a release are available from the
CVS repository in
@@ -199,7 +199,7 @@
.Xr uname 1 .
.It Va CVSROOT
The location of the
-.Fx
+.Dx
CVS repository.
This path name is referenced to the real system root,
.Em not
Index: share/man/man7/security.7
===================================================================
RCS file: /home/dcvs/src/share/man/man7/security.7,v
retrieving revision 1.2
diff -u -u -r1.2 security.7
--- share/man/man7/security.7 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man7/security.7 25 Feb 2004 21:55:45 -0000
@@ -10,7 +10,7 @@
.Os
.Sh NAME
.Nm security
-.Nd introduction to security under FreeBSD
+.Nd introduction to security under DragonFly
.Sh DESCRIPTION
Security is a function that begins and ends with the system administrator.
While all
@@ -244,7 +244,7 @@
If you are running a machine through which people only login via sshd and
never login via telnetd or rshd or rlogind, then turn off those services!
.Pp
-.Fx
+.Dx
now defaults to running ntalkd, comsat, and finger in a sandbox.
Another program which may be a candidate for running in a sandbox is
.Xr named 8 .
@@ -324,7 +324,7 @@
If an attacker breaks root he can do just about anything, but there
are certain conveniences. For example, most modern kernels have a
packet sniffing device driver built in. Under
-.Fx
+.Dx
it is called
the
.Sq bpf
@@ -558,7 +558,7 @@
service and forget to update the firewall. You can still open up the
high-numbered port range on the firewall to allow permissive-like operation
without compromising your low ports. Also take note that
-.Fx
+.Dx
allows you to
control the range of port numbers used for dynamic binding via the various
net.inet.ip.portrange sysctl's
@@ -587,7 +587,7 @@
outgoing network with ICMP responses. This type of attack can also crash the
server by running it out of mbuf's, especially if the server cannot drain the
ICMP responses it generates fast enough. The
-.Fx
+.Dx
kernel has a new kernel
compile option called ICMP_BANDLIM which limits the effectiveness of these
sorts of attacks. The last major class of springboard attacks is related to
Index: share/man/man7/style.perl.7
===================================================================
RCS file: /home/dcvs/src/share/man/man7/style.perl.7,v
retrieving revision 1.2
diff -u -u -r1.2 style.perl.7
--- share/man/man7/style.perl.7 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man7/style.perl.7 25 Feb 2004 21:57:28 -0000
@@ -30,10 +30,10 @@
.Os
.Sh NAME
.Nm style.perl
-.Nd "FreeBSD Perl source file style guide"
+.Nd "DragonFly Perl source file style guide"
.Sh DESCRIPTION
This file specifies the preferred style for perl scripts in the
-.Fx
+.Dx
source tree.
.Bd -literal
#
Index: share/man/man7/tuning.7
===================================================================
RCS file: /home/dcvs/src/share/man/man7/tuning.7,v
retrieving revision 1.2
diff -u -u -r1.2 tuning.7
--- share/man/man7/tuning.7 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man7/tuning.7 25 Feb 2004 21:56:41 -0000
@@ -10,7 +10,7 @@
.Os
.Sh NAME
.Nm tuning
-.Nd performance tuning under FreeBSD
+.Nd performance tuning under DragonFly
.Sh SYSTEM SETUP - DISKLABEL, NEWFS, TUNEFS, SWAP
When using
.Xr disklabel 8
@@ -196,7 +196,7 @@
and
.Em cylinders/group .
.Pp
-.Fx
+.Dx
performs best when using 8K or 16K filesystem block sizes.
The default filesystem block size is 16K,
which provides best performance for most applications,
@@ -302,7 +302,7 @@
filesystems normally update the last-accessed time of a file or
directory whenever it is accessed.
This operation is handled in
-.Fx
+.Dx
with a delayed write and normally does not create a burden on the system.
However, if your system is accessing a huge number of files on a continuing
basis the buffer cache can wind up getting polluted with atime updates,
@@ -361,7 +361,7 @@
If
you really need to get sophisticated, we recommend using a real hardware
RAID controller from the list of
-.Fx
+.Dx
supported controllers.
.Sh SYSCTL TUNING
.Xr sysctl 8
@@ -527,14 +527,14 @@
the acknowledgement may be sent in its own packet before the remote service
has a chance to echo the data it just received. This same concept also
applies to any interactive protocol (e.g. SMTP, WWW, POP3) and can cut the
-number of tiny packets flowing across the network in half. The FreeBSD
+number of tiny packets flowing across the network in half. The DragonFly
delayed-ack implementation also follows the TCP protocol rule that
at least every other packet be acknowledged even if the standard 100ms
timeout has not yet passed. Normally the worst a delayed ack can do is
slightly delay the teardown of a connection, or slightly delay the ramp-up
of a slow-start TCP connection. While we aren't sure we believe that
the several FAQs related to packages such as SAMBA and SQUID which advise
-turning off delayed acks may be refering to the slow-start issue. In FreeBSD
+turning off delayed acks may be refering to the slow-start issue. In DragonFly
it would be more beneficial to increase the slow-start flightsize via
the
.Va net.inet.tcp.slowstart_flightsize
Index: share/man/man8/crash.8
===================================================================
RCS file: /home/dcvs/src/share/man/man8/crash.8,v
retrieving revision 1.2
diff -u -u -r1.2 crash.8
--- share/man/man8/crash.8 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man8/crash.8 25 Feb 2004 22:26:22 -0000
@@ -42,7 +42,7 @@
.Os
.Sh NAME
.Nm crash
-.Nd FreeBSD system failures
+.Nd DragonFly system failures
.Sh DESCRIPTION
This section explains a bit about system crashes
and (very briefly) how to analyze crash dumps.
Index: share/man/man8/diskless.8
===================================================================
RCS file: /home/dcvs/src/share/man/man8/diskless.8,v
retrieving revision 1.2
diff -u -u -r1.2 diskless.8
--- share/man/man8/diskless.8 17 Jun 2003 04:37:00 -0000 1.2
+++ share/man/man8/diskless.8 25 Feb 2004 22:26:55 -0000
@@ -287,7 +287,7 @@
.Sh BUGS
This manpage is probably incomplete.
.Pp
-.Fx
+.Dx
sometimes requires to write onto
the root partition, so the startup scripts mount MFS
filesystems on some locations (e.g.\&
Index: share/man/man8/rc.8
===================================================================
RCS file: /home/dcvs/src/share/man/man8/rc.8,v
retrieving revision 1.3
diff -u -u -r1.3 rc.8
--- share/man/man8/rc.8 1 Aug 2003 04:31:03 -0000 1.3
+++ share/man/man8/rc.8 25 Feb 2004 22:28:58 -0000
@@ -246,7 +246,7 @@
.Dq Li BEFORE
keywords.
In addition, all scripts must have a
-.Dq Li "# KEYWORD: FreeBSD"
+.Dq Li "# KEYWORD: DragonFly"
line.
.Pp
Each script is expected to support at least the following arguments, which
@@ -261,7 +261,7 @@
Also checks if the service is already running and refuses to start if
it is.
This latter check is not performed by standard
-.Fx
+.Dx
scripts if the system is starting directly to multi-user mode, to
speed up the boot process.
If
@@ -485,7 +485,7 @@
# PROVIDE: foo
# REQUIRE: bar_service_required_to_precede_foo
# BEFORE: baz_service_requiring_foo_to_precede_it
-# KEYWORD: FreeBSD
+# KEYWORD: DragonFly
\&. /etc/rc.subr
@@ -507,7 +507,7 @@
# PROVIDE: foo
# REQUIRE: bar_service_required_to_precede_foo
# BEFORE: baz_service_requiring_foo_to_precede_it
-# KEYWORD: FreeBSD
+# KEYWORD: DragonFly
\&. /etc/rc.subr
Index: share/man/man8/rc.subr.8
===================================================================
RCS file: /home/dcvs/src/share/man/man8/rc.subr.8,v
retrieving revision 1.1
diff -u -u -r1.1 rc.subr.8
--- share/man/man8/rc.subr.8 1 Aug 2003 04:36:57 -0000 1.1
+++ share/man/man8/rc.subr.8 25 Feb 2004 22:30:44 -0000
@@ -100,7 +100,8 @@
.Bl -tag -width 4n
.It Ic OSTYPE
Its value will be either
-.Fx
+.Dx Ns ,
+.Fx Ns ,
or
.Nx ,
depending on which OS it is running on.
@@ -693,7 +694,7 @@
.El
.It Ic set_rcvar Op Ar base
Set the variable name required to start a service. In
-.Fx
+.Dx
a daemon is usually controlled by an
.Xr rc.conf 5
variable consisting of a daemon's name postfixed by the string
Index: share/man/man8/yp.8
===================================================================
RCS file: /home/dcvs/src/share/man/man8/yp.8,v
retrieving revision 1.2
diff -u -u -r1.2 yp.8
--- share/man/man8/yp.8 17 Jun 2003 04:37:01 -0000 1.2
+++ share/man/man8/yp.8 25 Feb 2004 22:25:09 -0000
@@ -109,7 +109,7 @@
.Tn NIS
.Em maps .
In
-.Fx ,
+.Dx ,
these maps are stored in
.Pa /var/yp/ Ns Aq Ar domainname
where
@@ -126,7 +126,7 @@
its own independent set of maps.
.Pp
In
-.Fx ,
+.Dx ,
the
.Tn NIS
maps are Berkeley DB hashed database files (the
@@ -162,7 +162,7 @@
.Pa passwd.byname.pag
files on other operating systems (both of which are really parts of the
same map),
-.Fx
+.Dx
will have only one file called
.Pa passwd.byname .
The difference in format is not significant: only the
@@ -370,17 +370,17 @@
.El
.Pp
The
-.Fx
+.Dx
.Xr ypserv 8
is specially designed to provided enhanced security (compared to
other
.Tn NIS
implementations) when used exclusively with
-.Fx
+.Dx / Fx
client
systems.
The
-.Fx
+.Dx
password database system (which is derived directly
from
.Bx 4.4 )
@@ -397,7 +397,7 @@
data.
.Pp
To help prevent this,
-.Fx Ns 's
+.Dx Ns 's
.Tn NIS
server handles the shadow password maps
.Pa ( master.passwd.byname
@@ -411,7 +411,7 @@
All other requests are denied: requests from non-privileged
ports will receive only an error code from the server.
Additionally,
-.Fx Ns 's
+.Dx Ns 's
.Xr ypserv 8
includes support for
.An Wietse Venema Ns 's
@@ -428,7 +428,7 @@
the shadow password maps.
.Pp
On the client side,
-.Fx Ns 's
+.Dx Ns 's
.Xr getpwent 3
functions will automatically search for the
.Pa master.passwd
@@ -441,12 +441,12 @@
maps will be used instead.
.Sh COMPATIBILITY
When using a
-.No non- Ns Fx
+.No non- Ns Dx Ns / Ns Fx
.Tn NIS
server for
.Xr passwd 5
files, it is unlikely that the default MD5-based format that
-.Fx
+.Dx
uses for passwords will be accepted by it.
If this is the case, the value of the
.Va passwd_format
@@ -475,7 +475,7 @@
or
.Pa hosts.byaddr
maps.
-.Fx Ns 's
+.Dx Ns 's
resolver uses
.Tn DNS
by default (it can be made to use
@@ -497,14 +497,14 @@
v1 server
in order to placate certain systems that insist on the presence of
a v1 server
-.No ( Fx
+.No ( Dx
uses only
.Tn NIS
v2, but many other systems,
including
.Tn SunOS
4.x, search for both a v1 and v2 server when binding).
-.Fx Ns 's
+.Dx Ns 's
.Xr ypserv 8
does not actually handle
.Tn NIS
@@ -519,7 +519,7 @@
and flags.)
.Sh BUGS
While
-.Fx
+.Dx
now has both
.Tn NIS
client and server capabilities, it does not yet have support for
@@ -530,7 +530,7 @@
Both of these require secure
.Tn RPC ,
which
-.Fx
+.Dx
does not
support yet either.
.Pp
Index: share/man/man9/inittodr.9
===================================================================
RCS file: /home/dcvs/src/share/man/man9/inittodr.9,v
retrieving revision 1.2
diff -u -u -r1.2 inittodr.9
--- share/man/man9/inittodr.9 17 Jun 2003 04:37:01 -0000 1.2
+++ share/man/man9/inittodr.9 23 Feb 2004 20:45:05 -0000
@@ -117,7 +117,7 @@
different.
.Pp
The
-.Fx
+.Dx
implementation should do a better job of validating the time provided in
.Fa base
when the battery-backed clock is unusable. Currently it unconditionally
Index: share/man/man9/posix4.9
===================================================================
RCS file: /home/dcvs/src/share/man/man9/posix4.9,v
retrieving revision 1.2
diff -u -u -r1.2 posix4.9
--- share/man/man9/posix4.9 17 Jun 2003 04:37:01 -0000 1.2
+++ share/man/man9/posix4.9 23 Feb 2004 20:45:18 -0000
@@ -70,7 +70,7 @@
The following test macros are set up in <sys/_posix.h>. They should
used by system header files to avoid the kind of tests you see in
<sys/_posix.h>. Source programs should not use these
-.Fx
+.Dx
specific
implementation details and should test _POSIX_VERSION, _POSIX_SOURCE
and _POSIX_C_SOURCE.
Index: share/man/man9/spl.9
===================================================================
RCS file: /home/dcvs/src/share/man/man9/spl.9,v
retrieving revision 1.3
diff -u -u -r1.3 spl.9
--- share/man/man9/spl.9 1 Aug 2003 17:46:25 -0000 1.3
+++ share/man/man9/spl.9 23 Feb 2004 20:45:57 -0000
@@ -186,7 +186,7 @@
names, and were inclusive up to higher priority levels (i.e., priority
5 has been blocking everything up to level 5). This is no longer the
case in
-.Fx .
+.Dx .
The traditional name
.Ql level
for them is still reflected in the letter
Index: share/man/man9/style.9
===================================================================
RCS file: /home/dcvs/src/share/man/man9/style.9,v
retrieving revision 1.5
diff -u -u -r1.5 style.9
--- share/man/man9/style.9 5 Feb 2004 11:51:54 -0000 1.5
+++ share/man/man9/style.9 23 Feb 2004 20:44:25 -0000
@@ -31,7 +31,7 @@
.Nd "kernel source file style guide"
.Sh DESCRIPTION
This file specifies the preferred style for kernel source files in the
-.Fx
+.Dx
source tree.
It is also a guide for preferred userland code style.
Many of the style rules are implicit in the examples.
@@ -681,7 +681,7 @@
Stylistic changes (including whitespace changes) are hard on the source
repository and are to be avoided without good reason.
Code that is approximately
-.Fx
+.Dx
KNF
.Nm
compliant in the repository must not diverge from compliance.
@@ -705,5 +705,5 @@
.Bx 4.4 Lite2
release, with occasional updates to reflect the current practice and
desire of the
-.Fx
+.Dx
project.
Index: sys/boot/common/loader.8
===================================================================
RCS file: /home/dcvs/src/sys/boot/common/loader.8,v
retrieving revision 1.4
diff -u -u -r1.4 loader.8
--- sys/boot/common/loader.8 10 Nov 2003 06:08:31 -0000 1.4
+++ sys/boot/common/loader.8 25 Feb 2004 22:45:19 -0000
@@ -37,7 +37,7 @@
The program called
.Nm
is the final stage of
-.Fx Ns 's
+.Dx Ns 's
kernel bootstrapping process.
On IA32 (i386) architectures, it is a
.Pa BTX
@@ -623,7 +623,7 @@
Forth standard words, extra
.Tn FICL
words, extra
-.Fx
+.Dx
words, and the builtin commands;
the latter were already described.
The
@@ -738,8 +738,8 @@
.It arch-alpha
.Ic TRUE
if the architecture is AXP.
-.It FreeBSD_version
-.Fx
+.It DragonFly_version
+.Dx
version at compile time.
.It loader_version
.Nm
Index: sys/emulation/ibcs2/ibcs2.8
===================================================================
RCS file: /home/dcvs/src/sys/emulation/ibcs2/ibcs2.8,v
retrieving revision 1.2
diff -u -u -r1.2 ibcs2.8
--- sys/emulation/ibcs2/ibcs2.8 17 Jun 2003 04:28:44 -0000 1.2
+++ sys/emulation/ibcs2/ibcs2.8 25 Feb 2004 22:41:58 -0000
@@ -44,7 +44,7 @@
system call interface, and is far from complete. COFF binaries
and shared libraries are supported, however no shared libraries
are provided with the
-.Fx
+.Dx
distribution.
.Sh FILES
.Bl -tag -width /usr/share/examples/ibcs2/* -compact
Index: usr.bin/brandelf/brandelf.1
===================================================================
RCS file: /home/dcvs/src/usr.bin/brandelf/brandelf.1,v
retrieving revision 1.2
diff -u -u -r1.2 brandelf.1
--- usr.bin/brandelf/brandelf.1 17 Jun 2003 04:29:25 -0000 1.2
+++ usr.bin/brandelf/brandelf.1 18 Feb 2004 21:25:50 -0000
@@ -42,7 +42,7 @@
.Ar
.Sh DESCRIPTION
This command marks an ELF binary to be run under a certain ABI for
-.Fx .
+.Dx .
.Pp
The options are as follows:
.Bl -tag -width Fl
@@ -65,6 +65,10 @@
.Dq Tn Linux ,
and
.Dq Tn SVR4 .
+(
+.Dx currently uses
+.Dq Fx
+as its native branding.)
.It Ar file
If
.Fl t Ar string
Index: usr.bin/chpass/chpass.1
===================================================================
RCS file: /home/dcvs/src/usr.bin/chpass/chpass.1,v
retrieving revision 1.2
diff -u -u -r1.2 chpass.1
--- usr.bin/chpass/chpass.1 17 Jun 2003 04:29:25 -0000 1.2
+++ usr.bin/chpass/chpass.1 18 Feb 2004 20:59:24 -0000
@@ -301,6 +301,8 @@
.Pp
Note: these exceptions only apply when the NIS master server is a
.Fx
+or
+.Dx
system).
.Pp
Consequently, except where noted, the following restrictions apply when
Index: usr.bin/doscmd/doscmd.1
===================================================================
RCS file: /home/dcvs/src/usr.bin/doscmd/doscmd.1,v
retrieving revision 1.2
diff -u -u -r1.2 doscmd.1
--- usr.bin/doscmd/doscmd.1 17 Jun 2003 04:29:26 -0000 1.2
+++ usr.bin/doscmd/doscmd.1 18 Feb 2004 21:05:33 -0000
@@ -722,7 +722,7 @@
the magic
.Li redir
program, which installs
-.Fx
+.Dx
disks. To use
them add lines to your .doscmdrc such as:
.Bd -literal -offset indent
Index: usr.bin/getconf/getconf.1
===================================================================
RCS file: /home/dcvs/src/usr.bin/getconf/getconf.1,v
retrieving revision 1.2
diff -u -u -r1.2 getconf.1
--- usr.bin/getconf/getconf.1 17 Jun 2003 04:29:27 -0000 1.2
+++ usr.bin/getconf/getconf.1 18 Feb 2004 21:07:45 -0000
@@ -140,7 +140,7 @@
C type
.Vt long .
At present, all programming environments supported by
-.Fx
+.Dx
have this property.
Several of the
.Xr confstr 3
Index: usr.bin/limits/limits.1
===================================================================
RCS file: /home/dcvs/src/usr.bin/limits/limits.1,v
retrieving revision 1.2
diff -u -u -r1.2 limits.1
--- usr.bin/limits/limits.1 17 Jun 2003 04:29:28 -0000 1.2
+++ usr.bin/limits/limits.1 18 Feb 2004 21:23:38 -0000
@@ -369,6 +369,6 @@
are valid and settable by the current user.
Only a superuser account may raise hard limits, and when doing so
the
-.Fx
+.Dx
kernel will silently lower limits to values less than
specified if the values given are too high.
Index: usr.bin/locate/locate/locate.1
===================================================================
RCS file: /home/dcvs/src/usr.bin/locate/locate/locate.1,v
retrieving revision 1.2
diff -u -u -r1.2 locate.1
--- usr.bin/locate/locate/locate.1 17 Jun 2003 04:29:28 -0000 1.2
+++ usr.bin/locate/locate/locate.1 18 Feb 2004 21:24:37 -0000
@@ -248,7 +248,7 @@
implementation understand databases in host byte order or
network byte order if both architectures use the same integer size.
So you can read on a
-.Fx Ns /i386
+.Dx Ns /i386
machine
(little endian)
a locate database which was built on SunOS/sparc machine
Index: usr.bin/mktemp/mktemp.1
===================================================================
RCS file: /home/dcvs/src/usr.bin/mktemp/mktemp.1,v
retrieving revision 1.2
diff -u -u -r1.2 mktemp.1
--- usr.bin/mktemp/mktemp.1 17 Jun 2003 04:29:29 -0000 1.2
+++ usr.bin/mktemp/mktemp.1 18 Feb 2004 21:28:44 -0000
@@ -194,4 +194,4 @@
first appeared in
.Fx 2.2.7 .
This man page is taken from
-.Ox
+.Ox .
Index: usr.bin/rpcgen/rpcgen.1
===================================================================
RCS file: /home/dcvs/src/usr.bin/rpcgen/rpcgen.1,v
retrieving revision 1.2
diff -u -u -r1.2 rpcgen.1
--- usr.bin/rpcgen/rpcgen.1 17 Jun 2003 04:29:31 -0000 1.2
+++ usr.bin/rpcgen/rpcgen.1 18 Feb 2004 21:33:03 -0000
@@ -252,10 +252,10 @@
of the operating system.
.Pp
Note: in
-.Fx ,
+.dx ,
this compatibility flag is turned on by
default since
-.Fx
+.Dx
supports only the older
.Tn ONC RPC
library.
@@ -298,7 +298,7 @@
Note: in order to provide backwards compatibility with the older
.Nm
on the
-.Fx
+.Dx
platform, the default is actually 0 (which means
that inline code generation is disabled by default). You must specify
a non-zero value explicitly to override this default.
Index: usr.bin/sed/sed.1
===================================================================
RCS file: /home/dcvs/src/usr.bin/sed/sed.1,v
retrieving revision 1.2
diff -u -u -r1.2 sed.1
--- usr.bin/sed/sed.1 17 Jun 2003 04:29:31 -0000 1.2
+++ usr.bin/sed/sed.1 18 Feb 2004 21:33:46 -0000
@@ -532,7 +532,7 @@
The
.Fl i
option is a non-standard
-.Fx
+.Dx
extension and may not be available on other operating systems.
.Sh HISTORY
A
Index: usr.bin/xargs/xargs.1
===================================================================
RCS file: /home/dcvs/src/usr.bin/xargs/xargs.1,v
retrieving revision 1.2
diff -u -u -r1.2 xargs.1
--- usr.bin/xargs/xargs.1 17 Jun 2003 04:29:34 -0000 1.2
+++ usr.bin/xargs/xargs.1 18 Feb 2004 20:55:36 -0000
@@ -289,7 +289,7 @@
and
.Fl R
options are non-standard
-.Fx
+.Dx
extensions which may not be available on other operating systems.
.Sh HISTORY
The
Index: usr.sbin/boot0cfg/boot0cfg.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/boot0cfg/boot0cfg.8,v
retrieving revision 1.2
diff -u -u -r1.2 boot0cfg.8
--- usr.sbin/boot0cfg/boot0cfg.8 17 Jun 2003 04:29:52 -0000 1.2
+++ usr.sbin/boot0cfg/boot0cfg.8 25 Feb 2004 22:37:30 -0000
@@ -44,7 +44,7 @@
.Ar disk
.Sh DESCRIPTION
The
-.Fx
+.Dx
.Sq boot0
boot manager permits the operator to select from which disk and
slice an i386 machine (PC) is booted.
Index: usr.sbin/config/config.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/config/config.8,v
retrieving revision 1.2
diff -u -u -r1.2 config.8
--- usr.sbin/config/config.8 17 Jun 2003 04:29:53 -0000 1.2
+++ usr.sbin/config/config.8 25 Feb 2004 22:36:55 -0000
@@ -114,7 +114,7 @@
where
.Va ARCH
represents one of the architectures supported by
-.Fx .
+.Dx .
.Nm
creates the directory
.Pa ../../compile/ Ns Ar SYSTEM_NAME
@@ -189,7 +189,7 @@
.Pp
For reasons of history, time and space, building a debug kernel is not the
default with
-.Fx :
+.Dx :
a debug kernel takes up to 30% longer to build and
requires about 30 MB of disk storage in the build directory, compared to about 6
MB for a non-debug kernel.
Index: usr.sbin/fwcontrol/fwcontrol.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/fwcontrol/fwcontrol.8,v
retrieving revision 1.2
diff -u -u -r1.2 fwcontrol.8
--- usr.sbin/fwcontrol/fwcontrol.8 17 Jun 2003 04:29:53 -0000 1.2
+++ usr.sbin/fwcontrol/fwcontrol.8 25 Feb 2004 22:40:50 -0000
@@ -48,7 +48,7 @@
The
.Nm
utility is designed to provide a way for users to access and control the
-.Fx
FireWire subsystem.
Without options,
.Nm
Index: usr.sbin/i4b/man/i4bing.4
===================================================================
RCS file: /home/dcvs/src/usr.sbin/i4b/man/i4bing.4,v
retrieving revision 1.2
diff -u -u -r1.2 i4bing.4
--- usr.sbin/i4b/man/i4bing.4 17 Jun 2003 04:29:55 -0000 1.2
+++ usr.sbin/i4b/man/i4bing.4 25 Feb 2004 21:02:34 -0000
@@ -41,7 +41,7 @@
The
.Nm
driver interfaces the
-.Fx
+.Dx
NetGraph subsystem with the
isdn4bsd package.
.Pp
Index: usr.sbin/i4b/man/i4bisppp.4
===================================================================
RCS file: /home/dcvs/src/usr.sbin/i4b/man/i4bisppp.4,v
retrieving revision 1.2
diff -u -u -r1.2 i4bisppp.4
--- usr.sbin/i4b/man/i4bisppp.4 17 Jun 2003 04:29:55 -0000 1.2
+++ usr.sbin/i4b/man/i4bisppp.4 25 Feb 2004 21:06:33 -0000
@@ -35,7 +35,7 @@
.Sh NAME
.Nm i4bisppp
.Nd isdn4bsd synchronous PPP over ISDN B-channel network driver
-.Sh FreeBSD SYNOPSIS
+.Sh DragonFly / FreeBSD SYNOPSIS
.Cd pseudo-device \&"i4bisppp\&" Op count
.Sh NetBSD SYNOPSIS
none
@@ -50,7 +50,7 @@
backend and the ISDN4BSD package.
.Pp
Beginning with i4b version 0.95 (and only for
-.Fx ) ,
+.Fx and Dx ) ,
the sppp
subsystem was integrated into the
.Nm
Index: usr.sbin/i4b/man/ihfc.4
===================================================================
RCS file: /home/dcvs/src/usr.sbin/i4b/man/ihfc.4,v
retrieving revision 1.2
diff -u -u -r1.2 ihfc.4
--- usr.sbin/i4b/man/ihfc.4 17 Jun 2003 04:29:55 -0000 1.2
+++ usr.sbin/i4b/man/ihfc.4 25 Feb 2004 21:05:30 -0000
@@ -35,6 +35,7 @@
.Nd isdn4bsd Cologne Chip Designs HFC[-S][-SP] 2B[DS0] driver
.Sh SYNOPSIS
All PnP cards (AcerISDN P10, Teles 16.3c PnP),
+.Dx Ns ,
.Fx
4.x/5.x:
.Cd "device ihfc"
@@ -45,7 +46,7 @@
4.x:
.Cd "device ihfc0 at isa?"
.Pp
-.Fx
+.Dx Ns , Fx
5.x:
.Cd "device ihfc"
NOTE:
Index: usr.sbin/jail/jail.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/jail/jail.8,v
retrieving revision 1.2
diff -u -u -r1.2 jail.8
--- usr.sbin/jail/jail.8 17 Jun 2003 04:29:55 -0000 1.2
+++ usr.sbin/jail/jail.8 25 Feb 2004 22:44:14 -0000
@@ -72,7 +72,7 @@
.Ss "Setting up a Jail Directory Tree"
This example shows how to setup a jail directory tree
containing an entire
-.Fx
+.Dx
distribution:
.Bd -literal
D=/here/is/the/jail
@@ -339,8 +339,8 @@
.Dl jail.set_hostname_allowed=0
.Pp
In a future version of
-.Fx ,
-the mechanisms for managing jails will be
+.Dx ,
+the mechanisms for managing jails may be
more refined.
.Ss "Sysctl MIB Entries"
Certain aspects of the jail containments environment may be modified from
Index: usr.sbin/lpr/lpr/lpr.1
===================================================================
RCS file: /home/dcvs/src/usr.sbin/lpr/lpr/lpr.1,v
retrieving revision 1.2
diff -u -u -r1.2 lpr.1
--- usr.sbin/lpr/lpr/lpr.1 17 Jun 2003 04:29:56 -0000 1.2
+++ usr.sbin/lpr/lpr/lpr.1 18 Feb 2004 21:26:55 -0000
@@ -90,7 +90,7 @@
.Pp
The following options are historical and not directly supported by any
software included in
-.Fx .
+.Dx .
.Bl -tag -width indent
.It Fl c
The files are assumed to contain data produced by
@@ -301,7 +301,7 @@
.Ql Z
control file line is used for two different purposes; for
standard
-.Fx
+.Dx
.Xr lpd 8 ,
it specifies a locale to be passed to
.Xr pr 1 .
Index: usr.sbin/mergemaster/mergemaster.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/mergemaster/mergemaster.8,v
retrieving revision 1.2
diff -u -u -r1.2 mergemaster.8
--- usr.sbin/mergemaster/mergemaster.8 17 Jun 2003 04:29:57 -0000 1.2
+++ usr.sbin/mergemaster/mergemaster.8 25 Feb 2004 22:46:25 -0000
@@ -46,7 +46,7 @@
utility is a Bourne shell script which is designed to aid you
in updating the various configuration and other files
associated with
-.Fx .
+.Dx .
It is
.Sy HIGHLY
recommended that you back up your
@@ -83,7 +83,7 @@
.Pa /var/tmp/temproot
and compares the
.Xr cvs 1
-version $Id/$FreeBSD strings for files that have them, deleting
+version $Id/$DragonFly strings for files that have them, deleting
the temporary file if the strings match.
If there is
no $Id string, or if the strings are different it
@@ -306,7 +306,7 @@
#DIFF_FLAG='-u'
#
# Additional options for diff. This will get unset when using -s.
-#DIFF_OPTIONS='-I$\&FreeBSD:.*[$]' # Ignores CVS Id tags
+#DIFF_OPTIONS='-I$\&DragonFly:.*[$]' # Ignores CVS Id tags
#
# Verbose mode includes more details and additional checks
#VERBOSE=
Index: usr.sbin/mtree/mtree.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/mtree/mtree.8,v
retrieving revision 1.2
diff -u -u -r1.2 mtree.8
--- usr.sbin/mtree/mtree.8 17 Jun 2003 04:29:57 -0000 1.2
+++ usr.sbin/mtree/mtree.8 25 Feb 2004 22:50:33 -0000
@@ -317,7 +317,7 @@
for distributions and other such things; the files in
.Pa /etc/mtree
were used to create almost all directories in this
-.Fx
+.Dx
distribution.
.Sh FILES
.Bl -tag -width /etc/mtree -compact
Index: usr.sbin/ntp/doc/ntpd.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/ntp/doc/ntpd.8,v
retrieving revision 1.2
diff -u -u -r1.2 ntpd.8
--- usr.sbin/ntp/doc/ntpd.8 17 Jun 2003 04:29:58 -0000 1.2
+++ usr.sbin/ntp/doc/ntpd.8 25 Feb 2004 22:52:59 -0000
@@ -442,7 +442,8 @@
retired.
.Pp
When kernel support is available to discipline the clock
-frequency, which is the case for stock Solaris, Tru64, Linux and
+frequency, which is the case for stock Solaris, Tru64, Linux,
+.Dx Ns , and
.Fx ,
a useful feature is available to discipline the clock
frequency.
Index: usr.sbin/ppp/ppp.8.m4
===================================================================
RCS file: /home/dcvs/src/usr.sbin/ppp/ppp.8.m4,v
retrieving revision 1.2
diff -u -u -r1.2 ppp.8.m4
--- usr.sbin/ppp/ppp.8.m4 17 Jun 2003 04:30:00 -0000 1.2
+++ usr.sbin/ppp/ppp.8.m4 25 Feb 2004 22:53:59 -0000
@@ -2168,7 +2168,7 @@
.Ed
.Pp
Cuaa0 is the first serial port on
-.Fx .
+.Dx .
If you're running
.Nm
on
Index: usr.sbin/quot/quot.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/quot/quot.8,v
retrieving revision 1.2
diff -u -u -r1.2 quot.8
--- usr.sbin/quot/quot.8 17 Jun 2003 04:30:02 -0000 1.2
+++ usr.sbin/quot/quot.8 25 Feb 2004 22:54:37 -0000
@@ -95,7 +95,7 @@
.Nm ls Fl i
in the example above)
does not exist in
-.Fx .
+.Dx .
.Sh SEE ALSO
.Xr df 1 ,
.Xr quota 1 ,
Index: usr.sbin/rpc.lockd/rpc.lockd.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/rpc.lockd/rpc.lockd.8,v
retrieving revision 1.2
diff -u -u -r1.2 rpc.lockd.8
--- usr.sbin/rpc.lockd/rpc.lockd.8 17 Jun 2003 04:30:02 -0000 1.2
+++ usr.sbin/rpc.lockd/rpc.lockd.8 25 Feb 2004 22:55:59 -0000
@@ -82,10 +82,10 @@
.Sh BUGS
The current implementation provides only the server side of the protocol
(ie. clients running other OS types can establish locks on a
-.Fx
+.Dx
fileserver,
but there is currently no means for a
-.Fx
+.Dx
client to establish locks).
.Pp
Versions 1, 2 and 3 of the protocol are supported. However, only versions
Index: usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8,v
retrieving revision 1.2
diff -u -u -r1.2 rpc.yppasswdd.8
--- usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 17 Jun 2003 04:30:02 -0000 1.2
+++ usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 25 Feb 2004 22:57:34 -0000
@@ -117,7 +117,7 @@
.Pa /var/yp/Makefile ) .
.Pp
The
-.Fx
+.Dx
version of
.Nm
also allows the super-user on the NIS master server to perform more
@@ -208,7 +208,7 @@
can only operate on a single NIS domain, which is generally the same as
the system default domain of the NIS master server.
The
-.Fx
+.Dx
.Nm
attempts to overcome this problem in spite of the inherent limitations
of the
Index: usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8,v
retrieving revision 1.2
diff -u -u -r1.2 rpc.ypxfrd.8
--- usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8 17 Jun 2003 04:30:02 -0000 1.2
+++ usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8 25 Feb 2004 22:58:02 -0000
@@ -133,14 +133,14 @@
.Xr ypxfr 8
.Sh BUGS
The
-.Fx
+.Dx
.Nm ypxfrd
protocol is not compatible with that used by SunOS.
This is unfortunate
but unavoidable: Sun's protocol is not freely available, and even if it
were it would probably not be useful since the SunOS NIS v2 implementation
uses the original ndbm package for its map databases whereas the
-.Fx
+.Dx
implementation uses Berkeley DB.
These two packages use vastly different
file formats.
Index: usr.sbin/rtprio/rtprio.1
===================================================================
RCS file: /home/dcvs/src/usr.sbin/rtprio/rtprio.1,v
retrieving revision 1.2
diff -u -u -r1.2 rtprio.1
--- usr.sbin/rtprio/rtprio.1 17 Jun 2003 04:30:03 -0000 1.2
+++ usr.sbin/rtprio/rtprio.1 18 Feb 2004 21:13:17 -0000
@@ -189,14 +189,14 @@
.Xr ps 1 ) .
.Pp
There is in
-.Fx
+.Dx
no way to ensure that a process page is present in memory therefore
the process may be stopped for pagein (see
.Xr mprotect 2 ,
.Xr madvise 2 ) .
.Pp
Under
-.Fx
+.Dx
system calls are currently never preempted, therefore non-realtime
processes can starve realtime processes, or idletime processes can
starve normal priority processes.
@@ -205,7 +205,5 @@
.An Henrik Vestergaard Draboel Aq hvd at xxxxxxxxxxxxx
is the original author.
This
-implementation in
-.Fx
-was substantially rewritten by
+implementation was substantially rewritten by
.An David Greenman .
Index: usr.sbin/tzsetup/tzsetup.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/tzsetup/tzsetup.8,v
retrieving revision 1.2
diff -u -u -r1.2 tzsetup.8
--- usr.sbin/tzsetup/tzsetup.8 17 Jun 2003 04:30:03 -0000 1.2
+++ usr.sbin/tzsetup/tzsetup.8 25 Feb 2004 22:59:15 -0000
@@ -127,5 +127,5 @@
The representation of certain localities as being associated with certain
countries and/or territories is for the purposes of identification only,
and does not imply any endorsement or rejection on the part of the
-.Fx
+.Dx
Project of the territorial claims of any entity.
Index: usr.sbin/yp_mkdb/yp_mkdb.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/yp_mkdb/yp_mkdb.8,v
retrieving revision 1.2
diff -u -u -r1.2 yp_mkdb.8
--- usr.sbin/yp_mkdb/yp_mkdb.8 17 Jun 2003 04:30:04 -0000 1.2
+++ usr.sbin/yp_mkdb/yp_mkdb.8 25 Feb 2004 23:01:28 -0000
@@ -59,7 +59,7 @@
utility creates
.Xr db 3
style databases for use with
-.Fx Ns 's
+.Dx Ns 's
NIS server.
The
.Nm
Index: usr.sbin/yppush/yppush.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/yppush/yppush.8,v
retrieving revision 1.2
diff -u -u -r1.2 yppush.8
--- usr.sbin/yppush/yppush.8 17 Jun 2003 04:30:04 -0000 1.2
+++ usr.sbin/yppush/yppush.8 25 Feb 2004 23:01:54 -0000
@@ -65,7 +65,7 @@
.Dq Li NOPUSH=True
entry in the Makefile must first be commented out
(the default
-.Fx
+.Dx
configuration assumes a small network with only
a single NIS server; in such a configuration,
.Nm
Index: usr.sbin/ypserv/ypserv.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/ypserv/ypserv.8,v
retrieving revision 1.2
diff -u -u -r1.2 ypserv.8
--- usr.sbin/ypserv/ypserv.8 17 Jun 2003 04:30:05 -0000 1.2
+++ usr.sbin/ypserv/ypserv.8 25 Feb 2004 23:03:14 -0000
@@ -102,7 +102,7 @@
.Xr db 3
format to help speed retrieval when there are many records involved.
In
-.Fx ,
+.Dx ,
the maps are always readable and writable only by root for security
reasons.
Technically this is only necessary for the password
@@ -118,11 +118,11 @@
.Pa /etc/rc.conf .
.Sh SPECIAL FEATURES
There are some problems associated with distributing a
-.Fx
+.Dx
password
database via
.Tn NIS Ns :
-.Fx
+.Dx
normally only stores encrypted passwords
in
.Pa /etc/master.passwd ,
@@ -133,7 +133,7 @@
map, this security feature would be completely defeated.
.Pp
To make up for this, the
-.Fx
+.Dx
version of
.Nm
handles the
@@ -153,7 +153,7 @@
Furthermore, the
.Xr getpwent 3
routines in the
-.Fx
+.Dx
standard C library will only attempt to retrieve
data from the
.Pa master.passwd.byname
@@ -196,9 +196,9 @@
which do not run UNIX-based operating systems).
.It
If you plan to use a
-.Fx
+.Dx
system to serve
-.No non- Ns Fx
+.No non- Ns Dx Ns / Ns Fx
clients that
have no support for password shadowing (which is most of them), you
will have to disable the password shadowing entirely by uncommenting the
@@ -211,7 +211,7 @@
.Pa passwd.byuid
maps to be generated with valid encrypted password fields, which is
necessary in order for
-.No non- Ns Fx
+.No non- Ns Dx Ns / Ns Fx
clients to perform user
authentication through
.Tn NIS .
@@ -278,7 +278,7 @@
the
.Em tcpwrapper
package is not distributed with
-.Fx .
+.Dx .
However, if you have
.Pa libwrap.a
and
@@ -307,7 +307,7 @@
.Tn NIS
v1 clients.
The
-.Fx
+.Dx
.Tn NIS
implementation only uses the
.Tn NIS
@@ -386,11 +386,11 @@
.Tn NIS
for hostname and address resolution.
The
-.Fx
+.Dx
resolver can be configured to do DNS
queries directly, therefore it is not necessary to enable this
option when serving only
-.Fx
+.Dx
.Tn NIS
clients.
.It Fl d
Index: usr.sbin/zic/zic.8
===================================================================
RCS file: /home/dcvs/src/usr.sbin/zic/zic.8,v
retrieving revision 1.2
diff -u -u -r1.2 zic.8
--- usr.sbin/zic/zic.8 17 Jun 2003 04:30:05 -0000 1.2
+++ usr.sbin/zic/zic.8 25 Feb 2004 23:04:40 -0000
@@ -62,7 +62,7 @@
.No "Link timezone localtime
.Ed
(Note that this action has no effect on
-.Fx ,
+.Dx ,
since the local time zone is specified in
.Pa /etc/localtime
and not
More information about the Submit
mailing list