d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Assorted mdoc(7), grammar, spelling, and punctuation fixes.

Browse Source 
Approved by:	re (blanket)
This commit is contained in:
Ruslan Ermilov 2003-05-21 15:49:01 +00:00
parent 3e32fa3860
commit c8185672b2
11 changed files with 123 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
share/man/man5/procfs.5
View File

@ -173,7 +173,7 @@ is the effective group id)
all comma separated.
.It
the hostname of the jail in which the process runs, or
.Sq Li -
.Ql -
to indicate that the process is not running within a jail.
.El
.El

60
share/man/man5/rc.conf.5
View File

@ -157,13 +157,13 @@ files are generated.
.Pq Vt str
Empty by default.
A semi-colon
.Pq Dq \&;
.Pq Ql \&;
delimited list of paths containing
.Xr kld 4
modules.
If empty,
the contents of the
.Em kern.module_path
.Va kern.module_path
.Xr sysctl 8
are used.
.It Va pccard_enable
@ -702,7 +702,7 @@ for more information.
.It Va ip_portrange_first
.Pq Vt int
If not set to
.Dq Li NO
.Dq Li NO ,
this is the first port in the default portrange.
Refer to
.Xr ip 4
@ -710,7 +710,7 @@ for more information.
.It Va ip_portrange_last
.Pq Vt int
If not set to
.Dq Li NO
.Dq Li NO ,
this is the last port in the default portrange.
Refer to
.Xr ip 4
@ -796,12 +796,12 @@ Aliases should be set as
.Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
.Va ipv6_prefix_ Ns Aq Ar interface
does something.
Interfaces that does not have a
Interfaces that do not have a
.Va ipv6_ifconfig_ Ns Aq Ar interface
setting will auto configures by
setting will be auto configured by
.Xr rtsol 8
if the
.Ar ipv6_gateway_enable
.Va ipv6_gateway_enable
is set to
.Dq Li NO .
Note that the IPv6 networking code does not support the
@ -810,7 +810,7 @@ files.
.It Va ipv6_default_interface
.Pq Vt str
If not set to
.Dq Li NO
.Dq Li NO ,
this is the default output interface for scoped addresses.
Now this works only for IPv6 link local multicast addresses.
.It Va cloned_interfaces
@ -1495,7 +1495,7 @@ daemon.
If set to
.Dq Li YES ,
run the
rpc.ypupdated
.Nm rpc.ypupdated
daemon at system boot time.
.It Va defaultrouter
.Pq Vt str
@ -1534,7 +1534,7 @@ in the value, a
.Va ipv6_route_ Ns Aq Ar element
variable is assumed to exist
whose contents will later be passed to a
.Dq Nm route Cm add -inet6
.Dq Nm route Cm add Fl inet6
operation.
.It Va gateway_enable
.Pq Vt bool
@ -1735,7 +1735,7 @@ daemon.
.It Va stf_interface_ipv4addr
.Pq Vt str
If not set to
.Dq Li NO
.Dq Li NO ,
this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
interface).
Specify this entry to enable the 6to4 interface.
@ -1745,7 +1745,7 @@ Prefix length for 6to4 IPv4 addresses, to limit peer address range.
An effective value is 0-31.
.It Va stf_interface_ipv6_ifid
.Pq Vt str
IPv6 interface id for
IPv6 interface ID for
.Xr stf 4 .
This can be set to
.Dq Li AUTO .
@ -1756,7 +1756,7 @@ IPv6 Site Level Aggregator for
.It Va ipv6_faith_prefix
.Pq Vt str
If not set to
.Dq Li NO
.Dq Li NO ,
this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
translator.
You also need
@ -1767,7 +1767,7 @@ setup.
If set to
.Dq Li YES
this enables IPv4 mapped IPv6 address communication (like
::ffff:a.b.c.d).
.Li ::ffff:a.b.c.d ) .
.It Va atm_enable
.Pq Vt bool
Set to
@ -2260,12 +2260,12 @@ initial boot time.
.It Va svr4_enable
.Pq Vt bool
If set to
.Dq Li YES
.Dq Li YES ,
enable SysVR4 emulation at boot time.
.It Va sysvipc_enable
.Pq Vt bool
If set to
.Dq Li YES
.Dq Li YES ,
load System V IPC primitives at boot time.
.It Va clear_tmp_enable
.Pq Vt bool
@ -2282,10 +2282,12 @@ NOTE:
.Pa /usr/lib
will always be added first, so it need not appear in this list.
.It Va ldconfig_paths_aout
.Pq str
.Pq Vt str
Set to the list of shared library paths to use with
.Xr ldconfig 8 .
legacy aout support.
.Xr ldconfig 8
legacy
.Xr a.out 5
support.
.It Va ldconfig_insecure
.Pq Vt bool
The
@ -2350,7 +2352,7 @@ these are the flags to pass to the
.Xr sshd 8
daemon.
.It Va usbd_enable
.Pq bool
.Pq Vt bool
If set to
.Dq Li YES ,
run the
@ -2387,22 +2389,26 @@ jail_vjail_rootdir="/var/jails/vjail/root"
jail_vjail_exec="/bin/sh /etc/rc"
.Ed
.Pp
The last one is optional. It defaults to
The last one is optional.
It defaults to
.Pa /etc/rc
if it is not set.
.It Va jail_set_hostname_allow
.Pq Vt bool
If set to NO,
If set to
.Dq Li NO ,
do not allow the root user in a jail to set its hostname.
.It Va jail_socket_unixiproute_only
.Pq Vt bool
If set to NO,
If set to
.Dq Li NO ,
do not allow any protocol,
besides TCP/IP,
to be used within a jail.
.It Va jail_sysvipc_allow
.Pq Vt bool
If set to YES,
If set to
.Dq Li YES ,
allow applications within a jail to use System V IPC.
.It Va unaligned_print
.Pq Vt bool
@ -2662,12 +2668,12 @@ device as early as possible in the boot process.
.It Va entropy_save_sz
.Pq Vt int
Size of the entropy cache files saved by
save-entropy
.Nm save-entropy
periodically.
.It Va entropy_save_num
.Pq Vt int
Number of entropy cache files to save by
save-entropy
.Nm save-entropy
periodically.
.It Va ipsec_enable
.Pq Vt bool
@ -2680,7 +2686,7 @@ on
at boot time.
.It Va ipsec_file
.Pq Vt str
Config file for
Configuration file for
.Xr setkey 8 .
.It Va dmesg_enable
.Pq Vt bool

