diff options
| author | Mike Pritchard <mpp@FreeBSD.org> | 1996-05-01 22:44:14 +0000 |
|---|---|---|
| committer | Mike Pritchard <mpp@FreeBSD.org> | 1996-05-01 22:44:14 +0000 |
| commit | 21ce69b4581854fa4c25cf1517a66287c88779eb (patch) | |
| tree | 476cafad638e8205561cfbf1e6b7170606de1878 /lib/libc | |
| parent | e3857bbe00628e8ae9c279aee4a79b06ea7089b8 (diff) | |
Notes
Diffstat (limited to 'lib/libc')
31 files changed, 86 insertions, 62 deletions
diff --git a/lib/libc/gen/clock.3 b/lib/libc/gen/clock.3 index 8f1b78a6ba37..0e5ad06bd56d 100644 --- a/lib/libc/gen/clock.3 +++ b/lib/libc/gen/clock.3 @@ -42,7 +42,7 @@ .Nm clock .Nd determine processor time used .Sh SYNOPSIS -.Fd #include <sys/types.h> +.Fd #include <time.h> .Ft clock_t .Fn clock void .Sh DESCRIPTION diff --git a/lib/libc/gen/crypt.3 b/lib/libc/gen/crypt.3 index d95f7040a059..28b51123e94e 100644 --- a/lib/libc/gen/crypt.3 +++ b/lib/libc/gen/crypt.3 @@ -54,7 +54,7 @@ .Fn des_cipher "const char *in" "char *out" "long salt" "int count" .Sh DESCRIPTION The -.Xr crypt +.Fn crypt function performs password encryption. It is derived from the diff --git a/lib/libc/gen/ctermid.3 b/lib/libc/gen/ctermid.3 index ff92420eda55..2e3e9e6d71bc 100644 --- a/lib/libc/gen/ctermid.3 +++ b/lib/libc/gen/ctermid.3 @@ -80,7 +80,7 @@ The current implementation detects no error conditions. .Xr ttyname 3 .Sh STANDARDS The -.Xr ctermid +.Fn ctermid function conforms to .St -p1003.1-88 . .Sh BUGS diff --git a/lib/libc/gen/err.3 b/lib/libc/gen/err.3 index a80edeb4c607..f89cf7f3e682 100644 --- a/lib/libc/gen/err.3 +++ b/lib/libc/gen/err.3 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" From: @(#)err.3 8.1 (Berkeley) 6/9/93 -.\" $Id$ +.\" $Id: err.3,v 1.3 1996/02/11 22:33:27 mpp Exp $ .\" .Dd April 13, 1995 .Dt ERR 3 @@ -107,7 +107,7 @@ functions do not return, but exit with the value of the argument The .Fn err_set_exit function can be used to specify a function which is called before -.Xr exit 2 +.Xr exit 3 to perform any necessary cleanup; passing a null function pointer for .Va exitf resets the hook to do nothing. @@ -135,6 +135,7 @@ if ((fd = open(block_device, O_RDONLY, 0)) == -1) err(1, "%s", block_device); .Ed .Sh SEE ALSO +.Xr exit 3 , .Xr strerror 3 .Sh HISTORY The diff --git a/lib/libc/gen/exec.3 b/lib/libc/gen/exec.3 index 3438becdeab5..bda6e9e6169f 100644 --- a/lib/libc/gen/exec.3 +++ b/lib/libc/gen/exec.3 @@ -65,7 +65,7 @@ new process image. The functions described in this manual page are front-ends for the function .Xr execve 2 . (See the manual page for -.Xr execve +.Xr execve 2 for detailed information about the replacement of the current process.) .Pp The initial argument for these functions is the pathname of a file which @@ -148,7 +148,7 @@ used. In addition, certain errors are treated specially. .Pp If permission is denied for a file (the attempted -.Xr execve +.Fn execve returned .Er EACCES ) , these functions will continue searching the rest of @@ -159,7 +159,7 @@ set to .Er EACCES . .Pp If the header of a file isn't recognized (the attempted -.Xr execve +.Fn execve returned .Er ENOEXEC ) , these functions will execute the shell with the path of @@ -167,7 +167,7 @@ the file as its first argument. (If this attempt fails, no further searching is done.) .Pp If the file is currently busy (the attempted -.Xr execve +.Fn execve returned .Er ETXTBUSY ) , these functions will sleep for several seconds, @@ -179,7 +179,7 @@ executes a file with the program tracing facilities enabled (see .Xr ptrace 2 ) . .Sh RETURN VALUES If any of the -.Xr exec +.Fn exec functions returns, an error will have occurred. The return value is \-1, and the global variable .Va errno @@ -213,10 +213,9 @@ for any of the errors specified for the library function .Xr sh 1 , .Xr execve 2 , .Xr fork 2 , -.Xr trace 2 , -.Xr environ 7 , +.Xr ktrace 2 , .Xr ptrace 2 , -.Xr environ 7 , +.Xr environ 7 . .Sh COMPATIBILITY Historically, the default path for the .Fn execlp diff --git a/lib/libc/gen/fnmatch.3 b/lib/libc/gen/fnmatch.3 index 5d5dfd58fbf5..8d0919c3e872 100644 --- a/lib/libc/gen/fnmatch.3 +++ b/lib/libc/gen/fnmatch.3 @@ -107,8 +107,7 @@ otherwise, it returns the value .Sh SEE ALSO .Xr sh 1 , .Xr glob 3 , -.Xr regex 3 , -.Xr wordexp 3 +.Xr regex 3 .Sh STANDARDS The .Fn fnmatch diff --git a/lib/libc/gen/fts.3 b/lib/libc/gen/fts.3 index dde076d08a01..630a5b2c64e7 100644 --- a/lib/libc/gen/fts.3 +++ b/lib/libc/gen/fts.3 @@ -42,7 +42,7 @@ .Fd #include <sys/stat.h> .Fd #include <fts.h> .Ft FTS * -.Fn fts_open "char * const *path_argv" "int options" "int *compar(const FTSENT **, const FTSENT **)" +.Fn fts_open "char * const *path_argv" "int options" "int (*compar)(const FTSENT **, const FTSENT **)" .Ft FTSENT * .Fn fts_read "FTS *ftsp" .Ft FTSENT * @@ -122,7 +122,7 @@ typedef struct _ftsent { These fields are defined as follows: .Bl -tag -width "fts_namelen" .It Fa fts_info -One of the following flags describing the returned +One of the following values describing the returned .Fa FTSENT structure and the file it represents. diff --git a/lib/libc/gen/getbootfile.3 b/lib/libc/gen/getbootfile.3 index cfab748d529a..8c22b46e6bdc 100644 --- a/lib/libc/gen/getbootfile.3 +++ b/lib/libc/gen/getbootfile.3 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" From: @(#)gethostname.3 8.1 (Berkeley) 6/4/93 -.\" $Id$ +.\" $Id: getbootfile.3,v 1.2 1996/02/11 22:33:31 mpp Exp $ .\" .Dd September 23, 1994 .Dt GETBOOTFILE 3 @@ -48,7 +48,7 @@ The function retrieves the full pathname of the file from which the current kernel was loaded, and returns a static pointer to the name. A read/write interface to this information is available via the -.Xr sysctl 2 +.Xr sysctl 3 MIB variable .Dq Li kern.bootfile . .Sh RETURN VALUES @@ -57,7 +57,7 @@ fails, a a null pointer is returned and an error code is placed in the global location .Va errno . .Sh SEE ALSO -.Xr sysctl 2 +.Xr sysctl 3 .Sh BUGS If the boot blocks have not been modified to pass this information into the kernel at boot time, the static string diff --git a/lib/libc/gen/getdomainname.3 b/lib/libc/gen/getdomainname.3 index 8ba5995017ad..27b8903b231a 100644 --- a/lib/libc/gen/getdomainname.3 +++ b/lib/libc/gen/getdomainname.3 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)getdomainname.2 6.7 (Berkeley) 3/10/91 -.\" $Id: getdomainname.2,v 1.1 1993/10/25 03:11:30 rgrimes Exp $ +.\" $Id: getdomainname.3,v 1.2 1996/02/11 22:33:32 mpp Exp $ .\" .Dd March 10, 1991 .Dt GETDOMAINNAME 3 @@ -83,8 +83,8 @@ invalid address. The caller tried to set the domainname and was not the super-user. .El .Sh SEE ALSO -.Xr sysctl 2 -.Xr gethostid 3 +.Xr gethostid 3 , +.Xr sysctl 3 .Sh BUGS Host names are limited to .Dv MAXHOSTNAMELEN diff --git a/lib/libc/gen/getgrent.3 b/lib/libc/gen/getgrent.3 index 132ba6b06707..07e1687dc0ab 100644 --- a/lib/libc/gen/getgrent.3 +++ b/lib/libc/gen/getgrent.3 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" From: @(#)getgrent.3 8.2 (Berkeley) 4/19/94 -.\" $Id$ +.\" $Id: getgrent.3,v 1.3 1996/05/01 01:40:01 bde Exp $ .\" .Dd September 29, 1994 .Dt GETGRENT 3 @@ -45,6 +45,7 @@ .Nm endgrent .Nd group database operations .Sh SYNOPSIS +.Fd #include <sys/types.h> .Fd #include <grp.h> .Ft struct group * .Fn getgrent void diff --git a/lib/libc/gen/gethostname.3 b/lib/libc/gen/gethostname.3 index fcb0303d7bb1..88ccf3a77e40 100644 --- a/lib/libc/gen/gethostname.3 +++ b/lib/libc/gen/gethostname.3 @@ -82,8 +82,8 @@ invalid address. The caller tried to set the hostname and was not the super-user. .El .Sh SEE ALSO -.Xr sysctl 2 -.Xr gethostid 3 +.Xr gethostid 3 , +.Xr sysctl 3 .Sh BUGS Host names are limited to .Dv MAXHOSTNAMELEN diff --git a/lib/libc/gen/getloadavg.3 b/lib/libc/gen/getloadavg.3 index 2eafd5bf25f2..e451d672970b 100644 --- a/lib/libc/gen/getloadavg.3 +++ b/lib/libc/gen/getloadavg.3 @@ -55,8 +55,8 @@ If the load average was unobtainable, \-1 is returned; otherwise, the number of samples actually retrieved is returned. .Sh SEE ALSO .Xr uptime 1 , -.Xr sysctl 2 , -.Xr kvm_getloadavg 3 +.Xr kvm_getloadavg 3 , +.Xr sysctl 3 .Sh HISTORY The .Fn getloadavg diff --git a/lib/libc/gen/getmntinfo.3 b/lib/libc/gen/getmntinfo.3 index f0e83ea374a8..da1d5ad4671b 100644 --- a/lib/libc/gen/getmntinfo.3 +++ b/lib/libc/gen/getmntinfo.3 @@ -48,7 +48,7 @@ The .Fn getmntinfo function returns an array of -.Xr statfs +.Fn statfs structures describing each currently mounted file system (see .Xr statfs 2 ) . .Pp @@ -104,5 +104,5 @@ will modify the same object. The memory allocated by .Fn getmntinfo cannot be -.Xr free 2 Ns 'd +.Xr free 3 Ns 'd by the application. diff --git a/lib/libc/gen/getnetgrent.3 b/lib/libc/gen/getnetgrent.3 index de2523e5ed88..07d58063a4ac 100644 --- a/lib/libc/gen/getnetgrent.3 +++ b/lib/libc/gen/getnetgrent.3 @@ -113,7 +113,7 @@ have no return value. netgroup database file .El .Sh SEE ALSO -.Fn netgroup 5 +.Xr netgroup 5 .Sh COMPATIBILITY The netgroup members have three string fields to maintain compatibility with other vendor implementations, however it is not obvious what use the diff --git a/lib/libc/gen/getpagesize.3 b/lib/libc/gen/getpagesize.3 index 1a2629740b73..ea7f587d3cb6 100644 --- a/lib/libc/gen/getpagesize.3 +++ b/lib/libc/gen/getpagesize.3 @@ -47,8 +47,7 @@ returns the number of bytes in a page. Page granularity is the granularity of many of the memory management calls. .Pp -The page size is a -.Xr system +The page size is a system page size and may not be the same as the underlying hardware page size. .Sh SEE ALSO diff --git a/lib/libc/gen/getpass.3 b/lib/libc/gen/getpass.3 index 34e91cbd47fb..f312d42b8f5a 100644 --- a/lib/libc/gen/getpass.3 +++ b/lib/libc/gen/getpass.3 @@ -86,3 +86,7 @@ will modify the same object. The calling process should zero the password as soon as possible to avoid leaving the cleartext password visible in the process's address space. +.Pp +Upon receipt of a SIGTSTP, the input buffer will be flushed, so any +partially typed password must be retyped when the process +continues. diff --git a/lib/libc/gen/getpwent.3 b/lib/libc/gen/getpwent.3 index 6c23f491a66c..a6a13212fb34 100644 --- a/lib/libc/gen/getpwent.3 +++ b/lib/libc/gen/getpwent.3 @@ -170,9 +170,9 @@ function has no return value. .Sh FILES .Bl -tag -width /etc/master.passwd -compact -.It Pa /var/db/pwd.db +.It Pa /etc/pwd.db The insecure password database file -.It Pa /var/db/spwd.db +.It Pa /etc/spwd.db The secure password database file .It Pa /etc/master.passwd The current password file @@ -180,12 +180,12 @@ The current password file A Version 7 format password file .El .Sh SEE ALSO -.Xr getlogin 3 , +.Xr getlogin 2 , .Xr getgrent 3 , +.Xr yp 4 , .Xr passwd 5 , .Xr pwd_mkdb 8 , -.Xr vipw 8 , -.Xr yp 4 +.Xr vipw 8 .Sh HISTORY The .Nm getpwent , diff --git a/lib/libc/gen/getvfsent.3 b/lib/libc/gen/getvfsent.3 index a8151b0ae317..ed6396d5ee93 100644 --- a/lib/libc/gen/getvfsent.3 +++ b/lib/libc/gen/getvfsent.3 @@ -1,4 +1,4 @@ -.\" $Id$ +.\" $Id: getvfsent.3,v 1.3 1996/05/01 01:40:04 bde Exp $ .\" Written by Garrett A. Wollman, September 1994. .\" This manual page is in the public domain. .\" @@ -15,6 +15,7 @@ .Nm vfsload .Nd manage virtual filesystem modules .Sh SYNOPSIS +.Fd #include <sys/param.h> .Fd #include <sys/mount.h> .Ft struct vfsconf * .Fn getvfsbyname "const char *name" @@ -179,7 +180,7 @@ fails, .Va errno may be set to one of the values documented for .Xr fork 2 , -.Xr waitpid 3 , +.Xr waitpid 2 , .Xr chdir 2 , or .Xr execlp 3 , diff --git a/lib/libc/gen/glob.3 b/lib/libc/gen/glob.3 index f28bc2a0025e..4e3625bb0c9f 100644 --- a/lib/libc/gen/glob.3 +++ b/lib/libc/gen/glob.3 @@ -220,10 +220,11 @@ to provide globbing from directories stored on tape. Pre-process the pattern string to expand .Ql {pat,pat,...} strings like -.Xr csh 1. The pattern +.Xr csh 1 . +The pattern .Ql {} -is left unexpanded for historical reasons -.Xr (Csh 1 +is left unexpanded for historical reasons (and +.Xr csh 1 does the same thing to ease typing of diff --git a/lib/libc/gen/nlist.3 b/lib/libc/gen/nlist.3 index 11c9ee40e14b..981a4c81dfa5 100644 --- a/lib/libc/gen/nlist.3 +++ b/lib/libc/gen/nlist.3 @@ -46,8 +46,8 @@ The .Fn nlist function retrieves name list entries from the symbol table of an -executable file. (See -.Xr a.out 5 . ) +executable file (see +.Xr a.out 5 ) . The argument .Fa \&nl is set to reference the diff --git a/lib/libc/gen/popen.3 b/lib/libc/gen/popen.3 index 6f89a5cbaf0c..db4adfa8cf59 100644 --- a/lib/libc/gen/popen.3 +++ b/lib/libc/gen/popen.3 @@ -170,9 +170,9 @@ The .Fn popen argument always calls -.Xr sh , +.Xr sh 1 , never calls -.Xr csh . +.Xr csh 1 . .Sh HISTORY A .Fn popen diff --git a/lib/libc/gen/psignal.3 b/lib/libc/gen/psignal.3 index 4e7cfb842a70..2be78336390f 100644 --- a/lib/libc/gen/psignal.3 +++ b/lib/libc/gen/psignal.3 @@ -43,8 +43,8 @@ .Fd #include <sys/signal.h> .Ft void .Fn psignal "unsigned sig" "const char *s" -.Vt extern char *sys_siglist[]; -.Vt extern char *sys_signame[]; +.Vt extern const char * const sys_siglist[]; +.Vt extern const char * const sys_signame[]; .Sh DESCRIPTION The .Fn psignal diff --git a/lib/libc/gen/setjmp.3 b/lib/libc/gen/setjmp.3 index 47cdfa5cfff7..3b5d89e11c58 100644 --- a/lib/libc/gen/setjmp.3 +++ b/lib/libc/gen/setjmp.3 @@ -44,7 +44,8 @@ .Nm setjmp , .Nm longjmp , .Nm _setjmp , -.Nm _longjmp longjmperror +.Nm _longjmp , +.Nm longjmperror .Nd non-local jumps .Sh SYNOPSIS .Fd #include <setjmp.h> @@ -125,7 +126,7 @@ pairs save and restore the signal mask while .Fn _setjmp Ns / Ns Fn _longjmp pairs save and restore only the register set and the stack. (See -.Fn sigmask 2 . ) +.Fn sigprocmask 2 . ) .Pp The .Fn sigsetjmp Ns / Ns Fn siglongjmp @@ -144,7 +145,7 @@ routine calls the routine If .Fn longjmperror returns the program is aborted (see -.Xr abort 2 ) . +.Xr abort 3 ) . The default version of .Fn longjmperror prints the message diff --git a/lib/libc/gen/signal.3 b/lib/libc/gen/signal.3 index 86189f12e242..3fd52d8580c4 100644 --- a/lib/libc/gen/signal.3 +++ b/lib/libc/gen/signal.3 @@ -98,7 +98,7 @@ call (formerly .It Dv SIGKILL No " terminate process" " kill program" .It Dv SIGBUS No " create core image" " bus error" .It Dv SIGSEGV No " create core image" " segmentation violation" -.It Dv SIGSYS No " create core image" " system call given invalid argument" +.It Dv SIGSYS No " create core image" " non-existent system call invoked" .It Dv SIGPIPE No " terminate process" " write on a pipe with no reader" .It Dv SIGALRM No " terminate process" " real-time timer expired" .It Dv SIGTERM No " terminate process" " software termination signal" @@ -193,7 +193,7 @@ Otherwise, \-1 is returned and the global variable .Va errno is set to indicate the error. .Sh ERRORS -.Xr Signal +.Fn Signal will fail and no action will take place if one of the following occur: .Bl -tag -width [EINVAL] diff --git a/lib/libc/gen/sleep.3 b/lib/libc/gen/sleep.3 index 9e3c7976a13e..1016a3d55c42 100644 --- a/lib/libc/gen/sleep.3 +++ b/lib/libc/gen/sleep.3 @@ -70,12 +70,31 @@ A similar but less compatible function can be obtained with a single .Xr select 2 ; such a function would not restart after signals, but would not interfere with other uses of -.Xr setitimer . +.Xr setitimer 2 . .Sh RETURN VALUES +The +.Fn sleep +function returns the number of seconds remaining to complete the operation. If +sleep is interrupted or cannot allocate a timer it may will return the value +needed to be passed to a subsequent sleep to complete the necessary delay. +.Fn sleep +repeatedly until it returns zero may busy-wait until a timer +is available. .Sh SEE ALSO .Xr setitimer 2 , .Xr sigpause 2 , .Xr usleep 3 +.Sh CAVEAT +In practice the FreeBSD implementation will not be interrupted: it will +always return the original argument or zero. Code that depends on +sleep being interrupted (using it as a timed pause, for example) needs +to be recoded to use +.Xr select 2 +or some other delay mechanism. Code that +calls +.Fn sleep +repeatedly until it returns zero may busy-wait until a timer +is available. .Sh HISTORY A .Fn sleep diff --git a/lib/libc/gen/sysconf.3 b/lib/libc/gen/sysconf.3 index 53622f6c7616..a67208fe1259 100644 --- a/lib/libc/gen/sysconf.3 +++ b/lib/libc/gen/sysconf.3 @@ -64,7 +64,7 @@ The available values are as follows: .Pp .It Li _SC_ARG_MAX The maximum bytes of argument to -.Xr exec 2 . +.Xr execve 2 . .It Li _SC_CHILD_MAX The maximum number of simultaneous processes per user id. .It Li _SC_CLK_TCK diff --git a/lib/libc/gen/syslog.3 b/lib/libc/gen/syslog.3 index 8a46d05d8b55..832fd9ce52e5 100644 --- a/lib/libc/gen/syslog.3 +++ b/lib/libc/gen/syslog.3 @@ -139,12 +139,12 @@ one or more of the following values: If .Fn syslog cannot pass the message to -.Xr syslogd +.Xr syslogd 8 it will attempt to write the message to the console .Pq Dq Pa /dev/console. .It Dv LOG_NDELAY Open the connection to -.Xr syslogd +.Xr syslogd 8 immediately. Normally the open is delayed until the first message is logged. Useful for programs that need to manage the order in which file diff --git a/lib/libc/gen/tcgetpgrp.3 b/lib/libc/gen/tcgetpgrp.3 index e97c25627211..40f48b115d0c 100644 --- a/lib/libc/gen/tcgetpgrp.3 +++ b/lib/libc/gen/tcgetpgrp.3 @@ -68,7 +68,7 @@ underlying terminal device represented by is not the controlling terminal. .El .Sh SEE ALSO -.Xr setpgid 3 , +.Xr setpgid 2 , .Xr setsid 2 , .Xr tcsetpgrp 3 .Sh STANDARDS diff --git a/lib/libc/gen/tcsetpgrp.3 b/lib/libc/gen/tcsetpgrp.3 index e1f8af00cb3e..9047e4c44cbe 100644 --- a/lib/libc/gen/tcsetpgrp.3 +++ b/lib/libc/gen/tcsetpgrp.3 @@ -89,7 +89,7 @@ argument does not match the process group ID of a process in the same session as the calling process. .El .Sh SEE ALSO -.Xr setpgid 3 , +.Xr setpgid 2 , .Xr setsid 2 , .Xr tcgetpgrp 3 .Sh STANDARDS diff --git a/lib/libc/gen/time.3 b/lib/libc/gen/time.3 index 62833936a5a1..ecf767dc281e 100644 --- a/lib/libc/gen/time.3 +++ b/lib/libc/gen/time.3 @@ -42,7 +42,6 @@ .Nm time .Nd get time of day .Sh SYNOPSIS -.Fd #include <sys/types.h> .Fd #include <time.h> .Ft time_t .Fn time "time_t *tloc" diff --git a/lib/libc/gen/unvis.3 b/lib/libc/gen/unvis.3 index 807a851327b0..c65024d5915a 100644 --- a/lib/libc/gen/unvis.3 +++ b/lib/libc/gen/unvis.3 @@ -100,7 +100,7 @@ to zero. Call with each successive byte, along with a pointer to this integer, and a pointer to a destination character. The -.Xr unvis +.Fn unvis function has several return codes that must be handled properly. They are: .Bl -tag -width UNVIS_VALIDPUSH |
