summaryrefslogtreecommitdiffstats
path: root/share/man/man5
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2004-06-16 08:33:57 +0000
committerru <ru@FreeBSD.org>2004-06-16 08:33:57 +0000
commitaa52a5a900bdec01cd64392151f45ae2b913614b (patch)
tree45340076f670c5a33c9f8979cfb69f5797c2be57 /share/man/man5
parent075deb0c4c016fbd1931955599b44e3592fa397c (diff)
downloadFreeBSD-src-aa52a5a900bdec01cd64392151f45ae2b913614b.zip
FreeBSD-src-aa52a5a900bdec01cd64392151f45ae2b913614b.tar.gz
Assorted markup, spelling, and grammar fixes.
Diffstat (limited to 'share/man/man5')
-rw-r--r--share/man/man5/config.55
-rw-r--r--share/man/man5/devfs.53
-rw-r--r--share/man/man5/hosts.lpd.54
-rw-r--r--share/man/man5/libmap.conf.518
-rw-r--r--share/man/man5/make.conf.516
-rw-r--r--share/man/man5/periodic.conf.520
-rw-r--r--share/man/man5/rc.conf.592
-rw-r--r--share/man/man5/remote.54
-rw-r--r--share/man/man5/resolver.527
9 files changed, 111 insertions, 78 deletions
diff --git a/share/man/man5/config.5 b/share/man/man5/config.5
index 52ff0f8..63d7b32 100644
--- a/share/man/man5/config.5
+++ b/share/man/man5/config.5
@@ -23,7 +23,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd July 3, 2003
+.Dd May 13, 2004
.Dt CONFIG 5
.Os
.Sh NAME
@@ -128,7 +128,8 @@ embedded environments that do not start from
.\" -------- FILES --------
.It Ic files Ar filename
Specifies a file containing a list of files specific to that kernel
-configuration file (ala files.ARCH).
+configuration file (a la
+.Pa files. Ns Aq Ar arch ) .
.\" -------- HINTS --------
.It Ic hints Ar filename
Specifies a file to load a static device configuration specification
diff --git a/share/man/man5/devfs.5 b/share/man/man5/devfs.5
index f4067be..8ef5841 100644
--- a/share/man/man5/devfs.5
+++ b/share/man/man5/devfs.5
@@ -64,7 +64,8 @@ mount point.
.Pp
The
.Xr mknod 8
-tool can be used to recover deleted device entries under devfs.
+tool can be used to recover deleted device entries under
+.Nm .
.Sh FILES
.Bl -tag -width /dev/XXXX -compact
.It Pa /dev
diff --git a/share/man/man5/hosts.lpd.5 b/share/man/man5/hosts.lpd.5
index 35a9b3a..910ac66 100644
--- a/share/man/man5/hosts.lpd.5
+++ b/share/man/man5/hosts.lpd.5
@@ -46,7 +46,9 @@ List every hostname or IP address on a line itself.
.Pp
If you want to allow access for any and all host,
you can usually use the NIS netgroups feature to
-do this by adding a line with a single '+' character.
+do this by adding a line with a single
+.Ql +
+character.
.Sh FILES
.Bl -tag -width /etc/hosts.lpdxxxxx -compact
.It Pa /etc/hosts.lpd
diff --git a/share/man/man5/libmap.conf.5 b/share/man/man5/libmap.conf.5
index 784aa37..4299e58 100644
--- a/share/man/man5/libmap.conf.5
+++ b/share/man/man5/libmap.conf.5
@@ -48,7 +48,7 @@ executable or library in brackets.
All mappings following a constraint will only be evaluated for that constraint.
Constraints can be one of three types:
.Bl -tag -width indent
-.It Exact
+.It Exact
The constraint is matched literally so that only an executable with an
identical fully qualified pathname will match the constraint.
This means that the executable
@@ -61,10 +61,10 @@ This is the default constraint type.
A constraint with no path is matched against the basename of the
executable.
.Pa foo
-will match
+will match
.Pa /bin/foo ,
.Pa /usr/local/sbin/foo ,
-or any other executable named
+or any other executable named
.Pa foo ,
no matter what its path is.
.It Directory
@@ -74,16 +74,16 @@ pathname of the executable.
will match any executable with a path starting with /usr/bin.
.El
.Pp
-Note that the executable path matched against is the
-.Pa path
-parameter in an
+Note that the executable path matched against is the
+.Fa path
+parameter in an
.Fn exec*
-function call.
+function call.
The Directory or Exact constraints can only match when the executable
is called with a full pathname.
Most programs executed from a shell are run without a full path, via
.Fn exec*p ,
-so the Basename constraint type is the most useful.
+so the Basename constraint type is the most useful.
.Pp
WARNING!
Constrained mappings must never appear first in the configuration file.
@@ -95,7 +95,7 @@ The most common use at the date of writing is for allowing multiple
.Tn POSIX
threading libraries to be used on a system without relinking or
changing symlinks.
-.Sh EXAMPLE
+.Sh EXAMPLES
.Bd -literal
# /etc/libmap.conf
#
diff --git a/share/man/man5/make.conf.5 b/share/man/man5/make.conf.5
index 1b82ab9..df86cc3 100644
--- a/share/man/man5/make.conf.5
+++ b/share/man/man5/make.conf.5
@@ -609,7 +609,9 @@ Set to disable the installation of
as an suid root program.
.It Va SENDMAIL_MC
.Pq Vt str
-The default m4 configuration file to use at install time.
+The default
+.Xr m4 1
+configuration file to use at install time.
The value should include the full path to the
.Pa .mc
file, e.g.,
@@ -621,7 +623,9 @@ Note that
is now deprecated.
.It Va SENDMAIL_SUBMIT_MC
.Pq Vt str
-The default m4 configuration file for mail submission
+The default
+.Xr m4 1
+configuration file for mail submission
to use at install time.
The value should include the full path to the
.Pa .mc
@@ -643,14 +647,18 @@ file(s), e.g.,
.Pa /etc/mail/bar.mc .
.It Va SENDMAIL_CF_DIR
.Pq Vt str
-Override the default location for the m4 configuration files used to build a
+Override the default location for the
+.Xr m4 1
+configuration files used to build a
.Pa .cf
file from a
.Pa .mc
file.
.It Va SENDMAIL_M4_FLAGS
.Pq Vt str
-Flags passed to m4 when building a
+Flags passed to
+.Xr m4 1
+when building a
.Pa .cf
file from a
.Pa .mc
diff --git a/share/man/man5/periodic.conf.5 b/share/man/man5/periodic.conf.5
index 82e057d..dc6a9b8 100644
--- a/share/man/man5/periodic.conf.5
+++ b/share/man/man5/periodic.conf.5
@@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd June 22, 2000
+.Dd May 30, 2004
.Dt PERIODIC.CONF 5
.Os
.Sh NAME
@@ -659,25 +659,31 @@ As an example, this variable might be set to
if the portupgrade port has been installed.
.It Va pkg_version_index
.Pq Vt string
-This variable specifies the INDEX file from
+This variable specifies the
+.Pa INDEX
+file from
.Pa /usr/ports
that should be used by
.Xr pkg_version 1 .
Because the dependency tree may be substantially different between versions of
.Fx ,
-there may be more than one INDEX file in
+there may be more than one
+.Pa INDEX
+file in
.Pa /usr/ports .
.Pp
Note, if the
.Va pkg_version
variable is set to
-.Dq portversion ,
-it will also be necessary to arrange that the correct INDEX file is specified
+.Dq Li portversion ,
+it will also be necessary to arrange that the correct
+.Pa INDEX
+file is specified
using environment variables and that
-.Dq pkg_version_index
+.Va pkg_version_index
is cleared in
.Pa /etc/periodic.conf
-.Pq pkg_version_index= .
+.Pq Dq Li pkg_version_index= .
.It Va weekly_local
.Pq Vt str
Set to a list of extra scripts that should be run after all other
diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5
index 7543dc6..a30e490 100644
--- a/share/man/man5/rc.conf.5
+++ b/share/man/man5/rc.conf.5
@@ -226,33 +226,35 @@ based cards.
List of removable network interfaces to be supported by
.Pa /etc/pccard_ether .
.It Va tmpmfs
-Controls the creation of an mfs
+Controls the creation of a
.Pa /tmp
-file system.
+memory file system.
Always happens if set to
.Dq Li YES
and never happens if set to
.Dq Li NO .
-If set anything else, a memory file system is created if
+If set to anything else, a memory file system is created if
.Pa /tmp
is not writable.
.It Va tmpsize
-Controls the size of a created mfm
-.Pa /tmp .
+Controls the size of a created
+.Pa /tmp
+memory file system.
.It Va varmfs
-Controls the creation of an mfs
+Controls the creation of a
.Pa /var
-file system.
+memory file system.
Always happens if set to
.Dq Li YES
and never happens if set to
.Dq Li NO .
-If set anything else, a memory file system is created if
+If set to anything else, a memory file system is created if
.Pa /var
is not writable.
.It Va varsize
-Controls the size of a created mfm
-.Pa /var .
+Controls the size of a created
+.Pa /var
+memory file system.
.It Va populate_var
Controls the automatic population of the
.Pa /var
@@ -261,7 +263,9 @@ Always happens if set to
.Dq Li YES
and never happens if set to
.Dq Li NO .
-If set anything else, a memory file system is created if /tmp is not writable.
+If set to anything else, a memory file system is created if
+.Pa /tmp
+is not writable.
Note that this process requires access to certain commands in
.Pa /usr
before
@@ -673,9 +677,8 @@ enables
packet filtering.
.Pp
Typical usage will require putting
-.Bd -literal
-pf_enable="YES"
-.Ed
+.Pp
+.Dl pf_enable="YES"
.Pp
into
.Pa /etc/rc.conf
@@ -684,7 +687,7 @@ and editing
appropriately.
.Pp
Having
-.Bd -literal
+.Bd -literal -offset indent
options PFIL_HOOKS
options RANDOM_IP_ID
.Ed
@@ -693,14 +696,14 @@ in the kernel configuration file is required for use as a
.Xr kld 4
module.
.Pp
-.Bd -literal
-device pf
-.Ed
+.Dl "device pf"
.Pp
builds it into the kernel.
.It Va pf_rules
.Pq Vt str
-Path to pf ruleset configuration file
+Path to
+.Xr pf 4
+ruleset configuration file
(default
.Pa /etc/pf.conf ) .
.It Va pf_program
@@ -738,7 +741,7 @@ is set to
.Dq Li YES
this controls where
.Xr pflogd 8
-stores the logfile.
+stores the logfile
(default
.Pa /var/log/pflog ) .
Check
@@ -1959,7 +1962,8 @@ Also refer to the files in
for more detailed configuration information.
.It Va atm_load
.Pq Vt str
-This is a list of physical ATM interface drivers to load. Typical values are
+This is a list of physical ATM interface drivers to load.
+Typical values are
.Dq Li hfa_pci
and/or
.Dq Li hea_pci .
@@ -2947,46 +2951,52 @@ and
in time to be mounted from
.Xr fstab 5 .
Each listed unit
-.Nm X
+.Ar X
must specify at least a
.Ar type
in a
-.Nm ramdisk_X_config
+.Va ramdisk_ Ns Ao Ar X Ac Ns Va _config
variable.
-.It Va ramdisk_X_config
+.It Va ramdisk_ Ns Ao Ar X Ac Ns Va _config
.Pq Vt str
Arguments to
.Xr mdconfig 8
for ramdisk
-.Nm X .
-At minimum a
-.Fl Ar t type
-must be specified, where
+.Ar X .
+At minimum a
+.Fl t Ar type
+must be specified, where
.Ar type
must be one of
-.Nm malloc
+.Cm malloc
or
-.Nm swap .
-.It Va ramdisk_X_newfs
+.Cm swap .
+.It Va ramdisk_ Ns Ao Ar X Ac Ns Va _newfs
.Pq Vt str
-Optional arguments passed to
+Optional arguments passed to
.Xr newfs 8
to initialize ramdisk
-.Nm X .
-.It Va ramdisk_X_owner
+.Ar X .
+.It Va ramdisk_ Ns Ao Ar X Ac Ns Va _owner
.Pq Vt str
An ownership specification passed to
.Xr chown 8
after the specified ramdisk unit
-.Nm X
-has been mounted. Both the md device and the mount point will be changed.
-.It Va ramdisk_X_perms
+.Ar X
+has been mounted.
+Both the
+.Xr md 4
+device and the mount point will be changed.
+.It Va ramdisk_ Ns Ao Ar X Ac Ns Va _perms
.Pq Vt str
A mode string passed to
.Xr chmod 1
after the specified ramdisk unit
-.Nm X
-has been mounted. Both the md device and the mount point will be changed.
+.Ar X
+has been mounted.
+Both the
+.Xr md 4
+device and the mount point will be changed.
.El
.Sh FILES
.Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
@@ -3001,6 +3011,7 @@ has been mounted. Both the md device and the mount point will be changed.
.Xr info 1 ,
.Xr kbdcontrol 1 ,
.Xr makewhatis 1 ,
+.Xr vi 1 ,
.Xr vidcontrol 1 ,
.Xr ip 4 ,
.Xr kld 4 ,
@@ -3038,9 +3049,9 @@ has been mounted. Both the md device and the mount point will be changed.
.Xr rc.sendmail 8 ,
.Xr route 8 ,
.Xr routed 8 ,
+.Xr rpcbind 8 ,
.Xr rpc.lockd 8 ,
.Xr rpc.statd 8 ,
-.Xr rpcbind 8 ,
.Xr rwhod 8 ,
.Xr savecore 8 ,
.Xr sshd 8 ,
@@ -3049,7 +3060,6 @@ has been mounted. Both the md device and the mount point will be changed.
.Xr syslogd 8 ,
.Xr timed 8 ,
.Xr usbd 8 ,
-.Xr vi 1 ,
.Xr vinum 8 ,
.Xr yp 8 ,
.Xr ypbind 8 ,
diff --git a/share/man/man5/remote.5 b/share/man/man5/remote.5
index 33ac813..e50f1f3 100644
--- a/share/man/man5/remote.5
+++ b/share/man/man5/remote.5
@@ -207,5 +207,7 @@ The
file format appeared in
.Bx 4.2 .
.Sh BUGS
-Tip uses its own notion of the serial ports data rate rather than the
+The
+.Xr tip 1
+utility uses its own notion of the serial ports data rate rather than the
system default for a serial port.
diff --git a/share/man/man5/resolver.5 b/share/man/man5/resolver.5
index 535b54e..51b730e 100644
--- a/share/man/man5/resolver.5
+++ b/share/man/man5/resolver.5
@@ -32,7 +32,7 @@
.\" @(#)resolver.5 8.1 (Berkeley) 6/5/93
.\" $FreeBSD$
.\"
-.Dd November 11, 1993
+.Dd December 7, 2003
.Dt RESOLVER 5
.Os
.Sh NAME
@@ -83,7 +83,8 @@ If no
entry is present, the domain is determined
from the local host name returned by
.Xr gethostname 3 ;
-the domain part is taken to be everything after the first `.'.
+the domain part is taken to be everything after the first
+.Ql \&. .
Finally, if the host name does not contain a domain part, the root
domain is assumed.
.It Sy search
@@ -113,8 +114,9 @@ The IP address
and optional network pairs are separated by slashes.
Up to 10 pairs may
be specified.
+E.g.,
.Pp
-e.g. sortlist 130.155.160.0/255.255.240.0 130.155.0.0
+.Dl "sortlist 130.155.160.0/255.255.240.0 130.155.0.0"
.It Sy options
Options allows certain internal resolver variables to be modified.
The syntax is
@@ -148,21 +150,22 @@ will be tried first as an absolute name before any
elements are appended to it.
.It Sy timeout: Ns Ar n
sets the amount of time the resolver will wait for a response from a remote
-name server before retrying the query via a different name server. Measured in
-seconds, the default is
+name server before retrying the query via a different name server.
+Measured in seconds, the default is
.Dv RES_TIMEOUT
(see
-.Pa <resolv.h> ) .
+.In resolv.h ) .
.It Sy attempts: Ns Ar n
sets the number of times the resolver will send a query to its name servers
-before giving up and returning an error to the calling application. The
-default is
+before giving up and returning an error to the calling application.
+The default is
.Dv RES_DFLRETRY
(see
-.Pa <resolv.h> ) .
+.In resolv.h ) .
.It Sy no_tld_query
tells the resolver not to attempt to resolve a top level domain name, that
-is, a name that contains no dots. Use of this option doesn't prevent
+is, a name that contains no dots.
+Use of this option does not prevent
the resolver from obeying the standard
.Sy domain
and
@@ -186,8 +189,8 @@ the last instance will override.
The keyword and value must appear on a single line, and the keyword
(e.g.\&
.Sy nameserver )
-must start the line. The value follows
-the keyword, separated by white space.
+must start the line.
+The value follows the keyword, separated by white space.
.Sh FILES
.Bl -tag -width /etc/resolv.conf -compact
.It Pa /etc/resolv.conf
OpenPOWER on IntegriCloud