14
share/man/man7/release.7
View File

@ -89,8 +89,7 @@ release documentation, and so on.
.Pp
This target must be built as root with the
.Va kern.securelevel
sysctl set to -1
.Pq "the default".
sysctl set to \-1 (the default).
.It Cm rerelease
Assumes that the output of a release build has been manually modified,
and performs the minimal number of steps to rebuild the release using
@ -474,12 +473,13 @@ and
This manual page was written by
.An Murray Stokely Aq murray@FreeBSD.org .
.Sh BUGS
Infrastructure changes are occassionally made to the FreeBSD
Infrastructure changes are occassionally made to the
.Fx
documentation set in such a way that release builds on security
branches can fail.
To work around this, release builds can be made to checkout the
documentation from the last fully supported release of FreeBSD.
documentation from the last fully supported release of
.Fx .
For example:
.Bd -literal -offset indent
make release RELEASETAG=RELENG_4_5 DOCRELEASETAG=RELEASE_4_5_0 ...
.Ed
.Pp
.Dl "make release RELEASETAG=RELENG_4_5 DOCRELEASETAG=RELEASE_4_5_0 ..."

4
share/man/man7/tuning.7
View File

@ -776,10 +776,10 @@ with
so you should not need to modify this parameter except under extreme
circumstances.
See the
.Dq TUNING
.Sx TUNING
section in the
.Xr sendfile 2
man page for details.
manual page for details.
.Sh KERNEL CONFIG TUNING
There are a number of kernel options that you may have to fiddle with in
a large-scale system.

8
share/man/man9/BUS_SETUP_INTR.9
View File

@ -85,14 +85,16 @@ will be called with the value
as its only argument.
.Pp
The
.Fa cookiep
argument is a pointer to a void * that
.Fa cookiep
argument is a pointer to a
.Vt "void *"
that
.Nm
will write a cookie for the parent bus' use to if it is successful in
establishing an interrupt.
Driver writers may assume that this cookie will be non-zero.
The nexus driver will write 0 on failure to
.Fa cookiep.
.Fa cookiep .
.Pp
The interrupt handler will be detached by
.Fn BUS_TEARDOWN_INTR .

14
share/man/man9/bus_alloc_resource.9
View File

