update from jerry
[unix-history] / usr / src / share / man / man3 / intro.3
CommitLineData
09056340
KM
1.\" Copyright (c) 1980 Regents of the University of California.
2.\" All rights reserved. The Berkeley software License Agreement
3.\" specifies the terms and conditions for redistribution.
4.\"
40c0e121 5.\" @(#)intro.3 6.2 (Berkeley) %G%
09056340 6.\"
e45d659d 7.TH INTRO 3 ""
09056340
KM
8.UC 4
9.SH NAME
10intro \- introduction to library functions
09056340
KM
11.SH DESCRIPTION
12This section describes functions that may be found
ecdf96eb
KM
13in various libraries. The library functions are those other than the
14functions which directly invoke UNIX system primitives, described in section 2.
15This section has the libraries physically grouped together. This is a
16departure from older versions of the UNIX Programmer's Reference Manual,
17which did not group functions by library.
18The functions described in this section are grouped into various libraries:
09056340 19.TP 6n
ecdf96eb
KM
20(3) and (3S)
21The straight ``3'' functions are the standard C library functions. The
22C library also includes all the functions described in section 2. The
233S functions comprise the standard I/O library. Together with the
24(3N), (3X), and (3C) routines, these functions constitute
25library \fIlibc\fP,
09056340 26which is automatically loaded by the C compiler
ecdf96eb
KM
27.IR cc (1),
28the Pascal compiler
29.IR pc (1),
09056340
KM
30and the Fortran compiler
31.IR f77 (1).
32The link editor
33.IR ld (1)
34searches this library under the `\-lc' option.
35Declarations for some of these functions may be obtained
36from include files indicated on the appropriate pages.
37.TP
ecdf96eb
KM
38(3F)
39The 3F functions are all functions callable from FORTRAN. These
40functions perform the same jobs as do the straight ``3'' functions.
09056340
KM
41.TP
42(3M)
43These functions constitute the math library,
ecdf96eb
KM
44.IR libm .
45They are automatically loaded as needed by the Pascal
46compiler
47.IR pc (1)
48and the Fortran compiler
09056340
KM
49.IR f77 (1).
50The link editor searches this library under the `\-lm' option.
ecdf96eb
KM
51Declarations for these functions may be obtained from the include file
52.RI < math.h >.
53.TP
54(3N)
55These functions constitute the internet network library,
09056340
KM
56.TP
57(3S)
ecdf96eb
KM
58These functions constitute the `standard I/O package', see
59.IR intro (3S).
09056340
KM
60These functions are in the library
61.I libc
ecdf96eb
KM
62already mentioned. Declarations for these functions may be obtained from
63the include file
64.RI < stdio.h >.
09056340
KM
65.TP
66(3X)
ecdf96eb
KM
67Various specialized libraries have not been given distinctive captions.
68Files in which such libraries are found are named on appropriate pages.
69.TP
70(3C)
71Routines included for compatibility with other systems. In particular,
72a number of system call interfaces provided in previous releases of
734BSD have been included for source code compatibility. The manual page
74entry for each compatibility routine indicates the proper interface to use.
09056340
KM
75.SH FILES
76.nf
77/lib/libc.a
ecdf96eb
KM
78/usr/lib/libm.a
79/usr/lib/libc_p.a
80/usr/lib/libm_p.a
09056340
KM
81.fi
82.SH SEE ALSO
ecdf96eb
KM
83intro(3C),
84intro(3S),
85intro(3F),
86intro(3M),
87intro(3N),
88nm(1),
89ld(1),
90cc(1),
91f77(1),
92intro(2)
09056340
KM
93.SH DIAGNOSTICS
94Functions in the math library (3M) may return
95conventional values when the function is undefined for the
96given arguments or when the value is not representable.
97In these cases the external variable
98.I errno
99(see
100.IR intro (2))
ecdf96eb
KM
101is set to the value EDOM (domain error) or ERANGE (range error).
102The values of EDOM and ERANGE are defined in the include file
103.RI < math.h >.
104.SH "LIST OF FUNCTIONS"
105.sp 2
09056340 106.nf
ecdf96eb
KM
107.ta \w'getprotobynumber'u+2n +\w'getprotoent'u+10n
108\fIName\fP \fIAppears on Page\fP \fIDescription\fP
109.ta \w'getprotobynumber'u+4n +\w'getprotoent'u+4n
110.sp 5p
111abort abort.3 generate a fault
40c0e121 112abort abort.3f abnormal termination
ecdf96eb
KM
113abs abs.3 integer absolute value
114access access.3f determine accessability of a file
115acos sin.3m trigonometric functions
116alarm alarm.3c schedule signal after specified time
117alarm alarm.3f execute a subroutine after a specified time
118alloca malloc.3 memory allocator
40c0e121 119arc plot.3f f77 interface to plot(3x)
ecdf96eb
KM
120arc plot.3x graphics interface
121asctime ctime.3 convert date and time to ASCII
122asin sin.3m trigonometric functions
123assert assert.3x program verification
124atan sin.3m trigonometric functions
125atan2 sin.3m trigonometric functions
126atof atof.3 convert ASCII to numbers
127atoi atof.3 convert ASCII to numbers
128atol atof.3 convert ASCII to numbers
129bcmp bstring.3 bit and byte string operations
130bcopy bstring.3 bit and byte string operations
40c0e121 131bessel bessel.3f bessel functions of two kinds for integer orders
ecdf96eb 132bit bit.3f and, or, xor, not, rshift, lshift bitwise functions
40c0e121 133box plot.3f f77 interface to plot(3x)
ecdf96eb
KM
134bzero bstring.3 bit and byte string operations
135cabs hypot.3m Euclidean distance
136calloc malloc.3 memory allocator
137ceil floor.3m absolute value, floor, ceiling functions
138chdir chdir.3f change default directory
139chmod chmod.3f change mode of a file
40c0e121 140circle plot.3f f77 interface to plot(3x)
ecdf96eb
KM
141circle plot.3x graphics interface
142clearerr ferror.3s stream status inquiries
143closedir directory.3 directory operations
144closelog syslog.3 control system log
145closepl plot.3x graphics interface
40c0e121
KM
146clospl plot.3f f77 interface to plot(3x)
147cont plot.3f f77 interface to plot(3x)
ecdf96eb
KM
148cont plot.3x graphics interface
149cos sin.3m trigonometric functions
150cosh sinh.3m hyperbolic functions
151crypt crypt.3 DES encryption
152ctime ctime.3 convert date and time to ASCII
153ctime time.3f return system time
154curses curses.3x screen functions with ``optimal'' cursor motion
155dbminit dbm.3x data base subroutines
156delete dbm.3x data base subroutines
157dffrac flmin.3f return extreme values
158dflmax flmin.3f return extreme values
ecdf96eb 159dflmin flmin.3f return extreme values
ecdf96eb 160drand rand.3f return random values
40c0e121 161drandm random.3f better random number generator
ecdf96eb
KM
162dtime etime.3f return elapsed execution time
163ecvt ecvt.3 output conversion
164edata end.3 last locations in program
165encrypt crypt.3 DES encryption
166end end.3 last locations in program
167endfsent getfsent.3x get file system descriptor file entry
168endgrent getgrent.3 get group file entry
169endhostent gethostent.3n get network host entry
170endnetent getnetent.3n get network entry
171endprotoent getprotoent.3n get protocol entry
172endpwent getpwent.3 get password file entry
173endservent getservent.3n get service entry
174environ execl.3 execute a file
40c0e121 175erase plot.3f f77 interface to plot(3x)
ecdf96eb
KM
176erase plot.3x graphics interface
177etext end.3 last locations in program
178etime etime.3f return elapsed execution time
179exec execl.3 execute a file
180exece execl.3 execute a file
181execl execl.3 execute a file
182execle execl.3 execute a file
183execlp execl.3 execute a file
184exect execl.3 execute a file
185execv execl.3 execute a file
186execvp execl.3 execute a file
187exit exit.3 terminate a process after flushing any pending output
188exit exit.3f terminate process with status
189exp exp.3m exponential, logarithm, power, square root
190fabs floor.3m absolute value, floor, ceiling functions
40c0e121 191falloc malloc.3f memory allocator
ecdf96eb
KM
192fclose fclose.3s close or flush a stream
193fcvt ecvt.3 output conversion
194fdate fdate.3f return date and time in an ASCII string
195feof ferror.3s stream status inquiries
196ferror ferror.3s stream status inquiries
197fetch dbm.3x data base subroutines
198fflush fclose.3s close or flush a stream
199ffrac flmin.3f return extreme values
200ffs bstring.3 bit and byte string operations
201fgetc getc.3f get a character from a logical unit
202fgetc getc.3s get character or word from stream
203fgets gets.3s get a string from a stream
204fileno ferror.3s stream status inquiries
205firstkey dbm.3x data base subroutines
206flmax flmin.3f return extreme values
ecdf96eb 207flmin flmin.3f return extreme values
ecdf96eb
KM
208floor floor.3m absolute value, floor, ceiling functions
209flush flush.3f flush output to a logical unit
e45d659d 210fopen fopen.3s open a stream
ecdf96eb
KM
211fork fork.3f create a copy of this process
212fpecnt trpfpe.3f trap and repair floating point faults
213fprintf printf.3s formatted output conversion
214fputc putc.3f write a character to a fortran logical unit
215fputc putc.3s put character or word on a stream
216fputs puts.3s put a string on a stream
217fread fread.3s buffered binary input/output
218free malloc.3 memory allocator
40c0e121 219free malloc.3f memory allocator
ecdf96eb
KM
220frexp frexp.3 split into mantissa and exponent
221fscanf scanf.3s formatted input conversion
222fseek fseek.3f reposition a file on a logical unit
223fseek fseek.3s reposition a stream
224fstat stat.3f get file status
225ftell fseek.3f reposition a file on a logical unit
226ftell fseek.3s reposition a stream
227ftime time.3c get date and time
228fwrite fread.3s buffered binary input/output
229gamma gamma.3m log gamma function
230gcvt ecvt.3 output conversion
231gerror perror.3f get system error messages
232getarg getarg.3f return command line arguments
233getc getc.3f get a character from a logical unit
234getc getc.3s get character or word from stream
235getchar getc.3s get character or word from stream
236getcwd getcwd.3f get pathname of current working directory
237getdiskbyname getdisk.3x get disk description by its name
238getenv getenv.3 value for environment name
239getenv getenv.3f get value of environment variables
240getfsent getfsent.3x get file system descriptor file entry
241getfsfile getfsent.3x get file system descriptor file entry
242getfsspec getfsent.3x get file system descriptor file entry
243getfstype getfsent.3x get file system descriptor file entry
244getgid getuid.3f get user or group ID of the caller
245getgrent getgrent.3 get group file entry
246getgrgid getgrent.3 get group file entry
247getgrnam getgrent.3 get group file entry
248gethostbyaddr gethostent.3n get network host entry
249gethostbyname gethostent.3n get network host entry
250gethostent gethostent.3n get network host entry
251getlog getlog.3f get user's login name
252getlogin getlogin.3 get login name
253getnetbyaddr getnetent.3n get network entry
254getnetbyname getnetent.3n get network entry
255getnetent getnetent.3n get network entry
256getpass getpass.3 read a password
257getpid getpid.3f get process id
258getprotobyname getprotoent.3n get protocol entry
259getprotobynumber getprotoent.3n get protocol entry
260getprotoent getprotoent.3n get protocol entry
261getpw getpw.3 get name from uid
262getpwent getpwent.3 get password file entry
263getpwnam getpwent.3 get password file entry
264getpwuid getpwent.3 get password file entry
265gets gets.3s get a string from a stream
266getservbyname getservent.3n get service entry
267getservbyport getservent.3n get service entry
268getservent getservent.3n get service entry
269getuid getuid.3f get user or group ID of the caller
270getw getc.3s get character or word from stream
271getwd getwd.3 get current working directory pathname
272gmtime ctime.3 convert date and time to ASCII
273gmtime time.3f return system time
274gtty stty.3c set and get terminal state (defunct)
275hostnm hostnm.3f get name of current host
276htonl byteorder.3n convert values between host and network byte order
277htons byteorder.3n convert values between host and network byte order
278hypot hypot.3m Euclidean distance
279iargc getarg.3f return command line arguments
280idate idate.3f return date or time in numerical form
281ierrno perror.3f get system error messages
282index index.3f tell about character objects
283index string.3 string operations
284inet_addr inet.3n Internet address manipulation routines
285inet_lnaof inet.3n Internet address manipulation routines
286inet_makeaddr inet.3n Internet address manipulation routines
287inet_netof inet.3n Internet address manipulation routines
288inet_network inet.3n Internet address manipulation routines
289initgroups initgroups.3x initialize group access list
290initstate random.3 better random number generator
291inmax flmin.3f return extreme values
ecdf96eb
KM
292insque insque.3 insert/remove element from a queue
293ioinit ioinit.3f change f77 I/O initialization
294irand rand.3f return random values
40c0e121 295irandm random.3f better random number generator
ecdf96eb
KM
296isalnum ctype.3 character classification macros
297isalpha ctype.3 character classification macros
298isascii ctype.3 character classification macros
299isatty ttynam.3f find name of a terminal port
300isatty ttyname.3 find name of a terminal
301iscntrl ctype.3 character classification macros
302isdigit ctype.3 character classification macros
303islower ctype.3 character classification macros
304isprint ctype.3 character classification macros
305ispunct ctype.3 character classification macros
306isspace ctype.3 character classification macros
307isupper ctype.3 character classification macros
308itime idate.3f return date or time in numerical form
309j0 j0.3m bessel functions
310j1 j0.3m bessel functions
311jn j0.3m bessel functions
312kill kill.3f send a signal to a process
40c0e121 313label plot.3f f77 interface to plot(3x)
ecdf96eb
KM
314label plot.3x graphics interface
315ldexp frexp.3 split into mantissa and exponent
316len index.3f tell about character objects
317lib2648 lib2648.3x subroutines for the HP 2648 graphics terminal
40c0e121 318line plot.3f f77 interface to plot(3x)
ecdf96eb 319line plot.3x graphics interface
40c0e121 320linemd plot.3f f77 interface to plot(3x)
ecdf96eb
KM
321linemod plot.3x graphics interface
322link link.3f make a link to an existing file
323lnblnk index.3f tell about character objects
324loc loc.3f return the address of an object
325localtime ctime.3 convert date and time to ASCII
326log exp.3m exponential, logarithm, power, square root
327log10 exp.3m exponential, logarithm, power, square root
328long long.3f integer object conversion
329longjmp setjmp.3 non-local goto
330lstat stat.3f get file status
331ltime time.3f return system time
332malloc malloc.3 memory allocator
40c0e121 333malloc malloc.3f memory allocator
ecdf96eb
KM
334mktemp mktemp.3 make a unique file name
335modf frexp.3 split into mantissa and exponent
336moncontrol monitor.3 prepare execution profile
337monitor monitor.3 prepare execution profile
338monstartup monitor.3 prepare execution profile
40c0e121 339move plot.3f f77 interface to plot(3x)
ecdf96eb
KM
340move plot.3x graphics interface
341nextkey dbm.3x data base subroutines
342nice nice.3c set program priority
343nlist nlist.3 get entries from name list
344ntohl byteorder.3n convert values between host and network byte order
345ntohs byteorder.3n convert values between host and network byte order
346opendir directory.3 directory operations
347openlog syslog.3 control system log
40c0e121 348openpl plot.3f f77 interface to plot(3x)
e45d659d 349openpl plot.3x graphics interface
ecdf96eb
KM
350pause pause.3c stop until signal
351pclose popen.3 initiate I/O to/from a process
352perror perror.3 system error messages
353perror perror.3f get system error messages
40c0e121 354point plot.3f f77 interface to plot(3x)
ecdf96eb
KM
355point plot.3x graphics interface
356popen popen.3 initiate I/O to/from a process
357pow exp.3m exponential, logarithm, power, square root
358printf printf.3s formatted output conversion
359psignal psignal.3 system signal messages
360putc putc.3f write a character to a fortran logical unit
361putc putc.3s put character or word on a stream
362putchar putc.3s put character or word on a stream
363puts puts.3s put a string on a stream
364putw putc.3s put character or word on a stream
365qsort qsort.3 quicker sort
366qsort qsort.3f quick sort
367rand rand.3c random number generator
368rand rand.3f return random values
369random random.3 better random number generator
40c0e121 370random random.3f better random number generator
ecdf96eb
KM
371rcmd rcmd.3x routines for returning a stream to a remote command
372re_comp regex.3 regular expression handler
373re_exec regex.3 regular expression handler
374readdir directory.3 directory operations
375realloc malloc.3 memory allocator
376remque insque.3 insert/remove element from a queue
377rename rename.3f rename a file
378rewind fseek.3s reposition a stream
379rewinddir directory.3 directory operations
380rexec rexec.3x return stream to a remote command
381rindex index.3f tell about character objects
382rindex string.3 string operations
383rresvport rcmd.3x routines for returning a stream to a remote command
384ruserok rcmd.3x routines for returning a stream to a remote command
385scandir scandir.3 scan a directory
386scanf scanf.3s formatted input conversion
387seekdir directory.3 directory operations
388setbuf setbuf.3s assign buffering to a stream
389setbuffer setbuf.3s assign buffering to a stream
390setegid setuid.3 set user and group ID
391seteuid setuid.3 set user and group ID
392setfsent getfsent.3x get file system descriptor file entry
393setgid setuid.3 set user and group ID
394setgrent getgrent.3 get group file entry
395sethostent gethostent.3n get network host entry
396setjmp setjmp.3 non-local goto
397setkey crypt.3 DES encryption
398setlinebuf setbuf.3s assign buffering to a stream
399setnetent getnetent.3n get network entry
400setprotoent getprotoent.3n get protocol entry
401setpwent getpwent.3 get password file entry
402setrgid setuid.3 set user and group ID
403setruid setuid.3 set user and group ID
404setservent getservent.3n get service entry
405setstate random.3 better random number generator
406setuid setuid.3 set user and group ID
407short long.3f integer object conversion
408signal signal.3 simplified software signal facilities
409signal signal.3f change the action for a signal
410sin sin.3m trigonometric functions
411sinh sinh.3m hyperbolic functions
412sleep sleep.3 suspend execution for interval
413sleep sleep.3f suspend execution for an interval
40c0e121 414space plot.3f f77 interface to plot(3x)
ecdf96eb
KM
415space plot.3x graphics interface
416sprintf printf.3s formatted output conversion
417sqrt exp.3m exponential, logarithm, power, square root
418srand rand.3c random number generator
419srandom random.3 better random number generator
420sscanf scanf.3s formatted input conversion
421stat stat.3f get file status
422stdio intro.3s standard buffered input/output package
423store dbm.3x data base subroutines
424strcat string.3 string operations
425strcmp string.3 string operations
426strcpy string.3 string operations
427strlen string.3 string operations
428strncat string.3 string operations
429strncmp string.3 string operations
430strncpy string.3 string operations
431stty stty.3c set and get terminal state (defunct)
432swab swab.3 swap bytes
433sys_errlist perror.3 system error messages
434sys_nerr perror.3 system error messages
435sys_siglist psignal.3 system signal messages
436syslog syslog.3 control system log
437system system.3 issue a shell command
438system system.3f execute a \s-2UNIX\s0 command
439tan sin.3m trigonometric functions
440tanh sinh.3m hyperbolic functions
441tclose topen.3f f77 tape I/O
442telldir directory.3 directory operations
443tgetent termcap.3x terminal independent operation routines
444tgetflag termcap.3x terminal independent operation routines
445tgetnum termcap.3x terminal independent operation routines
446tgetstr termcap.3x terminal independent operation routines
447tgoto termcap.3x terminal independent operation routines
448time time.3c get date and time
449time time.3f return system time
450times times.3c get process times
451timezone ctime.3 convert date and time to ASCII
452topen topen.3f f77 tape I/O
453tputs termcap.3x terminal independent operation routines
454traper traper.3f trap arithmetic errors
455trapov trapov.3f trap and repair floating point overflow
456tread topen.3f f77 tape I/O
457trewin topen.3f f77 tape I/O
458trpfpe trpfpe.3f trap and repair floating point faults
459tskipf topen.3f f77 tape I/O
460tstate topen.3f f77 tape I/O
461ttynam ttynam.3f find name of a terminal port
462ttyname ttyname.3 find name of a terminal
463ttyslot ttyname.3 find name of a terminal
464twrite topen.3f f77 tape I/O
465ungetc ungetc.3s push character back into input stream
466unlink unlink.3f remove a directory entry
467utime utime.3c set file times
468valloc valloc.3 aligned memory allocator
469varargs varargs.3 variable argument list
470vlimit vlimit.3c control maximum system resource consumption
471vtimes vtimes.3c get information about resource utilization
472wait wait.3f wait for a process to terminate
473y0 j0.3m bessel functions
474y1 j0.3m bessel functions
475yn j0.3m bessel functions
09056340 476.fi