diff options
Diffstat (limited to 'share/man')
33 files changed, 562 insertions, 441 deletions
diff --git a/share/man/man3/pthread_attr.3 b/share/man/man3/pthread_attr.3 index 454cefb..3797542 100644 --- a/share/man/man3/pthread_attr.3 +++ b/share/man/man3/pthread_attr.3 @@ -144,9 +144,9 @@ Invalid value for .Pp The .Fn pthread_attr_setstacksize -or +and .Fn pthread_attr_setstack -function will fail if: +functions will fail if: .Bl -tag -width Er .It Bq Er EINVAL .Fa stacksize diff --git a/share/man/man3/pthread_attr_get_np.3 b/share/man/man3/pthread_attr_get_np.3 index 57b8e2a..bf856d4 100644 --- a/share/man/man3/pthread_attr_get_np.3 +++ b/share/man/man3/pthread_attr_get_np.3 @@ -44,8 +44,8 @@ Most fields of .Vt pthread_attr_t structure are exact values of attributes provided at thread creation time (as parameter to -.Fn pthread_create -function), except stack address. +.Xr pthread_create 3 +function), except for the stack address. .Pp Value returned as .Fa dst @@ -61,11 +61,11 @@ should point to allocated memory area big enough to fit this structure. It is HIGHLY RECOMMENDED to use .Xr pthread_attr_init 3 function to allocate attribute storage. -.Sh IMPLEMENTATION DETAILS +.Sh IMPLEMENTATION NOTES The .Fn pthread_attr_get_np -function will always return pointer to thread's real stack address -regardless to its value in original attributes structure. +function will always return a pointer to the thread's real stack address, +regardless of its value in the original attributes structure. .Sh EXAMPLES .Bd -literal size_t @@ -109,7 +109,7 @@ thread ID. .Xr pthread_attr_init 3 .Sh AUTHORS The -.Nm -function and manpage were written by +.Fn pthread_attr_get_np +function and this manual page were written by .An Alexey Zelkin -.Aq phantom@FreeBSD.org +.Aq phantom@FreeBSD.org . diff --git a/share/man/man3/pthread_attr_setcreatesuspend_np.3 b/share/man/man3/pthread_attr_setcreatesuspend_np.3 index 15b0857..7059905 100644 --- a/share/man/man3/pthread_attr_setcreatesuspend_np.3 +++ b/share/man/man3/pthread_attr_setcreatesuspend_np.3 @@ -40,35 +40,33 @@ The .Fn pthread_attr_setcreatesuspend_np instructs -.Fn pthread_create -that thread created with attribute +.Xr pthread_create 3 +that the thread created with the .Fa attr -should be created and left in suspended state until explicit resume call (by +attribute +should be created and left in a suspended state until explicitly resumed +by the call to .Fn pthread_resume_np or -.Fn pthread_resume_all_np -function.) +.Fn pthread_resume_all_np . .Sh RETURN VALUES .Rv -std pthread_attr_setcreatesuspend_np .Sh ERRORS The .Fn pthread_attr_setcreatesuspend_np function will fail if: -.Bl -tag -witdh Er +.Bl -tag -width Er .It Bq Er EINVAL The value specified by .Fa attr -is invalid +is invalid. .El .Sh SEE ALSO -.Xr pthread_attr_init 3 , .Xr pthread_attr_destroy 3 , +.Xr pthread_attr_init 3 , .Xr pthread_create 3 , .Xr pthread_resume_all_np 3 , .Xr pthread_resume_np 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/share/man/man3/pthread_main_np.3 b/share/man/man3/pthread_main_np.3 index 6d9d830..9065b90 100644 --- a/share/man/man3/pthread_main_np.3 +++ b/share/man/man3/pthread_main_np.3 @@ -35,33 +35,26 @@ .Sh SYNOPSIS .In pthread_np.h .Ft int -.Fn pthread_main_np "void" +.Fn pthread_main_np void .Sh DESCRIPTION The .Fn pthread_main_np -is used in userland threads environment to identify initial thread. -Its semantics is similar to Solaris's +function +is used in userland threads environment to identify the initial thread. +Its semantics is similar to the Solaris's .Fn thr_main function. .Sh RETURN VALUES The .Fn pthread_main_np -function returns one of the following: -.Bl -tag -.It 1 -if the calling thread is the initial thread -.It 0 -if the calling thread is not the initial thread -.It -1 -if threads initialization has not completed -.El +function returns +1 if the calling thread is the initial thread, +0 if the calling thread is not the initial thread, +and \-1 if the thread's initialization has not yet completed. .Sh SEE ALSO .Xr pthread_create 3 , .Xr pthread_equal 3 , .Xr pthread_self 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/share/man/man3/pthread_multi_np.3 b/share/man/man3/pthread_multi_np.3 index ba143fe..5588c6c 100644 --- a/share/man/man3/pthread_multi_np.3 +++ b/share/man/man3/pthread_multi_np.3 @@ -30,35 +30,37 @@ .Sh NAME .Nm pthread_multi_np , .Nm pthread_single_np -.Nd switch betwen multi- and single-threaded scheduling modes +.Nd "switch between multi- and single-threaded scheduling modes" .Sh LIBRARY .Lb libc_r .Sh SYNOPSIS .In pthread_np.h .Ft int -.Fn pthread_multi_np "void" +.Fn pthread_multi_np void .Ft int -.Fn pthread_single_np "void" +.Fn pthread_single_np void .Sh DESCRIPTION The .Fn pthread_single_np -function call switches process to single-threaded mode, i.e. -suspend all threads except current. -Semantic of this function is similar to -.Fn pthread_suspend_all_np . +function switches the process to a single-threaded mode, i.e., +suspends all threads except the current. +The semantics of this function is similar to +.Xr pthread_suspend_all_np 3 . .Pp The .Fn pthread_multi_np -function call switches process to multi-threaded mode, entered by -.Fn pthread_single_np -Semantic of this function is similar to -.Fn pthread_resume_all_np . +function switches the process to a multi-threaded mode. +The semantics of this function is similar to +.Xr pthread_resume_all_np 3 . +.Sh RETURN VALUES +The +.Fn pthread_multi_np +and +.Nm pthread_single_np +functions always return 0. .Sh SEE ALSO .Xr pthread_resume_all_np 3 , -.Xr pthread_single_all_np 3 +.Xr pthread_suspend_all_np 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/share/man/man3/pthread_mutexattr_getkind_np.3 b/share/man/man3/pthread_mutexattr_getkind_np.3 index 5cdfc26..8bb673c 100644 --- a/share/man/man3/pthread_mutexattr_getkind_np.3 +++ b/share/man/man3/pthread_mutexattr_getkind_np.3 @@ -30,7 +30,7 @@ .Sh NAME .Nm pthread_mutexattr_getkind_np , .Nm pthread_mutexattr_setkind_np -.Nd mutex attribute operations (LEGACY) +.Nd mutex attribute operations (legacy) .Sh LIBRARY .Lb libc_r .Sh SYNOPSIS @@ -40,45 +40,42 @@ .Ft int .Fn pthread_mutexattr_setkind_np "pthread_mutexattr_t *attr" "int kind" .Sh DESCRIPTION -These functions are DEPRECATED and NON-PORTABLE implementation of mutex types -manipulation. +.Bf -symbolic +These functions are deprecated and non-portable implementation of +the mutex type manipulation. +.Ef .Pp -It's recomended to use -.Fn pthread_mutexattr_gettype +It is recommended to use the +.Xr pthread_mutexattr_gettype 3 and -.Fn pthread_mutexattr_settype +.Xr pthread_mutexattr_settype 3 functions instead. .Sh RETURN VALUES The .Fn pthread_mutexattr_getkind_np -function returns positive value representing -.Ft kind -of mutex attribute +function returns a positive value representing the +.Dq kind +of the mutex attribute .Fa attr -if successful; otherwise the value -1 is returned and the global variable -.Fa errno +if successful; otherwise the value \-1 is returned and the global variable +.Va errno is set to indicate the error. .Pp -The -.Fn pthread_mutexattr_settype -function returns the value 0 if successful; otherwise -the value -1 is returned and the global variable -.Fa errno -is set to indicate the error. +.Rv -std pthread_mutexattr_setkind_np .Sh ERRORS The .Fn pthread_mutexattr_getkind_np and .Fn pthread_mutexattr_setkind_np functions will fail if: -.Bl -tag -witdh Er +.Bl -tag -width Er .It Bq Er EINVAL The value specified by .Fa attr -is invalid +is invalid. .El .Sh SEE ALSO -.Xr pthread_mutex_create 3 , -.Xr pthread_mutex_destroy 3 , .Xr pthread_mutexattr_gettype 3 , -.Xr pthread_mutexattr_settype 3 +.Xr pthread_mutexattr_settype 3 , +.Xr pthread_mutex_create 3 , +.Xr pthread_mutex_destroy 3 diff --git a/share/man/man3/pthread_resume_all_np.3 b/share/man/man3/pthread_resume_all_np.3 index a59497c..90b2657 100644 --- a/share/man/man3/pthread_resume_all_np.3 +++ b/share/man/man3/pthread_resume_all_np.3 @@ -35,21 +35,17 @@ .Sh SYNOPSIS .In pthread_np.h .Ft void -.Fn pthread_resume_all_np "void" +.Fn pthread_resume_all_np void .Sh DESCRIPTION The .Fn pthread_resume_all_np -function call causes all active thread to be scanned -and resume those which were suspended previously. +function causes all active threads to be scanned +and resumes those which were previously suspended. .Sh SEE ALSO .Xr pthread_attr_setcreatesuspend_np 3 , .Xr pthread_resume_np 3 , .Xr pthread_suspend_all_np 3 , .Xr pthread_suspend_np 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org - +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/share/man/man3/pthread_resume_np.3 b/share/man/man3/pthread_resume_np.3 index 355e5cf..4a1a077 100644 --- a/share/man/man3/pthread_resume_np.3 +++ b/share/man/man3/pthread_resume_np.3 @@ -39,8 +39,8 @@ .Sh DESCRIPTION The .Fn pthread_resume_np -function called on suspended thread cause it to resume. -If thread specified by +function, called on a suspended thread, causes it to resume. +If a thread specified by the .Fa tid argument is not suspended, no actions will be performed. .Sh RETURN VALUES @@ -52,13 +52,13 @@ Otherwise, an error number is returned to indicate the error. The .Fn pthread_resume_np function will fail if: -.Bl -tag -witdh Er +.Bl -tag -width Er .It Bq Er EINVAL -The value specified by +The value specified by the .Fa tid -is invalid +argument is invalid. .It Bq ESRC -No thread could be found corresponding to thread ID specified by +No thread could be found corresponding to the thread ID specified by the .Fa tid argument. .El @@ -68,9 +68,5 @@ argument. .Xr pthread_suspend_all_np 3 , .Xr pthread_suspend_np 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org - +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/share/man/man3/pthread_set_name_np.3 b/share/man/man3/pthread_set_name_np.3 index 1919e95..a768e4c 100644 --- a/share/man/man3/pthread_set_name_np.3 +++ b/share/man/man3/pthread_set_name_np.3 @@ -45,15 +45,11 @@ argument to string value specified by .Fa name argument. .Pp -This is rather debuging interface and using it at day-by-day basis makes +This is a debugging interface and using it on a day-by-day basis makes no sense. .Sh ERRORS -Because of debuging orientation of this function all errors that may -appear inside are sliently ignored. +Because of the debugging nature of this function, all errors that may +appear inside are silently ignored. .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org - +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/share/man/man3/pthread_suspend_all_np.3 b/share/man/man3/pthread_suspend_all_np.3 index 2a33b30..56c78f1 100644 --- a/share/man/man3/pthread_suspend_all_np.3 +++ b/share/man/man3/pthread_suspend_all_np.3 @@ -35,12 +35,13 @@ .Sh SYNOPSIS .In pthread_np.h .Ft void -.Fn pthread_suspend_all_np "void" +.Fn pthread_suspend_all_np void .Sh DESCRIPTION The .Fn pthread_suspend_all_np -function call causes all active thread to be suspended. -The only exception is current thread, i.e. thread which called +function causes all active threads to be suspended. +The only exception is the current thread, +the thread that called the .Fn pthread_suspend_all_np function. .Sh SEE ALSO @@ -48,9 +49,5 @@ function. .Xr pthread_resume_np 3 , .Xr pthread_suspend_np 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org - +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/share/man/man3/pthread_suspend_np.3 b/share/man/man3/pthread_suspend_np.3 index d742a86..c8a9c8f 100644 --- a/share/man/man3/pthread_suspend_np.3 +++ b/share/man/man3/pthread_suspend_np.3 @@ -39,7 +39,7 @@ .Sh DESCRIPTION The .Fn pthread_suspend_np -function called on active thread cause it to suspend. +function, called on an active thread, causes it to suspend. .Sh RETURN VALUES If successful, .Fn pthread_suspend_np @@ -49,15 +49,15 @@ Otherwise, an error number is returned to indicate the error. The .Fn pthread_suspend_np function will fail if: -.Bl -tag -witdh Er +.Bl -tag -width Er .It Bq Er EDEADLK -Attempt to suspend current thread +An attempt was made to suspend the current thread. .It Bq Er EINVAL -The value specified by +The value specified by the .Fa tid -is invalid +argument is invalid. .It Bq ESRC -No thread could be found corresponding to thread ID specified by +No thread could be found corresponding to the thread ID specified by the .Fa tid argument. .El @@ -66,9 +66,5 @@ argument. .Xr pthread_resume_np 3 , .Xr pthread_suspend_all_np 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org - +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/share/man/man3/pthread_switch_add_np.3 b/share/man/man3/pthread_switch_add_np.3 index 07476cf..9e7618c 100644 --- a/share/man/man3/pthread_switch_add_np.3 +++ b/share/man/man3/pthread_switch_add_np.3 @@ -30,7 +30,7 @@ .Sh NAME .Nm pthread_switch_add_np , .Nm pthread_switch_delete_np -.Nd threads context switches debugging primitives +.Nd thread context switches debugging primitives .Sh LIBRARY .Lb libc_r .Sh SYNOPSIS @@ -40,22 +40,22 @@ .Ft int .Fn pthread_switch_delete_np "pthread_switch_routine_t routine" .Sh DESCRIPTION -The application is allowed to monitor thread context switches inside -threading library. -An application can install routine that gets called everytime a thread -(explicitly created by the application with -.Fn pthread_create -function) gets context switched. -This routine gets passed the pthread IDs of the threads that are +An application is allowed to monitor the thread context switches inside +the threading library. +An application can install a routine that gets called every time a thread +(explicitly created by an application with the +.Xr pthread_create 3 +function) gets the context switched. +The routine is passed the thread IDs of the threads that are being switched in and out. -Installation and removal of these hooks may be done using +Installation and removal of these hooks may be done using the .Fn pthread_switch_add_np and .Fn pthread_switch_delete_np functions respectively. .Sh RETURN VALUES If successful, -functions return 0. +these functions return 0. Otherwise, an error number is returned to indicate the error. .Sh ERRORS The @@ -63,25 +63,25 @@ The may fail if: .Bl -tag -width Er .It Bq Er EINVAL -NULL pointer passed as +.Dv NULL +pointer was passed in the .Fa routine argument. .El +.Pp The .Fn pthread_switch_delete_np may fail if: .Bl -tag -width Er .It Bq Er EINVAL +The .Fa routine -argument is different from argument previously passed to +argument is different from the argument previously passed to the .Fn pthread_switch_add_np +function. .El .Sh SEE ALSO .Xr pthread_create 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org - +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/share/man/man4/aac.4 b/share/man/man4/aac.4 index 4425117..6d486f3 100644 --- a/share/man/man4/aac.4 +++ b/share/man/man4/aac.4 @@ -83,14 +83,18 @@ exist for the Dell and HP flavors, respectively, and are required for the CLI management utility available from these vendors to work. If the kernel is compiled with the .Dv COMPAT_LINUX -option, or the aac_linux.ko and linux.ko modules are loaded, the +option, or the +.Pa aac_linux.ko +and +.Pa linux.ko +modules are loaded, the Linux-compatible .Xr ioctl 2 interface for the management device will be enabled and will allow Linux-based management applications to control the card. .Pp The -.Cd aacp +.Nm aacp device enables the SCSI pass-thru interface and allows devices connected to the card such as cdroms to be available via the CAM .Xr scsi 4 diff --git a/share/man/man4/ciss.4 b/share/man/man4/ciss.4 index 7c79c05..e72613a 100644 --- a/share/man/man4/ciss.4 +++ b/share/man/man4/ciss.4 @@ -7,13 +7,11 @@ .Os .Sh NAME .Nm ciss -.Nd Common Interface for SCSI-3 Support driver. +.Nd Common Interface for SCSI-3 Support driver .Sh SYNOPSIS -For one or more adapters: -.Cd device scbus -.Cd device ciss +.Cd "device scbus" +.Cd "device ciss" .Sh DESCRIPTION -.Pp The .Nm driver claims to provide a common interface between generic SCSI @@ -24,29 +22,29 @@ The driver supports .Em CISS as defined in the document entitled -.Dq CISS Command Interface for SCSI-3 Support Open Specification , -Version 1.04, -Valence Number 1, dated 20001127, produced by Compaq Computer -Corporation. +.%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1" , +dated 2000/11/27, produced by Compaq Computer Corporation. .Pp We provide a shim layer between the .Nm -interface and CAM, +interface and +.Xr CAM 4 , offloading most of the queueing and being-a-disk chores onto CAM. Entry to the driver is via the PCI bus attachment -.Fa ciss_probe , -.Fa ciss_attach , -etc and via the CAM interface -.Fa ciss_cam_action , +.Fn ciss_probe , +.Fn ciss_attach , +etc. and via the CAM interface +.Fn ciss_cam_action , and -.Fa ciss_cam_poll . +.Fn ciss_cam_poll . The Compaq .Nm adapters require faked responses to get reasonable behavior out of them. In addition, the .Nm -command set is by no means adequate to support the functionality of a RAID controller, +command set is by no means adequate to support the functionality +of a RAID controller, and thus the supported Compaq adapters utilize portions of the control protocol from earlier Compaq adapter families. .Pp @@ -60,29 +58,36 @@ queues) to exchange commands with the adapter. Other interfaces are available, but we are not supposed to know about them, and it is dubious whether they would provide major performance improvements except under extreme load. -.Sh COMPATIBILITY -Non disk devices (such as internal DATs and devices +.Pp +Non-disk devices (such as internal DATs and devices attached to the external SCSI bus) are not yet supported. .Pp Supported controllers include: .Pp -.Bl -tag -compact -width "Compaq Smart Array 5* series" -.It Compaq Smart Array 5300 -.It Compaq Smart Array 532 -.It Compaq Smart Array 5i +.Bl -item -compact +.It +Compaq Smart Array 5300 +.It +Compaq Smart Array 532 +.It +Compaq Smart Array 5i .El .Sh SEE ALSO .Xr cam 4 , .Xr pass 4 , .Xr xpt 4 , -.Xr camcontrol 8 , -.Pp -.Dq CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, -Valence Number 1, dated 20001127, produced by Compaq Computer Corporation. +.Xr camcontrol 8 +.Rs +.%T "CISS Command Interface for SCSI-3 Support Open Specification, Version 1.04, Valence Number 1" +.%D 2000/11/27 +.%Q "Compaq Computer Corporation" +.Re .Sh AUTHORS +.An -nosplit The .Nm driver was written by .An Mike Smith Aq msmith@FreeBSD.org . +.Pp This manual page is based on his comments and was written by .An Tom Rhodes Aq trhodes@FreeBSD.org . diff --git a/share/man/man4/devctl.4 b/share/man/man4/devctl.4 index b2ea80f..e4eb5ef 100644 --- a/share/man/man4/devctl.4 +++ b/share/man/man4/devctl.4 @@ -22,35 +22,49 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $FreeBSD$ +.\" $FreeBSD$ .\" .Dd February 11, 2003 .Dt DEVCTL 4 .Os .Sh NAME .Nm devctl -.Nd Device event reporting and device control interface. +.Nd "device event reporting and device control interface" .Sh DESCRIPTION The .Nm device is used to report device events from the kernel. Future versions will allow for some device control as well. .Sh IMPLEMENTATION NOTES -This design allows only one reader for /dev/devctl. +This design allows only one reader for +.Pa /dev/devctl . This is not desirable in the long run, but will get a lot of hair out of this implementation. Maybe we should make this device a clonable device. .Pp -Also note: we specifically do not attach a device to the device_t tree +Also note: we specifically do not attach a device to the +.Vt device_t +tree to avoid potential chicken and egg problems. One could argue that all of this belongs to the root node. -One could also further argue that the sysctl interface that we have -not might more properly be an ioctl interface. +One could also further argue that the +.Xr sysctl 3 +interface that we have now might more properly be an +.Xr ioctl 2 +interface. .Pp -SIGIO support is included in the driver. -However, the author is not sure that the SIGIO support is done correctly. -It was copied from a driver that had SIGIO support that likely hasn't been -tested since 3.4 or 2.2.8! +.Dv SIGIO +support is included in the driver. +However, the author is not sure that the +.Dv SIGIO +support is done correctly. +It was copied from a driver that had +.Dv SIGIO +support that likely has not been +tested since +.Fx 3.4 +or +.Fx 2.2.8 ! .Pp The read channel for this device is used to report changes to userland in realtime. @@ -59,39 +73,49 @@ If you try to read this device a character at a time, you will loose the rest of the data. Listening programs are expected to cope. .Pp -The sysctl and boot parameter hw.bus.devctl_disable is used to disable +The sysctl and boot parameter +.Va hw.bus.devctl_disable +is used to disable .Nm -when no devd is running. +when no +.Xr devd 8 +is running. .Sh PROTOCOL +The .Nm -uses an ASCII protocol. +device +uses an +.Tn ASCII +protocol. The driver returns one record at a time to its readers. Each record is terminated with a newline. The first character of the record is the event type. .Pp .Bl -column -compact "Type" "Description" .Em "Type Description" -+ Device node in tree attached -- Device node in tree detached -? Unknown device detected ++ Device node in tree attached. +- Device node in tree detached. +? Unknown device detected. .El -.Ss Message formats +.Ss Message Formats Except for the first character in the record, attach and detach messages have the same format. -.D1 Tdev at parent on location -.Bl -column -compact "Part" "Description" +.Pp +.D1 Ar T Ns Ar dev Li at Ar parent Li on Ar location +.Pp +.Bl -column -compact "location" "Description" .Em "Part Description" -T + or - -dev The device name that was attached/detached -parent The device name of the parent bus that attached the device -location Bus specific location information +.It Ar T Ta "+ or -" +.It Ar dev Ta "The device name that was attached/detached." +.It Ar parent Ta "The device name of the parent bus that attached the device." +.It Ar location Ta "Bus specific location information." .El .Pp The nomatch messages can be used to load devices driver. If you load a device driver, then one of two things can happen. -If the device driver attaches to something, you'll get a device +If the device driver attaches to something, you will get a device attached message. -If it doesn't, then nothing will happen. +If it does not, then nothing will happen. .Pp The attach and detach messages arrive after the event. This means one cannot use the attach message to load an alternate @@ -101,4 +125,3 @@ One cannot use the detach messages to flush data to the device. The device is already gone. .Sh SEE ALSO .Xr devd 8 - diff --git a/share/man/man4/firewire.4 b/share/man/man4/firewire.4 index 1683e06..525ed4c 100644 --- a/share/man/man4/firewire.4 +++ b/share/man/man4/firewire.4 @@ -78,17 +78,17 @@ On .Nm bus, every device is identified with EUI 64 address. .Sh FILES -.Bl -tag -width indent -compact +.Bl -tag -compact .It Pa /dev/fw0 .It Pa /dev/fwmem0 .El .Sh SEE ALSO -.Xr fwcontrol 8 , .Xr fwe 4 , .Xr fwohci 4 , -.Xr kldload 8 , .Xr pci 4 , .Xr sbp 4 , +.Xr fwcontrol 8 , +.Xr kldload 8 , .Xr sysctl 8 .Sh HISTORY The @@ -106,6 +106,7 @@ and for the .Fx project. -.Pp .Sh BUGS -See fwohci(4) for security note. +See +.Xr fwohci 4 +for security note. diff --git a/share/man/man4/fwe.4 b/share/man/man4/fwe.4 index 939e168..b813417 100644 --- a/share/man/man4/fwe.4 +++ b/share/man/man4/fwe.4 @@ -74,11 +74,11 @@ Note this driver uses very different protocol from RFC 2734 .Xr arp 4 , .Xr firewire 4 , .Xr fwohci 4 , -.Xr kldload 8 , .Xr netintro 4 , .Xr ng_ether 4 , .Xr polling 4 , .Xr ifconfig 8 , +.Xr kldload 8 , .Xr sysctl 8 .Sh AUTHORS The diff --git a/share/man/man4/fwohci.4 b/share/man/man4/fwohci.4 index a85a43c..bfbf6b8 100644 --- a/share/man/man4/fwohci.4 +++ b/share/man/man4/fwohci.4 @@ -65,27 +65,30 @@ Ricoh R5C552 .El .Sh SEE ALSO .Xr firewire 4 , -.Xr fwcontrol 8 , .Xr fwe 4 , -.Xr kldload 8 , -.Xr sbp 4 +.Xr sbp 4 , +.Xr fwcontrol 8 , +.Xr kldload 8 .Sh HISTORY The .Nm device driver first appeared in .Fx 5.0 . .Sh AUTHORS +.An -nosplit The .Nm device driver was written by .An Katsushi Kobayashi and .An Hidetoshi Shimokawa . -.Pp .Sh BUGS The driver allows physical access from any nodes on the bus by default. This means that any devices on the bus can read and modify any memory space -which can be accessed by IEEE 1394 OHCI chip. It is allowed mostly -for sbp(4) devices. This should be changed to allow it only for specific -devices. Anyway FireWire is a bus and not expected to be connected with -un-trustable devices because a node can monitor all the traffic. +which can be accessed by IEEE 1394 OHCI chip. +It is allowed mostly for +.Xr sbp 4 +devices. +This should be changed to allow it only for specific devices. +Anyway, FireWire is a bus and not expected to be connected with +un-trustable devices because a node can monitor all the traffic. diff --git a/share/man/man4/gif.4 b/share/man/man4/gif.4 index 3f6520a..0012765 100644 --- a/share/man/man4/gif.4 +++ b/share/man/man4/gif.4 @@ -56,8 +56,7 @@ Each interface is created at runtime using interface cloning. This is most easily done with the -.Xr ifconfig 8 -.Cm create +.Dq Nm ifconfig Cm create command or using the .Va gifconfig_ Ns Aq Ar interface variable in diff --git a/share/man/man4/ida.4 b/share/man/man4/ida.4 index b0231ea..143caf5 100644 --- a/share/man/man4/ida.4 +++ b/share/man/man4/ida.4 @@ -9,11 +9,9 @@ .Nm ida .Nd Compaq Intelligent Drive Array Controllers .Sh SYNOPSIS -For one or more devices: .Cd device scbus .Cd device ida .Sh DESCRIPTION -.Pp The Compaq Intelligent Drive Array (IDA) technology is used to distribute data across an array of hard drives. It unites these hard drives into one or more high-performance logical drives. @@ -21,37 +19,49 @@ The drive array is managed by an array controller. .Pp These controllers have the ability to provide fault tolerance for the connected drives and optionally provide write cache for the logical drives. -It is also possible for an application to access the SCSI bus subsystem directly by -using the pass-through interface. -.Sh IMPLEMENTATION NOTES -Extreme caution should be exercised when using the pass-through interface. -It is possible to interfere with normal system I/O and cause hangs if -pass-through is used to an active device. -Pass-through should only be used to a device that is otherwise quiescent. -.Sh COMPATIBILITY +It is also possible for an application to access the SCSI bus subsystem +directly by using the pass-through interface. .Pp The following controllers are supported by the .Nm driver: -.Bl -tag -compact -width "Supported Devices" -.It Compaq SMART Array 221 -.It Compaq Integrated SMART Array Controller -.It Compaq SMART Array 4200 -.It Compaq SMART Array 4250ES -.It Compaq SMART 3200 Controller -.It Compaq SMART 3100ES Controller -.It Compaq SMART-2/DH Controller -.It Compaq SMART-2/SL Controller -.It Compaq SMART-2/P Controller -.It Compaq SMART-2/E Controller -.It Compaq SMART Controller +.Pp +.Bl -item -compact +.It +Compaq SMART Array 221 +.It +Compaq Integrated SMART Array Controller +.It +Compaq SMART Array 4200 +.It +Compaq SMART Array 4250ES +.It +Compaq SMART 3200 Controller +.It +Compaq SMART 3100ES Controller +.It +Compaq SMART-2/DH Controller +.It +Compaq SMART-2/SL Controller +.It +Compaq SMART-2/P Controller +.It +Compaq SMART-2/E Controller +.It +Compaq SMART Controller .El +.Sh IMPLEMENTATION NOTES +Extreme caution should be exercised when using the pass-through interface. +It is possible to interfere with normal system I/O and cause hangs if +pass-through is used to an active device. +Pass-through should only be used to a device that is otherwise quiescent. .Sh SEE ALSO .Xr cam 4 , .Xr pass 4 , .Xr xpt 4 , -.Xr camcontrol 8 . +.Xr camcontrol 8 .Sh AUTHORS +.An -nosplit The .Nm driver was written by diff --git a/share/man/man4/iir.4 b/share/man/man4/iir.4 index 7c5f5b9f..6ff0b2a 100644 --- a/share/man/man4/iir.4 +++ b/share/man/man4/iir.4 @@ -7,34 +7,39 @@ .Os .Sh NAME .Nm iir -.Nd Intel Integrated RAID Controller and ICP Vortex driver +.Nd Intel Integrated RAID controller and ICP Vortex driver .Sh SYNOPSIS -For one or more adapters: -.Cd device scbus -.Cd device iir +.Cd "device scbus" +.Cd "device iir" .Sh DESCRIPTION -.Pp The .Nm driver claims to interface with the Intel integrated -RAID controller cards, and the all versions of the +RAID controller cards, and all versions of the ICP Vortex controllers (including FC). -.Sh COMPATIBILITY .Pp Supported controllers include: .Pp -.Bl -tag -compact -width "Supported RAID Controllers" -.It Intel RAID Controller SRCMR -.It Intel Server RAID Controller U3-l (SRCU31a) -.It Intel Server RAID Controller U3-1L (SRCU31La) -.It Intel Server RAID Controller U3-2 (SRCU32) -.It All past and future releases of Intel and ICP RAID Controllers. +.Bl -item -compact +.It +Intel RAID Controller SRCMR +.It +Intel Server RAID Controller U3-l (SRCU31a) +.It +Intel Server RAID Controller U3-1L (SRCU31La) +.It +Intel Server RAID Controller U3-2 (SRCU32) +.It +All past and future releases of Intel and ICP RAID Controllers. .El .Pp -.Bl -tag -compact -width "Unsupported RAID Controllers" -.It Intel RAID Controller SRCU21 (discontinued) -.It Intel RAID Controller SRCU31 (older revision, not compatible) -.It Intel RAID Controller SRCU31L (older revision, not compatible) +.Bl -item -compact +.It +Intel RAID Controller SRCU21 (discontinued) +.It +Intel RAID Controller SRCU31 (older revision, not compatible) +.It +Intel RAID Controller SRCU31L (older revision, not compatible) .El .Pp The SRCU31 and SRCU31L can be updated via a firmware update available @@ -43,19 +48,21 @@ from Intel. .Xr cam 4 , .Xr pass 4 , .Xr xpt 4 , -.Xr camcontrol 8 . +.Xr camcontrol 8 .Sh AUTHORS The .Nm driver is supported and maintained by -.An -nosplit Achim Leubner Aq achim.leubner@intel.com +.An -nosplit +.An Achim Leubner Aq achim.leubner@intel.com and .An Boji Tony Kannanthanam Aq boji.t.kannanthanam@intel.com -of Intel's Storage Components devision. +of Intel's Storage Components division. +.Pp This manual page was written by .An Tom Rhodes Aq trhodes@FreeBSD.org and is based on information supplied by the driver authors and the website of -.An Mike Smith Aq msith@FreeBSD.org +.An Mike Smith Aq msith@FreeBSD.org . .Sh BUGS During a .Fx diff --git a/share/man/man4/ip.4 b/share/man/man4/ip.4 index 99a20fd..7130014 100644 --- a/share/man/man4/ip.4 +++ b/share/man/man4/ip.4 @@ -176,49 +176,52 @@ use the default range of values, normally through .Dv IPPORT_HILASTAUTO . This is adjustable through the sysctl setting: -.Sy net.inet.ip.portrange.first +.Va net.inet.ip.portrange.first and -.Sy net.inet.ip.portrange.last . +.Va net.inet.ip.portrange.last . .It Dv IP_PORTRANGE_HIGH use a high range of values, normally .Dv IPPORT_HIFIRSTAUTO and .Dv IPPORT_HILASTAUTO . This is adjustable through the sysctl setting: -.Sy net.inet.ip.portrange.hifirst +.Va net.inet.ip.portrange.hifirst and -.Sy net.inet.ip.portrange.hilast . +.Va net.inet.ip.portrange.hilast . .It Dv IP_PORTRANGE_LOW use a low range of ports, which are normally restricted to privileged processes on .Ux systems. The range is normally from -.Dv IPPORT_RESERVED - 1 -down to +.Dv IPPORT_RESERVED +\- 1 down to .Li IPPORT_RESERVEDSTART in descending order. This is adjustable through the sysctl setting: -.Sy net.inet.ip.portrange.lowfirst +.Va net.inet.ip.portrange.lowfirst and -.Sy net.inet.ip.portrange.lowlast . +.Va net.inet.ip.portrange.lowlast . .El .Pp The range of privileged ports which only may be opened by root-owned processes may be modified by the -.Sy net.inet.ip.portrange.reservedlow +.Va net.inet.ip.portrange.reservedlow and -.Sy net.inet.ip.portrange.reservedhigh +.Va net.inet.ip.portrange.reservedhigh sysctl settings. The values default to the traditional range, 0 through -.Dv IPPORT_RESERVED - 1 +.Dv IPPORT_RESERVED +\- 1 (0 through 1023), respectively. Note that these settings do not affect and are not accounted for in the use or calculation of the other -.Sy net.inet.ip.portrange +.Va net.inet.ip.portrange values above. -Changing these values departs from Unix tradition and has security -concequences that the administrator should carefully evaluate before +Changing these values departs from +.Ux +tradition and has security +consequences that the administrator should carefully evaluate before modifying these settings. .Ss "Multicast Options" .Pp diff --git a/share/man/man4/lmc.4 b/share/man/man4/lmc.4 index 9d5e5cb..2cbbd50 100644 --- a/share/man/man4/lmc.4 +++ b/share/man/man4/lmc.4 @@ -39,40 +39,40 @@ .Os .Sh NAME .Nm lmc -.Nd LAN Media Corp PCI WAN adapter driver +.Nd LAN Media Corp. PCI WAN adapter driver .Sh SYNOPSIS .Cd "device lmc" .Sh DESCRIPTION The .Nm -driver supports Lan Media Corp Wide Area Network +driver supports Lan Media Corp. Wide Area Network .Pq Tn WAN adapters based on the .Tn DEC .Tn DECchip -21140A (DEC "Tulip") +21140A (DEC +.Dq Tulip ) .Tn PCI Fast .Tn Ethernet controller. Supported boards include: -.Pp -.Bl -tag -width xxxx -offset indent +.Bl -tag -width "LMC5200" .It LMC1000 Synchronous Serial Interface adapter (V.10/RS423, EIA530A, X.21, V.35, -EIA449/EIA530/V.36, and V.28/EIA232) +EIA449/EIA530/V.36, and V.28/EIA232). .It LMC1200 T1/E1 .Tn WAN -adapter +adapter. .It LMC5200 High Speed Synchronous Interface .Pq Tn HSSI -adapter +adapter. .It LMC5245 DS3 .Tn WAN -adapter +adapter. .El .Sh SEE ALSO .Xr arp 4 , @@ -86,6 +86,6 @@ The .Nm driver appeared in -.Fx 5.0 +.Fx 5.0 and .Nx 1.4 . diff --git a/share/man/man4/random.4 b/share/man/man4/random.4 index a61c107..059db4c 100644 --- a/share/man/man4/random.4 +++ b/share/man/man4/random.4 @@ -201,29 +201,30 @@ The sequence of numbers should also appear numerically uncorrelated, as simulation often assumes independence of its random inputs. Often it is desirable to reproduce the results of a simulation exactly, -so that if the generator is seeded in the same way +so that if the generator is seeded in the same way, it should produce the same results. A peripheral concern for simulation is the speed of a random number generator. .Pp Another issue in simulation is -the size of the state associated with the random number generator and +the size of the state associated with the random number generator, and how frequently it repeats itself. For example, a program which shuffles a pack of cards should have 52! possible outputs, which requires the random number generator to have 52! starting states. This means the seed should have at least log_2(52!) ~ 226 bits of state if the program is to stand a chance of outputting all possible sequences, -and the program needs some unbiased way of generating these these bits. +and the program needs some unbiased way of generating these bits. Again, the .Nm device could be used for seeding here, -but in practice smaller seeds are usually considered acceptable. +but in practice, smaller seeds are usually considered acceptable. .Pp .Fx provides two families of functions which are considered -suitable for simulation. The +suitable for simulation. +The .Xr random 3 family of functions provides a random integer between 0 to @@ -246,8 +247,8 @@ The family of functions are also provided, which provide random floating point numbers in various ranges. .Pp -Randomness as used for collision avoidance, -for example in certain network protocols, +Randomness that is used for collision avoidance +(for example, in certain network protocols) has slightly different semantics again. It is usually expected that the numbers will be uniform, as this produces the lowest chances of collision. @@ -260,7 +261,7 @@ unlike the previous cases. .Pp One final consideration for the seeding of random number generators is a bootstrapping problem. -In some cases it may be difficult to find enough randomness to +In some cases, it may be difficult to find enough randomness to seed a random number generator until a system is fully operational, but the system requires random numbers to become fully operational. There is no substitute for careful thought here, @@ -281,16 +282,16 @@ it is known to be poor for simulation and absolutely unsuitable for cryptographic purposes, so its use is discouraged. .Sh FILES -.Bl -tag -width /dev/random +.Bl -tag -width ".Pa /dev/random" .It Pa /dev/random .El .Sh SEE ALSO -.Xr RAND_add 3 , -.Xr RAND_bytes 3 , .Xr arc4random 3 , .Xr drand48 3 , .Xr rand 3 , .Xr random 3 , +.Xr RAND_add 3 , +.Xr RAND_bytes 3 , .Xr sysctl 8 .Sh HISTORY A diff --git a/share/man/man4/sbp.4 b/share/man/man4/sbp.4 index 2b2e6f5..883d910 100644 --- a/share/man/man4/sbp.4 +++ b/share/man/man4/sbp.4 @@ -58,18 +58,22 @@ driver provides support for SBP-2 devices that attach to the firewire It should work with SBP-2 devices which CAM layer supports, for example, HDD, CDROM drive and DVD drive. .Pp -Some users familier with +Some users familiar with .Xr umass 4 -might wander why the device is not detached at the CAM layer when the device -is unplugged. It's detached only if the device has not been plugged again -during several bus resets. This is for preventing to detach an active filesystem +might wonder why the device is not detached at the CAM layer when the device +is unplugged. +It is detached only if the device has not been plugged again +during several bus resets. +This is for preventing to detach an active file system even when the device cannot be probe correctly for some reason after a bus reset or when the device is temporary disconnected because the user changes the bus -topology. If you want to force to detach the device, run 'fwcontrol -r' +topology. +If you want to force to detach the device, run +.Dq Nm fwcontrol Fl r several times. .Sh SEE ALSO -.Xr camcontrol 8 , .Xr firewire 4 , +.Xr camcontrol 8 , .Xr fwcontrol 8 , .Xr kldload 8 , .Xr sysctl 8 diff --git a/share/man/man4/targ.4 b/share/man/man4/targ.4 index d623c12..5e8a727 100644 --- a/share/man/man4/targ.4 +++ b/share/man/man4/targ.4 @@ -48,7 +48,9 @@ driver supplies control devices, .Pa /dev/targ0 , .Pa /dev/targ1 , etc. -If a device is already in use, open(2) will fail and +If a device is already in use, +.Xr open 2 +will fail and .Va errno will be set to .Er EBUSY . diff --git a/share/man/man4/vinum.4 b/share/man/man4/vinum.4 index 52e4c8e..e86af66 100644 --- a/share/man/man4/vinum.4 +++ b/share/man/man4/vinum.4 @@ -178,7 +178,7 @@ perform this function. .El .Sh KERNEL CONFIGURATION .Nm -is currently supplied as a loadable kernel module (KLD), and does not require +is currently supplied as a KLD module, and does not require configuration. As with other KLDs, it is absolutely necessary to match the KLD to the version of the operating system. @@ -236,7 +236,7 @@ explaining the problem and what to do to correct it. Make .Nm automatically scan all available disks at attach time. -This is a deprecated way that is primarily intented for environments +This is a deprecated way that is primarily intended for environments that do not want to rely on kernel environment variables set by .Xr loader 8 . .Pp @@ -311,8 +311,8 @@ subsystem can be automatically started at attach time. There are two kernel environment variables that can be set in .Xr loader.conf 5 to accomplish this. -.Bl -tag -width "vinum.autostart" -offset indent -.It Dv vinum.autostart +.Bl -tag -width ".Va vinum.autostart" -offset indent +.It Va vinum.autostart If this variable is set (to any value), the attach function will attempt to scan all available disks for valid .Nm @@ -321,10 +321,12 @@ This is the preferred way if automatic startup is desired. .Pp Example: .Dl vinum.autostart="YES" -.It Dv vinum.drives +.It Va vinum.drives Alternatively, this variable can enumerate a list of disk devices to scan for configuration records. -Note that only the `bare' device names need to be given, since +Note that only the +.Dq bare +device names need to be given, since .Nm will automatically scan all possible slices and partitions. .Pp @@ -338,7 +340,7 @@ variable of .Xr rc.conf 5 . Note that if .Nm -is to supply to the volume for the root filesystem, it is necessary +is to supply to the volume for the root file system, it is necessary to start the subsystem early. This can be achieved by specifying .Pp diff --git a/share/man/man4/wi.4 b/share/man/man4/wi.4 index a52c714..dc6b988 100644 --- a/share/man/man4/wi.4 +++ b/share/man/man4/wi.4 @@ -31,12 +31,12 @@ .\" $FreeBSD$ .\" $OpenBSD: wi.4tbl,v 1.14 2002/04/29 19:53:50 jsyn Exp $ .\" -.Dd January +.Dd February 17, 2003 .Dt WI 4 .Os .Sh NAME .Nm wi -.Nd "Lucent Heremes, Intersil PRISM and Spectrum24 IEEE 802.11 driver" +.Nd "Lucent Hermes, Intersil PRISM and Spectrum24 IEEE 802.11 driver" .Sh SYNOPSIS .Cd "device wi" .Sh DESCRIPTION diff --git a/share/man/man5/msdosfs.5 b/share/man/man5/msdosfs.5 index 0c75099..d2ee45c 100644 --- a/share/man/man5/msdosfs.5 +++ b/share/man/man5/msdosfs.5 @@ -7,33 +7,27 @@ .Os .Sh NAME .Nm msdosfs -.Nd msdos file system +.Nd MS-DOS file system .Sh SYNOPSIS -.Bd -literal -/dev/ad0sN /dos msdosfs rw 0 0 -.Ed -.Pp -To link into the kernel: .Cd "options MSDOSFS" .Sh DESCRIPTION -.Pp The .Nm driver will permit the .Fx kernel to read and write -.Em msdos +.Tn MS-DOS based file systems. .Pp The most common usage follows: .Pp -.Dl "# mount_msdosfs /dev/ad0sN /dos +.Dl "mount_msdosfs /dev/ad0sN /mnt" .Pp where -.Sy N +.Ar N is the partition number and .Pa /mnt -is a mount point directory in the root file system. +is a mount point. Some users tend to create a .Pa /dos directory for @@ -50,7 +44,7 @@ that looks similar to: .Ed .Pp This will mount an -.Em msdos +.Tn MS-DOS based partition at the .Pa /dos mount point during system boot. @@ -58,7 +52,7 @@ Using .Pa /mnt as a permanent mount point is not advised as its intention has always been to be a temporary mount point for floppy and -zip disks. +ZIP disks. See .Xr hier 7 for more information on @@ -69,7 +63,7 @@ directory layout. .Xr unmount 2 , .Xr mount 8 , .Xr mount_msdosfs 8 , -.Xr umount 8 , +.Xr umount 8 .Rs .%T "The FreeBSD Handbook" .%O "http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/" diff --git a/share/man/man5/periodic.conf.5 b/share/man/man5/periodic.conf.5 index df394b6..84bd970 100644 --- a/share/man/man5/periodic.conf.5 +++ b/share/man/man5/periodic.conf.5 @@ -237,12 +237,12 @@ if you want the removed files to be reported in your daily output. Set to .Dq YES to run -.Ic sendmail -bH +.Nm sendmail Fl bH to automatically purge stale entries from .Xr sendmail 8 Ns 's host status cache. Files will be deleted using the same criteria as -.Nm sendmail +.Xr sendmail 8 would normally use when determining whether to believe the cached information, as configured in .Pa /etc/mail/sendmail.cf . @@ -279,7 +279,7 @@ file backed up and modifications to be displayed in your daily output. Set to .Dq YES if you want to run -.Ic calendar -a +.Nm calendar Fl a daily. .It Va daily_accounting_enable .Pq Vt bool @@ -341,7 +341,7 @@ if you want to run (with the arguments supplied in .Va daily_status_disks_df_flags ) and -.Ic dump -W . +.Nm dump Fl W . .It Va daily_status_disks_df_flags .Pq Vt str Set to the arguments for the @@ -355,7 +355,7 @@ is set to Set to .Dq YES if you want to run -.Ic netstat -i . +.Nm netstat Fl i . .It Va daily_status_network_usedns .Pq Vt bool Set to @@ -390,7 +390,7 @@ if you want to run Set to .Dq YES if you want to shorten the -.Nm mailq +.Xr mailq 1 output when .Va daily_status_mailq_enable is set to @@ -601,7 +601,7 @@ Set to if you want to run .Pa /usr/libexec/locate.updatedb . This script is run using -.Ic nice -5 +.Nm nice Fl 5 as user .An nobody , and generates the table used by the diff --git a/share/man/man7/operator.7 b/share/man/man7/operator.7 index ef6cb6d..b092bef 100644 --- a/share/man/man7/operator.7 +++ b/share/man/man7/operator.7 @@ -32,7 +32,7 @@ .\" @(#)operator.7 8.1 (Berkeley) 6/9/93 .\" $FreeBSD$ .\" -.Dd June 9, 1993 +.Dd January 22, 2003 .Dt OPERATOR 7 .Os .Sh NAME @@ -40,24 +40,24 @@ .Nd C operator precedence and order of evaluation .Sh DESCRIPTION .Bd -ragged -offset indent -compact -.Bl -column "\&= += -= *= /= %= <<= >>= &= ^= |=" +.Bl -column "= += -= *= /= %= <<= >>= &= ^= |=" .It Sy "Operator Associativity" .It "-------- -------------" -.It "\&() [] -> . left to right" +.It "() [] -> . left to right" .It "! ~ ++ -- - (type) * & sizeof right to left" -.It "\&* / % left to right" -.It "\&+ - left to right" -.It "\&<< >> left to right" -.It "\&< <= > >= left to right" -.It "\&== != left to right" -.It "\&& left to right" -.It "\&^ left to right" -.It "\&| left to right" -.It "\&&& left to right" -.It "\&|| left to right" -.It "\&?: right to left" -.It "\&= += -= *= /= %= <<= >>= &= ^= |= right to left" -.It "\&, left to right" +.It "* / % left to right" +.It "+ - left to right" +.It "<< >> left to right" +.It "< <= > >= left to right" +.It "== != left to right" +.It "& left to right" +.It "^ left to right" +.It "| left to right" +.It "&& left to right" +.It "|| left to right" +.It "?: right to left" +.It "= += -= *= /= %= <<= >>= &= ^= |= right to left" +.It ", left to right" .El .Ed .Sh FILES diff --git a/share/man/man8/diskless.8 b/share/man/man8/diskless.8 index f368a5e..45ddabb 100644 --- a/share/man/man8/diskless.8 +++ b/share/man/man8/diskless.8 @@ -26,7 +26,7 @@ .\" .\" $FreeBSD$ .\" -.Dd April 18, 2001 +.Dd December 23, 2002 .Dt DISKLESS 8 .Os .Sh NAME @@ -38,76 +38,130 @@ The ability to boot a machine over the network is useful for or .Em dataless machines, or as a temporary measure while repairing or -re-installing filesystems on a local disk. +re-installing file systems on a local disk. This file provides a general description of the interactions between a client and its server when a client is booting over the network. .Sh OPERATION When booting a system over the network, there are three phases of interaction between client and server: -.Pp -.Bl -enum -compact +.Bl -enum .It -The stage-1 bootstrap, typically PXE built into your ethernet +The stage-1 bootstrap, typically PXE built into your Ethernet card, loads a second-stage boot program. .It -The second-stage boot program, typically 'pxeboot', loads modules and -the kernel and boots the kernel. +The second-stage boot program, typically +.Xr pxeboot 8 , +loads modules and +the kernel, and boots the kernel. .It -The kernel NFS mounts the root directory and continues from there. +The kernel +.Tn NFS +mounts the root directory and continues from there. .El .Pp Each of these phases are described in further detail below. .Pp -First the stage-1 bootstrap loads the stage-2 boot program over -the network. The stage-1 bootstrap typically uses BOOTP or DHCP -to obtain the filename to load, then uses TFTP to load the file. -This file is typically called "pxeboot" and should be copied from +First, the stage-1 bootstrap loads the stage-2 boot program over +the network. +The stage-1 bootstrap typically uses +.Tn BOOTP +or +.Tn DHCP +to obtain the filename to load, then uses +.Tn TFTP +to load the file. +This file is typically called +.Pa pxeboot , +and should be copied from .Pa /boot/pxeboot -into the tftp directory on the server, which is typically +into the +.Tn TFTP +directory on the server, which is typically .Pa /tftpdir . .Pp The stage-2 boot program then loads additional modules and the kernel. -These files may not exist on the DHCP or BOOTP server. You can use the -.Sy next-server -option available in DHCP configurations to specify the server holding -the second stage boot files and kernel. The stage-2 program uses -NFS or TFTP to obtain these files. By default, NFS is used. -If you are using pxeboot you can install a version that uses -TFTP by setting LOADER_TFTP_SUPPORT=YES +These files may not exist on the +.Tn DHCP +or +.Tn BOOTP +server. +You can use the +.Ic next-server +option available in +.Tn DHCP +configurations to specify the server holding +the second stage boot files and kernel. +The stage-2 program uses +.Tn NFS +or +.Tn TFTP +to obtain these files. +By default, +.Tn NFS +is used. +If you are using +.Xr pxeboot 8 , +you can install a version that uses +.Tn TFTP +by setting +.Li LOADER_TFTP_SUPPORT=YES in your .Pa /etc/make.conf , -then recompiling and reinstalling pxeboot via the command listed below. -It is often necessary to use TFTP here so you can place a custom kernel -in /tftpdir/. -If you use NFS and do not have a custom root filesystem for the diskless +then recompiling and reinstalling +.Xr pxeboot 8 +via the command listed below. +It is often necessary to use +.Tn TFTP +here so you can place a custom kernel +in +.Pa /tftpdir/ . +If you use +.Tn NFS +and do not have a custom root file system for the +.Nm client, the stage-2 boot will load your server's kernel as the kernel for -the diskless machine, which may not be what you want to have happen. +the +.Nm +machine, which may not be what you want to have happen. .Bd -literal -offset indent cd /usr/src/sys/i386/boot make clean; make; make install cp /boot/pxeboot /tftpdir/ .Ed .Pp -In phase 3, the kernel again uses DHCP or BOOTP to acquire +In phase 3, the kernel again uses +.Tn DHCP +or +.Tn BOOTP +to acquire configuration information, and proceeds to mount the -root filesystem and start operation. The boot -scripts recognize a diskless startup and peform +root file system and start operation. +The boot +scripts recognize a +.Nm +startup and perform the actions found in .Pa /etc/rc.d/initdiskless and .Pa /etc/rc.d/diskless . -In older systems the scripts are located in +On older systems, the scripts are located in .Pa /etc/rc.diskless1 and .Pa /etc/rc.diskless2 . .Sh CONFIGURATION -In order to run a diskless client, you need the following: +In order to run a +.Nm +client, you need the following: .Bl -bullet .It -An NFS server which exports a root and /usr partition with -appropriate permissions. -The diskless -scripts work with readonly partitions, as long as root is exported with +An +.Tn NFS +server which exports a root and +.Pa /usr +partitions with appropriate permissions. +The +.Nm +scripts work with read-only partitions, as long as root is exported with .Fl maproot Ns =0 so that some system files can be accessed. As an example, @@ -120,15 +174,15 @@ can contain the following lines: .Pp where .Aq ROOT -is the mountpoint on the server of the root partition. +is the mount point on the server of the root partition. The script .Pa /usr/share/examples/diskless/clone_root -can be used to create a shared readonly root partition, +can be used to create a shared read-only root partition, but in many cases you may decide to export -(again as readonly) the root directory used by +(again as read-only) the root directory used by the server itself. .It -a +A .Tn BOOTP or .Tn DHCP @@ -136,7 +190,7 @@ server. .Xr bootpd 8 can be enabled by uncommenting the -.Em bootps +.Dq Li bootps line in .Pa /etc/inetd.conf . A sample @@ -164,7 +218,8 @@ A properly initialized root partition. The script .Pa /usr/share/examples/diskless/clone_root can help in creating it, using the server's root partition -as a reference. If you are just starting out you should +as a reference. +If you are just starting out, you should simply use the server's own root directory, .Pa / , and not try to clone it. @@ -173,11 +228,17 @@ You often do not want to use the same .Pa rc.conf or .Pa rc.local -files for the diskless boot as you do on the server. The diskless boot +files for the +.Nm +boot as you do on the server. +The +.Nm +boot scripts provide a mechanism through which you can override various files in .Pa /etc -(as well as other subdirectories of root). The scripts provide four +(as well as other subdirectories of root). +The scripts provide four overriding directories situated in .Pa /conf/base , .Pa /conf/default , @@ -188,26 +249,35 @@ You should always create .Pa /conf/base/etc , which will entirely replace the server's .Pa /etc -on the diskless machine. +on the +.Nm +machine. You can clone the server's .Pa /etc -here or you can create a special file which tells the diskless boot scripts +here or you can create a special file which tells the +.Nm +boot scripts to remount the server's .Pa /etc onto .Pa /conf/base/etc . You do this by creating the file .Pa /conf/base/etc/diskless_remount -containing the mount point to use as a basis of the diskless machine's +containing the mount point to use as a basis of the +.Nm +machine's .Pa /etc . For example, the file might contain: -.Bd -literal -offset 4n -10.0.0.1:/etc -.Ed .Pp -The diskless scripts create memory filesystems to hold the overriden -directories. Only a 2MB partition is created by default, which may not -be sufficient for your purposes. To override this you can create the +.Dl 10.0.0.1:/etc +.Pp +The +.Nm +scripts create memory file systems to hold the overriden +directories. +Only a 2MB partition is created by default, which may not +be sufficient for your purposes. +To override this, you can create the file .Pa /conf/base/etc/md_size containing the size, in 512 byte sectors, of the memory disk to create @@ -215,22 +285,26 @@ for that directory. .Pp You then typically provide file-by-file overrides in the .Pa /conf/default/etc -directory. At a minimum you must provides overrides for -.Pa /etc/fstab , -.Pa /etc/rc.conf , +directory. +At a minimum, you must provide overrides for +.Pa /etc/fstab , /etc/rc.conf , and .Pa /etc/rc.local via -.Pa /conf/default/etc/fstab , -.Pa /conf/default/etc/rc.conf , +.Pa /conf/default/etc/fstab , /conf/default/etc/rc.conf , and .Pa /conf/default/etc/rc.local . .Pp -Overrides are hierarchical. You can supply network-specific defaults +Overrides are hierarchical. +You can supply network-specific defaults in the -.Pa /conf/<BROADCASTIP>/etc -directory, where <BROADCASTIP> represents the broadcast IP address of -the diskless system as given to it via +.Pa /conf/ Ns Ao Ar BROADCASTIP Ac Ns Pa /etc +directory, where +.Aq Ar BROADCASTIP +represents the broadcast IP address of +the +.Nm +system as given to it via .Tn BOOTP . The .Pa diskless_remount @@ -248,13 +322,15 @@ Since you normally clone the server's .Pa /etc using the .Pa /conf/base/etc/diskless_remount , -you might wish to remove unneeded files from the memory filesystem. For -example, if the server has a firewall but you do not, you might wish +you might wish to remove unneeded files from the memory file system. +For example, +if the server has a firewall but you do not, you might wish to remove .Pa /etc/ipfw.conf . You can do this by creating a -.Pa /conf/base/<DIRECTORY>.remove -file. For example, +.Pa /conf/base/ Ns Ao Ar DIRECTORY Ac Ns Pa .remove +file. +For example, .Pa /conf/base/etc.remove , which contains a list of relative paths that the boot scripts should remove from the memory file systems. @@ -270,11 +346,15 @@ proc /proc procfs rw 0 0 You also need to create a customized version of .Pa /conf/default/etc/rc.conf which should contain -the startup options for the diskless client, and +the startup options for the +.Nm +client, and .Pa /conf/default/etc/rc.local which could be empty but prevents the server's own .Pa /etc/rc.local -from leaking onto the diskless system. +from leaking onto the +.Nm +system. .Pp In .Pa rc.conf , @@ -289,27 +369,38 @@ Finally, it might be convenient to use a statement using .Li `hostname` as the switch variable to do machine-specific configuration -in case a number of diskless clients share the same configuration +in case a number of +.Nm +clients share the same configuration files. .It -The kernel for the diskless clients, which will be loaded using -NFS or TFTP, should be built with at least the following options: -.Bd -literal -offset indent -options BOOTP -options BOOTP_NFSROOT -options BOOTP_COMPAT -.Ed +The kernel for the +.Nm +clients, which will be loaded using +.Tn NFS +or +.Tn TFTP , +should be built with at least the following options: +.Pp +.D1 Cd "options BOOTP" +.D1 Cd "options BOOTP_NFSROOT" +.D1 Cd "options BOOTP_COMPAT" .Pp In the devices section add: -.Bd -literal -offset indent -device md -.Ed .Pp -If you use the firewall, remember to default to open or your kernel -will not be able to send/receive the bootp packets. +.D1 Cd "device md" +.Pp +If you use the firewall, remember to default to +.Dq open , +or your kernel +will not be able to send/receive the +.Tn BOOTP +packets. .El .Sh SECURITY ISSUES -Be warned that using unencrypted NFS to mount root and user +Be warned that using unencrypted +.Tn NFS +to mount root and user partitions may expose information such as encryption keys. .Sh BUGS @@ -318,7 +409,7 @@ This manpage is probably incomplete. .Fx sometimes requires to write onto the root partition, so the startup scripts mount MFS -filesystems on some locations (e.g.\& +file systems on some locations (e.g.\& .Pa /etc and .Pa /var ) , @@ -333,5 +424,6 @@ The process might not handle all cases. .Xr nfsd 8 , .Xr pxeboot 8 , .Xr reboot 8 , -.Xr tftpd 8 , -.Xr ports/net/etherboot +.Xr tftpd 8 +.Pp +.Pa ports/net/etherboot diff --git a/share/man/man9/sleep.9 b/share/man/man9/sleep.9 index b883f17..0954ae2 100644 --- a/share/man/man9/sleep.9 +++ b/share/man/man9/sleep.9 @@ -24,7 +24,7 @@ .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" .\" $FreeBSD$ -.\" " +.\" .Dd December 17, 1998 .Os .Dt SLEEP 9 @@ -54,14 +54,14 @@ and handle event-based process blocking. If a process must wait for an external event, it is put on sleep by -.Nm tsleep . +.Fn tsleep . The parameter .Ar ident is an arbitrary address that uniquely identifies the event on which the process is being asleep. All processes sleeping on a single .Ar ident are woken up later by -.Nm wakeup , +.Fn wakeup , often called from inside an interrupt routine, to indicate that the resource the process was blocking on is available now. .Pp @@ -83,7 +83,7 @@ but only one of them can actually do any useful work when made runnable. .Pp The -.Nm tsleep +.Fn tsleep function is the general sleep call. Suspends the current process until a wakeup is performed on the specified identifier. @@ -113,12 +113,12 @@ is returned if the system call should be interrupted by the signal .Er EINTR ) . .Pp The -.Nm msleep +.Fn msleep function is a variation on tsleep. The parameter .Ar mtx is a mutex, which will be exited before sleeping, and entered before -.Nm msleep +.Fn msleep returns. If .Ar pri @@ -144,12 +144,12 @@ appeared in a very early version of .Ux . .Pp The -.Nm tsleep +.Fn tsleep function appeared in .Bx 4.4 . .Pp The -.Nm +.Fn sleep function used to be the traditional form. It does not let you specify a timeout or a .Ar wmesg , |
