From d0441d10b5801db1d53f885fa707ae3768d2c98d Mon Sep 17 00:00:00 2001 From: charnier Date: Mon, 24 Mar 2003 16:05:24 +0000 Subject: The .Fn function. Use .Xr where appropriate. --- share/man/man3/pthread_attr_get_np.3 | 3 ++- share/man/man3/pthread_condattr.3 | 9 +++++--- share/man/man3/pthread_create.3 | 6 ++++-- share/man/man3/pthread_detach.3 | 6 ++++-- share/man/man3/pthread_equal.3 | 3 ++- share/man/man3/pthread_exit.3 | 3 ++- share/man/man3/pthread_getspecific.3 | 6 ++++-- share/man/man3/pthread_join.3 | 6 ++++-- share/man/man3/pthread_key_create.3 | 6 ++++-- share/man/man3/pthread_key_delete.3 | 6 ++++-- share/man/man3/pthread_kill.3 | 6 ++++-- share/man/man3/pthread_mutex_destroy.3 | 6 ++++-- share/man/man3/pthread_mutex_init.3 | 6 ++++-- share/man/man3/pthread_mutex_lock.3 | 6 ++++-- share/man/man3/pthread_mutex_trylock.3 | 6 ++++-- share/man/man3/pthread_mutex_unlock.3 | 6 ++++-- share/man/man3/pthread_mutexattr.3 | 30 +++++++++++++++++--------- share/man/man3/pthread_once.3 | 3 ++- share/man/man3/pthread_rwlockattr_destroy.3 | 3 ++- share/man/man3/pthread_rwlockattr_getpshared.3 | 3 ++- share/man/man3/pthread_rwlockattr_setpshared.3 | 6 ++++-- share/man/man3/pthread_schedparam.3 | 9 +++++--- share/man/man3/pthread_self.3 | 3 ++- share/man/man3/pthread_setspecific.3 | 13 ++++++----- share/man/man3/pthread_sigmask.3 | 6 ++++-- share/man/man3/pthread_testcancel.3 | 3 ++- 26 files changed, 112 insertions(+), 57 deletions(-) (limited to 'share/man') diff --git a/share/man/man3/pthread_attr_get_np.3 b/share/man/man3/pthread_attr_get_np.3 index bf856d4..82e1065 100644 --- a/share/man/man3/pthread_attr_get_np.3 +++ b/share/man/man3/pthread_attr_get_np.3 @@ -87,8 +87,9 @@ If successful, function returns 0. Otherwise, an error number is returned to indicate the error. .Sh ERRORS +The .Fn pthread_attr_get_np -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL Invalid value for one of given parameters. diff --git a/share/man/man3/pthread_condattr.3 b/share/man/man3/pthread_condattr.3 index 478e112..fb0c318 100644 --- a/share/man/man3/pthread_condattr.3 +++ b/share/man/man3/pthread_condattr.3 @@ -61,15 +61,17 @@ function destroys a condition attribute object. If successful, these functions return 0. Otherwise, an error number is returned to indicate the error. .Sh ERRORS +The .Fn pthread_condattr_init -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er ENOMEM Out of memory. .El .Pp +The .Fn pthread_condattr_destroy -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL Invalid value for @@ -78,8 +80,9 @@ Invalid value for .Sh SEE ALSO .Xr pthread_cond_init 3 .Sh STANDARDS +The .Fn pthread_condattr_init and .Fn pthread_condattr_destroy -conform to +functions conform to .St -p1003.1-96 diff --git a/share/man/man3/pthread_create.3 b/share/man/man3/pthread_create.3 index 35f783c..32f1875 100644 --- a/share/man/man3/pthread_create.3 +++ b/share/man/man3/pthread_create.3 @@ -99,8 +99,9 @@ function will return zero. Otherwise an error number will be returned to indicate the error. .Sh ERRORS +The .Fn pthread_create -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EAGAIN The system lacked the necessary resources to create another thread, or @@ -118,6 +119,7 @@ is invalid. .Xr pthread_exit 3 , .Xr pthread_join 3 .Sh STANDARDS +The .Fn pthread_create -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_detach.3 b/share/man/man3/pthread_detach.3 index 15729af..55dd222 100644 --- a/share/man/man3/pthread_detach.3 +++ b/share/man/man3/pthread_detach.3 @@ -69,8 +69,9 @@ These early drafts also passed a pointer to pthread_t as the argument. Beware! .Sh ERRORS +The .Fn pthread_detach -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL The implementation has detected that the value specified by @@ -84,6 +85,7 @@ thread ID, .Sh SEE ALSO .Xr pthread_join 3 .Sh STANDARDS +The .Fn pthread_detach -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_equal.3 b/share/man/man3/pthread_equal.3 index 8b733da..9b10fad 100644 --- a/share/man/man3/pthread_equal.3 +++ b/share/man/man3/pthread_equal.3 @@ -63,6 +63,7 @@ None. .Xr pthread_create 3 , .Xr pthread_exit 3 .Sh STANDARDS +The .Fn pthread_equal -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_exit.3 b/share/man/man3/pthread_exit.3 index 0bfdad6..1398307 100644 --- a/share/man/man3/pthread_exit.3 +++ b/share/man/man3/pthread_exit.3 @@ -99,6 +99,7 @@ None. .Xr pthread_create 3 , .Xr pthread_join 3 .Sh STANDARDS +The .Fn pthread_exit -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_getspecific.3 b/share/man/man3/pthread_getspecific.3 index c7a04fa..a7999e5 100644 --- a/share/man/man3/pthread_getspecific.3 +++ b/share/man/man3/pthread_getspecific.3 @@ -61,8 +61,9 @@ has been deleted with .Fn pthread_key_delete is undefined. .Pp +The .Fn pthread_getspecific -may be called from a thread-specific data destructor function. +function may be called from a thread-specific data destructor function. .Sh RETURN VALUES The .Fn pthread_getspecific @@ -78,6 +79,7 @@ None. .Xr pthread_key_delete 3 , .Xr pthread_setspecific 3 .Sh STANDARDS +The .Fn pthread_getspecific -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_join.3 b/share/man/man3/pthread_join.3 index 98ae70d..513e291 100644 --- a/share/man/man3/pthread_join.3 +++ b/share/man/man3/pthread_join.3 @@ -79,8 +79,9 @@ function will return zero. Otherwise an error number will be returned to indicate the error. .Sh ERRORS +The .Fn pthread_join -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL The implementation has detected that the value specified by @@ -99,6 +100,7 @@ specifies the calling thread. .Xr wait 2 , .Xr pthread_create 3 .Sh STANDARDS +The .Fn pthread_join -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_key_create.3 b/share/man/man3/pthread_key_create.3 index 7075dcc..a2b0918 100644 --- a/share/man/man3/pthread_key_create.3 +++ b/share/man/man3/pthread_key_create.3 @@ -87,8 +87,9 @@ and returns zero. Otherwise an error number will be returned to indicate the error. .Sh ERRORS +The .Fn pthread_key_create -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EAGAIN The system lacked the necessary resources to create another thread-specific @@ -102,6 +103,7 @@ Insufficient memory exists to create the key. .Xr pthread_key_delete 3 , .Xr pthread_setspecific 3 .Sh STANDARDS +The .Fn pthread_key_create -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_key_delete.3 b/share/man/man3/pthread_key_delete.3 index bc0cf8a..c025857 100644 --- a/share/man/man3/pthread_key_delete.3 +++ b/share/man/man3/pthread_key_delete.3 @@ -80,8 +80,9 @@ function will return zero. Otherwise an error number will be returned to indicate the error. .Sh ERRORS +The .Fn pthread_key_delete -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL The @@ -93,6 +94,7 @@ value is invalid. .Xr pthread_key_create 3 , .Xr pthread_setspecific 3 .Sh STANDARDS +The .Fn pthread_key_delete -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_kill.3 b/share/man/man3/pthread_kill.3 index e46e2b2..94434bf 100644 --- a/share/man/man3/pthread_kill.3 +++ b/share/man/man3/pthread_kill.3 @@ -55,8 +55,9 @@ If successful, returns 0. Otherwise, an error number is returned. .Sh ERRORS +The .Fn pthread_kill -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er ESRCH .Fa thread @@ -70,6 +71,7 @@ is an invalid or unsupported signal number. .Xr pthread_self 3 , .Xr raise 3 .Sh STANDARDS +The .Fn pthread_kill -conforms to +function conforms to .St -p1003.1-96 diff --git a/share/man/man3/pthread_mutex_destroy.3 b/share/man/man3/pthread_mutex_destroy.3 index 59d2b48..1ae5147 100644 --- a/share/man/man3/pthread_mutex_destroy.3 +++ b/share/man/man3/pthread_mutex_destroy.3 @@ -50,8 +50,9 @@ If successful, will return zero, otherwise an error number will be returned to indicate the error. .Sh ERRORS +The .Fn pthread_mutex_destroy -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL The value specified by @@ -67,6 +68,7 @@ is locked by another thread. .Xr pthread_mutex_trylock 3 , .Xr pthread_mutex_unlock 3 .Sh STANDARDS +The .Fn pthread_mutex_destroy -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_mutex_init.3 b/share/man/man3/pthread_mutex_init.3 index c3fb60c..11fbee9 100644 --- a/share/man/man3/pthread_mutex_init.3 +++ b/share/man/man3/pthread_mutex_init.3 @@ -54,8 +54,9 @@ will return zero and put the new mutex id into .Fa mutex , otherwise an error number will be returned to indicate the error. .Sh ERRORS +The .Fn pthread_mutex_init -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL The value specified by @@ -72,6 +73,7 @@ The temporarily lacks the resources to create another mutex. .Xr pthread_mutex_trylock 3 , .Xr pthread_mutex_unlock 3 .Sh STANDARDS +The .Fn pthread_mutex_init -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_mutex_lock.3 b/share/man/man3/pthread_mutex_lock.3 index cc35ff2..01628c8 100644 --- a/share/man/man3/pthread_mutex_lock.3 +++ b/share/man/man3/pthread_mutex_lock.3 @@ -52,8 +52,9 @@ If successful, will return zero, otherwise an error number will be returned to indicate the error. .Sh ERRORS +The .Fn pthread_mutex_lock -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL The value specified by @@ -69,6 +70,7 @@ A deadlock would occur if the thread blocked waiting for .Xr pthread_mutex_trylock 3 , .Xr pthread_mutex_unlock 3 .Sh STANDARDS +The .Fn pthread_mutex_lock -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_mutex_trylock.3 b/share/man/man3/pthread_mutex_trylock.3 index 5de24ce..a40bf97 100644 --- a/share/man/man3/pthread_mutex_trylock.3 +++ b/share/man/man3/pthread_mutex_trylock.3 @@ -53,8 +53,9 @@ If successful, will return zero, otherwise an error number will be returned to indicate the error. .Sh ERRORS +The .Fn pthread_mutex_trylock -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL The value specified by @@ -70,6 +71,7 @@ is already locked. .Xr pthread_mutex_lock 3 , .Xr pthread_mutex_unlock 3 .Sh STANDARDS +The .Fn pthread_mutex_trylock -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_mutex_unlock.3 b/share/man/man3/pthread_mutex_unlock.3 index f6bc457..8e05cce 100644 --- a/share/man/man3/pthread_mutex_unlock.3 +++ b/share/man/man3/pthread_mutex_unlock.3 @@ -52,8 +52,9 @@ If successful, will return zero, otherwise an error number will be returned to indicate the error. .Sh ERRORS +The .Fn pthread_mutex_unlock -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL The value specified by @@ -69,6 +70,7 @@ The current thread does not hold a lock on .Xr pthread_mutex_lock 3 , .Xr pthread_mutex_trylock 3 .Sh STANDARDS +The .Fn pthread_mutex_unlock -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_mutexattr.3 b/share/man/man3/pthread_mutexattr.3 index b6d84d1..91fde14 100644 --- a/share/man/man3/pthread_mutexattr.3 +++ b/share/man/man3/pthread_mutexattr.3 @@ -89,23 +89,26 @@ to the location pointed to by the second function parameter. If successful, these functions return 0. Otherwise, an error number is returned to indicate the error. .Sh ERRORS +The .Fn pthread_mutexattr_init -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er ENOMEM Out of memory. .El .Pp +The .Fn pthread_mutexattr_destroy -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL Invalid value for .Fa attr . .El .Pp +The .Fn pthread_mutexattr_setprioceiling -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL Invalid value for @@ -114,16 +117,18 @@ or invalid value for .Fa prioceiling . .El .Pp +The .Fn pthread_mutexattr_getprioceiling -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL Invalid value for .Fa attr . .El .Pp +The .Fn pthread_mutexattr_setprotocol -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL Invalid value for @@ -132,16 +137,18 @@ or invalid value for .Fa protocol . .El .Pp +The .Fn pthread_mutexattr_getprotocol -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL Invalid value for .Fa attr . .El .Pp +The .Fn pthread_mutexattr_settype -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL Invalid value for @@ -150,8 +157,9 @@ or invalid value for .Fa type . .El .Pp +The .Fn pthread_mutexattr_gettype -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL Invalid value for @@ -160,12 +168,14 @@ Invalid value for .Sh SEE ALSO .Xr pthread_mutex_init 3 .Sh STANDARDS +The .Fn pthread_mutexattr_init and .Fn pthread_mutexattr_destroy -conform to +functions conform to .St -p1003.1-96 .Pp +The .Fn pthread_mutexattr_setprioceiling , .Fn pthread_mutexattr_getprioceiling , .Fn pthread_mutexattr_setprotocol , @@ -173,5 +183,5 @@ conform to .Fn pthread_mutexattr_settype , and .Fn pthread_mutexattr_gettype -conform to +functions conform to .St -susv2 diff --git a/share/man/man3/pthread_once.3 b/share/man/man3/pthread_once.3 index 7ad97fe..aed9698 100644 --- a/share/man/man3/pthread_once.3 +++ b/share/man/man3/pthread_once.3 @@ -100,6 +100,7 @@ indicate the error. .Sh ERRORS None. .Sh STANDARDS +The .Fn pthread_once -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_rwlockattr_destroy.3 b/share/man/man3/pthread_rwlockattr_destroy.3 index 3ba97cf..65c6d3f 100644 --- a/share/man/man3/pthread_rwlockattr_destroy.3 +++ b/share/man/man3/pthread_rwlockattr_destroy.3 @@ -55,8 +55,9 @@ The function is expected to conform to .St -susv2 . .Sh ERRORS +The .Fn pthread_rwlockattr_destroy -may fail if: +function may fail if: .Bl -tag -width Er .It Bq Er EINVAL The value specified by diff --git a/share/man/man3/pthread_rwlockattr_getpshared.3 b/share/man/man3/pthread_rwlockattr_getpshared.3 index 56bda44..227f512 100644 --- a/share/man/man3/pthread_rwlockattr_getpshared.3 +++ b/share/man/man3/pthread_rwlockattr_getpshared.3 @@ -67,8 +67,9 @@ The function is expected to conform to .St -susv2 . .Sh ERRORS +The .Fn pthread_rwlockattr_getpshared -may fail if: +function may fail if: .Bl -tag -width Er .It Bq Er EINVAL The value specified by diff --git a/share/man/man3/pthread_rwlockattr_setpshared.3 b/share/man/man3/pthread_rwlockattr_setpshared.3 index e19e66c..f04bf9f 100644 --- a/share/man/man3/pthread_rwlockattr_setpshared.3 +++ b/share/man/man3/pthread_rwlockattr_setpshared.3 @@ -43,8 +43,9 @@ function sets the process shared attribute of .Fa attr to the value referenced by .Fa pshared . +The .Fa pshared -may be one of two values: +argument may be one of two values: .Bl -tag -width PTHREAD_PROCESS_PRIVATE .It Dv PTHREAD_PROCESS_SHARED Any thread of any process that has access to the memory where the @@ -69,8 +70,9 @@ The function is expected to conform to .St -susv2 . .Sh ERRORS +The .Fn pthread_rwlockattr_setpshared -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL The value specified by diff --git a/share/man/man3/pthread_schedparam.3 b/share/man/man3/pthread_schedparam.3 index c76f4d90..ea72087 100644 --- a/share/man/man3/pthread_schedparam.3 +++ b/share/man/man3/pthread_schedparam.3 @@ -62,8 +62,9 @@ and no more than If successful, these functions return 0. Otherwise, an error number is returned to indicate the error. .Sh ERRORS +The .Fn pthread_setschedparam -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL Invalid value for @@ -75,16 +76,18 @@ Non-existent thread .Va thread . .El .Pp +The .Fn pthread_getschedparam -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er ESRCH Non-existent thread .Va thread . .El .Sh STANDARDS +The .Fn pthread_setschedparam and .Fn pthread_getschedparam -conform to +functions conform to .St -susv2 diff --git a/share/man/man3/pthread_self.3 b/share/man/man3/pthread_self.3 index 899af43..db7dd29 100644 --- a/share/man/man3/pthread_self.3 +++ b/share/man/man3/pthread_self.3 @@ -56,6 +56,7 @@ None. .Xr pthread_create 3 , .Xr pthread_equal 3 .Sh STANDARDS +The .Fn pthread_self -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_setspecific.3 b/share/man/man3/pthread_setspecific.3 index 5bc274c..a2c47d0 100644 --- a/share/man/man3/pthread_setspecific.3 +++ b/share/man/man3/pthread_setspecific.3 @@ -64,18 +64,20 @@ has been deleted with .Fn pthread_key_delete is undefined. .Pp +The .Fn pthread_setspecific -may be called from a thread-specific data destructor function, however this -may result in lost storage or infinite loops. +function may be called from a thread-specific data destructor function, +however this may result in lost storage or infinite loops. .Sh RETURN VALUES -If successful, the +If successful, the .Fn pthread_setspecific function will return zero. Otherwise an error number will be returned to indicate the error. .Sh ERRORS +The .Fn pthread_setspecific -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er ENOMEM Insufficient memory exists to associate the value with the @@ -90,6 +92,7 @@ value is invalid. .Xr pthread_key_create 3 , .Xr pthread_key_delete 3 .Sh STANDARDS +The .Fn pthread_setspecific -conforms to +function conforms to .St -p1003.1-96 . diff --git a/share/man/man3/pthread_sigmask.3 b/share/man/man3/pthread_sigmask.3 index 5efa925..df97ce1 100644 --- a/share/man/man3/pthread_sigmask.3 +++ b/share/man/man3/pthread_sigmask.3 @@ -77,8 +77,9 @@ If successful, returns 0. Otherwise, an error is returned. .Sh ERRORS +The .Fn pthread_sigmask -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EINVAL .Fa how @@ -91,6 +92,7 @@ is not one of the defined values. .Xr sigsuspend 2 , .Xr sigsetops 3 .Sh STANDARDS +The .Fn pthread_sigmask -conforms to +function conforms to .St -p1003.1-96 diff --git a/share/man/man3/pthread_testcancel.3 b/share/man/man3/pthread_testcancel.3 index 6467ac6..de69294 100644 --- a/share/man/man3/pthread_testcancel.3 +++ b/share/man/man3/pthread_testcancel.3 @@ -197,8 +197,9 @@ or .Sh SEE ALSO .Xr pthread_cancel 3 .Sh STANDARDS +The .Fn pthread_testcancel -conforms to +function conforms to .St -p1003.1-96 . .Sh AUTHORS This man page was written by -- cgit v1.1