summaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2003-06-02 15:02:06 +0000
committerru <ru@FreeBSD.org>2003-06-02 15:02:06 +0000
commit29f96439114d622208dd85a833e0929e1310b66a (patch)
tree4a56090fec39317e942be1d49dd392fac4bed632 /share
parent2550ebdaa67be2186e18324278575cf49f6e9804 (diff)
downloadFreeBSD-src-29f96439114d622208dd85a833e0929e1310b66a.zip
FreeBSD-src-29f96439114d622208dd85a833e0929e1310b66a.tar.gz
Assorted mdoc(7) fixes.
Diffstat (limited to 'share')
-rw-r--r--share/man/man4/acpi.431
-rw-r--r--share/man/man5/rc.conf.55
-rw-r--r--share/man/man9/VFS_SET.92
-rw-r--r--share/man/man9/VFS_VGET.92
-rw-r--r--share/man/man9/namei.968
-rw-r--r--share/man/man9/rtalloc.92
6 files changed, 58 insertions, 52 deletions
diff --git a/share/man/man4/acpi.4 b/share/man/man4/acpi.4
index 9ba72e9..37c1e95 100644
--- a/share/man/man4/acpi.4
+++ b/share/man/man4/acpi.4
@@ -32,9 +32,9 @@
.Nm acpi
.Nd Advanced Configuration and Power Management support
.Sh SYNOPSIS
-.Cd device acpi
+.Cd "device acpi"
.Pp
-.Cd options ACPI_DEBUG
+.Cd "options ACPI_DEBUG"
.Sh DESCRIPTION
The
.Nm
@@ -203,8 +203,7 @@ To disable the
.Nm
driver completely, set the kernel environment variable
.Va hint.acpi.0.disabled
-to
-.Dq 1 .
+to 1.
Some i386 machines totally fail to operate with some or all of ACPI disabled.
Other i386 machines fail with ACPI enabled.
Non-i386 platforms do not support operating systems which do not use ACPI.
@@ -295,27 +294,27 @@ utilities from the
.Pa devel/acpicatools
port, and some ACPI knowledge.
.Sh TUNABLES
-.Bl -tag -width children
-.It Li acpi_dsdt_load
-Enables loading of a custom acpi DSDT.
-.It Li acpi_dsdt_name
+.Bl -tag -width indent
+.It Va acpi_dsdt_load
+Enables loading of a custom ACPI DSDT.
+.It Va acpi_dsdt_name
Name of the DSDT table to load, if loading is enabled.
-.It Li debug.acpi.disable
+.It Va debug.acpi.disable
Selectively disables portions of ACPI for debugging purposes.
-.It Li hint.acpi.0.disabled
-Disables all of ACPI
-.It Li hw.acpi.cpu.performance_speed
+.It Va hint.acpi.0.disabled
+Disables all of ACPI.
+.It Va hw.acpi.cpu.performance_speed
Sets the speed of the CPU, if it supports multiple speeds, while in
the performance power profile.
-.It Li hw.acpi.cpu.economy_speed
+.It Va hw.acpi.cpu.economy_speed
Sets the speed of the CPU, if it supports multiple speeds, while in
the economy power profile.
-.It Li hw.acpi.ec.event_driven
+.It Va hw.acpi.ec.event_driven
Enables or disables the event driven model for the embedded controller
driver.
-.It Li hw.acpi.pci.link.%d.%d.%d.irq
+.It Va hw.acpi.pci.link.%d.%d.%d.irq
Override the interrupt to use.
-.It Li hw.acpi.verbose
+.It Va hw.acpi.verbose
Turn on verbose debugging information about what ACPI is doing.
.El
.Sh COMPATIBILITY
diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5
index 9ae905e..5f51f39 100644
--- a/share/man/man5/rc.conf.5
+++ b/share/man/man5/rc.conf.5
@@ -934,8 +934,9 @@ the X server to start before disk I/O bandwidth is monopolized by
.Xr fsck 8 .
.It Va netfs_types
.Pq Vt str
-List of file system types that are network-based. This list should
-generally not be modified by end users. Use
+List of file system types that are network-based.
+This list should generally not be modified by end users.
+Use
.Va extra_netfs_types
instead.
.It Va extra_netfs_types
diff --git a/share/man/man9/VFS_SET.9 b/share/man/man9/VFS_SET.9
index 2f2b8f4..c47ec22 100644
--- a/share/man/man9/VFS_SET.9
+++ b/share/man/man9/VFS_SET.9
@@ -57,7 +57,7 @@ as the event handler.
Possible values for the
.Fa flags
argument are documented below:
-.Bl -hang -width VFCF_SYNTHETIC
+.Bl -hang -width ".Dv VFCF_SYNTHETIC"
.It Dv VFCF_STATIC
File system should be statically available in the kernel.
.It Dv VFCF_NETWORK
diff --git a/share/man/man9/VFS_VGET.9 b/share/man/man9/VFS_VGET.9
index 35d094f..dbca02d 100644
--- a/share/man/man9/VFS_VGET.9
+++ b/share/man/man9/VFS_VGET.9
@@ -44,7 +44,7 @@
This converts an inode number into a locked vnode.
.Pp
Its arguments are:
-.Bl -tag -width flags
+.Bl -tag -width ".Fa flags"
.It Fa mp
The file system.
.It Fa ino
diff --git a/share/man/man9/namei.9 b/share/man/man9/namei.9
index 2556d9f..72ad4d1 100644
--- a/share/man/man9/namei.9
+++ b/share/man/man9/namei.9
@@ -1,6 +1,6 @@
.\"
.\" Copyright (c) 1998, 1999 Eivind Eklund
-.\" Copyright (c) 2003, Hiten M. Pandya
+.\" Copyright (c) 2003 Hiten M. Pandya
.\"
.\" All rights reserved.
.\"
@@ -47,7 +47,10 @@
.Ft int
.Fn namei "struct nameidata *ndp"
.Ft void
-.Fn NDINIT "struct nameidata *ndp" "u_long op" "u_long flags" "enum uio_seg segflg" "const char *namep" "struct thread *td"
+.Fo NDINIT
+.Fa "struct nameidata *ndp" "u_long op" "u_long flags"
+.Fa "enum uio_seg segflg" "const char *namep" "struct thread *td"
+.Fc
.Ft void
.Fn NDFREE "struct nameidata *ndp" "const uint flags"
.Sh DESCRIPTION
@@ -63,9 +66,9 @@ using either
.Xr vrele 9
or
.Xr vput 9 ,
-depending on whether you specified the
+depending on whether the
.Dv LOCKLEAF
-flag or not.
+flag was specified or not.
.Pp
The
.Fn NDINIT
@@ -73,8 +76,7 @@ function is used to initialize
.Nm
components.
It takes the following arguments:
-.Pp
-.Bl -tag -width segflg
+.Bl -tag -width ".Fa segflg"
.It Fa ndp
The
.Vt "struct nameidata"
@@ -84,9 +86,7 @@ The operation which
.Fn namei
will perform.
The following operations are valid:
-.Dv LOOKUP ,
-.Dv CREATE ,
-.Dv DELETE ,
+.Dv LOOKUP , CREATE , DELETE ,
and
.Dv RENAME .
The latter three are just setup for those
@@ -106,7 +106,7 @@ or in the kernel address space
.Pq Dv UIO_SYSSPACE .
.It Fa namep
Pointer to the component's pathname buffer
-.Pq the file or directory name that will be looked up .
+(the file or directory name that will be looked up).
.It Fa td
The thread context to use for
.Nm
@@ -116,16 +116,19 @@ operations and locks.
The
.Fn namei
function takes the following set of
-.Dq operation flags
+.Dq "operation flags"
that influence its operation:
-.Bl -tag -width WANTPARENT
+.Bl -tag -width ".Dv WANTPARENT"
.It Dv LOCKLEAF
Lock vnode on return.
-This is a full lock of the vnode; you'll have to use
+This is a full lock of the vnode; the
.Xr VOP_UNLOCK 9
-to release the lock (or use
+should be used
+to release the lock (or
.Xr vput 9
-to release the lock and do a
+which is equivalent to calling
+.Xr VOP_UNLOCK 9
+followed by
.Xr vrele 9 ,
all in one).
.It Dv LOCKPARENT
@@ -138,7 +141,7 @@ in locked state, unless it is identical to
in which case
.Va ni_dvp
is not locked per se (but may be locked due to
-.Dv LOCKLEAF ).
+.Dv LOCKLEAF ) .
If a lock is enforced, it should be released using
.Xr vput 9
or
@@ -155,10 +158,11 @@ The parent vnode must be released separately by using
Avoid
.Fn namei
creating this entry in the namecache if it is not
-already present. Normally
+already present.
+Normally,
.Fn namei
will add entries to the name cache
-if they're not already there.
+if they are not already there.
.It Dv FOLLOW
With this flag,
.Fn namei
@@ -179,7 +183,7 @@ are intentionally not followed.
.It Dv SAVENAME
Do not free the pathname buffer at the end of the
.Fn namei
-invocation, instead free it later in
+invocation; instead, free it later in
.Fn NDFREE
so that the caller may access the pathname buffer.
See below for details.
@@ -192,10 +196,11 @@ See below for details.
The
.Vt nameidata
structure is composed of the following fields:
-.Bl -tag -width ni_cnd.cn_pnbuf
+.Bl -tag -width ".Va ni_cnd.cn_pnbuf"
.It Va ni_startdir
In the normal case, this is either the current directory or the root.
-It is the current directory if the name passed in doesn't start with /
+It is the current directory if the name passed in does not start with
+.Ql /
and we have not gone through any symlinks with an absolute path, and
the root otherwise.
.Pp
@@ -228,10 +233,9 @@ It is locked if
.Dv LOCKPARENT
is set.
Freeing this in
-.Dv NDFREE
+.Fn NDFREE
can be inhibited by
-.Dv NDF_NO_DVP_RELE ,
-.Dv NDF_NO_DVP_PUT ,
+.Dv NDF_NO_DVP_RELE , NDF_NO_DVP_PUT ,
or
.Dv NDF_NO_DVP_UNLOCK
(with the obvious effects).
@@ -249,11 +253,10 @@ is set, it is also locked.
Freeing this in
.Fn NDFREE
can be inhibited by
-.Dv NDF_NO_VP_RELE ,
-.Dv NDF_NO_VP_PUT ,
+.Dv NDF_NO_VP_RELE , NDF_NO_VP_PUT ,
or
.Dv NDF_NO_VP_UNLOCK
-.Pq with the obvious effects .
+(with the obvious effects).
.It Va ni_cnd.cn_pnbuf
The pathname buffer contains the location of the file or directory
that will be used by the
@@ -268,7 +271,7 @@ or
.Dv SAVENAME
flag is set, then the pathname buffer is available
after calling the
-.Nm namei
+.Fn namei
function.
.Pp
To only deallocate resources used by the pathname buffer,
@@ -286,7 +289,9 @@ flag can be passed to the
function.
.El
.Sh FILES
-.Pa src/sys/kern/vfs_lookup.c
+.Bl -tag
+.It Pa src/sys/kern/vfs_lookup.c
+.El
.Sh SEE ALSO
.Xr uio 9 ,
.Xr uma 9 ,
@@ -295,10 +300,11 @@ function.
.Xr vput 9 ,
.Xr vref 9
.Sh AUTHORS
+.An -nosplit
This manual page was written by
-.An Eivind Eklund Aq eivind@FreeBSD.ORG
+.An Eivind Eklund Aq eivind@FreeBSD.org
and later significantly revised by
-.An Hiten M. Pandya Aq hmp@FreeBSD.ORG .
+.An Hiten M. Pandya Aq hmp@FreeBSD.org .
.Sh BUGS
The
.Dv LOCKPARENT
diff --git a/share/man/man9/rtalloc.9 b/share/man/man9/rtalloc.9
index 85c5685..1b01b74 100644
--- a/share/man/man9/rtalloc.9
+++ b/share/man/man9/rtalloc.9
@@ -104,7 +104,7 @@ for the first time, callers should ensure that unused bits of the
structure are set to zero. On subsequent calls,
.Fn rtalloc
returns without performing a lookup if
-.Va ro->ro_rt
+.Fa ro->ro_rt
is non-null and the
.Dv RTF_UP
flag is set in the route's
OpenPOWER on IntegriCloud