@ -85,23 +85,17 @@ You must not depend on the value you gave it earlier.
and
.Fa end
are the start/end addresses of the resource.
If you specify values of
.Dv 0
for
If you specify values of 0 for
.Fa start
and
.Dv ~0
for
and ~0 for
.Fa end
and
.Dv 1
for
and 1 for
.Fa count ,
the default values for the bus are calculated.
.It
.Fa count
is the size of the resource, e.g. the size of an I/O port (often
.Dv 1, but some devices override this).
1, but some devices override this).
If you specified the default values for
.Fa start
and

9
share/man/man9/device_get_ivars.9
View File

@ -38,18 +38,17 @@
.Sh SYNOPSIS
.In sys/param.h
.In sys/bus.h
.Ft void *
.Ft "void *"
.Fn device_get_ivars "device_t dev"
.Ft void
.Fn device_get_ivars "device_t dev" "void *ivar"
.Fn device_set_ivars "device_t dev" "void *ivar"
.Sh DESCRIPTION
.Pp
The
.Nm device_get_ivar
.Fn device_get_ivars
function returns the bus-specific instance variables of a device.
.Pp
The
.Nm device_set_ivar
.Fn device_set_ivars
function sets the bus-specific instance variables of a device.
.Pp
Typically, only bus drivers will use these functions.

8
share/man/man9/device_get_softc.9
View File

@ -44,9 +44,9 @@ Return the driver-specific state of
.Fa dev .
The softc is automatically allocated the first time it is requested.
The size of the allocation is determined by the device's
.Ft driver_t
.Vt driver_t
information used to define the driver.
The softc typically encaposlates the state of this instance of the
The softc typically encapsulates the state of this instance of the
device.
.Pp
Driver writers are discouraged from using their own softc management
@ -56,9 +56,9 @@ tree that predates this function.
.Sh RETURN VALUES
The pointer to the driver-specific instance variable is returned.
.Sh SEE ALSO
.Xr driver 9 ,
.Xr device 9 ,
.Xr device_set_softc 9
.Xr device_set_softc 9 ,
.Xr driver 9
.Sh AUTHORS
This man page was written by
.An Doug Rabson .

44
share/man/man9/malloc.9
View File

@ -54,7 +54,7 @@
.In sys/malloc.h
.Ft void *
.Fn malloc "unsigned long size" "struct malloc_type *type" "int flags"
.Fn MALLOC "space" "cast" "unsigned long size" "struct malloc_type *type" "int flags"
.Fn MALLOC space cast "unsigned long size" "struct malloc_type *type" "int flags"
.Ft void
.Fn free "void *addr" "struct malloc_type *type"
.Fn FREE "void *addr" "struct malloc_type *type"
@ -62,11 +62,11 @@
.Fn realloc "void *addr" "unsigned long size" "struct malloc_type *type" "int flags"
.Ft void *
.Fn reallocf "void *addr" "unsigned long size" "struct malloc_type *type" "int flags"
.Fn MALLOC_DECLARE "type"
.Fn MALLOC_DECLARE type
.In sys/param.h
.In sys/malloc.h
.In sys/kernel.h
.Fn MALLOC_DEFINE "type" "shortdesc" "longdesc"
.Fn MALLOC_DEFINE type shortdesc longdesc
.Sh DESCRIPTION
The
.Fn malloc
@ -139,7 +139,8 @@ free((addr), type)
.Pp
Unlike its standard C library counterpart
.Pq Xr malloc 3 ,
the kernel version takes two more arguments. The
the kernel version takes two more arguments.
The
.Fa flags
argument further qualifies
.Fn malloc Ns 's
@ -160,8 +161,8 @@ Note that
.Dv M_NOWAIT
is required when running in an interrupt context.
.It Dv M_WAITOK
Indicates that it is ok to wait for resources.
If the request cannot be immediately fulfilled the current process is put
Indicates that it is OK to wait for resources.
If the request cannot be immediately fulfilled, the current process is put
to sleep to wait for resources to be released by other processes.
The
.Fn malloc ,
@ -175,10 +176,12 @@ if
is specified.
.It Dv M_USE_RESERVE
Indicates that the system can dig into its reserve in order to obtain the
requested memory. This option used to be called M_KERNEL but has been
renamed to something more obvious. This option has been deprecated and is
slowly being removed from the kernel, and so should not be used with any new
programming.
requested memory.
This option used to be called
.Dv M_KERNEL
but has been renamed to something more obvious.
This option has been deprecated and is slowly being removed from the kernel,
and so should not be used with any new programming.
.El
.Pp
Exactly one of either
@ -198,7 +201,7 @@ The statistics can be examined by
A
.Fa type
is defined using
.Va struct malloc_type
.Vt "struct malloc_type"
via the
.Fn MALLOC_DECLARE
and
@ -221,13 +224,13 @@ MALLOC(buf, struct foo_buf *, sizeof *buf, M_FOOBUF, M_NOWAIT);
.Ed
.Pp
In order to use
.Fn MALLOC_DEFINE
.Fn MALLOC_DEFINE ,
one must include
.Aq sys/param.h
.Aq Pa sys/param.h
(instead of
.Aq sys/types.h )
.Aq Pa sys/types.h )
and
.Aq sys/kernel.h .
.Aq Pa sys/kernel.h .
.Sh RETURN VALUES
The
.Fn malloc ,
@ -263,8 +266,8 @@ and
and
.Fn reallocf
may not be called from fast interrupts handlers.
When called from threaded interrupts
.Ar flag
When called from threaded interrupts,
.Fa flags
must contain
.Dv M_NOWAIT .
.Pp
@ -274,8 +277,11 @@ and
.Fn reallocf
must not be called with
.Dv M_WAITOK
while a mutex other than Giant is held.
Giant may or may not be held when
while a mutex other than
.Va Giant
is held.
.Va Giant
may or may not be held when
.Fn free
is called.
.Pp

