aboutsummaryrefslogtreecommitdiff
path: root/share
diff options
context:
space:
mode:
authorRuslan Ermilov <ru@FreeBSD.org>2002-12-24 13:41:48 +0000
committerRuslan Ermilov <ru@FreeBSD.org>2002-12-24 13:41:48 +0000
commitfacc67676f0239e4912f737638710058315d9fc7 (patch)
tree3a2594ccf0dfa39e2b9d787edfbc673670ae29da /share
parentfcb18f74b4c7b87af01dea8ad0793c8c57333d54 (diff)
Notes
Diffstat (limited to 'share')
-rw-r--r--share/man/man3/pthread_rwlock_wrlock.37
-rw-r--r--share/man/man3/pthread_rwlockattr_setpshared.32
-rw-r--r--share/man/man4/worm.42
-rw-r--r--share/man/man7/hier.72
-rw-r--r--share/man/man7/ports.72
-rw-r--r--share/man/man9/DEVICE_PROBE.91
-rw-r--r--share/man/man9/VOP_ATTRIB.910
-rw-r--r--share/man/man9/VOP_INACTIVE.94
-rw-r--r--share/man/man9/VOP_LINK.92
-rw-r--r--share/man/man9/VOP_OPENCLOSE.98
-rw-r--r--share/man/man9/accf_data.95
-rw-r--r--share/man/man9/accf_http.99
-rw-r--r--share/man/man9/device_add_child.94
-rw-r--r--share/man/man9/device_enable.96
-rw-r--r--share/man/man9/device_get_state.912
-rw-r--r--share/man/man9/device_quiet.96
-rw-r--r--share/man/man9/device_set_desc.92
-rw-r--r--share/man/man9/device_set_flags.94
-rw-r--r--share/man/man9/vget.92
-rw-r--r--share/man/man9/vref.92
-rw-r--r--share/man/man9/vrele.92
21 files changed, 48 insertions, 46 deletions
diff --git a/share/man/man3/pthread_rwlock_wrlock.3 b/share/man/man3/pthread_rwlock_wrlock.3
index 55ab5f933468..c74a46653a79 100644
--- a/share/man/man3/pthread_rwlock_wrlock.3
+++ b/share/man/man3/pthread_rwlock_wrlock.3
@@ -61,9 +61,10 @@ and
functions will return zero. Otherwise an error number will be returned
to indicate the error.
.Sh SEE ALSO
-.Xr pthread_rwlock_trywrlock 3 ,
-.Xr pthread_rwlock_unlock 3 ,
-.Xr pthread_rwlock_wrlock 3
+.Xr pthread_rwlock_init 3 ,
+.Xr pthread_rwlock_rdlock 3 ,
+.Xr pthread_rwlock_tryrdlock 3 ,
+.Xr pthread_rwlock_unlock 3
.Sh STANDARDS
The
.Fn pthread_rwlock_wrlock
diff --git a/share/man/man3/pthread_rwlockattr_setpshared.3 b/share/man/man3/pthread_rwlockattr_setpshared.3
index 48b854d21a6b..e19e66c1c188 100644
--- a/share/man/man3/pthread_rwlockattr_setpshared.3
+++ b/share/man/man3/pthread_rwlockattr_setpshared.3
@@ -60,8 +60,8 @@ If successful, the
function will return zero. Otherwise an error number will be returned
to indicate the error.
.Sh SEE ALSO
+.Xr pthread_rwlockattr_getpshared 3 ,
.Xr pthread_rwlockattr_init 3 ,
-.Xr pthread_rwlockattr_setpshared 3 ,
.Xr pthread_rwlock_init 3
.Sh STANDARDS
The
diff --git a/share/man/man4/worm.4 b/share/man/man4/worm.4
index b050aa3de794..32111b0a1f91 100644
--- a/share/man/man4/worm.4
+++ b/share/man/man4/worm.4
@@ -60,7 +60,7 @@ by a CAM-compliant
layer. The new
.Tn SCSI
layer doesn't include a
-.Xr worm 4
+.Nm
driver, and isn't likely to include one in the future. Future in-kernel
support for CD-R/CD-RW/DVD drives will likely be implemented through the
.Xr cd 4
diff --git a/share/man/man7/hier.7 b/share/man/man7/hier.7
index f07c9f3602dd..8827fb5806fd 100644
--- a/share/man/man7/hier.7
+++ b/share/man/man7/hier.7
@@ -408,7 +408,7 @@ Also used as the default destination for the
.Fx
ports framework.
Within local/, the general layout sketched out by
-.Xr hier 7
+.Nm
for /usr
should be used. Exceptions are the man directory (directly under local/
rather than under local/share/), ports documentation (in share/doc/<port>/),
diff --git a/share/man/man7/ports.7 b/share/man/man7/ports.7
index 943c384cd1ab..2b480fbd9b84 100644
--- a/share/man/man7/ports.7
+++ b/share/man/man7/ports.7
@@ -380,6 +380,6 @@ the
chapter of
.%B "The FreeBSD Handbook" ,
and
-.Xr ports 7 .
+this man page.
.Pp
This man page is too long.
diff --git a/share/man/man9/DEVICE_PROBE.9 b/share/man/man9/DEVICE_PROBE.9
index c772e20c8040..36e48e9bdb3f 100644
--- a/share/man/man9/DEVICE_PROBE.9
+++ b/share/man/man9/DEVICE_PROBE.9
@@ -81,7 +81,6 @@ priority, e.g. -100 indicates a lower priority than -50.
.Xr device 9 ,
.Xr DEVICE_DETACH 9 ,
.Xr DEVICE_IDENTIFY 9 ,
-.Xr DEVICE_PROBE 9 ,
.Xr DEVICE_SHUTDOWN 9
.Sh AUTHORS
This man page was written by
diff --git a/share/man/man9/VOP_ATTRIB.9 b/share/man/man9/VOP_ATTRIB.9
index e75958bcdf29..885edc414716 100644
--- a/share/man/man9/VOP_ATTRIB.9
+++ b/share/man/man9/VOP_ATTRIB.9
@@ -60,7 +60,7 @@ the thread
.El
.Pp
Attributes which are not being modified by
-.Xr VOP_SETATTR 9
+.Fn VOP_SETATTR
should be set to the value
.Dv VNOVAL ;
.Fn VATTR_NULL
@@ -69,21 +69,21 @@ the contents of
.Fa *vap
prior to setting specific values.
.Sh LOCKS
-.Xr VOP_GETATTR 9
+.Fn VOP_GETATTR
expects the vnode to be locked on entry and will leave the vnode locked on
return.
The lock type can be either shared or exclusive.
.Pp
-.Xr VOP_SETATTR 9
+.Fn VOP_SETATTR
expects the vnode to be locked on entry and will leave the vnode locked on
return.
The lock type must be exclusive.
.Sh RETURN VALUES
-.Xr VOP_GETATTR 9
+.Fn VOP_GETATTR
returns 0 if it was able to retrieve the attribute data via
.Fa *vap ,
otherwise an appropriate error is returned.
-.Xr VOP_SETATTR 9
+.Fn VOP_SETATTR
returns zero if the attributes were changed successfully, otherwise an
appropriate error is returned.
.Sh PSEUDOCODE
diff --git a/share/man/man9/VOP_INACTIVE.9 b/share/man/man9/VOP_INACTIVE.9
index 9fa38336ebbb..25f8859aa540 100644
--- a/share/man/man9/VOP_INACTIVE.9
+++ b/share/man/man9/VOP_INACTIVE.9
@@ -49,12 +49,12 @@ The arguments are:
the vnode being reclaimed
.El
.Pp
-.Xr VOP_INACTIVE 9
+.Fn VOP_INACTIVE
is called when the kernel is no longer using the vnode. This may be
because the reference count reaches zero or it may be that the
file system is being forcibly unmounted while there are open files.
It can be used to reclaim space for 'open but deleted' files.
-.Xr VOP_RECLAIM 9
+.Fn VOP_RECLAIM
is called when a vnode is being reused for a different file system.
Any file system specific resources associated with the vnode should be
freed.
diff --git a/share/man/man9/VOP_LINK.9 b/share/man/man9/VOP_LINK.9
index f95c55de2116..9d5bde7b2b13 100644
--- a/share/man/man9/VOP_LINK.9
+++ b/share/man/man9/VOP_LINK.9
@@ -60,7 +60,7 @@ The directory and file vnodes should
.Em not
be released on exit.
.Sh LOCKS
-.Xr VOP_LINK 9
+.Fn VOP_LINK
expects the directory and file vnodes to be locked on entry and will leave
the vnodes locked on return.
.Sh RETURN VALUES
diff --git a/share/man/man9/VOP_OPENCLOSE.9 b/share/man/man9/VOP_OPENCLOSE.9
index 5c1be6cb6d56..45a046fbdce7 100644
--- a/share/man/man9/VOP_OPENCLOSE.9
+++ b/share/man/man9/VOP_OPENCLOSE.9
@@ -44,9 +44,9 @@
.Fn VOP_CLOSE "struct vnode *vp" "int mode" "struct ucred *cred" "struct thread *td"
.Sh DESCRIPTION
The
-.Xr VOP_OPEN 9
+.Fn VOP_OPEN
entry point is called before a file is accessed by a process and the
-.Xr VOP_CLOSE 9
+.Fn VOP_CLOSE
entry point is called after a file is finished with by the process.
.Pp
The arguments are:
@@ -65,12 +65,12 @@ The access mode is a set of flags, including
.Dv O_NONBLOCK ,
.Dv O_APPEND .
.Sh LOCKS
-.Xr VOP_OPEN 9
+.Fn VOP_OPEN
expects
.Fa vp
to be locked on entry and will leave it locked on return.
.Pp
-.Xr VOP_CLOSE 9
+.Fn VOP_CLOSE
expects at least a reference to be associated with the vnode and does not
care whether the vnode is locked or not. The lock and reference state is
left unchanged on return. Note that
diff --git a/share/man/man9/accf_data.9 b/share/man/man9/accf_data.9
index a7c78bfdf07d..4b465d3006bb 100644
--- a/share/man/man9/accf_data.9
+++ b/share/man/man9/accf_data.9
@@ -51,8 +51,9 @@ kernel option is also a module that can be enabled at runtime via
if the INET option has been compiled into the kernel.
.Sh EXAMPLE
Assuming ACCEPT_FILTER_DATA has been included in the kernel config
-file or the module
-.Xr accf_data 9
+file or the
+.Nm
+module
has been loaded, this will enable the data accept filter
on the socket
.Fa sok .
diff --git a/share/man/man9/accf_http.9 b/share/man/man9/accf_http.9
index 1438e0868a63..69e724b0b72c 100644
--- a/share/man/man9/accf_http.9
+++ b/share/man/man9/accf_http.9
@@ -52,7 +52,7 @@ via
.Fn accept .
.Pp
The utility of
-.Xr accf_http 9
+.Nm
is such that a server will not have to context switch several times
before performing the initial parsing of the request.
This effectively reduces the amount of required CPU utilization
@@ -67,14 +67,15 @@ or
based servers.
.Pp
The
-.Xr accf_http 9
+.Nm
kernel option is also a module that can be enabled at runtime via
.Xr kldload 8
if the INET option has been compiled into the kernel.
.Sh EXAMPLE
Assuming ACCEPT_FILTER_HTTP has been included in the kernel config
-file or the module
-.Xr accf_http 9
+file or the
+.Nm
+module
has been loaded, this will enable the http accept filter
on the socket
.Fa sok .
diff --git a/share/man/man9/device_add_child.9 b/share/man/man9/device_add_child.9
index 3c5d2e3c948c..8d0863915121 100644
--- a/share/man/man9/device_add_child.9
+++ b/share/man/man9/device_add_child.9
@@ -82,12 +82,12 @@ of unrelated drivers and therefore must be probed first),
the
.Fa order
argument of
-.Xr device_add_child_ordered 9
+.Fn device_add_child_ordered
should be used to specify a partial ordering.
The new device will be added before any existing device with a greater
order.
If
-.Xr device_add_child 9
+.Fn device_add_child
is used, then the new child will be added as if its order was zero.
.Sh RETURN VALUES
The new device if successful, NULL otherwise.
diff --git a/share/man/man9/device_enable.9 b/share/man/man9/device_enable.9
index a2b4070b8f4f..7e7fdc91be05 100644
--- a/share/man/man9/device_enable.9
+++ b/share/man/man9/device_enable.9
@@ -50,11 +50,11 @@ Each device has an enabled flag associated with it. A device is
enabled by default when it is created but may be disabled (for
instance to prevent a destructive or time consuming probe attempt).
To disable a device, call
-.Xr device_disable 9 ,
+.Fn device_disable ,
to re-enable it, call
-.Xr device_enable 9
+.Fn device_enable
and to test to see if a device is enabled, call
-.Xr device_is_enabled 9 .
+.Fn device_is_enabled .
.Sh SEE ALSO
.Xr device 9
.Sh AUTHORS
diff --git a/share/man/man9/device_get_state.9 b/share/man/man9/device_get_state.9
index e499336974e7..20695bda21fe 100644
--- a/share/man/man9/device_get_state.9
+++ b/share/man/man9/device_get_state.9
@@ -50,7 +50,7 @@
.Fn device_is_alive "device_t dev"
.Sh DESCRIPTION
The current state of a device is accessed by calling
-.Xr device_get_state 9
+.Fn device_get_state
which returns
.Dv DS_NOTPRESENT ,
.Dv DS_ALIVE ,
@@ -60,27 +60,27 @@ or
(described in
.Xr device 9 ) .
To test see if a device was successfully probed, call
-.Xr device_is_alive 9
+.Fn device_is_alive
which simply returns if the state is greater or equal to
.Dv DS_ALIVE .
.Pp
Each device has a busy count which is incremented when
-.Xr device_busy 9
+.Fn device_busy
is called and decremented when
-.Xr device_unbusy 9
+.Fn device_unbusy
is called. Both routines return an error if the device state is less
than
.Dv DS_ATTACHED .
.Pp
When
-.Xr device_busy 9
+.Fn device_busy
is called on a device in the
.Dv DS_ATTACHED
state, the device changes to the
.Dv DS_BUSY
state.
When
-.Xr device_unbusy 9
+.Fn device_unbusy
is called and after decrementing, the busy count for the device is
zero, the device changes to the
.Dv DS_ATTACHED
diff --git a/share/man/man9/device_quiet.9 b/share/man/man9/device_quiet.9
index c97508581397..502e1a927dca 100644
--- a/share/man/man9/device_quiet.9
+++ b/share/man/man9/device_quiet.9
@@ -50,14 +50,14 @@ Each device has a quiet flag associated with it. A device is
verbose by default when it is created but may be quieted to prevent
the device identification string to be printed during probe.
To quiet a device, call
-.Xr device_quiet 9 ,
+.Fn device_quiet ,
to re-enable to probe message (to make the message appear again, for
example after a
.Xr device_detach 9 )
call
-.Xr device_verbose 9 .
+.Fn device_verbose .
To test to see if a device is quieted, call
-.Xr device_is_quiet 9 .
+.Fn device_is_quiet .
.Sh SEE ALSO
.Xr device 9
.Sh AUTHORS
diff --git a/share/man/man9/device_set_desc.9 b/share/man/man9/device_set_desc.9
index 6ddbeabd0bff..05478059105d 100644
--- a/share/man/man9/device_set_desc.9
+++ b/share/man/man9/device_set_desc.9
@@ -50,7 +50,7 @@ Manipulate the verbose description of a device. This description (if
present) is printed as part of the message when it is attached during
autoconfiguration.
The variation
-.Xr device_set_desc_copy 9
+.Fn device_set_desc_copy
is used to set the description if the string passed is a temporary
buffer which will be overwritten.
In this case, the system will copy
diff --git a/share/man/man9/device_set_flags.9 b/share/man/man9/device_set_flags.9
index 70bb8508ad2b..b5304cc47932 100644
--- a/share/man/man9/device_set_flags.9
+++ b/share/man/man9/device_set_flags.9
@@ -46,9 +46,9 @@
Each device supports a set of driver-dependent flags which are often
used to control device behaviour.
These flags are read by calling
-.Xr device_get_flags 9
+.Fn device_get_flags
and written by calling
-.Xr device_set_flags 9 .
+.Fn device_set_flags .
.Sh SEE ALSO
.Xr device 9
.Sh AUTHORS
diff --git a/share/man/man9/vget.9 b/share/man/man9/vget.9
index 97c54f55c6be..a64238970c07 100644
--- a/share/man/man9/vget.9
+++ b/share/man/man9/vget.9
@@ -57,7 +57,7 @@ When a vnode which is on the free list is used again, for instance if
the vnode was found in the name cache as a result of a call to
.Xr VOP_LOOKUP 9
then the new user must call
-.Xr vget 9
+.Fn vget
to increment the reference count and remove it from the free list.
.Sh SEE ALSO
.Xr vnode 9 ,
diff --git a/share/man/man9/vref.9 b/share/man/man9/vref.9
index 214a05999441..5f7ec1bda43e 100644
--- a/share/man/man9/vref.9
+++ b/share/man/man9/vref.9
@@ -55,7 +55,7 @@ no longer being used and can be safely recycled for a different file.
Any code in the system which is using a vnode (e.g. during the
operation of some algorithm or to store in a data structure) should
call
-.Xr vref 9 .
+.Fn vref .
.Sh SEE ALSO
.Xr vget 9 ,
.Xr vnode 9 ,
diff --git a/share/man/man9/vrele.9 b/share/man/man9/vrele.9
index adfe769ce60d..28478dbdd88c 100644
--- a/share/man/man9/vrele.9
+++ b/share/man/man9/vrele.9
@@ -49,7 +49,7 @@ the vnode to decrement
.El
.Pp
Any code in the system which is using a vnode should call
-.Xr vrele 9
+.Fn vrele
when it is finished with the vnode.
If the
.Dv v_usecount