aboutsummaryrefslogtreecommitdiff
path: root/share/man
diff options
context:
space:
mode:
authorRuslan Ermilov <ru@FreeBSD.org>2005-01-12 21:48:25 +0000
committerRuslan Ermilov <ru@FreeBSD.org>2005-01-12 21:48:25 +0000
commitc0854fb7b271bc41ecee43bf0a295a72a1fee859 (patch)
tree55387cdd0f8237d019daf115b9f1109b18fa54ef /share/man
parentc16a777f08b568f5ccb99481aeacd6d85ae194ba (diff)
downloadsrc-c0854fb7b271bc41ecee43bf0a295a72a1fee859.tar.gz
src-c0854fb7b271bc41ecee43bf0a295a72a1fee859.zip
Scheduled mdoc(7) sweep.
Notes
Notes: svn path=/head/; revision=140140
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man5/periodic.conf.52
-rw-r--r--share/man/man5/rc.conf.531
-rw-r--r--share/man/man7/firewall.72
-rw-r--r--share/man/man9/bpf.92
-rw-r--r--share/man/man9/ifnet.93
-rw-r--r--share/man/man9/mbuf_tags.98
-rw-r--r--share/man/man9/microtime.910
-rw-r--r--share/man/man9/microuptime.914
-rw-r--r--share/man/man9/module.917
-rw-r--r--share/man/man9/pfil.92
-rw-r--r--share/man/man9/physio.92
-rw-r--r--share/man/man9/printf.922
-rw-r--r--share/man/man9/sleepqueue.94
-rw-r--r--share/man/man9/suser.94
-rw-r--r--share/man/man9/sx.94
-rw-r--r--share/man/man9/taskqueue.913
-rw-r--r--share/man/man9/time.925
-rw-r--r--share/man/man9/vflush.92
-rw-r--r--share/man/man9/vm_map.94
19 files changed, 92 insertions, 79 deletions
diff --git a/share/man/man5/periodic.conf.5 b/share/man/man5/periodic.conf.5
index 611213c1912a..c09cadca6953 100644
--- a/share/man/man5/periodic.conf.5
+++ b/share/man/man5/periodic.conf.5
@@ -445,7 +445,7 @@ Set to the arguments to pass to the
.Xr diff 1
utility when generating differences.
The default is
-.Fl b Fl u .
+.Fl b u .
.It Va daily_status_security_chksetuid_enable
.Pq Vt bool
Set to
diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5
index bb1cff3d4ec4..1a339fb34964 100644
--- a/share/man/man5/rc.conf.5
+++ b/share/man/man5/rc.conf.5
@@ -254,7 +254,7 @@ to waste as little space as possible.
See
.Xr mdmfs 8
for other options you can use in
-.Li tmpmfs_flags .
+.Va tmpmfs_flags .
.It Va varmfs
Controls the creation of a
.Pa /var
@@ -284,7 +284,7 @@ to waste as little space as possible.
See
.Xr mdmfs 8
for other options you can use in
-.Li varmfs_flags .
+.Va varmfs_flags .
.It Va populate_var
Controls the automatic population of the
.Pa /var
@@ -723,7 +723,9 @@ appropriately.
.Pp
.Dl "device pf"
.Pp
-builds pf into the kernel.
+builds
+.Xr pf 4
+into the kernel.
Otherwise it is loaded from a module.
.It Va pf_rules
.Pq Vt str
@@ -1124,7 +1126,7 @@ parts.
.Pq Vt int
Number of times to attempt attaching to a
.Xr gbde 4
-device, i.e. how many times the user is asked for the pass-phrase.
+device, i.e., how many times the user is asked for the pass-phrase.
Default is 3.
.It Va gbde_swap_enable
.Pq Vt bool
@@ -1637,19 +1639,18 @@ If set to
.Dq Li YES ,
.Xr ntpd 8
is run with the
-.Op Fl g
+.Fl g
flag, which syncs the system's clock on startup.
See
.Xr ntpd 8
for more information regarding the
-.Op Fl g
+.Fl g
option.
This is a preferred alternative to using
.Xr ntpdate 1
or specifying the
-.Pa /etc/rc.conf
-tunable
-.Op Ar ntpdate_enable .
+.Va ntpdate_enable
+variable.
.It Va nis_client_enable
.Pq Vt bool
If set to
@@ -2256,7 +2257,7 @@ etc).
.It Va moused_nondefault_enable
.Pq Vt str
If set to
-.Dq Li NO
+.Dq Li NO ,
the mouse device specified on
the command line is not automatically treated as enabled by the
.Pa /etc/rc.d/moused
@@ -3079,16 +3080,20 @@ recover pre-maturely terminated
.Xr vi 1
sessions.
.It Va ugidfw_enable
-.Dq Li NO
-Load the
+.Pq Vt bool
+Set to
+.Dq Li YES
+to load the
.Xr mac_bsdextended 4
module upon system initialization and load a default
ruleset file.
.It Va bsdextended_script
-.Dq Pa /etc/rc.bsdextended
+.Pq Vt str
The default
.Xr mac_bsdextended 4
ruleset file to load.
+The default value of this variable is
+.Pa /etc/rc.bsdextended .
.It Va ramdisk_units
.Pq Vt str
A list of one or more ramdisk units to configure with
diff --git a/share/man/man7/firewall.7 b/share/man/man7/firewall.7
index 3ccb9943603e..1bb5cb577eab 100644
--- a/share/man/man7/firewall.7
+++ b/share/man/man7/firewall.7
@@ -422,7 +422,7 @@ to indirectly bind services that do not otherwise give you the option.
.Xr natd 8 ,
.Xr nfsd 8
.Sh ADDITIONAL READING
-.Bl -tag -width xxxx
+.Bl -tag -width indent
.It Nm Ipfilter
.Xr ipf 5 ,
.Xr ipf 8 ,
diff --git a/share/man/man9/bpf.9 b/share/man/man9/bpf.9
index 215717985b13..fa4beccc5a55 100644
--- a/share/man/man9/bpf.9
+++ b/share/man/man9/bpf.9
@@ -197,7 +197,7 @@ returns 0 when the program is not a valid filter program.
.\"
.Sh SEE ALSO
.Xr tcpdump 1 ,
-.Xr bpf 4 .
+.Xr bpf 4
.\"
.Sh HISTORY
The Enet packet filter was created in 1980 by Mike Accetta and
diff --git a/share/man/man9/ifnet.9 b/share/man/man9/ifnet.9
index cb9d70d5f918..86c972414d3b 100644
--- a/share/man/man9/ifnet.9
+++ b/share/man/man9/ifnet.9
@@ -731,8 +731,7 @@ the current value of
.Pq Vt time_t
The time the interface was attached or the last time the statistics
below were reset.
-.Va ifi_epoch
-is intended to be used to set the SNMP variable
+This is intended to be used to set the SNMP variable
.Va ifCounterDiscontinuityTime .
It may also be used to determine if two successive queries for an
interface of the same index have returned results for the same
diff --git a/share/man/man9/mbuf_tags.9 b/share/man/man9/mbuf_tags.9
index b83627a85ae5..861b0bb2ae0c 100644
--- a/share/man/man9/mbuf_tags.9
+++ b/share/man/man9/mbuf_tags.9
@@ -20,7 +20,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd Nov 18, 2004
+.Dd November 18, 2004
.Dt MBUF_TAGS 9
.Os
.Sh NAME
@@ -122,7 +122,7 @@ and
cookie, respectively.
.Va m_tag_free
points to
-.Ft _m_tag_free .
+.Fn m_tag_free_default .
Following this structure are
.Va m_tag_len
bytes of space that can be used to store tag-specific information.
@@ -227,7 +227,9 @@ Free
using its
.Va m_tag_free
method.
-.Ft _m_tag_free
+The
+.Fn m_tag_free_default
+function
is used by default.
.It Fn m_tag_init mbuf
Initialize the tag storage for packet
diff --git a/share/man/man9/microtime.9 b/share/man/man9/microtime.9
index 7926dba92bbd..411f825e4a6f 100644
--- a/share/man/man9/microtime.9
+++ b/share/man/man9/microtime.9
@@ -55,7 +55,7 @@ The
and
.Fn getbintime
functions store the system time as a
-.Ft struct bintime
+.Vt "struct bintime"
at the addresses specified by
.Fa bt .
The
@@ -63,19 +63,21 @@ The
and
.Fn getmicrotime
functions perform the same utility, but record the time as a
-.Ft struct timeval
+.Vt "struct timeval"
instead.
Similarly the
.Fn nanotime
and
.Fn getnanotime
functions store the time as a
-.Ft struct timespec .
+.Vt "struct timespec" .
.Pp
-.Fn Bintime ,
+The
+.Fn bintime ,
.Fn microtime ,
and
.Fn nanotime
+functions
always query the timecounter to return the current time as precisely as
possible.
Whereas
diff --git a/share/man/man9/microuptime.9 b/share/man/man9/microuptime.9
index 3e0b6ac00b66..8f9985f72aa9 100644
--- a/share/man/man9/microuptime.9
+++ b/share/man/man9/microuptime.9
@@ -22,9 +22,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $FreeBSD$
+.\" $FreeBSD$
.\"
-.Dd September, 16 2004
+.Dd September 16, 2004
.Dt MICROUPTIME 9
.Os
.Sh NAME
@@ -55,7 +55,7 @@ The
and
.Fn getbinuptime
functions store the time elapsed since boot as a
-.Ft struct bintime
+.Vt "struct bintime"
at the address specified by
.Fa bt .
The
@@ -63,19 +63,21 @@ The
and
.Fn getmicrouptime
functions perform the same utility, but record the elapsed time as a
-.Ft struct timeval
+.Vt "struct timeval"
instead.
Similarly the
.Fn nanouptime
and
.Fn getnanouptime
functions store the elapsed time as a
-.Ft struct timespec .
+.Vt "struct timespec" .
.Pp
-.Fn Binuptime ,
+The
+.Fn binuptime ,
.Fn microuptime ,
and
.Fn nanouptime
+functions
always query the timecounter to return the current time as precisely as
possible.
Whereas
diff --git a/share/man/man9/module.9 b/share/man/man9/module.9
index 39b95a40fd81..eb2c68bac6d3 100644
--- a/share/man/man9/module.9
+++ b/share/man/man9/module.9
@@ -56,7 +56,8 @@ argument set to
.Pp
On unload it is first called with
.Fa what
-set to MOD_QUIESCE .
+set to
+.Dv MOD_QUIESCE .
If the unload was not forced, a non-zero return will prevent the
unload from happening.
.Pp
@@ -66,8 +67,14 @@ is set to
.Dv MOD_UNLOAD .
If the module returns non-zero to this, the unload will not happen.
.Pp
-The difference between MOD_QUIESCE and MOD_UNLOAD is that the module
-should fail MOD_QUIESCE if it is currently in use, whereas MOD_UNLOAD
+The difference between
+.Dv MOD_QUIESCE
+and
+.Dv MOD_UNLOAD
+is that the module should fail
+.Dv MOD_QUIESCE
+if it is currently in use, whereas
+.Dv MOD_UNLOAD
should only fail if it is impossible to unload the module, for instance
because there are memory references to the module which cannot be revoked.
.Pp
@@ -76,7 +83,9 @@ When the system is shutting down,
contains the value of
.Dv MOD_SHUTDOWN .
.Pp
-The module should return EOPNOTSUPP for unrecognized values of
+The module should return
+.Er EOPNOTSUPP
+for unrecognized values of
.Fa what .
.Sh EXAMPLES
.Bd -literal
diff --git a/share/man/man9/pfil.9 b/share/man/man9/pfil.9
index b02ca89c5af8..cf10e2505cb5 100644
--- a/share/man/man9/pfil.9
+++ b/share/man/man9/pfil.9
@@ -207,7 +207,7 @@ This means that traffic may be dropped unconditionally for a short period
of time.
.Fn pfil_run_hooks
will return
-.Dv ENOBUFS
+.Er ENOBUFS
to indicate this.
.Sh SEE ALSO
.Xr bpf 4 ,
diff --git a/share/man/man9/physio.9 b/share/man/man9/physio.9
index 8d6b0948ad65..c4f24a880905 100644
--- a/share/man/man9/physio.9
+++ b/share/man/man9/physio.9
@@ -72,7 +72,7 @@ Since
.Fa uio
normally describes user space addresses,
.Fn physio
-needs to lock the those pages into memory.
+needs to lock those pages into memory.
This is done by calling
.Fn vmapbuf
for the appropriate pages.
diff --git a/share/man/man9/printf.9 b/share/man/man9/printf.9
index 8a8d34044978..07fbd776f24d 100644
--- a/share/man/man9/printf.9
+++ b/share/man/man9/printf.9
@@ -36,13 +36,13 @@
.In sys/types.h
.In sys/systm.h
.Ft int
-.Fn printf "const char *fmt" "..."
+.Fn printf "const char *fmt" ...
.Ft void
-.Fn tprintf "struct proc *p" "int pri" "const char *fmt" "..."
+.Fn tprintf "struct proc *p" "int pri" "const char *fmt" ...
.Ft int
-.Fn uprintf "const char *fmt" "..."
+.Fn uprintf "const char *fmt" ...
.Ft void
-.Fn log "int pri" "const char *fmt" "..."
+.Fn log "int pri" "const char *fmt" ...
.Sh DESCRIPTION
The
.Xr printf 9
@@ -61,7 +61,7 @@ function outputs to the tty associated with the process
.Fa p
and the logging facility if
.Fa pri
-is not \&-1.
+is not \-1.
The
.Fn log
function sends the message to the kernel logging facility, using
@@ -86,7 +86,7 @@ These are used as a register value and a print mask for decoding bitmasks.
The print mask is made up of two parts: the base and the
arguments.
The base value is the output base expressed as an integer value;
-for example, \\10 gives octal and \\20 gives hexadecimal.
+for example, \e10 gives octal and \e20 gives hexadecimal.
The arguments are made up of a sequence of bit identifiers.
Each bit identifier begins with an integer value which is the number of the
bit this identifier describes.
@@ -126,7 +126,7 @@ parameter (mistakenly called
here).
Alternatively, if a
.Fa pri
-of \&-1 is given, the message will be appended to the last log message
+of \-1 is given, the message will be appended to the last log message
started by a previous call to
.Fn log .
As these messages are generated by the kernel itself, the facility will
@@ -146,8 +146,8 @@ void
printf_test(void)
{
- printf("reg=%b\\n", 3, "\\10\\2BITTWO\\1BITONE\\n");
- printf("out: %4D\\n", "AAAA", ":");
+ printf("reg=%b\en", 3, "\e10\e2BITTWO\e1BITONE\en");
+ printf("out: %4D\en", "AAAA", ":");
}
.Ed
.Pp
@@ -159,11 +159,11 @@ out: 41:41:41:41
.Pp
The call
.Bd -literal -offset indent
-log(LOG_DEBUG, "%s%d: been there.\\n", sc->sc_name, sc->sc_unit);
+log(LOG_DEBUG, "%s%d: been there.\en", sc->sc_name, sc->sc_unit);
.Ed
.Pp
will add the appropriate debug message at priority
-.Em kern.debug
+.Dq Li kern.debug
to the system log.
.Sh SEE ALSO
.Xr printf 3 ,
diff --git a/share/man/man9/sleepqueue.9 b/share/man/man9/sleepqueue.9
index 84410483edfd..eac8ec624d95 100644
--- a/share/man/man9/sleepqueue.9
+++ b/share/man/man9/sleepqueue.9
@@ -155,7 +155,7 @@ The
parameter is a bitmask consisting of the type of sleep queue being slept on
and zero or more optional flags.
There are currently two types of sleep queues:
-.Bl -tag -width SLEEPQ_CONDVAR
+.Bl -tag -width ".Dv SLEEPQ_CONDVAR"
.It Dv SLEEPQ_CONDVAR
A sleep queue used to implement condition variables.
.It Dv SLEEPQ_MSLEEP
@@ -167,7 +167,7 @@ and
.El
.Pp
There is currently only one optional flag:
-.Bl -tag -width SLEEPQ_INTERRUPTIBLE
+.Bl -tag -width ".Dv SLEEPQ_INTERRUPTIBLE"
.It Dv SLEEPQ_INTERRUPTIBLE
The current thread is entering an interruptible sleep.
.El
diff --git a/share/man/man9/suser.9 b/share/man/man9/suser.9
index 5a8def803445..2c62007ffcef 100644
--- a/share/man/man9/suser.9
+++ b/share/man/man9/suser.9
@@ -129,5 +129,5 @@ The
.Fn suser
and
.Fn suser_cred
-functions don't, in fact, record that superuser privileges have been
-used, and haven't done so since August 2000.
+functions do not, in fact, record that superuser privileges have been
+used, and have not done so since August 2000.
diff --git a/share/man/man9/sx.9 b/share/man/man9/sx.9
index 9e5f0eb92bf2..e0781b722bce 100644
--- a/share/man/man9/sx.9
+++ b/share/man/man9/sx.9
@@ -26,7 +26,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd August 14, 2001
+.Dd January 5, 2005
.Dt SX 9
.Os
.Sh NAME
@@ -72,7 +72,7 @@
.Ft void
.Fn sx_assert "struct sx *sx" "int what"
.\"
-.Ss sx utility macros
+.Ss Nm Ss utility macros
.Fn sx_unlock "struct sx *sx"
.Fn SX_SYSINIT "name" "struct sx *sx" "const char *description"
.\"
diff --git a/share/man/man9/taskqueue.9 b/share/man/man9/taskqueue.9
index add0a65135ef..1a539116ce32 100644
--- a/share/man/man9/taskqueue.9
+++ b/share/man/man9/taskqueue.9
@@ -166,7 +166,7 @@ Three macros
and
.Fn TASKQUEUE_DEFINE_THREAD "name"
are used to declare a reference to a global queue, to define the
-implementation of the queue, and declare a queue that uses it's own thread.
+implementation of the queue, and declare a queue that uses its own thread.
The
.Fn TASKQUEUE_DEFINE
macro arranges to call
@@ -187,8 +187,8 @@ allowing any further initialisation to be performed
.Pp
The
.Fn TASKQUEUE_DEFINE_THREAD
-macro defines a new taskqueue with it's own kernel thread to serve tasks. The
-variable
+macro defines a new taskqueue with its own kernel thread to serve tasks.
+The variable
.Vt struct proc *taskqueue_name_proc
is defined which contains the kernel thread serving the tasks.
The variable
@@ -213,12 +213,11 @@ To use these queues,
call
.Fn taskqueue_enqueue
with the value of the global taskqueue variable for the queue you wish to
-use (
-.Va taskqueue_swi ,
+use
+.Va ( taskqueue_swi ,
.Va taskqueue_swi_giant ,
or
-.Va taskqueue_thread
-).
+.Va taskqueue_thread ) .
.Pp
The software interrupt queues can be used,
for instance, for implementing interrupt handlers which must perform a
diff --git a/share/man/man9/time.9 b/share/man/man9/time.9
index 8153a8687f0d..d7916147d2b8 100644
--- a/share/man/man9/time.9
+++ b/share/man/man9/time.9
@@ -35,20 +35,16 @@
.Dt TIME 9
.Os
.Sh NAME
-.In sys/time.h
.Nm boottime ,
.Nm time_second ,
.Nm time_uptime
.Nd system time variables
.Sh SYNOPSIS
-.Bl -item -compact
-.It
-.Va extern struct timeval boottime ;
-.It
-.Va extern struct time_t time_second ;
-.It
-.Va extern struct timeval time_uptime ;
-.El
+.In sys/time.h
+.Pp
+.Vt extern struct timeval boottime ;
+.Vt extern struct time_t time_second ;
+.Vt extern struct timeval time_uptime ;
.Sh DESCRIPTION
The
.Va boottime
@@ -61,7 +57,8 @@ variable is the system's
clock to the second.
.Pp
The
-.Va time_uptime variable is the number of seconds since boot.
+.Va time_uptime
+variable is the number of seconds since boot.
.Pp
The
.Xr bintime 9,
@@ -70,7 +67,7 @@ The
.Xr getmicrotime 9 ,
.Xr nanotime 9 ,
and
-.Xr getnanotime 9 ,
+.Xr getnanotime 9
functions can be used to get the current time more accurately and in an
atomic manner.
Similarly, the
@@ -81,13 +78,12 @@ The
.Xr getmicrouptime 9 ,
.Xr nanouptime 9 ,
and
-.Xr getnanouptime 9 ,
+.Xr getnanouptime 9
functions can be used to get the time elapse since boot more accurately
and in an atomic manner.
The
.Va boottime
variable may be read and written without special precautions.
-.Pp
.Sh SEE ALSO
.Xr clock_settime 2 ,
.Xr ntp_adjtime 2 ,
@@ -107,8 +103,7 @@ variable may be read and written without special precautions.
.Rs
.%A "Poul-Henning Kamp"
.%T "Timecounters: Efficient and precise timekeeping in SMP kernels"
-.%J "Proceedings of EuroBSDCon 2002"
-.%C "Amsterdam"
+.%J "Proceedings of EuroBSDCon 2002, Amsterdam"
.%O /usr/share/doc/papers/timecounter.ascii.gz
.Re
.Rs
diff --git a/share/man/man9/vflush.9 b/share/man/man9/vflush.9
index 1123ea3a6984..8d413e564018 100644
--- a/share/man/man9/vflush.9
+++ b/share/man/man9/vflush.9
@@ -67,7 +67,7 @@ flag set will be skipped.
If set, only regular files currently opened for writing will be removed.
.El
.It Fa td
-thread performing the vflush.
+The calling thread.
.El
.Sh RETURN VALUES
A value of 0 is returned if the flush is successful; otherwise,
diff --git a/share/man/man9/vm_map.9 b/share/man/man9/vm_map.9
index 4491a26d4017..ca081cde42c4 100644
--- a/share/man/man9/vm_map.9
+++ b/share/man/man9/vm_map.9
@@ -101,7 +101,7 @@ Pointer to the underlying physical map with which this virtual map
is associated.
.It Va min_offset
The minimum
-.Va vm_offset_t
+.Vt vm_offset_t
in this map.
Programs should never use
.Va header.start
@@ -114,7 +114,7 @@ and
instead.
.It Va max_offset
The maximum
-.Va vm_offset_t
+.Vt vm_offset_t
in this map.
.El
.Pp