diff options
| author | ru <ru@FreeBSD.org> | 2001-02-01 16:38:02 +0000 |
|---|---|---|
| committer | ru <ru@FreeBSD.org> | 2001-02-01 16:38:02 +0000 |
| commit | 8a6f8b5fe456b5b3a8f1d86173f81cfcae6cfe19 (patch) | |
| tree | b428fc12404c6d6be2c1fce52490993ab3744097 /share | |
| parent | 4923ae6c3fe2f82d94fec60b85ed2a6272b2fd67 (diff) | |
| download | FreeBSD-src-8a6f8b5fe456b5b3a8f1d86173f81cfcae6cfe19.zip FreeBSD-src-8a6f8b5fe456b5b3a8f1d86173f81cfcae6cfe19.tar.gz | |
mdoc(7) police: split punctuation characters + misc fixes.
Diffstat (limited to 'share')
92 files changed, 1017 insertions, 754 deletions
diff --git a/share/examples/mdoc/example.3 b/share/examples/mdoc/example.3 index d4d495c..a887b7a 100644 --- a/share/examples/mdoc/example.3 +++ b/share/examples/mdoc/example.3 @@ -65,7 +65,8 @@ may have one of the following values: .Bl -tag -width EXAMPLE_ONE .It Dv EXAMPLE_ONE First example of a defined variable. -.Dv EXAMPLE_ONE is described below. +.Dv EXAMPLE_ONE +is described below. .It Dv EXAMPLE_TWO Second example. .El diff --git a/share/man/man3/bitstring.3 b/share/man/man3/bitstring.3 index 242e640..89521d6 100644 --- a/share/man/man3/bitstring.3 +++ b/share/man/man3/bitstring.3 @@ -43,7 +43,7 @@ .Nm bit_decl , .Nm bit_ffs , .Nm bit_nclear , -.Nm bit_nset, +.Nm bit_nset , .Nm bit_set , .Nm bitstr_size , .Nm bit_test diff --git a/share/man/man3/intro.3 b/share/man/man3/intro.3 index bc6e461..954464f 100644 --- a/share/man/man3/intro.3 +++ b/share/man/man3/intro.3 @@ -71,7 +71,8 @@ to supply the loader flag .Fl l Ns Ar c for these functions. There are several `libraries' or groups of functions included inside of -.Xr libc : the standard +.Xr libc : +the standard .Tn I/O routines, database routines, @@ -80,11 +81,10 @@ string operators, character tests and character operators, des encryption routines, storage allocation, time functions, signal handling and more. -.It Xo -.Xr libcurses -.Pf ( Fl l Ns Ar curses -.Fl l Ns Ar termcap ) -.Xc +.It Xr libcurses Po +.Fl l Ns Ar curses +.Fl l Ns Ar termcap +.Pc Terminal independent screen management routines for two dimensional non-bitmap display terminals. (See diff --git a/share/man/man3/pthread.3 b/share/man/man3/pthread.3 index 5287da2..b76ce73 100644 --- a/share/man/man3/pthread.3 +++ b/share/man/man3/pthread.3 @@ -64,142 +64,310 @@ Cleanup Routines .El .Sh THREAD ROUTINES .Bl -tag -width Er -.It int Fn pthread_create "pthread_t *thread" "const pthread_attr_t *attr" "void *(*start_routine)(void *)" "void *arg" +.It Xo +.Ft int +.Fn pthread_create "pthread_t *thread" "const pthread_attr_t *attr" "void *(*start_routine)(void *)" "void *arg" +.Xc Creates a new thread of execution. -.It int Fn pthread_detach "pthread_t thread" +.It Xo +.Ft int +.Fn pthread_detach "pthread_t thread" +.Xc Marks a thread for deletion. -.It int Fn pthread_equal "pthread_t t1" "pthread_t t2" +.It Xo +.Ft int +.Fn pthread_equal "pthread_t t1" "pthread_t t2" +.Xc Compares two thread IDs. -.It void Fn pthread_exit "void *value_ptr" +.It Xo +.Ft void +.Fn pthread_exit "void *value_ptr" +.Xc Terminates the calling thread. -.It int Fn pthread_join "pthread_t thread" "void **value_ptr" +.It Xo +.Ft int +.Fn pthread_join "pthread_t thread" "void **value_ptr" +.Xc Causes the calling thread to wait for the termination of the specified thread. -.It int Fn pthread_cancel "pthread_t thread" +.It Xo +.Ft int +.Fn pthread_cancel "pthread_t thread" +.Xc Cancels execution of a thread. -.It int Fn pthread_once "pthread_once_t *once_control" "void (*init_routine)(void)" +.It Xo +.Ft int +.Fn pthread_once "pthread_once_t *once_control" "void (*init_routine)(void)" +.Xc Calls an initialization routine once. -.It pthread_t Fn pthread_self void +.It Xo +.Ft pthread_t +.Fn pthread_self void +.Xc Returns the thread ID of the calling thread. .El .Sh ATTRIBUTE OBJECT ROUTINES .Bl -tag -width Er -.It int Fn pthread_attr_destroy "pthread_attr_t *attr" +.It Xo +.Ft int +.Fn pthread_attr_destroy "pthread_attr_t *attr" +.Xc Destroy a thread attributes object. -.It int Fn pthread_attr_getinheritsched "pthread_attr_t *attr" "int *inheritsched" +.It Xo +.Ft int +.Fn pthread_attr_getinheritsched "pthread_attr_t *attr" "int *inheritsched" +.Xc Get the inherit scheduling attribute from a thread attributes object. -.It int Fn pthread_attr_getschedparam "pthread_attr_t *attr" "struct sched_param *param" +.It Xo +.Ft int +.Fn pthread_attr_getschedparam "pthread_attr_t *attr" "struct sched_param *param" +.Xc Get the scheduling parameter attribute from a thread attributes object. -.It int Fn pthread_attr_getschedpolicy "pthread_attr_t *attr" "int *policy" +.It Xo +.Ft int +.Fn pthread_attr_getschedpolicy "pthread_attr_t *attr" "int *policy" +.Xc Get the scheduling policy attribute from a thread attributes object. -.It int Fn pthread_attr_getscope "pthread_attr_t *attr" "int *contentionscope" +.It Xo +.Ft int +.Fn pthread_attr_getscope "pthread_attr_t *attr" "int *contentionscope" +.Xc Get the contention scope attribute from a thread attributes object. -.It int Fn pthread_attr_getstacksize "pthread_attr_t *attr" "size_t *stacksize" +.It Xo +.Ft int +.Fn pthread_attr_getstacksize "pthread_attr_t *attr" "size_t *stacksize" +.Xc Get the stack size attribute from a thread attributes object. -.It int Fn pthread_attr_getstackaddr "pthread_attr_t *attr" "void **stackaddr" +.It Xo +.Ft int +.Fn pthread_attr_getstackaddr "pthread_attr_t *attr" "void **stackaddr" +.Xc Get the stack address attribute from a thread attributes object. -.It int Fn pthread_attr_getdetachstate "pthread_attr_t *attr" "int *detachstate" +.It Xo +.Ft int +.Fn pthread_attr_getdetachstate "pthread_attr_t *attr" "int *detachstate" +.Xc Get the detach state attribute from a thread attributes object. -.It int Fn pthread_attr_init "pthread_attr_t *attr" +.It Xo +.Ft int +.Fn pthread_attr_init "pthread_attr_t *attr" +.Xc Initialize a thread attributes object with default values. -.It int Fn pthread_attr_setinheritsched "pthread_attr_t *attr" "int inheritsched" +.It Xo +.Ft int +.Fn pthread_attr_setinheritsched "pthread_attr_t *attr" "int inheritsched" +.Xc Set the inherit scheduling attribute in a thread attributes object. -.It int Fn pthread_attr_setschedparam "pthread_attr_t *attr" "struct sched_param *param" +.It Xo +.Ft int +.Fn pthread_attr_setschedparam "pthread_attr_t *attr" "struct sched_param *param" +.Xc Set the scheduling parameter attribute in a thread attributes object. -.It int Fn pthread_attr_setschedpolicy "pthread_attr_t *attr" "int policy" +.It Xo +.Ft int +.Fn pthread_attr_setschedpolicy "pthread_attr_t *attr" "int policy" +.Xc Set the scheduling policy attribute in a thread attributes object. -.It int Fn pthread_attr_setscope "pthread_attr_t *attr" "int contentionscope" +.It Xo +.Ft int +.Fn pthread_attr_setscope "pthread_attr_t *attr" "int contentionscope" +.Xc Set the contention scope attribute in a thread attributes object. -.It int Fn pthread_attr_setstacksize "pthread_attr_t *attr" "size_t stacksize" +.It Xo +.Ft int +.Fn pthread_attr_setstacksize "pthread_attr_t *attr" "size_t stacksize" +.Xc Set the stack size attribute in a thread attributes object. -.It int Fn pthread_attr_setstackaddr "pthread_attr_t *attr" "void *stackaddr" +.It Xo +.Ft int +.Fn pthread_attr_setstackaddr "pthread_attr_t *attr" "void *stackaddr" +.Xc Set the stack address attribute in a thread attributes object. -.It int Fn pthread_attr_setdetachstate "pthread_attr_t *attr" "int detachstate" +.It Xo +.Ft int +.Fn pthread_attr_setdetachstate "pthread_attr_t *attr" "int detachstate" +.Xc Set the detach state in a thread attributes object. .El .Sh MUTEX ROUTINES .Bl -tag -width Er -.It int Fn pthread_mutexattr_destroy "pthread_mutexattr_t *attr" +.It Xo +.Ft int +.Fn pthread_mutexattr_destroy "pthread_mutexattr_t *attr" +.Xc Destroy a mutex attributes object. -.It int Fn pthread_mutexattr_init "pthread_mutexattr_t *attr" +.It Xo +.Ft int +.Fn pthread_mutexattr_init "pthread_mutexattr_t *attr" +.Xc Initialize a mutex attributes object with default values. -.It int Fn pthread_mutex_destroy "pthread_mutex_t *mutex" +.It Xo +.Ft int +.Fn pthread_mutex_destroy "pthread_mutex_t *mutex" +.Xc Destroy a mutex. -.It int Fn pthread_mutex_init "pthread_mutex_t *mutex" "const pthread_mutexattr_t *attr" +.It Xo +.Ft int +.Fn pthread_mutex_init "pthread_mutex_t *mutex" "const pthread_mutexattr_t *attr" +.Xc Initialize a mutex with specified attributes. -.It int Fn pthread_mutex_lock "pthread_mutex_t *mutex" +.It Xo +.Ft int +.Fn pthread_mutex_lock "pthread_mutex_t *mutex" +.Xc Lock a mutex and block until it becomes available. -.It int Fn pthread_mutex_trylock "pthread_mutex_t *mutex" +.It Xo +.Ft int +.Fn pthread_mutex_trylock "pthread_mutex_t *mutex" +.Xc Try to lock a mutex, but don't block if the mutex is locked by another thread, including the current thread. -.It int Fn pthread_mutex_unlock "pthread_mutex_t *mutex" +.It Xo +.Ft int +.Fn pthread_mutex_unlock "pthread_mutex_t *mutex" +.Xc Unlock a mutex. .El .Sh CONDITION VARIABLE ROUTINES .Bl -tag -width Er -.It int Fn pthread_condattr_init "pthread_condattr_t *attr" +.It Xo +.Ft int +.Fn pthread_condattr_init "pthread_condattr_t *attr" +.Xc Initialize a condition variable attributes object with default values. -.It int Fn pthread_condattr_destroy "pthread_condattr_t *attr" +.It Xo +.Ft int +.Fn pthread_condattr_destroy "pthread_condattr_t *attr" +.Xc Destroy a condition variable attributes object. -.It int Fn pthread_cond_broadcast "pthread_cond_t *cond" +.It Xo +.Ft int +.Fn pthread_cond_broadcast "pthread_cond_t *cond" +.Xc Unblock all threads currently blocked on the specified condition variable. -.It int Fn pthread_cond_destroy "pthread_cond_t *cond" +.It Xo +.Ft int +.Fn pthread_cond_destroy "pthread_cond_t *cond" +.Xc Destroy a condition variable. -.It int Fn pthread_cond_init "pthread_cond_t *cond" "const pthread_condattr_t *attr" +.It Xo +.Ft int +.Fn pthread_cond_init "pthread_cond_t *cond" "const pthread_condattr_t *attr" +.Xc Initialize a condition variable with specified attributes. -.It int Fn pthread_cond_signal "pthread_cond_t *cond" +.It Xo +.Ft int +.Fn pthread_cond_signal "pthread_cond_t *cond" +.Xc Unblock at least one of the threads blocked on the specified condition variable. -.It int Fn pthread_cond_timedwait "pthread_cond_t *cond" "pthread_mutex_t *mutex" "const struct timespec *abstime" +.It Xo +.Ft int +.Fn pthread_cond_timedwait "pthread_cond_t *cond" "pthread_mutex_t *mutex" "const struct timespec *abstime" +.Xc Wait no longer than the specified time for a condition and lock the specified mutex. -.It int Fn pthread_cond_wait "pthread_cond_t *" "pthread_mutex_t *mutex" +.It Xo +.Ft int +.Fn pthread_cond_wait "pthread_cond_t *" "pthread_mutex_t *mutex" +.Xc Wait for a condition and lock the specified mutex. .El .Sh READ/WRITE LOCK ROUTINES .Bl -tag -width Er -.It int Fn pthread_rwlock_destroy "pthread_rwlock_t *lock" +.It Xo +.Ft int +.Fn pthread_rwlock_destroy "pthread_rwlock_t *lock" +.Xc Destroy a read/write lock object. -.It int Fn pthread_rwlock_init "pthread_rwlock_t *lock" "const pthread_rwlockattr_t *attr" +.It Xo +.Ft int +.Fn pthread_rwlock_init "pthread_rwlock_t *lock" "const pthread_rwlockattr_t *attr" +.Xc Initialize a read/write lock object. -.It int Fn pthread_rwlock_rdlock "pthread_rwlock_t *lock" +.It Xo +.Ft int +.Fn pthread_rwlock_rdlock "pthread_rwlock_t *lock" +.Xc Lock a read/write lock for reading, blocking until the lock can be acquired. -.It int Fn pthread_rwlock_tryrdlock "pthread_rwlock_t *lock" +.It Xo +.Ft int +.Fn pthread_rwlock_tryrdlock "pthread_rwlock_t *lock" +.Xc Attempt to lock a read/write lock for reading, without blocking if the lock is unavailable. -.It int Fn pthread_rwlock_trywrlock "pthread_rwlock_t *lock" +.It Xo +.Ft int +.Fn pthread_rwlock_trywrlock "pthread_rwlock_t *lock" +.Xc Attempt to lock a read/write lock for writing, without blocking if the lock is unavailable. -.It int Fn pthread_rwlock_unlock "pthread_rwlock_t *lock" +.It Xo +.Ft int +.Fn pthread_rwlock_unlock "pthread_rwlock_t *lock" +.Xc Unlock a read/write lock. -.It int Fn pthread_rwlock_wrlock "pthread_rwlock_t *lock" +.It Xo +.Ft int +.Fn pthread_rwlock_wrlock "pthread_rwlock_t *lock" +.Xc Lock a read/write lock for writing, blocking until the lock can be acquired. -.It int Fn pthread_rwlockattr_destroy "pthread_rwlockattr_t *attr" +.It Xo +.Ft int +.Fn pthread_rwlockattr_destroy "pthread_rwlockattr_t *attr" +.Xc Destroy a read/write lock attribute object. -.It int Fn pthread_rwlockattr_getpshared "pthread_rwlockattr_t *attr" "int *pshared" +.It Xo +.Ft int +.Fn pthread_rwlockattr_getpshared "pthread_rwlockattr_t *attr" "int *pshared" +.Xc Retrieve the process shared setting for the read/write lock attribute object. -.It int Fn pthread_rwlockattr_init "pthread_rwlockattr_t *attr" +.It Xo +.Ft int +.Fn pthread_rwlockattr_init "pthread_rwlockattr_t *attr" +.Xc Initialize a read/write lock attribute object. -.It int Fn pthread_rwlockattr_setpshared "pthread_rwlockattr_t *attr" "int *pshared" +.It Xo +.Ft int +.Fn pthread_rwlockattr_setpshared "pthread_rwlockattr_t *attr" "int *pshared" +.Xc Set the process shared setting for the read/write lock attribute object. .El .Sh PER-THREAD CONTEXT ROUTINES .Bl -tag -width Er -.It int Fn pthread_key_create "pthread_key_t *key" "void (*routine)(void *)" +.It Xo +.Ft int +.Fn pthread_key_create "pthread_key_t *key" "void (*routine)(void *)" +.Xc Create a thread-specific data key. -.It int Fn pthread_key_delete "pthread_key_t key" +.It Xo +.Ft int +.Fn pthread_key_delete "pthread_key_t key" +.Xc Delete a thread-specific data key. -.It void * Fn pthread_getspecific "pthread_key_t key" "void **value_ptr" +.It Xo +.Ft "void *" +.Fn pthread_getspecific "pthread_key_t key" "void **value_ptr" +.Xc Get the thread-specific value for the specified key. -.It int Fn pthread_setspecific "pthread_key_t key" "const void *value_ptr" +.It Xo +.Ft int +.Fn pthread_setspecific "pthread_key_t key" "const void *value_ptr" +.Xc Set the thread-specific value for the specified key. .El .Sh CLEANUP ROUTINES .Bl -tag -width Er -.It void Fn pthread_cleanup_pop "int execute" +.It Xo +.Ft void +.Fn pthread_cleanup_pop "int execute" +.Xc Remove the routine at the top of the calling thread's cancellation cleanup stack and optionally invoke it. -.It void Fn pthread_cleanup_push "void (*routine)(void *)" "void *routine_arg" +.It Xo +.Ft void +.Fn pthread_cleanup_push "void (*routine)(void *)" "void *routine_arg" +.Xc Push the specified cancellation cleanup handler onto the calling thread's cancellation stack. .El diff --git a/share/man/man3/pthread_cond_wait.3 b/share/man/man3/pthread_cond_wait.3 index 9d70318..ccbf138 100644 --- a/share/man/man3/pthread_cond_wait.3 +++ b/share/man/man3/pthread_cond_wait.3 @@ -48,7 +48,8 @@ variable specified by and unblocks the mutex specified by .Fa mutex . The waiting thread unblocks only after another thread calls -.Xr pthread_cond_signal 3 , or +.Xr pthread_cond_signal 3 , +or .Xr pthread_cond_broadcast 3 with the same condition variable, and the current thread requires the lock on diff --git a/share/man/man3/pthread_testcancel.3 b/share/man/man3/pthread_testcancel.3 index c1bbc7d..c27c16d 100644 --- a/share/man/man3/pthread_testcancel.3 +++ b/share/man/man3/pthread_testcancel.3 @@ -195,5 +195,5 @@ conforms to ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12. .Sh AUTHORS This man page was written by -.An David Leonard <d@openbsd.org> +.An David Leonard Aq d@openbsd.org for the OpenBSD implementation of pthread_cancel. diff --git a/share/man/man4/aac.4 b/share/man/man4/aac.4 index 6485c01..2987d12 100644 --- a/share/man/man4/aac.4 +++ b/share/man/man4/aac.4 @@ -106,7 +106,7 @@ to the driver. These messages are printed on the system console, and are also queued for retrieval by a management application. .Sh SEE ALSO .Xr kld 4 , -.Xr linux 4, +.Xr linux 4 , .Xr kldload 8 .Sh HISTORY The diff --git a/share/man/man4/adw.4 b/share/man/man4/adw.4 index d633aea..d6aaf01 100644 --- a/share/man/man4/adw.4 +++ b/share/man/man4/adw.4 @@ -39,17 +39,17 @@ For one or more SCSI busses: This driver provides access to the 16bit .Tn SCSI bus connected to the Advanced Systems Products, Inc. -.Tn ASC3550 Ultra, +.Tn ASC3550 Ultra , and -.Tn ASC38C0800 Ultra2, +.Tn ASC38C0800 Ultra2 , SCSI Host Adapter chips. AdvanSys products incorporating these chips include the -.Tn ABP[3]940UW, -.Tn ABP950UW, -.Tn ABP970UW, -.Tn ABP3940U2W, +.Tn ABP[3]940UW , +.Tn ABP950UW , +.Tn ABP970UW , +.Tn ABP3940U2W , and -.Tn ABP3950U2W. +.Tn ABP3950U2W . Both chips support, synchronous transfers .Pq 20MHz and 40MHz max respectively , 16bit transfers, tagged queueing, diff --git a/share/man/man4/ahc.4 b/share/man/man4/ahc.4 index ab97a9b..be13cde 100644 --- a/share/man/man4/ahc.4 +++ b/share/man/man4/ahc.4 @@ -53,55 +53,55 @@ For one or more SCSI busses: This driver provides access to the .Tn SCSI bus(es) connected to Adaptec -.Tn AIC7770, -.Tn AIC7850, -.Tn AIC7860, -.Tn AIC7870, -.Tn AIC7880, -.Tn AIC7890, -.Tn AIC7891, -.Tn AIC7892, -.Tn AIC7895, -.Tn AIC7896, +.Tn AIC7770 , +.Tn AIC7850 , +.Tn AIC7860 , +.Tn AIC7870 , +.Tn AIC7880 , +.Tn AIC7890 , +.Tn AIC7891 , +.Tn AIC7892 , +.Tn AIC7895 , +.Tn AIC7896 , .Tn AIC7897 and .Tn AIC7899 host adapter chips. These chips are found on many motherboards as well as the following Adaptec SCSI controller cards: -.Tn 274X(W), -.Tn 274X(T), -.Tn 284X, -.Tn 2910, -.Tn 2915, -.Tn 2920, -.Tn 2930C, -.Tn 2930U2, -.Tn 2940, -.Tn 2940U, -.Tn 2940AU, -.Tn 2940UW, -.Tn 2940UW Dual, -.Tn 2940UW Pro, -.Tn 2940U2W, -.Tn 2940U2B, -.Tn 2950U2W, -.Tn 2950U2B, -.Tn 19160B, -.Tn 29160B, -.Tn 29160N, -.Tn 3940, -.Tn 3940U, -.Tn 3940AU, -.Tn 3940UW, -.Tn 3940AUW, -.Tn 3940U2W, -.Tn 3950U2, -.Tn 3960, -.Tn 39160, -.Tn 3985, +.Tn 274X(W) , +.Tn 274X(T) , +.Tn 284X , +.Tn 2910 , +.Tn 2915 , +.Tn 2920 , +.Tn 2930C , +.Tn 2930U2 , +.Tn 2940 , +.Tn 2940U , +.Tn 2940AU , +.Tn 2940UW , +.Tn 2940UW Dual , +.Tn 2940UW Pro , +.Tn 2940U2W , +.Tn 2940U2B , +.Tn 2950U2W , +.Tn 2950U2B , +.Tn 19160B , +.Tn 29160B , +.Tn 29160N , +.Tn 3940 , +.Tn 3940U , +.Tn 3940AU , +.Tn 3940UW , +.Tn 3940AUW , +.Tn 3940U2W , +.Tn 3950U2 , +.Tn 3960 , +.Tn 39160 , +.Tn 3985 , and -.Tn 4944UW. +.Tn 4944UW . .Pp Driver features include support for twin and wide busses, fast, ultra or ultra2 synchronous transfers depending on controller type, diff --git a/share/man/man4/asr.4 b/share/man/man4/asr.4 index 960ceca..5c08341 100644 --- a/share/man/man4/asr.4 +++ b/share/man/man4/asr.4 @@ -10,8 +10,7 @@ .Os FreeBSD .Sh NAME .Nm asr -.Nd -.Tn Driver for Adaptec I2O based SCSI host bus adapters. +.Nd driver for Adaptec I2O based SCSI host bus adapters .Sh SYNOPSIS .Cd "device asr" .Sh DESCRIPTION diff --git a/share/man/man4/atkbdc.4 b/share/man/man4/atkbdc.4 index eed2f39..1d00827 100644 --- a/share/man/man4/atkbdc.4 +++ b/share/man/man4/atkbdc.4 @@ -59,7 +59,7 @@ driver. They may be set in the kernel configuration file .Pq see Xr config 8 . .Bl -tag -width MOUSE -.It Em KBD_RESETDELAY=X, KBD_MAXWAIT=Y +.It Em KBD_RESETDELAY=X , KBD_MAXWAIT=Y The keyboard driver .Nm atkbd and the pointing device driver diff --git a/share/man/man4/awi.4 b/share/man/man4/awi.4 index 0f1b0b7..b3cee47 100644 --- a/share/man/man4/awi.4 +++ b/share/man/man4/awi.4 @@ -83,7 +83,7 @@ media type. For each media type, .Em adhoc mediaopt can be used to indicate the driver to operate in adhoc mode. Also, -.Em adhoc,flag0 +.Em adhoc , Ns Em flag0 mediaopt can be used for .Xr wi 4 compatible adhoc mode. diff --git a/share/man/man4/bktr.4 b/share/man/man4/bktr.4 index 01787ad..6ad3338 100644 --- a/share/man/man4/bktr.4 +++ b/share/man/man4/bktr.4 @@ -23,7 +23,7 @@ capture and capture on low cost, high performance boards. The driver based on the Matrox Meteor driver and uses the same API. The bktr driver should support most video cards based on the -.Em Brooktree Bt848/849/878/879 Video Capture Chip. +.Em "Brooktree Bt848/849/878/879 Video Capture Chip" . The driver also supports .Em FM Radio if the Tuner supports it. diff --git a/share/man/man4/bpf.4 b/share/man/man4/bpf.4 index b0a9571..35b97c1 100644 --- a/share/man/man4/bpf.4 +++ b/share/man/man4/bpf.4 @@ -75,7 +75,7 @@ This size is returned by the .Dv BIOCGBLEN ioctl (see below), and can be set with -.Dv BIOCSBLEN. +.Dv BIOCSBLEN . Note that an individual packet larger than this size is necessarily truncated. .Pp @@ -250,7 +250,8 @@ is given by the .Li bf_len field. Also, the actions of -.Dv BIOCFLUSH are performed. +.Dv BIOCFLUSH +are performed. See section .Sx "FILTER MACHINE" for an explanation of the filter language. @@ -458,7 +459,7 @@ or a word in the scratch memory store For .Dv BPF_IND and -.Dv BPF_ABS, +.Dv BPF_ABS , the data size must be specified as a word .Pq Dv BPF_W , halfword diff --git a/share/man/man4/ccd.4 b/share/man/man4/ccd.4 index c60d461..09324d4 100644 --- a/share/man/man4/ccd.4 +++ b/share/man/man4/ccd.4 @@ -58,7 +58,7 @@ partitions of the disks .Pa should not be combined. The kernel will only allow component partitions of type FS_BSDFFS (type -.Dq 4.2BSD +.Dq Bx 4.2 as shown as .Xr disklabel 8 ) . .Pp diff --git a/share/man/man4/ddb.4 b/share/man/man4/ddb.4 index ef53b3e..432b279 100644 --- a/share/man/man4/ddb.4 +++ b/share/man/man4/ddb.4 @@ -328,7 +328,7 @@ only print when the matching return is hit. .It Xo .No Cm trace Ns Op Cm /u .Op Ar frame -.Op Ar ,count +.Op , Ns Ar count .Xc Stack trace. The .Li u @@ -350,7 +350,7 @@ only if the machine dependent code supports it. .Ar addr .Ar value .Op Ar mask -.Op Ar ,count +.Op , Ns Ar count .Xc Search memory for .Ar value . diff --git a/share/man/man4/ed.4 b/share/man/man4/ed.4 index 896f415..79462e9 100644 --- a/share/man/man4/ed.4 +++ b/share/man/man4/ed.4 @@ -88,7 +88,7 @@ This flag disables the use of multiple transmit buffers and may be necessary in rare cases where packets are sent out faster than a machine on the other end can handle (as evidenced by severe packet lossage). Some -.No (non- Ns Fx +.No ( non- Ns Fx :-)) machines have terrible ethernet performance and simply can't cope with 1100K+ data rates. Use of this flag also provides diff --git a/share/man/man4/en.4 b/share/man/man4/en.4 index b62a691..366dabc 100644 --- a/share/man/man4/en.4 +++ b/share/man/man4/en.4 @@ -41,12 +41,12 @@ To enable the link use the following commands: .Dl # ifconfig en0 128.252.200.2 netmask 0xffffff00 up .Dl # route add -iface 128.252.200.1 -link en0:3.0.0.c9 .Sh DIAGNOSTICS -.Bl -diag -.It "en0 <Efficient Networks ENI-155p> rev 0 int a irq 5 on pci0:16" -.It "en0: ATM midway v0, board IDs 6.0, Utopia (pipelined), 512KB on-board RAM" -.It "en0: maximum DMA burst length = 64 bytes" -.It "en0: 7 32KB receive buffers, 8 32KB transmit buffers allocated" -.El +.Bd -literal +en0 <Efficient Networks ENI-155p> rev 0 int a irq 5 on pci0:16 +en0: ATM midway v0, board IDs 6.0, Utopia (pipelined), 512KB on-board RAM +en0: maximum DMA burst length = 64 bytes +en0: 7 32KB receive buffers, 8 32KB transmit buffers allocated +.Ed .Sh CAVEATS The driver extensively uses DMA on PCI. The first diff --git a/share/man/man4/fdc.4 b/share/man/man4/fdc.4 index 88a3d1d..338b030 100644 --- a/share/man/man4/fdc.4 +++ b/share/man/man4/fdc.4 @@ -72,9 +72,9 @@ can be turned off using flags .Ql 0x4 . .Sh FILES .Bl -tag -width Pa -compact -.It /dev/fd* +.It Pa /dev/fd* floppy disk device nodes -.It /dev/fd*.<size in kB> +.It Pa /dev/fd*. Ns Ar "<size in kB>" floppy disk device nodes where the trailing number indicates the floppy capacity .It Pa /sys/i386/conf/GENERIC diff --git a/share/man/man4/inet.4 b/share/man/man4/inet.4 index b1dc34f..13dae8f 100644 --- a/share/man/man4/inet.4 +++ b/share/man/man4/inet.4 @@ -157,7 +157,7 @@ All IP routes, except those with the flag and those to multicast destinations, have the .Dv RTF_PRCLONING flag forcibly enabled (they are thus said to be -.Dq "protocol cloning" ). +.Dq "protocol cloning" ) . .It When the last reference to an IP route is dropped, the route is examined to determine if it was created by cloning such a route. If diff --git a/share/man/man4/ip.4 b/share/man/man4/ip.4 index eeda4ce..cd37c7e 100644 --- a/share/man/man4/ip.4 +++ b/share/man/man4/ip.4 @@ -178,7 +178,7 @@ multicasting is supported only on sockets of type .Dv SOCK_DGRAM and -.Dv SOCK_RAW, +.Dv SOCK_RAW , and only on networks where the interface driver supports multicasting. .Pp @@ -366,7 +366,7 @@ ip->ip_off = offset; .Ed .Pp If the header source address is set to -.Dv INADDR_ANY, +.Dv INADDR_ANY , the kernel will choose an appropriate address. .Sh DIAGNOSTICS A socket operation may fail with one of the following errors returned: diff --git a/share/man/man4/ipfirewall.4 b/share/man/man4/ipfirewall.4 index e53d487..679d16f 100644 --- a/share/man/man4/ipfirewall.4 +++ b/share/man/man4/ipfirewall.4 @@ -184,7 +184,7 @@ by It has been heavily modified and ported to .Fx by -.Ar Ugen J.S.Antsilevich +.An Ugen J.S. Antsilevich .Aq ugen@NetVision.net.il . .Pp Several enhancements added by diff --git a/share/man/man4/man4.alpha/linux.4 b/share/man/man4/man4.alpha/linux.4 index 3aab977..9ff8a0d 100644 --- a/share/man/man4/man4.alpha/linux.4 +++ b/share/man/man4/man4.alpha/linux.4 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .Dd August 17, 2000 -.Dt LINUX 4 alpha +.Dt LINUX 4 Alpha .Os .Sh NAME .Nm linux diff --git a/share/man/man4/man4.alpha/osf1.4 b/share/man/man4/man4.alpha/osf1.4 index 7aa88bd..ec6e9a4 100644 --- a/share/man/man4/man4.alpha/osf1.4 +++ b/share/man/man4/man4.alpha/osf1.4 @@ -25,7 +25,7 @@ .\" $FreeBSD$ .\" .Dd November 13, 2000 -.Dt OSF/1 4 alpha +.Dt OSF/1 4 Alpha .Os .Sh NAME .Nm osf1 diff --git a/share/man/man4/man4.i386/alpm.4 b/share/man/man4/man4.i386/alpm.4 index caf6bea..8fdfd06 100644 --- a/share/man/man4/man4.i386/alpm.4 +++ b/share/man/man4/man4.i386/alpm.4 @@ -35,7 +35,8 @@ .Cd device alpm .Sh DESCRIPTION This driver provides access to the -.Tn Aladdin 15x3 Power Management Unit. Currently, only smbus controller +.Tn Aladdin 15x3 Power Management Unit . +Currently, only smbus controller function is implemented. .Pp The embedded SMBus controller of the Aladdin chipset may give you access diff --git a/share/man/man4/man4.i386/apm.4 b/share/man/man4/man4.i386/apm.4 index ddce25e..b301a2f 100644 --- a/share/man/man4/man4.i386/apm.4 +++ b/share/man/man4/man4.i386/apm.4 @@ -48,7 +48,7 @@ exports an application interface as a character device. Applications can control APM, or retrieve APM status information via this interface. .Nm exports the following interfaces. These symbols are defined in -.Dq Pa /usr/include/machine/apm_bios.h. +.Dq Pa /usr/include/machine/apm_bios.h . .Bl -tag -width 4n -offset indent .It Sy APMIO_SUSPEND Suspend system. @@ -66,17 +66,17 @@ Get per battery information. Some APM implementations execute the HLT .Pq Halt CPU until an interrupt occurs instruction in the -.Dq Pa Idle CPU +.Dq Em Idle CPU call, while others do not. Thus enabling this may result in redundant HLT executions because -.Dq Pa Idle CPU +.Dq Em Idle CPU is called from the kernel context switch routine that inherently executes HLT. This may reduce peak system performance. .Pp Also the system hangs up if HLT instruction is disabled in the kernel context switch routine, and if the APM implementation of the machine does not execute HLT in -.Dq Pa Idle CPU. +.Dq Em Idle CPU . On some implementations that do not support CPU clock slowdown, APM might not execute HLT. .Nm @@ -87,7 +87,7 @@ operation on such machines. The current version of .Nm does not call -.Dq Pa Idle CPU +.Dq Em Idle CPU from the kernel context switch routine if clock slowdown is not supported, and it executes HLT instruction by default. Therefore, there is no need to use these two operations in most cases. diff --git a/share/man/man4/man4.i386/asr.4 b/share/man/man4/man4.i386/asr.4 index 960ceca..5c08341 100644 --- a/share/man/man4/man4.i386/asr.4 +++ b/share/man/man4/man4.i386/asr.4 @@ -10,8 +10,7 @@ .Os FreeBSD .Sh NAME .Nm asr -.Nd -.Tn Driver for Adaptec I2O based SCSI host bus adapters. +.Nd driver for Adaptec I2O based SCSI host bus adapters .Sh SYNOPSIS .Cd "device asr" .Sh DESCRIPTION diff --git a/share/man/man4/man4.i386/en.4 b/share/man/man4/man4.i386/en.4 index b62a691..366dabc 100644 --- a/share/man/man4/man4.i386/en.4 +++ b/share/man/man4/man4.i386/en.4 @@ -41,12 +41,12 @@ To enable the link use the following commands: .Dl # ifconfig en0 128.252.200.2 netmask 0xffffff00 up .Dl # route add -iface 128.252.200.1 -link en0:3.0.0.c9 .Sh DIAGNOSTICS -.Bl -diag -.It "en0 <Efficient Networks ENI-155p> rev 0 int a irq 5 on pci0:16" -.It "en0: ATM midway v0, board IDs 6.0, Utopia (pipelined), 512KB on-board RAM" -.It "en0: maximum DMA burst length = 64 bytes" -.It "en0: 7 32KB receive buffers, 8 32KB transmit buffers allocated" -.El +.Bd -literal +en0 <Efficient Networks ENI-155p> rev 0 int a irq 5 on pci0:16 +en0: ATM midway v0, board IDs 6.0, Utopia (pipelined), 512KB on-board RAM +en0: maximum DMA burst length = 64 bytes +en0: 7 32KB receive buffers, 8 32KB transmit buffers allocated +.Ed .Sh CAVEATS The driver extensively uses DMA on PCI. The first diff --git a/share/man/man4/man4.i386/pnp.4 b/share/man/man4/man4.i386/pnp.4 index 5f00620..fb4976f 100644 --- a/share/man/man4/man4.i386/pnp.4 +++ b/share/man/man4/man4.i386/pnp.4 @@ -46,7 +46,7 @@ configuration of PnP cards, and device drivers to fetch/modify parameters in the card's configuration space. .Pp The manual override mechanism requires the kernel to be compiled with -.Cd options USERCONFIG. +.Cd options USERCONFIG . In this case, the kernel keeps a table of fixed size (20 entries as a default) where configuration data are held for PnP devices. Each diff --git a/share/man/man4/man4.i386/ray.4 b/share/man/man4/man4.i386/ray.4 index b3091f2..59d0172 100644 --- a/share/man/man4/man4.i386/ray.4 +++ b/share/man/man4/man4.i386/ray.4 @@ -199,7 +199,7 @@ option of A packet was ready for transmission but the NIC is not connected to a BSS. May occur when removing the PCCard. -.It ray?: "cannot transmit - no network" +.It "ray?: cannot transmit - no network" The wireless NIC has roamed from an access point and not connected with a new one yet. .It "ray?: cannot transmit - ECF busy" diff --git a/share/man/man4/man4.i386/spkr.4 b/share/man/man4/man4.i386/spkr.4 index d5a7571..d83e897 100644 --- a/share/man/man4/man4.i386/spkr.4 +++ b/share/man/man4/man4.i386/spkr.4 @@ -140,7 +140,7 @@ sets quarter notes, etc. Pause (rest), with .Sy n interpreted as for -.Ns Li L Sy n . +.Li L Sy n . May be followed by sustain dots. May also be written .Li ~ . @@ -169,7 +169,7 @@ very fast Prestissimo .It Li M[LNS] Set articulation. .Li MN -.Ns No ( Li N +.Li ( N for normal) is the default; the last 1/8th of the note's value is rest time. You can set diff --git a/share/man/man4/man4.i386/tw.4 b/share/man/man4/man4.i386/tw.4 index d91ce6e..f00afdc 100644 --- a/share/man/man4/man4.i386/tw.4 +++ b/share/man/man4/man4.i386/tw.4 @@ -84,12 +84,10 @@ The driver produces a series of three character packets. In each packet, the first character consists of flags, the second character is a four bit house code (0-15), and the third character is a five bit key/function code (0-31). The flags are the following: -.Bl -diag -.It +.Bd -literal #define TW_RCV_LOCAL 1 /* The packet arrived during a local transmission */ -.It #define TW_RCV_ERROR 2 /* An invalid/corrupted packet was received */ -.El +.Ed .Pp The .Fn select @@ -98,10 +96,8 @@ is data ready for reading. .Sh SEE ALSO .Xr xten 1 , .Xr xtend 8 -.Bl -diag -.It +.Pp TW-523 documentation from X-10 Inc. -.El .Sh FILES .Bl -tag -width /dev/tw .It Pa /dev/tw? diff --git a/share/man/man4/man4.i386/wl.4 b/share/man/man4/man4.i386/wl.4 index 900f4d9..d43f822 100644 --- a/share/man/man4/man4.i386/wl.4 +++ b/share/man/man4/man4.i386/wl.4 @@ -131,7 +131,7 @@ due to delays in the configuration code. .Sh SEE ALSO .Xr sysctl 8 , .Xr wlconfig 8 , -.Xr http://www.wavelan.com +.Pa http://www.wavelan.com .Sh HISTORY The .Nm diff --git a/share/man/man4/mem.4 b/share/man/man4/mem.4 index 064cc69..1d56020 100644 --- a/share/man/man4/mem.4 +++ b/share/man/man4/mem.4 @@ -81,7 +81,7 @@ Declarations and data types are to be found in .Pp The specific attributes, and number of programmable ranges may vary between architectures. The full set of supported attributes is: -.Bl -tag -width 10 +.Bl -tag -width indent .It MDF_UNCACHEABLE The region is not cached. .It MDF_WRITECOMBINE @@ -107,7 +107,7 @@ In addition to the region attributes listed above, the following flags may also be set in the .Fa mr_flags field: -.Bl -tag -width 10 +.Bl -tag -width indent .It MDF_FIXBASE The region's base address cannot be changed. .It MDF_FIXLEN @@ -178,7 +178,7 @@ enabled. .Sh BUGS Busy range attributes are not yet managed correctly. .Sh FILES -.Bl -tag -width Pa -compact +.Bl -tag -width /dev/kmem -compact .It Pa /dev/mem .It Pa /dev/kmem .El diff --git a/share/man/man4/netgraph.4 b/share/man/man4/netgraph.4 index 0414b11..317dfa0 100644 --- a/share/man/man4/netgraph.4 +++ b/share/man/man4/netgraph.4 @@ -364,7 +364,8 @@ Two other methods are also supported by all nodes: .Bl -tag -width xxx .It Receive data message A -.Em Netgraph queueable reqest item ,usually refered to as an +.Em Netgraph queueable reqest item , +usually refered to as an .Em item , is recieved by the function. The item contains a pointer to an mbuf and metadata about the packet. @@ -441,7 +442,7 @@ conformance with Frame Relay standards. The node may elect to nominate a different receive data function for data received on a particular hook, to simplify coding. It uses the -.Fn NG_HOOK_SET_RCVDATA "hook, fn" +.Fn NG_HOOK_SET_RCVDATA hook fn macro to do this. The function receives the same arguments in every way other than it will receive all (and only) packets from that hook. .It Receive control message @@ -468,7 +469,7 @@ The return address is retrieved from the using the .Fn NGI_RETADDR macro and is of type -.Em ng_ID_t. +.Em ng_ID_t . All control messages and replies are allocated with .Fn malloc @@ -491,7 +492,7 @@ the message out another hook to that on which it arrived. The node may elect to nominate a different receive message function for messages received on a particular hook, to simplify coding. It uses the -.Fn NG_HOOK_SET_RCVMSG "hook, fn" +.Fn NG_HOOK_SET_RCVMSG hook fn macro to do this. The function receives the same arguments in every way other than it will receive all (and only) messages from that hook. .El @@ -661,7 +662,7 @@ node ID Of type .Em ng_ID_t , This property can be retrieved using the macro -.Fn NG_NODE_ID "node". +.Fn NG_NODE_ID "node" . .Pp .It node name @@ -684,7 +685,7 @@ You may place anything of type .Em pointer here. Use the macros -.Fn NG_NODE_SET_PRIVATE "node, value" +.Fn NG_NODE_SET_PRIVATE node value and .Fn NG_NODE_PRIVATE "node" to set and retrieve this property. @@ -702,10 +703,10 @@ hooks The node may have a number of hooks. A traversal method is provided to allow all the hooks to be tested for some condition. -.Fn NG_NODE_FOREACH_HOOK "node, fn, arg, rethook" +.Fn NG_NODE_FOREACH_HOOK node fn arg rethook where fn is a function that will be called for each hook with the form -.Fn fn "hook, arg" +.Fn fn hook arg and returning 0 to terminate the search. If the search is terminated, then .Em rethook will be set to the hook at which the search was terminated. @@ -727,7 +728,7 @@ You may place anything of type .Em pointer here. Use the macros -.Fn NG_HOOK_SET_PRIVATE "hook, value" +.Fn NG_HOOK_SET_PRIVATE hook value and .Fn NG_HOOK_PRIVATE "hook" to set and retrieve this property. @@ -761,9 +762,9 @@ unless you have another reference still valid. Over-ride receive functions. .Pp The -.Fn NG_HOOK_SET_RCVDATA "hook, fn" +.Fn NG_HOOK_SET_RCVDATA hook fn and -.Fn NG_HOOK_SET_RCVMSG "hook, fn" +.Fn NG_HOOK_SET_RCVMSG hook fn macros can be used to set over-ride methods that will be used in preference to the generic receive data and reveive message functions. To unset these use the macros to set them to NULL. They will only be used for data and @@ -1152,7 +1153,7 @@ It has 4 hooks: and .Dv right2left . Data entering from the right is passed to the left and duplicated on -.Dv right2left, +.Dv right2left , and data entering from the left is passed to the right and duplicated on .Dv left2right . @@ -1222,7 +1223,7 @@ A server and client side implememtation of PPPoE. Used in conjunction with either .Xr ppp 8 or the -.Em mpd port. +.Em mpd port . .It BRIDGE This node, togther with the ethernet nodes allows a very flexible bridging system to be implemented. diff --git a/share/man/man4/ng_one2many.4 b/share/man/man4/ng_one2many.4 index e3a8456..5ca0448 100644 --- a/share/man/man4/ng_one2many.4 +++ b/share/man/man4/ng_one2many.4 @@ -168,7 +168,7 @@ but also atomically clears the statistics for the link as well. This node shuts down upon receipt of a .Dv NGM_SHUTDOWN control message, or when all hooks have been disconnected. -.Sh EXAMPLE +.Sh EXAMPLES The following commands will set up Ethernet interfaces .Dv fxp0 to deliver packets alternating over the physical interfaces @@ -215,10 +215,12 @@ The node type was implemented in .Fx 4.2 . .Sh AUTHORS -The one2many netgraph node (with round-robin algorithm) was written by +.An -nosplit +The +.Nm one2many +netgraph node (with round-robin algorithm) was written by .An Archie Cobbs -.Aq archie@freebsd.org . +.Aq archie@FreeBSD.org . The all algorithm was added by .An Rogier R. Mulhuijzen .Aq drwilco@drwilco.net . - diff --git a/share/man/man4/pcvt.4 b/share/man/man4/pcvt.4 index 315a2c3..6918d28 100644 --- a/share/man/man4/pcvt.4 +++ b/share/man/man4/pcvt.4 @@ -681,7 +681,7 @@ This feature is mainly intended to allow to switch between virtual screens even when running an X server. They are ugly with respect to the implied semantics -.Pq i.\& e., they break Berkeley semantics. +(i.e., they break Berkeley semantics). See the file .Pa i386/include/pcvt_ioctl.h for their documentation. diff --git a/share/man/man4/ppbus.4 b/share/man/man4/ppbus.4 index f710801..fc0e8b6 100644 --- a/share/man/man4/ppbus.4 +++ b/share/man/man4/ppbus.4 @@ -68,7 +68,7 @@ and non-standard software: .Pp .Bl -column "Driver" -compact .It Em Driver Ta Em Description -.It Sy vpo Ta "VPI0 parallel to Adaptec AIC-7110 SCSI controller driver." +.It Sy vpo Ta "VPI0 parallel to Adaptec AIC-7110 SCSI controller driver" . It uses standard and non-standard parallel port accesses. .It Sy ppi Ta "Parallel port interface for general I/O" .It Sy pps Ta "Pulse per second Timing Interface" diff --git a/share/man/man4/ppi.4 b/share/man/man4/ppi.4 index 336167a..1614729 100644 --- a/share/man/man4/ppi.4 +++ b/share/man/man4/ppi.4 @@ -57,27 +57,27 @@ calls. Each command takes a single .Ft u_int8_t argument, transferring one byte of data. The following commands are available: -.Bl -tag -width 10 -.It PPIGDATA, PPISDATA +.Bl -tag -width indent +.It Dv PPIGDATA , PPISDATA Get and set the contents of the data register. -.It PPIGSTATUS, PPISSTATUS +.It Dv PPIGSTATUS , PPISSTATUS Get and set the contents of the status register. -.It PPIGCTRL, PPISCTRL +.It Dv PPIGCTRL , PPISCTRL Get and set the contents of the control register. The following defines correspond to bits in this register. Setting a bit in the control register drives the corresponding output low. -.Bl -tag -width 10 -compact -.It STROBE -.It AUTOFEED -.It nINIT -.It SELECTIN -.It PCD +.Bl -tag -width indent -compact +.It Dv STROBE +.It Dv AUTOFEED +.It Dv nINIT +.It Dv SELECTIN +.It Dv PCD .El -.It PPIGEPP, PPISEPP +.It Dv PPIGEPP , PPISEPP Get and set the contents of the EPP control register. -.It PPIGECR, PPISECR +.It Dv PPIGECR , PPISECR Get and set the contents of the ECP control register. -.It PPIGFIFO, PPISFIFO +.It Dv PPIGFIFO , PPISFIFO Read and write the ECP FIFO (8-bit operations only). .El .Sh EXAMPLES diff --git a/share/man/man4/psm.4 b/share/man/man4/psm.4 index 01376f1..de5018d 100644 --- a/share/man/man4/psm.4 +++ b/share/man/man4/psm.4 @@ -194,7 +194,7 @@ driver. They may be set in the kernel configuration file .Pq see Xr config 8 . .Bl -tag -width MOUSE -.It Em KBD_RESETDELAY=X, KBD_MAXWAIT=Y +.It Em KBD_RESETDELAY=X , KBD_MAXWAIT=Y The .Nm driver will attempt to reset the pointing device during the boot process. @@ -215,7 +215,7 @@ The default values are and 5 for .Fa Y . -.It Em PSM_DEBUG=N, KBDIO_DEBUG=N +.It Em PSM_DEBUG=N , KBDIO_DEBUG=N Sets the debug level to .Fa N . The default debug level is zero. diff --git a/share/man/man4/rl.4 b/share/man/man4/rl.4 index 8419c8e..7bf0642 100644 --- a/share/man/man4/rl.4 +++ b/share/man/man4/rl.4 @@ -93,7 +93,8 @@ The option can also be used to select either .Ar full-duplex or -.Ar half-duplex modes. +.Ar half-duplex +modes. .It 100baseTX Set 100Mbps (fast ethernet) operation. The diff --git a/share/man/man4/spkr.4 b/share/man/man4/spkr.4 index d5a7571..d83e897 100644 --- a/share/man/man4/spkr.4 +++ b/share/man/man4/spkr.4 @@ -140,7 +140,7 @@ sets quarter notes, etc. Pause (rest), with .Sy n interpreted as for -.Ns Li L Sy n . +.Li L Sy n . May be followed by sustain dots. May also be written .Li ~ . @@ -169,7 +169,7 @@ very fast Prestissimo .It Li M[LNS] Set articulation. .Li MN -.Ns No ( Li N +.Li ( N for normal) is the default; the last 1/8th of the note's value is rest time. You can set diff --git a/share/man/man4/splash.4 b/share/man/man4/splash.4 index 8f37403..3aa1150 100644 --- a/share/man/man4/splash.4 +++ b/share/man/man4/splash.4 @@ -160,15 +160,15 @@ section above. .\".Sh DRIVER CONFIGURATION .Sh FILES .Bl -tag -width /boot/kernel/splash_xxxx.ko -compact -.It /boot/defaults/loader.conf +.It Pa /boot/defaults/loader.conf boot loader configuration defaults -.It /etc/rc.conf +.It Pa /etc/rc.conf system configuration information -.It /boot/kernel/splash_*.ko +.It Pa /boot/kernel/splash_*.ko splash image decoder modules -.It /boot/kernel/*_saver.ko +.It Pa /boot/kernel/*_saver.ko screen saver modules -.It /boot/kernel/vesa.ko +.It Pa /boot/kernel/vesa.ko the VESA support module .El .Sh EXAMPLES diff --git a/share/man/man4/sppp.4 b/share/man/man4/sppp.4 index 76e4c45..13ada10 100644 --- a/share/man/man4/sppp.4 +++ b/share/man/man4/sppp.4 @@ -124,7 +124,7 @@ value 0.0.0.1 which means that we don't care what address the remote side will use, as long as it is not 0.0.0.0. This is useful if your ISP has several dial-in servers. You can of course -.Ic route add something or other 0.0.0.1 +.Nm route Cm add Ar something_or_other 0.0.0.1 and it will do exactly what you would want it to. .Pp The PAP and CHAP authentication protocols as described in RFC 1334, diff --git a/share/man/man4/ste.4 b/share/man/man4/ste.4 index 5e30bc6..ca787f4 100644 --- a/share/man/man4/ste.4 +++ b/share/man/man4/ste.4 @@ -77,7 +77,8 @@ The option can also be used to select either .Ar full-duplex or -.Ar half-duplex modes. +.Ar half-duplex +modes. .It 100baseTX Set 100Mbps (fast ethernet) operation. The diff --git a/share/man/man4/sym.4 b/share/man/man4/sym.4 index a76ddcf..aa100a9 100644 --- a/share/man/man4/sym.4 +++ b/share/man/man4/sym.4 @@ -76,19 +76,19 @@ To control chip attachment balancing between the ncr driver and this driver .Cd options SYM_SETUP_LP_PROBE_MAP=<bit combination> .Sh DESCRIPTION This driver provides support for the Symbios/LSI Logic -.Tn 53C810, -.Tn 53C815, -.Tn 53C825, -.Tn 53C810A, -.Tn 53C825A, -.Tn 53C860, -.Tn 53C875, -.Tn 53C876, -.Tn 53C895, -.Tn 53C895A, -.Tn 53C896, -.Tn 53C897, -.Tn 53C1510D, +.Tn 53C810 , +.Tn 53C815 , +.Tn 53C825 , +.Tn 53C810A , +.Tn 53C825A , +.Tn 53C860 , +.Tn 53C875 , +.Tn 53C876 , +.Tn 53C895 , +.Tn 53C895A , +.Tn 53C896 , +.Tn 53C897 , +.Tn 53C1510D , and .Tn 53C1010 PCI SCSI controllers. diff --git a/share/man/man4/sysmouse.4 b/share/man/man4/sysmouse.4 index 2c80033..ceb55a6 100644 --- a/share/man/man4/sysmouse.4 +++ b/share/man/man4/sysmouse.4 @@ -166,7 +166,7 @@ field holds the number of buttons detected by the driver. The .Dv iftype is always -.Dv MOUSE_IF_SYSMOUSE. +.Dv MOUSE_IF_SYSMOUSE . .Pp The .Dv type diff --git a/share/man/man4/tap.4 b/share/man/man4/tap.4 index bac035a..b020349 100644 --- a/share/man/man4/tap.4 +++ b/share/man/man4/tap.4 @@ -51,11 +51,9 @@ and thus can be used with like any other Ethernet interface. When the system chooses to transmit an Ethernet frame on the network interface, the frame can be read from the control device -.Po -it appears as +(it appears as .Dq input -there -.Pc ; +there); writing an Ethernet frame to the control device generates an input frame on the network interface, as if the .Pq non-existent @@ -64,9 +62,7 @@ hardware had just received it. The Ethernet tunnel device, normally .Pa /dev/tap Ns Sy N , is exclusive-open -.Po -it cannot be opened if it is already open -.Pc +(it cannot be opened if it is already open) and is restricted to the super-user. A .Fn read @@ -121,11 +117,9 @@ value is or isn't zero .Pq Writes are always nonblocking . .It Dv FIOASYNC Turn asynchronous I/O for reads -.Po -i.e., generation of +(i.e., generation of .Dv SIGIO -when data is available to be read -.Pc +when data is available to be read) off or on, according as the argument .Va int Ns 's value is or isn't zero. @@ -152,12 +146,10 @@ address of the .Dq remote side. This command is used by the VMware port and expected to be executed on descriptor, associated with control device -.Po -usually +(usually .Pa /dev/vmnet Ns Sy N or -.Pa /dev/tap Ns Sy N -.Pc . +.Pa /dev/tap Ns Sy N ) . The .Va buffer , which is passed as the argument, is expected to have enough space to store @@ -189,10 +181,9 @@ writes are always non-blocking. .Pp On the last close of the data device, the interface is brought down -.Po -as if with -.Dq ifconfig tap Ns Sy N No down -.Pc unless the devices is a VMnet device. +(as if with +.Dq ifconfig tap Ns Sy N No down ) +unless the devices is a VMnet device. All queued frames are thrown away. If the interface is up when the data device is not open, output frames are thrown away rather than letting them pile up. diff --git a/share/man/man4/termios.4 b/share/man/man4/termios.4 index 2cf0c4b..f632b4c 100644 --- a/share/man/man4/termios.4 +++ b/share/man/man4/termios.4 @@ -47,7 +47,8 @@ supported on tty asynchronous communication ports. When a terminal file is opened, it normally causes the process to wait until a connection is established. For most hardware, the presence of a connection is indicated by the assertion of the hardware -.Dv CARRIER line. +.Dv CARRIER +line. If the termios structure associated with the terminal file has the .Dv CLOCAL flag set in the cflag, or if the @@ -323,7 +324,7 @@ characters (see the is received. This processing affects data in the input queue that has not yet been delimited by a newline -.Dv NL, +.Dv NL , .Dv EOF , or .Dv EOL @@ -631,7 +632,7 @@ system and are not a part of 1003.1 termios. Secondary .Dv EOL character. Same function as -.Dv EOL. +.Dv EOL . .It Dv WERASE Special character on input and is recognized if the .Dv ICANON @@ -705,7 +706,7 @@ Special Control Characters. Special character functions associated with changeable special control characters can be disabled individually by setting their value to -.Dv {_POSIX_VDISABLE}; +.Dv {_POSIX_VDISABLE} ; see .Sx "Special Control Characters" . .Pp @@ -989,7 +990,7 @@ and are composed of the following masks: /* enable following output processing */ .It Dv ONLCR /* map NL to CR-NL (ala -.Dv CRMOD) +.Dv CRMOD ) */ .It Dv OXTABS /* expand tabs to spaces */ @@ -1283,10 +1284,10 @@ If is set, canonical processing is enabled. This enables the erase and kill edit functions, and the assembly of input characters into lines delimited by -.Dv NL, +.Dv NL , .Dv EOF , and -.Dv EOL, +.Dv EOL , as described in .Sx "Canonical Mode Input Processing" . .Pp diff --git a/share/man/man4/ti.4 b/share/man/man4/ti.4 index 2c05cd4..32379ce 100644 --- a/share/man/man4/ti.4 +++ b/share/man/man4/ti.4 @@ -131,7 +131,8 @@ The option can also be used to select either .Ar full-duplex or -.Ar half-duplex modes. +.Ar half-duplex +modes. .It 100baseTX Set 100Mbps (fast ethernet) operation. The diff --git a/share/man/man4/ttcp.4 b/share/man/man4/ttcp.4 index 7018f5c..5a61e58 100644 --- a/share/man/man4/ttcp.4 +++ b/share/man/man4/ttcp.4 @@ -118,7 +118,7 @@ and system calls to understand the notion of .Dq implied connect and -.Dq send and shutdown. +.Dq send and shutdown . To send the request in a transaction, the .Xr sendto 2 system call is typically used, as in the following example: diff --git a/share/man/man4/tty.4 b/share/man/man4/tty.4 index ed675b1..6310e69 100644 --- a/share/man/man4/tty.4 +++ b/share/man/man4/tty.4 @@ -162,7 +162,7 @@ file descriptor zero by the following code fragment: Change to the new line discipline pointed to by .Fa ldisc . The available line disciplines are listed in -.Pa Aq sys/ttycom.h +.Aq Pa sys/ttycom.h and currently are: .Pp .Bl -tag -width NETGRAPHDISC -compact diff --git a/share/man/man4/tun.4 b/share/man/man4/tun.4 index 76fa90a..768bc35 100644 --- a/share/man/man4/tun.4 +++ b/share/man/man4/tun.4 @@ -28,12 +28,10 @@ driver, like the .Nm pty driver, provides two interfaces: an interface like the usual facility it is simulating -.Po -a network interface in the case of +(a network interface in the case of .Nm , or a terminal for -.Nm pty -.Pc , +.Nm pty ) , and a character-special device .Dq control interface. @@ -56,11 +54,9 @@ like any other interface. At boot time, they are interfaces, but this can be changed; see the description of the control device, below. When the system chooses to transmit a packet on the network interface, the packet can be read from the control device -.Po -it appears as +(it appears as .Dq input -there -.Pc ; +there); writing a packet to the control device generates an input packet on the network interface, as if the .Pq non-existent @@ -69,9 +65,7 @@ hardware had just received it. The tunnel device, normally .Pa /dev/tun Ns Sy N , is exclusive-open -.Po -it cannot be opened if it is already open -.Pc +(it cannot be opened if it is already open) and is restricted to the super-user. A .Fn read @@ -79,10 +73,8 @@ call will return an error .Pq Er EHOSTDOWN if the interface is not .Dq ready -.Po -which means that the control device is open and the interface's -address has been set -.Pc . +(which means that the control device is open and the interface's +address has been set). Once the interface is ready, .Fn read will return a packet if one is available; if not, it will either block @@ -197,11 +189,10 @@ value is or isn't zero .Pq Writes are always nonblocking . .It Dv FIOASYNC Turn asynchronous I/O for reads -.Po -i.e., generation of +(i.e., generation of .Dv SIGIO -when data is available to be read -.Pc off or on, according as the argument +when data is available to be read) +off or on, according as the argument .Va int Ns 's value is or isn't zero. .It Dv FIONREAD @@ -230,9 +221,8 @@ writes are always non-blocking. .Pp On the last close of the data device, by default, the interface is brought down -.Po as if with -.Dq ifconfig tun Ns Sy n No down -.Pc . +(as if with +.Dq ifconfig tun Ns Sy n No down ) . All queued packets are thrown away. If the interface is up when the data device is not open output packets are always thrown away rather than letting diff --git a/share/man/man4/vinum.4 b/share/man/man4/vinum.4 index 13eac04..0e215c1 100644 --- a/share/man/man4/vinum.4 +++ b/share/man/man4/vinum.4 @@ -799,9 +799,9 @@ sd name obj.p1.s3 drive drive4 plex obj.p1 state up len 204800b driveoffset 4098 The first line contains the .Nm label and must start with the text -.Li IN VINO. +.Li IN VINO . It also contains the name of the system. The exact definition is contained in -.Pa /usr/src/sys/dev/vinum/vinumvar.h. +.Pa /usr/src/sys/dev/vinum/vinumvar.h . The saved configuration starts in the middle of the line with the text .Li volume obj state up and starts in sector 9 of the disk. @@ -904,7 +904,8 @@ To perform remote serial debugging, link .Pa /var/crash/.gdbinit.serial to -.Pa /var/crash/.gdbinit and enter +.Pa /var/crash/.gdbinit +and enter .Bd -literal # cd /var/crash # gdb -k kernel.debug diff --git a/share/man/man4/vr.4 b/share/man/man4/vr.4 index 1a771ab..a80ef4f 100644 --- a/share/man/man4/vr.4 +++ b/share/man/man4/vr.4 @@ -82,7 +82,8 @@ The option can also be used to select either .Ar full-duplex or -.Ar half-duplex modes. +.Ar half-duplex +modes. .It 100baseTX Set 100Mbps (fast ethernet) operation. The diff --git a/share/man/man4/wb.4 b/share/man/man4/wb.4 index 307ac58..d9f731c 100644 --- a/share/man/man4/wb.4 +++ b/share/man/man4/wb.4 @@ -82,7 +82,8 @@ The option can also be used to select either .Ar full-duplex or -.Ar half-duplex modes. +.Ar half-duplex +modes. .It 100baseTX Set 100Mbps (fast ethernet) operation. The diff --git a/share/man/man4/xl.4 b/share/man/man4/xl.4 index 3af07ef..78ba9e3 100644 --- a/share/man/man4/xl.4 +++ b/share/man/man4/xl.4 @@ -92,7 +92,8 @@ The option can also be used to select either .Ar full-duplex or -.Ar half-duplex modes. +.Ar half-duplex +modes. .It 100baseTX Set 100Mbps (fast ethernet) operation. The @@ -100,7 +101,8 @@ The option can also be used to select either .Ar full-duplex or -.Ar half-duplex modes. +.Ar half-duplex +modes. .It 10base5/AUI Enable AUI transceiver (available only on COMBO cards). .It 10base2/BNC diff --git a/share/man/man4/xpt.4 b/share/man/man4/xpt.4 index 39e3aa1..f41f334 100644 --- a/share/man/man4/xpt.4 +++ b/share/man/man4/xpt.4 @@ -100,4 +100,4 @@ None. The CAM transport layer driver first appeared in .Fx 3.0 . .Sh AUTHORS -.An Kenneth Merry Aq ken@FreeBSD.ORG +.An Kenneth Merry Aq ken@FreeBSD.org diff --git a/share/man/man5/a.out.5 b/share/man/man5/a.out.5 index 1aa6e4c..a659ba7 100644 --- a/share/man/man5/a.out.5 +++ b/share/man/man5/a.out.5 @@ -103,14 +103,15 @@ The fields have the following functions: .It Fa a_midmag This field is stored in host byte-order. It has a number of sub-components accessed by the macros -.Dv N_GETFLAG() , -.Dv N_GETMID() , and -.Dv N_GETMAGIC() , +.Fn N_GETFLAG , +.Fn N_GETMID , +and +.Fn N_GETMAGIC , and set by the macro -.Dv N_SETMAGIC(). +.Fn N_SETMAGIC . .Pp The macro -.Dv N_GETFLAG() +.Fn N_GETFLAG returns a few flags: .Bl -tag -width EX_DYNAMIC .It Dv EX_DYNAMIC @@ -132,11 +133,11 @@ executable image (eg. a shared library), which is to be loaded into the process address space by the run-time link editor. .Pp The macro -.Dv N_GETMID() +.Fn N_GETMID returns the machine-id. This indicates which machine(s) the binary is intended to run on. .Pp -.Dv N_GETMAGIC() +.Fn N_GETMAGIC specifies the magic number, which uniquely identifies binary files and distinguishes different loading conventions. The field must contain one of the following values: @@ -287,7 +288,7 @@ only occurs in shared objects. .It Fa r_copy If set, this relocation record identifies a symbol whose contents should be copied to the location given in -.Fa r_address. +.Fa r_address . The copying is done by the run-time link-editor from a suitable data item in a shared object. .El diff --git a/share/man/man5/acct.5 b/share/man/man5/acct.5 index e2c3402..56cf727 100644 --- a/share/man/man5/acct.5 +++ b/share/man/man5/acct.5 @@ -92,7 +92,7 @@ the name of the executed file (at most ten characters of it) is saved in the field .Fa ac_comm and its status is saved by setting one of more of the following flags in -.Fa ac_flag: +.Fa ac_flag : .Dv AFORK , .Dv ASU , .Dv ACOMPAT , diff --git a/share/man/man5/elf.5 b/share/man/man5/elf.5 index 5502a81..36438bf 100644 --- a/share/man/man5/elf.5 +++ b/share/man/man5/elf.5 @@ -649,7 +649,7 @@ The system reserves indices between .Sy SHN_LORESERVE and -.Sy SHN_HIRESERVE, +.Sy SHN_HIRESERVE , inclusive. The section header table does not contain entries for the reserved indices. @@ -1191,18 +1191,25 @@ This value down to and including are reserved for processor-specific semantics. .Pp There are macros for packing and unpacking the binding and type fields: +.Pp .Bl -tag -width "ELF32_ST_INFO(bind, type)" -compact -.It Dv ELF32_ST_BIND(info) +.It Xo +.Fn ELF32_ST_BIND info +.Xc or -.Sy ELF64_ST_BIND(info) +.Fn ELF64_ST_BIND info extract a binding from an st_info value. -.It Dv ELF64_ST_TYPE(info) +.It Xo +.Fn ELF64_ST_TYPE info +.Xc or -.Sy ELF32_ST_TYPE(info) +.Fn ELF32_ST_TYPE info extract a type from an st_info value. -.It Dv ELF32_ST_INFO(bind, type) +.It Xo +.Fn ELF32_ST_INFO bind type +.Xc or -.Sy ELF64_ST_INFO(bind, type) +.Fn ELF64_ST_INFO bind type convert a binding and a type into an st_info value. .El .El diff --git a/share/man/man5/forward.5 b/share/man/man5/forward.5 index bb3dad6..28735b1 100644 --- a/share/man/man5/forward.5 +++ b/share/man/man5/forward.5 @@ -62,7 +62,7 @@ nobody@FreeBSD.org .Ed .Pp Mail would be forwarded to -.Ar nobody@FreeBSD.org +.Aq nobody@FreeBSD.org and to the program .Pa /usr/bin/vacation with the single argument diff --git a/share/man/man5/fs.5 b/share/man/man5/fs.5 index b47c25b..5280da0 100644 --- a/share/man/man5/fs.5 +++ b/share/man/man5/fs.5 @@ -313,7 +313,7 @@ defines the amount of space allocated in the super-block for this name. The limit on the amount of summary information per file system is defined by -.Dv MAXCSBUFS. +.Dv MAXCSBUFS . For a 4096 byte block size, it is currently parameterized for a maximum of two million cylinders. .Pp @@ -325,7 +325,7 @@ These blocks are read in from .Fa fs_cssize ) in addition to the super-block. .Pp -.Sy N.B.: +.Sy N.B. : .Fn sizeof "struct csum" must be a power of two in order for the diff --git a/share/man/man5/link.5 b/share/man/man5/link.5 index 2106230..48f9388 100644 --- a/share/man/man5/link.5 +++ b/share/man/man5/link.5 @@ -75,7 +75,7 @@ through the .size assembler directive. PIC code differs from conventional code in that it accesses data variables through an indirection table, the Global Offset Table, by convention accessible by the reserved name -.Em _GLOBAL_OFFSET_TABLE_. +.Dv _GLOBAL_OFFSET_TABLE_ . The exact mechanism used for this is machine dependent, usually a machine register is reserved for the purpose. The rational behind this construct @@ -105,7 +105,7 @@ If this symbol is non-zero, it points at a data structure from which the location of the necessary relocation- and symbol information can be derived. This is most notably used by the start-up module, -.Em crt0. +.Em crt0 . The _DYNAMIC structure is conventionally located at the start of the data segment of the image to which it pertains. .Pp @@ -138,11 +138,11 @@ The current version numbers understood by and .Xr ld.so 1 are -.Em LD_VERSION_SUN (3), +.Em LD_VERSION_SUN (3) , which is used by the .Tn SunOS 4.x releases, and -.Em LD_VERSION_BSD (8), +.Em LD_VERSION_BSD (8) , which has been in use since .Fx 1.1 . .It Fa d_un @@ -214,7 +214,7 @@ The number of buckets in .Fa sdt_hash .It Fa sdt_strings The location of the symbol string table that goes with -.Fa sdt_nzlist. +.Fa sdt_nzlist . .It Fa sdt_str_sz The size of the string table. .It Fa sdt_text_sz @@ -262,7 +262,7 @@ see also .Xr ldconfig 8 .Pc for a shared object matching -.Em lib\&<sod_name>\&.so.n.m. +.Em lib\&<sod_name>\&.so.n.m . If not set, .Fa sod_name should point at a full path name for the desired shared object. @@ -325,7 +325,7 @@ An array of these lives in the shared object's text segment and is addressed by the .Fa sdt_nzlist field of -.Fa section_dispatch_table. +.Fa section_dispatch_table . .Bd -literal -offset indent struct nzlist { struct nlist nlist; @@ -449,7 +449,7 @@ The address were a breakpoint will be set by the run-time linker to divert control to the debugger. This address is determined by the start-up module, -.Em crt0.o, +.Pa crt0.o , to be some convenient place before the call to _main. .It Fa dd_bpt_shadow Contains the original instruction that was at diff --git a/share/man/man5/make.conf.5 b/share/man/man5/make.conf.5 index 7f74526..978af0e 100644 --- a/share/man/man5/make.conf.5 +++ b/share/man/man5/make.conf.5 @@ -339,7 +339,7 @@ Set this to build KerberosIV (KTH eBones). .It Va MAKE_KERBEROS5 .Vt ( bool ) Set this to build Kerberos5 (KTH Heimdal). -.Em WARNING! +.Em WARNING ! This is still experimental code. If you need stable Kerberos5, use the port(s). diff --git a/share/man/man5/nsswitch.conf.5 b/share/man/man5/nsswitch.conf.5 index 1e7deff..4f48708 100644 --- a/share/man/man5/nsswitch.conf.5 +++ b/share/man/man5/nsswitch.conf.5 @@ -62,13 +62,17 @@ Each criterion consists of one or more status codes, and actions to take if that status code occurs. .Ss Sources The following sources are implemented: -.Bl -column "compat" -offset indent -compact -.It Sy "Source Description -.It "files Local files, such as" +.Pp +.Bl -tag -width Source -compact +.It Sy Source +.Sy Description +.It files +Local files, such as .Pa /etc/hosts , and .Pa /etc/passwd . -.It "dns Internet Domain Name System." +.It dns +Internet Domain Name System. .Dq hosts and .Sq networks @@ -77,8 +81,10 @@ use class entries, all other databases use .Sy HS class (Hesiod) entries. -.It "nis NIS (formerly YP)" -.It "compat support" +.It nis +NIS (formerly YP) +.It compat +support .Sq +/- in the .Dq passwd @@ -89,34 +95,46 @@ If this is present, it must be the only source for that entry. .El .Ss Databases The following databases are used by the following C library functions: -.Bl -column "networks" -offset indent -compact -.It Sy "Database Used by" -.It "group " +.Pp +.Bl -tag -width networks -compact +.It Sy Database +.Sy "Used by" +.It group .Xr getgrent 3 -.It "hosts " +.It hosts .Xr gethostbyname 3 -.It "networks " +.It networks .Xr getnetbyname 3 -.It "passwd " +.It passwd .Xr getpwent 3 -.It "shells " +.It shells .Xr getusershell 3 .El .Ss Status codes The following status codes are available: -.Bl -column "tryagain" -offset indent -compact -.It Sy "Status Description" -.It "success The requested entry was found." -.It "notfound The entry is not present at this source." -.It "tryagain The source is busy, and may respond to retries." -.It "unavail The source is not responding, or entry is corrupt." +.Pp +.Bl -tag -width tryagain -compact +.It Sy Status +.Sy Description +.It success +The requested entry was found. +.It notfound +The entry is not present at this source. +.It tryagain +The source is busy, and may respond to retries. +.It unavail +The source is not responding, or entry is corrupt. .El .Ss Actions For each of the status codes, one of two actions is possible: -.Bl -column "continue" -offset indent -compact -.It Sy "Action Description" -.It "continue Try the next source" -.It "return Return with the current result" +.Pp +.Bl -tag -width continue -compact +.It Sy Action +.Sy Description +.It continue +Try the next source +.It return +Return with the current result .El .Ss Format of file A @@ -124,16 +142,22 @@ A description of the syntax of .Nm is: -.Bl -column "<criterion>" -offset indent -.It "<entry> ::=" +.Pp +.Bl -tag -width <criterion> -compact +.It <entry> +::= <database> ":" [<source> [<criteria>]]* -.It "<criteria> ::=" +.It <criteria> +::= "[" <criterion>+ "]" -.It "<criterion> ::=" +.It <criterion> +::= <status> "=" <action> -.It "<status> ::=" +.It <status> +::= "success" | "notfound" | "unavail" | "tryagain" -.It "<action> ::=" +.It <action> +::= "return" | "continue" .El .Pp @@ -206,13 +230,20 @@ will default to an entry of .Dq files for the requested database. Exceptions are: -.Bl -column passwd_compat "dns files" -offset indent -.It Sy "Database Default source list" -.It "group compat" -.It "group_compat nis" -.It "hosts dns files" -.It "passwd compat" -.It "passwd_compat nis" +.Pp +.Bl -tag -width passwd_compat -compact +.It Sy Database +.Sy "Default source list" +.It group +compat +.It group_compat +nis +.It hosts +dns files +.It passwd +compat +.It passwd_compat +nis .El .Sh FILES .Bl -tag -width /etc/nsswitch.conf -compact @@ -228,10 +259,14 @@ To lookup hosts in and then from the DNS, and lookup user information from .Tn NIS then files, use: -.Bl -column "passwd:" -offset indent -.It "hosts: files dns" -.It "passwd: nis [notfound=return] files" -.It "group: nis [notfound=return] files" +.Pp +.Bl -tag -width passwd: -compact +.It hosts: +files dns +.It passwd: +nis [notfound=return] files +.It group: +nis [notfound=return] files .El .Pp The criteria diff --git a/share/man/man5/passwd.5 b/share/man/man5/passwd.5 index 7b49790..23037cb 100644 --- a/share/man/man5/passwd.5 +++ b/share/man/man5/passwd.5 @@ -281,7 +281,7 @@ fields, the specified numbers will override the information retrieved from the Hesiod domain or the .Tn NIS maps. As well, if the -.Ar gecos, +.Ar gecos , .Ar dir or .Ar shell diff --git a/share/man/man5/periodic.conf.5 b/share/man/man5/periodic.conf.5 index 74a3937..20ff45c 100644 --- a/share/man/man5/periodic.conf.5 +++ b/share/man/man5/periodic.conf.5 @@ -333,7 +333,7 @@ if is set to .Dq YES in -.Pa /etc/rc.conf ). +.Pa /etc/rc.conf ) . .It Ar daily_status_mailq_enable (bool) Set to .Dq YES diff --git a/share/man/man5/procfs.5 b/share/man/man5/procfs.5 index 68fe968..a67703d 100644 --- a/share/man/man5/procfs.5 +++ b/share/man/man5/procfs.5 @@ -142,7 +142,7 @@ process group id .It session id .It -.Ar major,minor +.Ar major , Ns Ar minor of the controlling terminal, or .Dv -1,-1 if there is no controlling terminal. diff --git a/share/man/man5/utmp.5 b/share/man/man5/utmp.5 index ca0d4fd..2ef38ef 100644 --- a/share/man/man5/utmp.5 +++ b/share/man/man5/utmp.5 @@ -91,7 +91,7 @@ Each time a user logs in, the program looks up the user's .Tn UID in the file -.Nm lastlog. +.Nm lastlog . If it is found, the timestamp of the last time the user logged in, the terminal line and the hostname are written to the standard output (unless the login is @@ -179,7 +179,7 @@ is recorded in the field In the field .Fa ut_line , the character -.Ql \\*(Ba +.Ql \&| indicates the time prior to the change, and the character .Ql \&{ indicates the new time. diff --git a/share/man/man7/hier.7 b/share/man/man7/hier.7 index 7750fea..2ccc3fc 100644 --- a/share/man/man7/hier.7 +++ b/share/man/man7/hier.7 @@ -41,315 +41,315 @@ .Sh DESCRIPTION A sketch of the filesystem hierarchy. .Bl -tag -width "/stand/" -.It Li / +.It Pa / root directory of the filesystem -.It Li /bin/ +.It Pa /bin/ user utilities fundamental to both single-user and multi-user environments -.It Li /boot/ +.It Pa /boot/ programs and configuration files used during operating system bootstrap .Pp .Bl -tag -width defaults/ -compact -.It Li defaults/ +.It Pa defaults/ default bootstrapping configuration files; see .Xr loader.conf 5 -.It Li kernel/ +.It Pa kernel/ pure kernel executable (the operating system loaded into memory at boot time). -.It Li modules/ +.It Pa modules/ third-part loadable kernel modules; see .Xr kldstat 8 .El -.It Li /dev/ +.It Pa /dev/ block and character device files .Pp .Bl -tag -width MAKEDEV -compact -.It Li MAKEDEV +.It Pa MAKEDEV script for creating device files; see .Xr MAKEDEV 8 -.It Li fd/ +.It Pa fd/ file descriptor files; see .Xr \&fd 4 .El -.It Li /etc/ +.It Pa /etc/ system configuration files and scripts .Pp .Bl -tag -width "disklabels/" -compact -.It Li defaults/ +.It Pa defaults/ default system configuration files; see .Xr rc 8 -.It Li gnats/ +.It Pa gnats/ gnats configuration files; see .Xr send-pr 1 -.It Li isdn/ +.It Pa isdn/ isdn4bsd configuration files; see .Xr isdnd 8 -.It Li kerberosIV/ +.It Pa kerberosIV/ configuration files for the kerberos version IV; see .Xr kerberos 1 -.It Li localtime +.It Pa localtime local timezone information; see .Xr ctime 3 -.It Li mail/ +.It Pa mail/ spam-filtering information -.It Li mtree/ +.It Pa mtree/ mtree configuration files; see .Xr mtree 8 -.It Li namedb/ +.It Pa namedb/ named configuration files; see .Xr named 8 -.It Li periodic/ +.It Pa periodic/ scripts that are run daily, weekly, and monthly, via .Xr cron 8 ; see .Xr periodic 8 -.It Li ppp/ +.It Pa ppp/ ppp configuration files; see .Xr ppp 8 -.It Li ssl/ +.It Pa ssl/ OpenSSL configuration files -.It Li uucp/ +.It Pa uucp/ uucp configuration files; see .Xr uucp 1 .El -.It Li /mnt/ +.It Pa /mnt/ empty directory commonly used by system administrators as a temporary mount point -.It Li /proc/ +.It Pa /proc/ process file system; see .Xr procfs 5 , .Xr mount_procfs 8 -.It Li /root/ +.It Pa /root/ root's HOME directory -.It Li /sbin/ +.It Pa /sbin/ system programs and administration utilities fundamental to both single-user and multi-user environments -.It Li /stand/ +.It Pa /stand/ programs used in a standalone environment -.It Li /tmp/ +.It Pa /tmp/ temporary files -.It Li /usr/ +.It Pa /usr/ contains the majority of user utilities and applications .Pp .Bl -tag -width "libdata/" -compact -.It Li bin/ +.It Pa bin/ common utilities, programming tools, and applications -.It Li games/ +.It Pa games/ useful and semi-frivolous programs -.It Li include/ +.It Pa include/ standard C include files .Pp .Bl -tag -width "kerberosIV/" -compact -.It Li arpa/ +.It Pa arpa/ C include files for Internet service protocols -.It Li cam/ +.It Pa cam/ C include files for the Common Access Methods Layer .Bl -tag -width "kerberosIV/" -compact .It scsi/ The SCSI device on top of CAM .El -.It Li dev/ +.It Pa dev/ C include files for programming various .Fx devices .Bl -tag -width "kerberosIV/" -compact -.It Li ppbus/ +.It Pa ppbus/ The parallel port bus; see .Xr ppbus 4 -.It Li usb/ +.It Pa usb/ The USB subsystem .El -.It Li g++/ +.It Pa g++/ GNU C++ include files .Bl -tag -width "kerberosIV/" -compact -.It Li std/ +.It Pa std/ GNU C++ libstdc++ include files .El -.It Li isc/ +.It Pa isc/ ISC utility library libisc include files -.It Li isofs/ +.It Pa isofs/ .Bl -tag -width "kerberosIV/" -compact -.It Li cd9660/ +.It Pa cd9660/ iso9660 filesystem .El -.It Li kerberosIV/ +.It Pa kerberosIV/ C include files for kerberos authentication package; see .Xr kerberos 1 -.It Li machine/ +.It Pa machine/ machine-specific C include files -.It Li msdosfs/ +.It Pa msdosfs/ MS-DOS file system -.It Li net/ +.It Pa net/ misc network C include files -.It Li netatalk/ +.It Pa netatalk/ Appletalk protocol -.It Li netatm/ +.It Pa netatm/ ATM include files; see .Xr atm 8 -.It Li netinet/ +.It Pa netinet/ C include files for Internet standard protocols; see .Xr inet 4 -.It Li netinet6/ +.It Pa netinet6/ C include files for Internet protocol version 6; see .Xr inet6 4 -.It Li netipx/ +.It Pa netipx/ IPX/SPX protocol stacks -.It Li netkey/ +.It Pa netkey/ kernel key-management service -.It Li netns/ +.It Pa netns/ Xerox NS protocols -.It Li netnatm/ +.It Pa netnatm/ NATM include files; see .Xr natm 4 -.It Li nfs/ +.It Pa nfs/ C include files for NFS (Network File System) -.It Li objc/ +.It Pa objc/ Objective C include files -.It Li openssl/ +.It Pa openssl/ OpenSSL (Cryptography/SSL toolkit) headers -.It Li pccard/ +.It Pa pccard/ PC-CARD controllers -.It Li posix4/ +.It Pa posix4/ POSIX real-time extensions includes; see .Xr p1003_1b 9 -.It Li protocols/ +.It Pa protocols/ C include files for Berkeley service protocols -.It Li readline/ +.It Pa readline/ get a line from a user, with editing; see .Xr readline 3 -.It Li rpc/ +.It Pa rpc/ remote procedure calls; see .Xr rpc 3 -.It Li rpcsvc/ +.It Pa rpcsvc/ definition of RPC service structures; see .Xr rpc 3 -.It Li security/ +.It Pa security/ PAM; see .Xr pam 8 -.It Li ss/ +.It Pa ss/ MIT SIPB .Sq subsystem library, part of Kerberos IV. -.It Li sys/ +.It Pa sys/ system C include files (kernel data structures) -.\" .It Li tcl/ +.\" .It Pa tcl/ .\" Tcl language; .\" see .\" .Xr Tcl n .\" .Bl -tag -width "kerberosIV/" -compact -.\" .It Li generic/ +.\" .It Pa generic/ .\" ??? -.\" .It Li unix/ +.\" .It Pa unix/ .\" ??? .\" .El -.It Li ufs/ +.It Pa ufs/ C include files for UFS (The U-word File System) .Bl -tag -width "kerberosIV/" -compact -.It Li ffs/ +.It Pa ffs/ Fast filesystem -.It Li mfs/ +.It Pa mfs/ memory file system; see .Xr mount_mfs 8 -.It Li ufs/ +.It Pa ufs/ UFS filesystem .El -.It Li vm/ +.It Pa vm/ virtual memory; see .Xr vmstat 8 .El .Pp -.It Li lib/ +.It Pa lib/ archive libraries .Bl -tag -width Fl -compact -.It Li aout/ +.It Pa aout/ a.out archive libraries -.It Li compat/ +.It Pa compat/ shared libraries for compatibility .Bl -tag -width Fl -compact -.It Li aout/ +.It Pa aout/ a.out backward compatibility libraries .El .El .Pp -.It Li libdata/ +.It Pa libdata/ misc. utility data files .Bl -tag -width Fl -compact -.It Li doscmd/ +.It Pa doscmd/ files used by doscmd (drivers, fonts, etc.); see .Xr doscmd 1 .Bl -tag -width 6n -compact -.It Li fonts/ +.It Pa fonts/ fonts used by doscmd .El -.It Li gcc/ +.It Pa gcc/ ??? -.It Li ldscripts/ +.It Pa ldscripts/ linker scripts; see .Xr ld 1 -.It Li lint/ +.It Pa lint/ various prebuilt lint libraries; see .Xr lint 1 -.It Li msdosfs/ +.It Pa msdosfs/ Character set conversion tables -.It Li perl/ +.It Pa perl/ .Bl -tag -width Fl -compact -.It Li 5.00503/ +.It Pa 5.00503/ contains Perl modules for Perl version 5.00503; see .Xr perl 1 .El -.It Li stallion/ +.It Pa stallion/ holds the download firmware images .El .Pp -.It Li libexec/ +.It Pa libexec/ system daemons & system utilities (executed by other programs) .Bl -tag -width Fl -compact -.It Li aout/ +.It Pa aout/ utilities to manipulate a.out executables -.It Li elf/ +.It Pa elf/ utilities to manipulate ELF executables -.It Li lpr/ +.It Pa lpr/ utilities and filters for LP print system; see .Xr lpr 1 -.It Li sm.bin/ +.It Pa sm.bin/ restricted shell for sendmail; see .Xr smrsh 8 -.It Li uucp/ +.It Pa uucp/ uucp utilities; see .Xr uucp 1 .El .Pp -.It Li local/ +.It Pa local/ local executables, libraries, etc. Also used as the default destination for the .Fx @@ -360,43 +360,43 @@ for /usr should be used. Exceptions are the man directory (directly under local/ rather than under local/share/), ports documentation (in share/doc/<port>/), and /usr/local/etc (mimics /etc). -.It Li obj/ +.It Pa obj/ architecture-specific target tree produced by building the /usr/src tree -.It Li ports/ +.It Pa ports/ The .Fx ports collection (optional). -.It Li sbin/ +.It Pa sbin/ system daemons & system utilities (executed by users) -.It Li share/ +.It Pa share/ architecture-independent files .Pp .Bl -tag -width "calendar/" -compact -.It Li calendar/ +.It Pa calendar/ a variety of pre-fab calendar files; see .Xr calendar 1 -.It Li dict/ +.It Pa dict/ word lists; see .Xr look 1 .Pp .Bl -tag -width Fl -compact -.It Li words +.It Pa words common words -.It Li web2 +.It Pa web2 words from Webster's 2nd International -.It Li papers/ +.It Pa papers/ reference databases; see .Xr refer 1 -.It Li special/ +.It Pa special/ custom word lists; see .Xr spell 1 .El .Pp -.It Li doc/ +.It Pa doc/ miscellaneous documentation; source for most of the printed .Bx @@ -405,318 +405,318 @@ from the .Tn USENIX association) .Bl -tag -width Fl -compact -.It Li FAQ/ +.It Pa FAQ/ Frequently Asked Questions -.It Li IPv6/ +.It Pa IPv6/ implementation notes for IPv6 -.It Li bind/ +.It Pa bind/ documents pertaining to BIND (the Berkeley Internet Name Domain) -.It Li es/ +.It Pa es/ Spanish translations of documents in /usr/share/doc -.It Li handbook/ +.It Pa handbook/ .Fx Handbook -.It Li ja/ +.It Pa ja/ Japanese translations of documents in /usr/share/doc -.It Li ncurses/ +.It Pa ncurses/ HTML documents pertaining to ncurses; see .Xr ncurses 3X -.It Li ntp/ +.It Pa ntp/ HTML documents pertaining to the Network Time Protocol -.It Li papers/ +.It Pa papers/ UNIX Papers -.It Li psd/ +.It Pa psd/ UNIX Programmer's Supplementary Documents -.It Li ru/ +.It Pa ru/ Russian translations of documents in /usr/share/doc -.It Li smm/ +.It Pa smm/ UNIX System Manager's Manual -.It Li tutorials/ +.It Pa tutorials/ .Fx tutorials -.It Li usd/ +.It Pa usd/ UNIX User's Supplementary Documents -.It Li zh/ +.It Pa zh/ Chinese translations of documents in /usr/share/doc .El .Pp -.It Li examples/ +.It Pa examples/ various examples for users and programmers -.It Li games/ +.It Pa games/ ASCII text files used by various games -.It Li groff_font/ +.It Pa groff_font/ device description file for device name -.It Li info/ +.It Pa info/ GNU Info hypertext system -.It Li isdn/ +.It Pa isdn/ ISDN -.It Li libg++/ +.It Pa libg++/ libg++'s genclass prototype/template class files -.It Li locale/ +.It Pa locale/ localization files; see .Xr setlocale 3 -.It Li man/ +.It Pa man/ manual pages -.It Li me/ +.It Pa me/ macros for use with the me macro package; see .Xr me 7 -.It Li misc/ +.It Pa misc/ misc system-wide ASCII text files .Bl -tag -width Fl -compact -.It Li fonts/ +.It Pa fonts/ ??? -.It Li pcvtfonts/ +.It Pa pcvtfonts/ pcvt fonts; see .Xr pcvt 4 -.It Li termcap +.It Pa termcap terminal characteristics database; see .Xr termcap 5 .El -.It Li mk/ +.It Pa mk/ templates for make; see .Xr make 1 -.It Li nls/ +.It Pa nls/ national language support files; see .Xr mklocale 1 -.It Li pcvt/ +.It Pa pcvt/ pcvt documentation and etc examples; see .Xr pcvt 4 -.It Li perl/ +.It Pa perl/ perl library files; see .Xr perl 1 -.It Li sendmail/ +.It Pa sendmail/ sendmail configuration files; see .Xr sendmail 8 -.It Li skel/ +.It Pa skel/ example . (dot) files for new accounts -.It Li syscons/ +.It Pa syscons/ files used by syscons; see .Xr syscons 4 .Bl -tag -width "scrnmaps/xx" -compact -.It Li fonts/ +.It Pa fonts/ console fonts; see .Xr vidcontrol 1 and .Xr vidfont 1 -.It Li keymaps/ +.It Pa keymaps/ console keyboard maps; see .Xr kbdcontrol 1 and .Xr kbdmap 1 -.It Li scrnmaps/ +.It Pa scrnmaps/ console screen maps .El -.It Li tabset/ +.It Pa tabset/ tab description files for a variety of terminals; used in the termcap file; see .Xr termcap 5 -.It Li tmac/ +.It Pa tmac/ text processing macros; see .Xr nroff 1 and .Xr troff 1 -.It Li vi/ +.It Pa vi/ localization support and utilities for .Xr vi 1 -.It Li zoneinfo/ +.It Pa zoneinfo/ timezone configuration information; see .Xr tzfile 5 .El -.It Li src/ +.It Pa src/ BSD, third-party, and/or local source files .Pp .Bl -tag -width "kerberosIV/" -compact -.It Li bin/ +.It Pa bin/ source code for files in /bin -.It Li contrib/ +.It Pa contrib/ source code for contributed software -.It Li crypto/ +.It Pa crypto/ source code for contributed cryptography software -.It Li etc/ +.It Pa etc/ source code for files in /etc -.It Li games/ +.It Pa games/ source code for files in /usr/games -.It Li gnu/ +.It Pa gnu/ Utilities covered by the GNU General Public License -.It Li include/ +.It Pa include/ source code for files in /usr/include -.It Li kerberosIV/ +.It Pa kerberosIV/ source code for kerberos version IV -.It Li lib/ +.It Pa lib/ source code for files in /usr/lib -.It Li libexec/ +.It Pa libexec/ source code for files in /usr/libexec -.It Li release/ +.It Pa release/ files required to produce a .Fx release -.It Li sbin/ +.It Pa sbin/ source code for files in /sbin -.It Li secure/ +.It Pa secure/ build directory for files in /usr/src/crypto -.It Li share/ +.It Pa share/ source for files in /usr/share -.It Li sys/ +.It Pa sys/ kernel source code -.It Li tools/ +.It Pa tools/ tools used for maintenance and testing of .Fx -.It Li usr.bin/ +.It Pa usr.bin/ source code for files in /usr/bin -.It Li usr.sbin/ +.It Pa usr.sbin/ source code for files in /usr/sbin .El .Pp -.It Li X11R6/ +.It Pa X11R6/ X11R6 distribution executables, libraries, etc (optional). .Bl -tag -width "include/" -compact -.It Li bin/ +.It Pa bin/ X11R6 binaries (servers, utilities, local packages/ports). -.It Li etc/ +.It Pa etc/ X11R6 configuration files and scripts. -.It Li include/ +.It Pa include/ X11R6 include files. -.It Li lib/ +.It Pa lib/ X11R6 libraries. -.It Li man/ +.It Pa man/ X11R6 manual pages. -.It Li share/ +.It Pa share/ architecture-independent files. .El .El -.It Li /var/ +.It Pa /var/ multi-purpose log, temporary, transient, and spool files .Pp .Bl -tag -width "preserve/" -compact -.It Li account/ +.It Pa account/ system accounting files .Pp .Bl -tag -width Fl -compact -.It Li acct +.It Pa acct execution accounting file; see .Xr acct 5 .El .Pp -.It Li at/ +.It Pa at/ timed command scheduling files; see .Xr \&at 1 .Bl -tag -width "preserve/" -compact -.It Li jobs/ +.It Pa jobs/ directory containing job files -.It Li spool/ +.It Pa spool/ directory containing output spool files .El .Pp -.It Li backups/ +.It Pa backups/ misc. backup files -.It Li crash/ +.It Pa crash/ default directory to store kernel crash dumps; see .Xr crash 8 and .Xr savecore 8 -.It Li cron/ +.It Pa cron/ files used by cron; see .Xr cron 8 .Bl -tag -width "preserve/" -compact -.It Li tabs/ +.It Pa tabs/ crontab files; see .Xr crontab 5 .El .Pp -.It Li db/ +.It Pa db/ misc. automatically generated system-specific database files -.It Li games/ +.It Pa games/ misc. game status and score files -.It Li log/ +.It Pa log/ misc. system log files .Pp .Bl -tag -width Fl -compact -.It Li wtmp +.It Pa wtmp login/logout log; see .Xr wtmp 5 .El .Pp -.It Li mail/ +.It Pa mail/ user mailbox files -.It Li preserve/ +.It Pa preserve/ temporary home of files preserved after an accidental death of an editor; see .Xr \&ex 1 -.It Li msgs/ +.It Pa msgs/ system messages database; see .Xr msgs 1 -.It Li quotas/ +.It Pa quotas/ filesystem quota information files -.It Li run/ +.It Pa run/ system information files describing various info about system since it was booted .Pp .Bl -tag -width Fl -compact -.It Li utmp +.It Pa utmp database of current users; see .Xr utmp 5 .El .Pp -.It Li rwho/ +.It Pa rwho/ rwho data files; see .Xr rwhod 8 , .Xr rwho 1 , and .Xr ruptime 1 -.It Li spool/ +.It Pa spool/ misc. printer and mail system spooling directories .Pp .Bl -tag -width Fl -compact -.It Li ftp/ +.It Pa ftp/ commonly ~ftp; the anonymous ftp root directory -.It Li mqueue/ +.It Pa mqueue/ undelivered mail queue; see .Xr sendmail 8 -.It Li output/ +.It Pa output/ line printer spooling directories -.It Li secretmail/ +.It Pa secretmail/ secretmail spool directory; see .Xr xget 1 -.It Li uucp/ +.It Pa uucp/ uucp spool directory -.It Li uucppublic/ +.It Pa uucppublic/ commonly ~uucp; public uucp temporary directory .El .Pp -.It Li tmp/ +.It Pa tmp/ temporary files that are kept between system reboots .Bl -tag -width Fl -compact -.It Li vi.recover/ +.It Pa vi.recover/ the directory where recovery files are stored .El -.It Li yp/ +.It Pa yp/ the NIS maps .El .El diff --git a/share/man/man7/security.7 b/share/man/man7/security.7 index b45f44c..d9f6536 100644 --- a/share/man/man7/security.7 +++ b/share/man/man7/security.7 @@ -679,7 +679,7 @@ machines. .Xr md5 1 , .Xr netstat 1 , .Xr ssh 1 , -.Xr openssl 1, +.Xr openssl 1 , .Xr xdm 1 , .Xr group 5 , .Xr ttys 5 , diff --git a/share/man/man7/style.perl.7 b/share/man/man7/style.perl.7 index 5b5ec5b..8d0f514 100644 --- a/share/man/man7/style.perl.7 +++ b/share/man/man7/style.perl.7 @@ -28,159 +28,166 @@ .Dt STYLE.PERL 7 .Os FreeBSD .Sh NAME -.Nm style.perl 7 +.Nm style.perl .Nd "FreeBSD Perl source file style guide" .Sh DESCRIPTION This file specifies the preferred style for perl scripts in the .Fx source tree. -.Bd -literal -offset 0i - # - # Style guide for Perl. Based on the kernel style guide. - # +.Bd -literal +# +# Style guide for Perl. Based on the kernel style guide. +# - # - # VERY important single-line comments look like this. - # +# +# VERY important single-line comments look like this. +# - # Most single-line comments look like this. +# Most single-line comments look like this. - # Multi-line comments look like this. Make them real sentences. - # Fill them so they look like real paragraphs. +# Multi-line comments look like this. Make them real sentences. +# Fill them so they look like real paragraphs. .Ed .Pp All scripts should follow the copyright block at the start of the script with a comment block that describes what the script does. -.Bd -literal -offset 0i - #!/usr/bin/perl -w +.Bd -literal +#!/usr/bin/perl -w - # COPYRIGHT - # BLOCK +# COPYRIGHT +# BLOCK - # This script processes an old kernel config file, which it gets on - # stdin, and outputs a new style hints file to stdout. +# This script processes an old kernel config file, which it gets on +# stdin, and outputs a new style hints file to stdout. .Ed +.Pp All scripts should use the -.Fa strict -module and run without warnings. For example: -.Bd -literal -offset 0i - #!/usr/bin/perl -w +.Xr strict 3 +module and run without warnings. +For example: +.Bd -literal +#!/usr/bin/perl -w - # Copyright, description of what the script does, etc +# Copyright, description of what the script does, etc - use strict; - ... +use strict; +\&... .Ed .Pp -Where possible run the script with taint mode switched on. This -is documented in +Where possible run the script with taint mode switched on. +This is documented in .Xr perlsec 1 . -.Bd -literal -offset 0i - #!/usr/bin/perl -wT +.Bd -literal +#!/usr/bin/perl -wT .Ed .Pp -The main program should be placed in a block labeled MAIN:. This +The main program should be placed in a block labeled MAIN:. +This makes it easier to identify the entry point in a large perl script, and provides a scope for variables which are used in the main program but nowhere else. -.Bd -literal -offset 0i - MAIN:{ +.Bd -literal +MAIN:{ print(foo("/usr/bin/man", "7", "style.perl")); exit(0); - } +} .Ed .Pp All subroutines should be defined using argument prototypes as defined in .Xr perlsub 1 . -.Bd -literal -offset 0i - sub foo($@) { +.Bd -literal +sub foo($@) { my $cmd = shift; my @args = @_; - } +} .Ed .Pp All variables should be defined before use; this is enforced if operating under -.Fa use strict . +.Ic use Ar strict . .Pp Scope local variables should be defined using -.Fa my +.Ic my .Va $variable and not -.Fa local +.Ic local .Va $variable . The -.Fa local +.Ic local declaration should only be used when it is required, and not by -default. Lots of perl4 scripts use -.Fa local +default. +Lots of perl4 scripts use +.Ic local because the -.Fa my +.Ic my definition didn't exist prior to perl5. .Pp In most cases globals should be defined at the top of the code using a -.Fa vars +.Xr vars 3 definition block: -.Bd -literal -offset 0i - use vars qw($globalscalar @globalarray %globalhash); +.Bd -literal +use vars qw($globalscalar @globalarray %globalhash); .Ed .Pp In some cases it may be appropriate to use -.Fa my +.Ic my statements at the top of the script as an alternative to using -.Fa vars +.Xr vars 3 declarations. .Pp All variables should be commented. -.Bd -literal -offset 0i - sub foo($@) { +.Bd -literal +sub foo($@) { my $cmd = shift; # Command to run my @args = @_; # Arguments to $cmd - } +} .Ed .Pp Local variables should be separated from function arguments by a blank line: -.Bd -literal -offset 0i - sub foo($@) { +.Bd -literal +sub foo($@) { my $cmd = shift; # Command to run my @args = @_; # Arguments to command my $pid; # Child PID local *PIPE; # Pipe my $output; # Output from command - } +} .Ed .Pp Whenever possible code should be run through the code checker .Nm perl -.Ar -wc +.Fl wc .Ar script.pl or .Nm perl -.Ar -wcT +.Fl wcT .Ar script.pl and produce no warnings. .Pp -Indentation is an 8 character tab. Second level indents are four spaces. -.Bd -literal -offset 0i - while (cnt < 20) { +Indentation is an 8 character tab. +Second level indents are four spaces. +.Bd -literal +while (cnt < 20) { z = a + really + long + statement + that + needs + two lines + gets + indented + four + spaces + on + the + second + and + subsequent + lines. - } +} .Ed .Pp Do not add whitespace at the end of a line, and only use tabs -followed by spaces to form the indentation. Do not use more spaces +followed by spaces to form the indentation. +Do not use more spaces than a tab will produce and do not use spaces in front of tabs. .Pp -Opening braces should be at the end of the controlling line. Else +Opening braces should be at the end of the controlling line. +Else and elsif belong on the same line as the closing brace for the previous if or elsif block: -.Bd -literal -offset 0i - sub foo($@) { +.Bd -literal +sub foo($@) { my $cmd = shift; # Command to run my @args = @_; # Arguments to command @@ -205,23 +212,24 @@ previous if or elsif block: die("$cmd returned exit code " . ($? >> 8) . "\\n"); } return $output; - } +} .Ed .Pp Where possible scripts should use standard modules instead of -rewriting the code inline. It may be appropriate in some cases to +rewriting the code inline. +It may be appropriate in some cases to import a CPAN module into the base system to facilitate this. .Pp Use -.Fa chomp +.Ic chomp instead of -.Fa chop +.Ic chop where appropriate. .Pp Use -.Fa unless +.Ic unless instead of -.Fa if (! ...\& ) +.Ic if Pq Cm \&! No ...\& where it improves readability. .Pp Where it doesn't conflict with this guide read @@ -234,5 +242,5 @@ and adopt Larry Wall's style recommendations. .Sh HISTORY This man page is largely based on the .Xr style 9 -man-page in +man page in .Fx . diff --git a/share/man/man8/picobsd.8 b/share/man/man8/picobsd.8 index b85b714..da90cd2 100644 --- a/share/man/man8/picobsd.8 +++ b/share/man/man8/picobsd.8 @@ -108,7 +108,7 @@ is used, but the principle also applies to the subdirectories and .Pa router . .Bl -hang -.It Em Build the kernel. +.It Em "Build the kernel" . Each directory contains a configuration file with a name starting with .Pa PICOBSD . When building a custom @@ -118,19 +118,19 @@ occupies about 600 kB after compression, and it is easy to have a kernel as large as 900 kB. It is probably not possible to build a first .Nm floppy with a kernel of 900 kB. -.It Em Create the MFS image. +.It Em "Create the MFS image" . The MFS image for the first floppy is created as a .Nm vnode file system which is subsequently mounted as .Pa /dev/vn0 on .Pa custom/mmnt . -.It Em Create the crunched executables. +.It Em "Create the crunched executables" . The executables for the first floppy are built in the directory .Pa crunch/crunch1/ . The contents of this executable are determined by the file .Pa crunch/crunch1/crunch.conf . -.It Em Build the floppy image. +.It Em "Build the floppy image" . A second file system image, which will later become the first floppy, is built and mounted as .Pa /dev/vn1 @@ -145,7 +145,7 @@ if the latter directory exists. This dual method allows specific files in .Pa floppy.tree/custom/ to overlay files from .Pa floppy.tree/ . -.It Em Create the image for the second floppy. +.It Em "Create the image for the second floppy" . Finally, the image for the second floppy is built. There is only one file on this floppy, which will be copied to the MFS-relative directory .Pa /bin @@ -153,7 +153,7 @@ at boot time. The contents are built in the directory .Pa crunch/crunch2/ . The contents of this executable are determined by the file .Pa crunch/crunch2/crunch.conf . -.It Em Copy the data to the floppies. +.It Em "Copy the data to the floppies" . The previous steps are performed by the .Nm make all step. @@ -163,7 +163,7 @@ does not copy data to the floppy disks. Instead, use for the first floppy, and .Nm make floppy2 for the second disk. -.It Em Create additional floppies. +.It Em "Create additional floppies" . You can theoretically possible to read a large number of floppies into the MFS. Each additional floppy, including the second, is a gzipped tar file containing files relative to diff --git a/share/man/man9/CONDSPLASSERT.9 b/share/man/man9/CONDSPLASSERT.9 index 24df198..7d54128 100644 --- a/share/man/man9/CONDSPLASSERT.9 +++ b/share/man/man9/CONDSPLASSERT.9 @@ -38,29 +38,31 @@ .Cd options INVARIANT_SUPPORT .Fn CONDSPLASSERT condition level "const char *msg" .Sh DESCRIPTION -.Sy This API is deprecated. -.Sy Use mutexes to protect data structures instead. -.Sy See +.Bf -symbolic +This API is deprecated. +Use mutexes to protect data structures instead. +See .Xr mutex 9 -.Sy for more information. +for more information. +.Ef .Pp In a kernel compiled with both "options INVARIANTS" and "options INVARIANT_SUPPORT", the .Fn CONDSPLASSERT macro compares the current spl level of the kernel with the spl -.Ar level +.Fa level specified in the macro .Fn CONDSPLASSERT if the specified condition is met. If the specified -.Ar level +.Fa level is not active .Fn CONDSPLASSERT calls the .Fn KASSERT macro with the -.Ar msg, +.Fa msg , terminating the running system. .Pp In a kernel that does not have both "options INVARIANTS" diff --git a/share/man/man9/SPLASSERT.9 b/share/man/man9/SPLASSERT.9 index 8396db1..e6a95bf 100644 --- a/share/man/man9/SPLASSERT.9 +++ b/share/man/man9/SPLASSERT.9 @@ -39,28 +39,30 @@ .Cd options INVARIANT_SUPPORT .Fn SPLASSERT level "const char *msg" .Sh DESCRIPTION -.Sy This API is deprecated. -.Sy Use mutexes to protect data structures instead. -.Sy See +.Bf -symbolic +This API is deprecated. +Use mutexes to protect data structures instead. +See .Xr mutex 9 -.Sy for more information. +for more information. +.Ef .Pp In a kernel compiled with both "options INVARIANTS" and "options INVARIANT_SUPPORT", the .Fn SPLASSERT macro compares the current spl level of the kernel with the spl -.Ar level +.Fa level specified in the macro .Fn SPLASSERT . If the specified -.Ar level +.Fa level is not active .Fn SPLASSERT calls the .Fn KASSERT macro with the -.Ar msg, +.Fa msg , terminating the running system. .Pp In a kernel that does not have both "options INVARIANTS" diff --git a/share/man/man9/VOP_ACCESS.9 b/share/man/man9/VOP_ACCESS.9 index edf8141..00b308c 100644 --- a/share/man/man9/VOP_ACCESS.9 +++ b/share/man/man9/VOP_ACCESS.9 @@ -60,8 +60,9 @@ The .Fa mode is a mask which can contain .Dv VREAD , -.Dv VWRITE or -.Dv VEXEC. +.Dv VWRITE +or +.Dv VEXEC . .Sh LOCKS The vnode will be locked on entry and should remain locked on return. .Sh RETURN VALUES diff --git a/share/man/man9/devclass.9 b/share/man/man9/devclass.9 index 4f0eec6..8539e34 100644 --- a/share/man/man9/devclass.9 +++ b/share/man/man9/devclass.9 @@ -35,7 +35,7 @@ .Nm devclass .Nd object representing a class of devices .Sh SYNOPSIS -.Dv typedef struct devclass *devclass_t; +.Vt typedef struct devclass *devclass_t ; .Sh DESCRIPTION .Pp The diff --git a/share/man/man9/device.9 b/share/man/man9/device.9 index f1e502f..1cb1524 100644 --- a/share/man/man9/device.9 +++ b/share/man/man9/device.9 @@ -35,7 +35,7 @@ .Nm device .Nd an abstract representation of a device .Sh SYNOPSIS -.Dv typedef struct device *device_t; +.Vt typedef struct device *device_t ; .Sh DESCRIPTION .Pp The device object represents a piece of hardware attached to the diff --git a/share/man/man9/ifnet.9 b/share/man/man9/ifnet.9 index 1555538..71c38ee 100644 --- a/share/man/man9/ifnet.9 +++ b/share/man/man9/ifnet.9 @@ -89,35 +89,35 @@ .\" .Ss "struct ifnet member functions" .Ft int -.Fn (*if_output) "struct ifnet *ifp" "struct mbuf *m" "struct sockaddr *dst" "struct rtentry *rt" +.Fn \*(lp*if_output\*(rp "struct ifnet *ifp" "struct mbuf *m" "struct sockaddr *dst" "struct rtentry *rt" .Ft void -.Fn (*if_start) "struct ifnet *ifp" +.Fn \*(lp*if_start\*(rp "struct ifnet *ifp" .Ft int -.Fn (*if_dont) "struct ifnet *ifp" +.Fn \*(lp*if_dont\*(rp "struct ifnet *ifp" .Ft int -.Fn (*if_ioctl) "struct ifnet *ifp" "int cmd" "caddr_t data" +.Fn \*(lp*if_ioctl\*(rp "struct ifnet *ifp" "int cmd" "caddr_t data" .Ft void -.Fn (*if_watchdog) "struct ifnet *ifp" +.Fn \*(lp*if_watchdog\*(rp "struct ifnet *ifp" .Ft int -.Fn (*if_poll_recv) "struct ifnet *ifp" "int *quotap" +.Fn \*(lp*if_poll_recv\*(rp "struct ifnet *ifp" "int *quotap" .Ft int -.Fn (*if_poll_xmit) "struct ifnet *ifp" "int *quotap" +.Fn \*(lp*if_poll_xmit\*(rp "struct ifnet *ifp" "int *quotap" .Ft void -.Fn (*if_poll_inttrn) "struct ifnet *ifp" +.Fn \*(lp*if_poll_inttrn\*(rp "struct ifnet *ifp" .Ft void -.Fn (*if_poll_slowinput) "struct ifnet *ifp" "struct mbuf *m" +.Fn \*(lp*if_poll_slowinput\*(rp "struct ifnet *ifp" "struct mbuf *m" .Ft void -.Fn (*if_init) "void *if_softc" +.Fn \*(lp*if_init\*(rp "void *if_softc" .Ft int -.Fn (*if_resolvemulti) "struct ifnet *ifp" "struct sockaddr **retsa" "struct sockaddr *addr" +.Fn \*(lp*if_resolvemulti\*(rp "struct ifnet *ifp" "struct sockaddr **retsa" "struct sockaddr *addr" .Ss "struct ifaddr member function" .Ft void -.Fn (*ifa_rtrequest) "int cmd" "struct rtentry *rt" "struct sockaddr *dst" +.Fn \*(lp*ifa_rtrequest\*(rp "int cmd" "struct rtentry *rt" "struct sockaddr *dst" .Ss "Global variables" -.Fd extern struct ifnethead ifnet; -.Fd extern struct ifaddr \&**ifnet_addrs; -.Fd extern int if_index; -.Fd extern int ifqmaxlen; +.Vt extern struct ifnethead ifnet ; +.Vt extern struct ifaddr \&**ifnet_addrs ; +.Vt extern int if_index ; +.Vt extern int ifqmaxlen ; .Sh DATA STRUCTURES The kernel mechanisms for handling network interfaces reside primarily in the diff --git a/share/man/man9/mbuf.9 b/share/man/man9/mbuf.9 index 2374ee1..89f3d64 100644 --- a/share/man/man9/mbuf.9 +++ b/share/man/man9/mbuf.9 @@ -316,7 +316,7 @@ then if the reference count of the storage is not greater than 1. The .Dv M_RDONLY flag can be set in the mbuf's -.Dv m_flags. +.Dv m_flags . This can be achieved during setup of the external storage, by passing the .Dv M_RDONLY @@ -366,7 +366,8 @@ must be less than or .Dv MHLEN , depending on the -.Dv M_PKTHDR flag setting. +.Dv M_PKTHDR +flag setting. .\" .It Fn m_pullup mbuf len Arrange that the first diff --git a/share/man/man9/mi_switch.9 b/share/man/man9/mi_switch.9 index 3f66664..3482656 100644 --- a/share/man/man9/mi_switch.9 +++ b/share/man/man9/mi_switch.9 @@ -66,7 +66,8 @@ can be enumerated as follows: .Bl -enum -offset indent .It from within -.Xr sleep 9 , and +.Xr sleep 9 +and .Xr tsleep 9 when the current process voluntarily relinquishes the CPU to wait for some resource to become diff --git a/share/man/man9/microseq.9 b/share/man/man9/microseq.9 index dce4b2e..b92175d 100644 --- a/share/man/man9/microseq.9 +++ b/share/man/man9/microseq.9 @@ -287,7 +287,7 @@ the parameter to pass to the function call .El .Pp The C function shall be declared as a -.Fd int(*)(void *p, char *ptr) +.Ft int(*)(void *p, char *ptr) . The ptr parameter is the current position in the buffer currently scanned. .Pp Predefined macro: MS_C_CALL(func,param) diff --git a/share/man/man9/panic.9 b/share/man/man9/panic.9 index 3b1ebf9..2f4c305 100644 --- a/share/man/man9/panic.9 +++ b/share/man/man9/panic.9 @@ -40,7 +40,7 @@ .Sh SYNOPSIS .Fd #include <sys/param.h> .Ft void -.Fn panic "const char *fmt, ..." +.Fn panic "const char *fmt" ... .Sh DESCRIPTION The .Fn panic diff --git a/share/man/man9/pfil.9 b/share/man/man9/pfil.9 index a0e9e82..05b8823 100644 --- a/share/man/man9/pfil.9 +++ b/share/man/man9/pfil.9 @@ -106,7 +106,7 @@ interface first appeared in The .Nm input and output lists were originally implemented as -.Pa Aq sys/queue.h +.Aq Pa sys/queue.h .Dv LIST structures; however this was changed in diff --git a/share/man/man9/rtentry.9 b/share/man/man9/rtentry.9 index 5c75560..6b0eb9b 100644 --- a/share/man/man9/rtentry.9 +++ b/share/man/man9/rtentry.9 @@ -53,7 +53,9 @@ The basic structure a route is defined by .Dq Li struct rtentry , which includes the following fields: .Bl -tag -offset indent -width 6n -.It Li "struct radix_node rt_nodes[2];" +.It Xo +.Vt "struct radix_node rt_nodes[2]" ; +.Xc Glue used by the radix-tree routines. These members also include in their substructure the key (i.e., destination address) and mask used when the route was created. The @@ -64,7 +66,9 @@ macros can be used to extract this information (in the form of a .Dq Li "struct sockaddr *" ) given a .Li "struct rtentry *" . -.It Li "struct sockaddr *rt_gateway;" +.It Xo +.Vt "struct sockaddr *rt_gateway" ; +.Xc The .Dq target of the route, which can either represent a destination in its own @@ -72,7 +76,9 @@ right (some protocols will put a link-layer address here), or some intermediate stop on the way to that destination (if the .Dv RTF_GATEWAY flag is set). -.It Li "long rt_refcnt;" +.It Xo +.Vt "long rt_refcnt" ; +.Xc Route entries are reference-counted; this field indicates the number of external (to the radix tree) references. If the .Dv RTF_UP @@ -80,17 +86,25 @@ flag is not present, the .Fn rtfree function will delete the route from the radix tree when the last reference drops. -.It Li "u_long rt_flags;" +.It Xo +.Vt "u_long rt_flags" ; +.Xc See below. -.It Li "struct ifnet *rt_ifp;" -.It Li "struct ifaddr *rt_ifa;" +.It Xo +.Vt "struct ifnet *rt_ifp" ; +.Xc +.It Xo +.Vt "struct ifaddr *rt_ifa" ; +.Xc These two fields represent the .Dq answer , as it were, to the question posed by a route lookup; that is, they name the interface and interface address to be used in sending a packet to the destination or set of destinations which this route represents. -.It Li "struct sockaddr *rt_genmask;" +.It Xo +.Vt "struct sockaddr *rt_genmask" ; +.Xc When the .Fn rtalloc family of functions performs a cloning operation as requested by the @@ -100,7 +114,9 @@ or flag, this field is used as the mask for the new route which is inserted into the table. If this field is a null pointer, then a host route is generated. -.It Li "caddr_t rt_llinfo;" +.It Xo +.Vt "caddr_t rt_llinfo" ; +.Xc When the .Dv RTF_LLINFO flag is set, this field contains information specific to the link @@ -111,9 +127,13 @@ routine.) Protocols such as .Xr arp 4 use this field to reference per-destination state internal to that protocol. -.It Li "struct rt_metrics rt_rmx;" +.It Xo +.Vt "struct rt_metrics rt_rmx" ; +.Xc See below. -.It Li "struct rtentry *rt_gwroute;" +.It Xo +.Vt "struct rtentry *rt_gwroute" ; +.Xc This member is a reference to a route whose destination is .Li rt_gateway . It is only used for @@ -121,7 +141,9 @@ It is only used for routes. .\" .It Dv "int (*rt_output)();" .\" See below. -.It Dv "struct rtentry *rt_parent;" +.It Xo +.Vt "struct rtentry *rt_parent" ; +.Xc A reference to the route from which this route was cloned, or a null pointer if this route was not generated by cloning. See also the .Dv RTF_WASCLONED @@ -213,21 +235,31 @@ Indicates that the destination is a multicast address. Every route has associated with it a set of metrics, defined by .Li struct rt_metrics : .Bl -tag -offset indent -width 6n -.It Li "u_long rmx_locks;" +.It Xo +.Vt "u_long rmx_locks" ; +.Xc Flag bits indicating which metrics the kernel is not permitted to dynamically modify. -.It Li "u_long rmx_mtu;" +.It Xo +.Vt "u_long rmx_mtu" ; +.Xc MTU for this path. -.It Li "u_long rmx_hopcount;" +.It Xo +.Vt "u_long rmx_hopcount" ; +.Xc Number of intermediate systems on the path to this destination. -.It Li "u_long rmx_expire;" +.It Xo +.Vt "u_long rmx_expire" ; +.Xc The time (a la .Xr time 3 ) at which this route should expire, or zero if it should never expire. It is the responsibility of individual protocol suites to ensure that routes are actually deleted once they expire. -.It Li "u_long rmx_recvpipe;" +.It Xo +.Vt "u_long rmx_recvpipe" ; +.Xc Nominally, the bandwidth-delay product for the path .Em from the destination @@ -235,24 +267,36 @@ the destination this system. In practice, this value is used to set the size of the receive buffer (and thus the window in sliding-window protocols like .Tn TCP ) . -.It Li "u_long rmx_sendpipe;" +.It Xo +.Vt "u_long rmx_sendpipe" ; +.Xc As before, but in the opposite direction. -.It Li "u_long rmx_ssthresh;" +.It Xo +.Vt "u_long rmx_ssthresh" ; +.Xc The slow-start threshold used in .Tn TCP congestion-avoidance. -.It Li "u_long rmx_rtt;" +.It Xo +.Vt "u_long rmx_rtt" ; +.Xc The round-trip time to this destination, in units of .Dv RMX_RTTUNIT per second. -.It Li "u_long rmx_rttvar;" +.It Xo +.Vt "u_long rmx_rttvar" ; +.Xc The average deviation of the round-type time to this destination, in units of .Dv RMX_RTTUNIT per second. -.It Li "u_long rmx_pksent;" +.It Xo +.Vt "u_long rmx_pksent" ; +.Xc A count of packets successfully sent via this route. -.It Li "u_long rmx_filler[4];" +.It Xo +.Vt "u_long rmx_filler[4]" ; +.Xc .\" XXX badly named Empty space available for protocol-specific information. .El diff --git a/share/man/man9/sleep.9 b/share/man/man9/sleep.9 index c4519d8..8a82350 100644 --- a/share/man/man9/sleep.9 +++ b/share/man/man9/sleep.9 @@ -254,4 +254,4 @@ This man page was written by and .Nm await were designed and written by -.An Matthew Dillon. +.An Matthew Dillon . diff --git a/share/man/man9/spl.9 b/share/man/man9/spl.9 index 9abcaba..f7902d4 100644 --- a/share/man/man9/spl.9 +++ b/share/man/man9/spl.9 @@ -68,11 +68,13 @@ .Ft void .Fn splx "intrmask_t ipl" .Sh DESCRIPTION -.Sy This API is deprecated. -.Sy Use mutexes to protect data structures instead. -.Sy See +.Bf -symbolic +This API is deprecated. +Use mutexes to protect data structures instead. +See .Xr mutex 9 -.Sy for more information. +for more information. +.Ef .Pp The .Fn spl diff --git a/share/man/man9/style.9 b/share/man/man9/style.9 index fc21355..59f2fbe 100644 --- a/share/man/man9/style.9 +++ b/share/man/man9/style.9 @@ -34,7 +34,7 @@ This file specifies the preferred style for kernel source files in the .Fx source tree. It is also a guide for preferred userland code style. -.Bd -literal -offset 0i +.Bd -literal /* * Style guide for the FreeBSD. Based on KNF (Kernel Normal Form). */ @@ -55,12 +55,12 @@ Kernel include files (i.e. sys/*.h) come first; normally, you'll need <sys/types.h> OR <sys/param.h>, but not both! <sys/types.h> includes <sys/cdefs.h>, and it's okay to depend on that. -.Bd -literal -offset 0i +.Bd -literal #include <sys/types.h> /* Non-local includes in angle brackets. */ .Ed .Pp If it's a network program, put the network include files next. -.Bd -literal -offset 0i +.Bd -literal #include <net/if.h> #include <net/if_dl.h> #include <net/route.h> @@ -70,18 +70,18 @@ If it's a network program, put the network include files next. .Pp Then there's a blank line, followed by the /usr include files. The /usr include files should be sorted! -.Bd -literal -offset 0i +.Bd -literal #include <stdio.h> .Ed .Pp Global pathnames are defined in /usr/include/paths.h. Pathnames local to the program go in pathnames.h in the local directory. -.Bd -literal -offset 0i +.Bd -literal #include <paths.h> .Ed .Pp Then, there's a blank line, and the user include files. -.Bd -literal -offset 0i +.Bd -literal #include "pathnames.h" /* Local includes in double quotes. */ .Ed .Pp @@ -121,7 +121,7 @@ statements. Any final statement-terminating semicolon should be supplied by the macro invocation rather than the macro, to make parsing easier for pretty-printers and editors. -.Bd -literal -offset 0i +.Bd -literal #define MACRO(x, y) do { \e variable = (x) + (y); \e (y) += 2; \e @@ -129,7 +129,7 @@ for pretty-printers and editors. .Ed .Pp Enumeration values are all uppercase. -.Bd -literal -offset 0i +.Bd -literal enum enumtype { ONE, TWO } et; .Ed .Pp @@ -145,7 +145,7 @@ Major structures should be declared at the top of the file in which they are used, or in separate header files if they are used in multiple source files. Use of the structures should be by separate declarations and should be "extern" if they are declared in a header file. -.Bd -literal -offset 0i +.Bd -literal struct foo { struct foo *next; /* List of active foo */ struct mumble amumble; /* Comment for mumble */ @@ -158,7 +158,7 @@ Use .Xr queue 3 macros rather than rolling your own lists, whenever possible. Thus, the previous example would be better written: -.Bd -literal -offset 0i +.Bd -literal #include <sys/queue.h> struct foo { LIST_ENTRY(foo) link; /* Queue macro glue for foo lists */ @@ -176,7 +176,7 @@ tag. Avoid typedefs ending in .Dq Li \&_t , except as specified in Standard C or by .Tn POSIX . -.Bd -literal -offset 0i +.Bd -literal /* Make the structure name match the typedef. */ typedef struct _bar { int level; @@ -209,7 +209,7 @@ to break precedents in the existing code and use the current style guidelines. .Pp The kernel has a name associated with parameter types, e.g., in the kernel use: -.Bd -literal -offset 0i +.Bd -literal void function(int fd); .Ed .Pp @@ -217,18 +217,18 @@ In header files visible to userland applications, prototypes that are visible must use either protected names or no names with the types. It is preferable to use protected names. e.g., use: -.Bd -literal -offset 0i +.Bd -literal void function(int); .Ed .Pp or: -.Bd -literal -offset 0i +.Bd -literal void function(int _fd); .Ed .Pp Prototypes may have an extra space after a tab to enable function names to line up: -.Bd -literal -offset 0i +.Bd -literal static char *function(int _arg, const char *_arg2, struct foo *_arg3, struct bar *_arg4); static void usage(void); @@ -253,7 +253,7 @@ parts of the switch cascade. Elements in a switch statement that cascade should have a FALLTHROUGH comment. Numerical arguments should be checked for accuracy. Code that cannot be reached should have a NOTREACHED comment. -.Bd -literal -offset 0i +.Bd -literal while ((ch = getopt(argc, argv, "abn")) != -1) switch (ch) { /* Indent the switch. */ case 'a': /* Don't indent the case. */ @@ -284,7 +284,7 @@ Space after keywords (if, while, for, return, switch). No braces are used for control statements with zero or only a single statement unless that statement is more than a single line in which case they are permitted. Forever loops are done with for's, not while's. -.Bd -literal -offset 0i +.Bd -literal for (p = buf; *p != '\e0'; ++p) ; /* nothing */ for (;;) @@ -304,7 +304,7 @@ Forever loops are done with for's, not while's. .Pp Parts of a for loop may be left empty. Don't put declarations inside blocks unless the routine is unusually complicated. -.Bd -literal -offset 0i +.Bd -literal for (; cnt < 15; cnt++) { stmt1; stmt2; @@ -313,7 +313,7 @@ inside blocks unless the routine is unusually complicated. .Pp Indentation is an 8 character tab. Second level indents are four spaces. -.Bd -literal -offset 0i +.Bd -literal while (cnt < 20) z = a + really + long + statement + that + needs + two lines + gets + indented + four + spaces + @@ -327,7 +327,7 @@ and do not use spaces in front of tabs. .Pp Closing and opening braces go on the same line as the else. Braces that aren't necessary may be left out. -.Bd -literal -offset 0i +.Bd -literal if (test) stmt; else if (bar) { @@ -347,7 +347,7 @@ or preceding or .Sq \&) characters. -.Bd -literal -offset 0i +.Bd -literal if (error = function(a1, a2)) exit(error); .Ed @@ -356,7 +356,7 @@ Unary operators don't require spaces, binary operators do. Don't use parentheses unless they're required for precedence or unless the statement is confusing without them. Remember that other people may confuse easier than you. Do YOU understand the following? -.Bd -literal -offset 0i +.Bd -literal a = b->c[0] + ~d == (e || f) || g && h ? i : j >> 1; k = !(l & FLAGS); .Ed @@ -364,7 +364,7 @@ confuse easier than you. Do YOU understand the following? Exits should be 0 on success, or according to the predefined values in .Xr sysexits 3 . -.Bd -literal -offset 0i +.Bd -literal exit(EX_OK); /* * Avoid obvious comments such as * "Exit 0 on success." @@ -374,7 +374,7 @@ values in .Pp The function type should be on a line by itself preceding the function. -.Bd -literal -offset 0i +.Bd -literal static char * function(int a1, int a2, float fl, int a4) { @@ -389,7 +389,7 @@ keyword. Be careful to not obfuscate the code by initializing variables in the declarations. Use this feature only thoughtfully. DO NOT use function calls in initializers! -.Bd -literal -offset 0i +.Bd -literal struct foo one, *two; double three; int *four, five; @@ -415,22 +415,22 @@ variadic args and is necessary for other args if the function prototype might not be in scope.) Test pointers against NULL, e.g., use: -.Bd -literal -offset 0i +.Bd -literal (p = f()) == NULL .Ed .Pp not: -.Bd -literal -offset 0i +.Bd -literal !(p = f()) .Ed .Pp Don't use '!' for tests unless it's a boolean, e.g. use -.Bd -literal -offset 0i +.Bd -literal if (*p == '\e0') .Ed .Pp not -.Bd -literal -offset 0i +.Bd -literal if (!*p) .Ed .Pp @@ -442,7 +442,7 @@ Use or .Xr warn 3 , don't roll your own! -.Bd -literal -offset 0i +.Bd -literal if ((four = malloc(sizeof(struct foo))) == NULL) err(1, (char *)NULL); if ((six = (int *)overflow()) == NULL) @@ -452,7 +452,7 @@ don't roll your own! .Ed .Pp Old-style function declarations look like this: -.Bd -literal -offset 0i +.Bd -literal static char * function(a1, a2, fl, a4) int a1, a2; /* Declare ints, too, don't default them. */ @@ -464,7 +464,7 @@ function(a1, a2, fl, a4) Use ANSI function declarations unless you explicitly need K&R compatibility. .Pp Variable numbers of arguments should look like this. -.Bd -literal -offset 0i +.Bd -literal #include <stdarg.h> void @@ -524,11 +524,11 @@ separates either-or options/arguments, and multiple options/arguments which are specified together are placed in a single set of brackets. .Pp -.Bd -ragged -offset 0.3i +.Bd -ragged -offset 4n "usage: f [-aDde] [-b b_arg] [-m m_arg] req1 req2 [opt1 [opt2]]\en" "usage: f [-a | -b] [-c [-dEe] [-n number]]\en" .Ed -.Bd -literal -offset 0i +.Bd -literal (void)fprintf(stderr, "usage: f [-ab]\en"); exit(EX_USAGE); } diff --git a/share/man/man9/sysctl_add_oid.9 b/share/man/man9/sysctl_add_oid.9 index 34acd76..6fa352a 100644 --- a/share/man/man9/sysctl_add_oid.9 +++ b/share/man/man9/sysctl_add_oid.9 @@ -367,7 +367,7 @@ any attempt to remove a node that contains any children will result in a .Er ENOTEMPTY error. -.Em "WARNING: use recursive deletion with extreme caution!" +.Em WARNING : "use recursive deletion with extreme caution" ! Normally it should not be needed if contexts are used. Contexts take care of tracking inter-dependencies between users of the tree. diff --git a/share/man/man9/time.9 b/share/man/man9/time.9 index 2f3153c2..6e0a6bc 100644 --- a/share/man/man9/time.9 +++ b/share/man/man9/time.9 @@ -111,7 +111,7 @@ function can be used to read the .Va time variable in an atomic manner. There is no equivalent function for accessing -.Va mono_time. +.Va mono_time . The .Va boottime and diff --git a/share/termcap/termcap.5 b/share/termcap/termcap.5 index 2d08aee..407a0d7 100644 --- a/share/termcap/termcap.5 +++ b/share/termcap/termcap.5 @@ -1131,7 +1131,7 @@ is safe to send. This turns out to be essential for the Ann Arbor 4080.) .Pp A final example is the Lear Siegler -.Tn ADM Ns \-3a, +.Tn ADM Ns \-3a , which offsets row and column by a blank character, thus .Dq Li cm=\eE=%+ %+\ \& . @@ -1245,7 +1245,7 @@ which all commands affect, it should be given as the parameterized string The four parameters are the starting and ending lines in memory and the starting and ending columns in memory, in that order. (This -.Xr terminfo +.Xr terminfo 5 capability is described for completeness. It is unlikely that any .Nm Ns \-using @@ -1468,7 +1468,7 @@ only those for which corresponding attribute commands exist. .Nm Ns \-using program will support this capability, which is defined for compatibility with -.Xr terminfo . ) +.Xr terminfo 5 . ) .Pp Terminals with the .Dq magic cookie @@ -1480,7 +1480,7 @@ rather than maintaining extra attribute bits for each character cell, instead deposit special .Dq cookies , or -.Dq garbage characters ,, +.Dq garbage characters , when they receive mode-setting sequences, which affect the display algorithm. .Pp @@ -1879,7 +1879,7 @@ this can be indicated with the parameterized string The first parameter is the character to be repeated and the second is the number of times to repeat it. (This is a -.Xr terminfo +.Xr terminfo 5 feature that is unlikely to be supported by a program that uses .Nm . ) .Pp @@ -1998,7 +1998,7 @@ causes the string to be transmitted to the computer. Unfortunately, due to lack of a definition for string parameters in .Nm , only -.Xr terminfo +.Xr terminfo 5 supports these capabilities. .Ss Glitches and Braindamage Hazeltine terminals, which do not allow `~' characters to be displayed, @@ -2116,7 +2116,7 @@ The .Nm functions were replaced by -.Xr terminfo +.Xr terminfo 5 in .At V Release 2.0. |