32
share/man/man9/mbuf.9
View File

@ -523,19 +523,29 @@ In case of failure, it returns
and attempts to restore the chain to its original state.
.El
.Sh STRESS TESTING
When running a kernel compiled with the option MBUF_STRESS_TEST,
the following sysctl-controlled options may be used to create
various failure / extreme cases for testing of network drivers
When running a kernel compiled with the option
.Dv MBUF_STRESS_TEST ,
the following
.Xr sysctl 8 Ns
-controlled options may be used to create
various failure/extreme cases for testing of network drivers
and other mbuf-reliant parts of the kernel.
.Pp
.Va net.inet.ip.mbuf_frag_size
causes ip_output to fragment outgoing mbuf chains into fragments of
the specified size. Setting this option to 1 is an excellent way to
.Bl -tag -width ident
.It Va net.inet.ip.mbuf_frag_size
Causes
.Fn ip_output
to fragment outgoing mbuf chains into fragments of the specified size.
Setting this variable to 1 is an excellent way to
test the long mbuf chain handling ability of network drivers.
.Pp
.Va kern.ipc.m_defragrandomfailures
causes the function m_defrag to randomly fail, returning NULL. Any
piece of code which uses m_defrag should be tested with this feature.
.It Va kern.ipc.m_defragrandomfailures
Causes the function
.Fn m_defrag
to randomly fail, returning
.Dv NULL .
Any piece of code which uses
.Fn m_defrag
should be tested with this feature.
.El
.Sh RETURN VALUES
See above.
.Sh HISTORY

23
share/man/man9/mutex.9
View File

@ -458,18 +458,29 @@ operations.
This can be used to trim superfluous logging messages for debugging purposes.
.El
.Ss Giant
If Giant must be acquired, it must be acquired prior to acquiring
If
.Va Giant
must be acquired, it must be acquired prior to acquiring
other mutexes.
Put another way: it is impossible to acquire Giant non-recursively while
Put another way: it is impossible to acquire
.Va Giant
non-recursively while
holding another mutex.
It is possible to acquire other mutexes while holding Giant, and it is
possible to acquire Giant recursively while holding other mutexes.
It is possible to acquire other mutexes while holding
.Va Giant ,
and it is possible to acquire
.Va Giant
recursively while holding other mutexes.
.Ss Sleeping
Sleeping while holding a mutex (except for Giant) is almost never safe
Sleeping while holding a mutex (except for
.Va Giant )
is almost never safe
and should be avoided.
There are numerous assertions which will fail if this is attempted.
.Ss Functions Which Access Memory in Userspace
No mutexes should be held (except for Giant) across functions which
No mutexes should be held (except for
.Va Giant )
across functions which
access memory in userspace, such as
.Xr copyin 9 ,
.Xr copyout 9 ,