Merge from vendor branch FILE:
[dragonfly.git] / lib / libc / sys / intro.2
1 .\" Copyright (c) 1980, 1983, 1986, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)intro.2     8.5 (Berkeley) 2/27/95
33 .\" $FreeBSD: src/lib/libc/sys/intro.2,v 1.21.2.7 2003/02/24 01:01:48 trhodes Exp $
34 .\" $DragonFly: src/lib/libc/sys/intro.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
35 .\"
36 .Dd February 27, 1995
37 .Dt INTRO 2
38 .Os
39 .Sh NAME
40 .Nm intro
41 .Nd introduction to system calls and error numbers
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In errno.h
46 .Sh DESCRIPTION
47 This section provides an overview of the system calls,
48 their error returns, and other common definitions and concepts.
49 .\".Pp
50 .\".Sy System call restart
51 .\".Pp
52 .\"<more later...>
53 .Sh RETURN VALUES
54 Nearly all of the system calls provide an error number referenced via
55 the external identifier errno.
56 This identifier is defined in
57 .Aq Pa sys/errno.h
58 as
59 .Pp
60 .Dl extern    int *       __error();
61 .Dl #define   errno       (* __error())
62 .Pp
63 The
64 .Va __error()
65 function returns a pointer to a field in the thread specific structure for
66 threads other than the initial thread.
67 For the initial thread and
68 non-threaded processes,
69 .Va __error()
70 returns a pointer to a global
71 .Va errno
72 variable that is compatible with the previous definition.
73 .Pp
74 When a system call detects an error,
75 it returns an integer value
76 indicating failure (usually -1)
77 and sets the variable
78 .Va errno
79 accordingly.
80 <This allows interpretation of the failure on receiving
81 a -1 and to take action accordingly.>
82 Successful calls never set
83 .Va errno ;
84 once set, it remains until another error occurs.
85 It should only be examined after an error.
86 Note that a number of system calls overload the meanings of these
87 error numbers, and that the meanings must be interpreted according
88 to the type and circumstances of the call.
89 .Pp
90 The following is a complete list of the errors and their
91 names as given in
92 .Aq Pa sys/errno.h .
93 .Bl -hang -width Ds
94 .It Er 0 Em "Undefined error: 0" .
95 Not used.
96 .It Er 1 EPERM Em "Operation not permitted" .
97 An attempt was made to perform an operation limited to processes
98 with appropriate privileges or to the owner of a file or other
99 resources.
100 .It Er 2 ENOENT Em "No such file or directory" .
101 A component of a specified pathname did not exist, or the
102 pathname was an empty string.
103 .It Er 3 ESRCH Em "No such process" .
104 No process could be found corresponding to that specified by the given
105 process ID.
106 .It Er 4 EINTR Em "Interrupted system call" .
107 An asynchronous signal (such as
108 .Dv SIGINT
109 or
110 .Dv SIGQUIT )
111 was caught by the process during the execution of an interruptible
112 function.
113 If the signal handler performs a normal return, the
114 interrupted function call will seem to have returned the error condition.
115 .It Er 5 EIO Em "Input/output error" .
116 Some physical input or output error occurred.
117 This error will not be reported until a subsequent operation on the same file
118 descriptor and may be lost (over written) by any subsequent errors.
119 .It Er 6 ENXIO Em "Device not configured" .
120 Input or output on a special file referred to a device that did not
121 exist, or
122 made a request beyond the limits of the device.
123 This error may also occur when, for example,
124 a tape drive is not online or no disk pack is
125 loaded on a drive.
126 .It Er 7 E2BIG Em "Argument list too long" .
127 The number of bytes used for the argument and environment
128 list of the new process exceeded the current limit
129 of 65536 bytes
130 .Pf ( Dv NCARGS
131 in
132 .Aq Pa sys/param.h ) .
133 .It Er 8 ENOEXEC Em "Exec format error" .
134 A request was made to execute a file
135 that, although it has the appropriate permissions,
136 was not in the format required for an
137 executable file.
138 .It Er 9 EBADF Em "Bad file descriptor" .
139 A file descriptor argument was out of range, referred to no open file,
140 or a read (write) request was made to a file that was only open for
141 writing (reading).
142 .Pp
143 .It Er 10 ECHILD Em "\&No child processes" .
144 A
145 .Xr wait 2
146 or
147 .Xr waitpid 2
148 function was executed by a process that had no existing or unwaited-for
149 child processes.
150 .It Er 11 EDEADLK Em "Resource deadlock avoided" .
151 An attempt was made to lock a system resource that
152 would have resulted in a deadlock situation.
153 .It Er 12 ENOMEM Em "Cannot allocate memory" .
154 The new process image required more memory than was allowed by the hardware
155 or by system-imposed memory management constraints.
156 A lack of swap space is normally temporary; however,
157 a lack of core is not.
158 Soft limits may be increased to their corresponding hard limits.
159 .It Er 13 EACCES Em "Permission denied" .
160 An attempt was made to access a file in a way forbidden
161 by its file access permissions.
162 .It Er 14 EFAULT Em "Bad address" .
163 The system detected an invalid address in attempting to
164 use an argument of a call.
165 .It Er 15 ENOTBLK Em "Block device required" .
166 A block device operation was attempted on a non-block device or file.
167 .It Er 16 EBUSY Em "Device busy" .
168 An attempt to use a system resource which was in use at the time
169 in a manner which would have conflicted with the request.
170 .It Er 17 EEXIST Em "File exists" .
171 An existing file was mentioned in an inappropriate context,
172 for instance, as the new link name in a
173 .Xr link 2
174 function.
175 .It Er 18 EXDEV Em "Cross-device link" .
176 A hard link to a file on another file system
177 was attempted.
178 .It Er 19 ENODEV Em "Operation not supported by device" .
179 An attempt was made to apply an inappropriate
180 function to a device,
181 for example,
182 trying to read a write-only device such as a printer.
183 .It Er 20 ENOTDIR Em "Not a directory" .
184 A component of the specified pathname existed, but it was
185 not a directory, when a directory was expected.
186 .It Er 21 EISDIR Em "Is a directory" .
187 An attempt was made to open a directory with write mode specified.
188 .It Er 22 EINVAL Em "Invalid argument" .
189 Some invalid argument was supplied.
190 (For example,
191 specifying an undefined signal to a
192 .Xr signal 3
193 or
194 .Xr kill 2
195 function).
196 .It Er 23 ENFILE Em "Too many open files in system" .
197 Maximum number of file descriptors allowable on the system
198 has been reached and a requests for an open cannot be satisfied
199 until at least one has been closed.
200 .It Er 24 EMFILE Em "Too many open files" .
201 <As released, the limit on the number of
202 open files per process is 64.>
203 The
204 .Xr getdtablesize 2
205 function will obtain the current limit.
206 .It Er 25 ENOTTY Em "Inappropriate ioctl for device" .
207 A control function (see
208 .Xr ioctl 2 )
209 was attempted for a file or
210 special device for which the operation was inappropriate.
211 .It Er 26 ETXTBSY Em "Text file busy" .
212 The new process was a pure procedure (shared text) file
213 which was open for writing by another process, or
214 while the pure procedure file was being executed an
215 .Xr open 2
216 call requested write access.
217 .It Er 27 EFBIG Em "File too large" .
218 The size of a file exceeded the maximum (about
219 .if t 2\u\s-231\s+2\d
220 .if n 2.1E9
221 bytes).
222 .It Er 28 ENOSPC Em "No space left on device" .
223 A
224 .Xr write 2
225 to an ordinary file, the creation of a
226 directory or symbolic link, or the creation of a directory
227 entry failed because no more disk blocks were available
228 on the file system, or the allocation of an inode for a newly
229 created file failed because no more inodes were available
230 on the file system.
231 .It Er 29 ESPIPE Em "Illegal seek" .
232 An
233 .Xr lseek 2
234 function was issued on a socket, pipe or
235 .Tn FIFO .
236 .It Er 30 EROFS Em "Read-only file system" .
237 An attempt was made to modify a file or directory
238 on a file system that was read-only at the time.
239 .It Er 31 EMLINK Em "Too many links" .
240 Maximum allowable hard links to a single file has been exceeded (limit
241 of 32767 hard links per file).
242 .It Er 32 EPIPE Em "Broken pipe" .
243 A write on a pipe, socket or
244 .Tn FIFO
245 for which there is no process
246 to read the data.
247 .It Er 33 EDOM Em "Numerical argument out of domain" .
248 A numerical input argument was outside the defined domain of the mathematical
249 function.
250 .It Er 34 ERANGE Em "Result too large" .
251 A numerical result of the function was too large to fit in the
252 available space (perhaps exceeded precision).
253 .It Er 35 EAGAIN Em "Resource temporarily unavailable" .
254 This is a temporary condition and later calls to the
255 same routine may complete normally.
256 .It Er 36 EINPROGRESS Em "Operation now in progress" .
257 An operation that takes a long time to complete (such as
258 a
259 .Xr connect 2 )
260 was attempted on a non-blocking object (see
261 .Xr fcntl 2 ) .
262 .It Er 37 EALREADY Em "Operation already in progress" .
263 An operation was attempted on a non-blocking object that already
264 had an operation in progress.
265 .It Er 38 ENOTSOCK Em "Socket operation on non-socket" .
266 Self-explanatory.
267 .It Er 39 EDESTADDRREQ Em "Destination address required" .
268 A required address was omitted from an operation on a socket.
269 .It Er 40 EMSGSIZE Em "Message too long" .
270 A message sent on a socket was larger than the internal message buffer
271 or some other network limit.
272 .It Er 41 EPROTOTYPE Em "Protocol wrong type for socket" .
273 A protocol was specified that does not support the semantics of the
274 socket type requested.
275 For example, you cannot use the
276 .Tn ARPA
277 Internet
278 .Tn UDP
279 protocol with type
280 .Dv SOCK_STREAM .
281 .It Er 42 ENOPROTOOPT Em "Protocol not available" .
282 A bad option or level was specified in a
283 .Xr getsockopt 2
284 or
285 .Xr setsockopt 2
286 call.
287 .It Er 43 EPROTONOSUPPORT Em "Protocol not supported" .
288 The protocol has not been configured into the
289 system or no implementation for it exists.
290 .It Er 44 ESOCKTNOSUPPORT Em "Socket type not supported" .
291 The support for the socket type has not been configured into the
292 system or no implementation for it exists.
293 .It Er 45 EOPNOTSUPP Em "Operation not supported" .
294 The attempted operation is not supported for the type of object referenced.
295 Usually this occurs when a file descriptor refers to a file or socket
296 that cannot support this operation,
297 for example, trying to
298 .Em accept
299 a connection on a datagram socket.
300 .It Er 46 EPFNOSUPPORT Em "Protocol family not supported" .
301 The protocol family has not been configured into the
302 system or no implementation for it exists.
303 .It Er 47 EAFNOSUPPORT Em "Address family not supported by protocol family" .
304 An address incompatible with the requested protocol was used.
305 For example, you shouldn't necessarily expect to be able to use
306 .Tn NS
307 addresses with
308 .Tn ARPA
309 Internet protocols.
310 .It Er 48 EADDRINUSE Em "Address already in use" .
311 Only one usage of each address is normally permitted.
312 .Pp
313 .It Er 49 EADDRNOTAVAIL Em "Cannot assign requested address" .
314 Normally results from an attempt to create a socket with an
315 address not on this machine.
316 .It Er 50 ENETDOWN Em "Network is down" .
317 A socket operation encountered a dead network.
318 .It Er 51 ENETUNREACH Em "Network is unreachable" .
319 A socket operation was attempted to an unreachable network.
320 .It Er 52 ENETRESET Em "Network dropped connection on reset" .
321 The host you were connected to crashed and rebooted.
322 .It Er 53 ECONNABORTED Em "Software caused connection abort" .
323 A connection abort was caused internal to your host machine.
324 .It Er 54 ECONNRESET Em "Connection reset by peer" .
325 A connection was forcibly closed by a peer.  This normally
326 results from a loss of the connection on the remote socket
327 due to a timeout or a reboot.
328 .It Er 55 ENOBUFS Em "\&No buffer space available" .
329 An operation on a socket or pipe was not performed because
330 the system lacked sufficient buffer space or because a queue was full.
331 .It Er 56 EISCONN Em "Socket is already connected" .
332 A
333 .Xr connect 2
334 request was made on an already connected socket; or,
335 a
336 .Xr sendto 2
337 or
338 .Xr sendmsg 2
339 request on a connected socket specified a destination
340 when already connected.
341 .It Er 57 ENOTCONN Em "Socket is not connected" .
342 An request to send or receive data was disallowed because
343 the socket was not connected and (when sending on a datagram socket)
344 no address was supplied.
345 .It Er 58 ESHUTDOWN Em "Cannot send after socket shutdown" .
346 A request to send data was disallowed because the socket
347 had already been shut down with a previous
348 .Xr shutdown 2
349 call.
350 .It Er 60 ETIMEDOUT Em "Operation timed out" .
351 A
352 .Xr connect 2
353 or
354 .Xr send 2
355 request failed because the connected party did not
356 properly respond after a period of time.  (The timeout
357 period is dependent on the communication protocol.)
358 .It Er 61 ECONNREFUSED Em "Connection refused" .
359 No connection could be made because the target machine actively
360 refused it.  This usually results from trying to connect
361 to a service that is inactive on the foreign host.
362 .It Er 62 ELOOP Em "Too many levels of symbolic links" .
363 A path name lookup involved more than 32
364 .Pq Dv MAXSYMLINKS
365 symbolic links.
366 .It Er 63 ENAMETOOLONG Em "File name too long" .
367 A component of a path name exceeded 255
368 .Pq Dv MAXNAMELEN
369 characters, or an entire
370 path name exceeded 1023
371 .Pq Dv MAXPATHLEN Ns -1
372 characters.
373 .It Er 64 EHOSTDOWN Em "Host is down" .
374 A socket operation failed because the destination host was down.
375 .It Er 65 EHOSTUNREACH Em "No route to host" .
376 A socket operation was attempted to an unreachable host.
377 .It Er 66 ENOTEMPTY Em "Directory not empty" .
378 A directory with entries other than
379 .Ql .\&
380 and
381 .Ql ..\&
382 was supplied to a remove directory or rename call.
383 .It Er 67 EPROCLIM Em "Too many processes" .
384 .It Er 68 EUSERS Em "Too many users" .
385 The quota system ran out of table entries.
386 .It Er 69 EDQUOT Em "Disc quota exceeded" .
387 A
388 .Xr write 2
389 to an ordinary file, the creation of a
390 directory or symbolic link, or the creation of a directory
391 entry failed because the user's quota of disk blocks was
392 exhausted, or the allocation of an inode for a newly
393 created file failed because the user's quota of inodes
394 was exhausted.
395 .It Er 70 ESTALE Em "Stale NFS file handle" .
396 An attempt was made to access an open file (on an
397 .Tn NFS
398 filesystem)
399 which is now unavailable as referenced by the file descriptor.
400 This may indicate the file was deleted on the
401 .Tn NFS
402 server or some
403 other catastrophic event occurred.
404 .It Er 72 EBADRPC Em "RPC struct is bad" .
405 Exchange of
406 .Tn RPC
407 information was unsuccessful.
408 .It Er 73 ERPCMISMATCH Em "RPC version wrong" .
409 The version of
410 .Tn RPC
411 on the remote peer is not compatible with
412 the local version.
413 .It Er 74 EPROGUNAVAIL Em "RPC prog. not avail" .
414 The requested program is not registered on the remote host.
415 .It Er 75 EPROGMISMATCH Em "Program version wrong" .
416 The requested version of the program is not available
417 on the remote host
418 .Pq Tn RPC .
419 .It Er 76 EPROCUNAVAIL Em "Bad procedure for program" .
420 An
421 .Tn RPC
422 call was attempted for a procedure which doesn't exist
423 in the remote program.
424 .It Er 77 ENOLCK Em "No locks available" .
425 A system-imposed limit on the number of simultaneous file
426 locks was reached.
427 .It Er 78 ENOSYS Em "Function not implemented" .
428 Attempted a system call that is not available on this
429 system.
430 .It Er 79 EFTYPE Em "Inappropriate file type or format" .
431 The file was the wrong type for the operation, or a data file had
432 the wrong format.
433 .It Er 80 EAUTH Em "Authentication error" .
434 Attempted to use an invalid authentication ticket to mount a
435 .Tn NFS
436 filesystem.
437 .It Er 81 ENEEDAUTH Em "Need authenticator" .
438 An authentication ticket must be obtained before the given
439 .Tn NFS
440 filesystem may be mounted.
441 .It Er 82 EIDRM Em "Identifier removed" .
442 An IPC identifier was removed while the current process was waiting on it.
443 .It Er 83 ENOMSG Em "No message of desired type" .
444 An IPC message queue does not contain a message of the desired type, or a
445 message catalog does not contain the requested message.
446 .It Er 84 EOVERFLOW Em "Value too large to be stored in data type" .
447 A numerical result of the function was too large to be stored in the caller
448 provided space.
449 .It Er 85 ECANCELED Em "Operation canceled" .
450 The scheduled operation was canceled.
451 .It Er 86 EILSEQ Em "Illegal byte sequence" .
452 While decoding a multibyte character the function came along an
453 invalid or an incomplete sequence of bytes or the given wide
454 character is invalid.
455 .El
456 .Sh DEFINITIONS
457 .Bl -tag -width Ds
458 .It  Process ID .
459 Each active process in the system is uniquely identified by a non-negative
460 integer called a process ID.  The range of this ID is from 0 to 99999.
461 .It  Parent process ID
462 A new process is created by a currently active process; (see
463 .Xr fork 2 ) .
464 The parent process ID of a process is initially the process ID of its creator.
465 If the creating process exits,
466 the parent process ID of each child is set to the ID of a system process,
467 .Xr init 8 .
468 .It  Process Group
469 Each active process is a member of a process group that is identified by
470 a non-negative integer called the process group ID.  This is the process
471 ID of the group leader.  This grouping permits the signaling of related
472 processes (see
473 .Xr termios 4 )
474 and the job control mechanisms of
475 .Xr csh 1 .
476 .It Session
477 A session is a set of one or more process groups.
478 A session is created by a successful call to
479 .Xr setsid 2 ,
480 which causes the caller to become the only member of the only process
481 group in the new session.
482 .It Session leader
483 A process that has created a new session by a successful call to
484 .Xr setsid 2 ,
485 is known as a session leader.
486 Only a session leader may acquire a terminal as its controlling terminal (see
487 .Xr termios 4 ) .
488 .It Controlling process
489 A session leader with a controlling terminal is a controlling process.
490 .It Controlling terminal
491 A terminal that is associated with a session is known as the controlling
492 terminal for that session and its members.
493 .It  "Terminal Process Group ID"
494 A terminal may be acquired by a session leader as its controlling terminal.
495 Once a terminal is associated with a session, any of the process groups
496 within the session may be placed into the foreground by setting
497 the terminal process group ID to the ID of the process group.
498 This facility is used
499 to arbitrate between multiple jobs contending for the same terminal;
500 (see
501 .Xr csh 1
502 and
503 .Xr tty 4 ) .
504 .It  "Orphaned Process Group"
505 A process group is considered to be
506 .Em orphaned
507 if it is not under the control of a job control shell.
508 More precisely, a process group is orphaned
509 when none of its members has a parent process that is in the same session
510 as the group,
511 but is in a different process group.
512 Note that when a process exits, the parent process for its children
513 is changed to be
514 .Xr init 8 ,
515 which is in a separate session.
516 Not all members of an orphaned process group are necessarily orphaned
517 processes (those whose creating process has exited).
518 The process group of a session leader is orphaned by definition.
519 .It "Real User ID and Real Group ID"
520 Each user on the system is identified by a positive integer
521 termed the real user ID.
522 .Pp
523 Each user is also a member of one or more groups.
524 One of these groups is distinguished from others and
525 used in implementing accounting facilities.  The positive
526 integer corresponding to this distinguished group is termed
527 the real group ID.
528 .Pp
529 All processes have a real user ID and real group ID.
530 These are initialized from the equivalent attributes
531 of the process that created it.
532 .It "Effective User Id, Effective Group Id, and Group Access List"
533 Access to system resources is governed by two values:
534 the effective user ID, and the group access list.
535 The first member of the group access list is also known as the
536 effective group ID.
537 (In POSIX.1, the group access list is known as the set of supplementary
538 group IDs, and it is unspecified whether the effective group ID is
539 a member of the list.)
540 .Pp
541 The effective user ID and effective group ID are initially the
542 process's real user ID and real group ID respectively.  Either
543 may be modified through execution of a set-user-ID or set-group-ID
544 file (possibly by one its ancestors) (see
545 .Xr execve 2 ) .
546 By convention, the effective group ID (the first member of the group access
547 list) is duplicated, so that the execution of a set-group-ID program
548 does not result in the loss of the original (real) group ID.
549 .Pp
550 The group access list is a set of group IDs
551 used only in determining resource accessibility.  Access checks
552 are performed as described below in ``File Access Permissions''.
553 .It  "Saved Set User ID and Saved Set Group ID"
554 When a process executes a new file, the effective user ID is set
555 to the owner of the file if the file is set-user-ID, and the effective
556 group ID (first element of the group access list) is set to the group
557 of the file if the file is set-group-ID.
558 The effective user ID of the process is then recorded as the saved set-user-ID,
559 and the effective group ID of the process is recorded as the saved set-group-ID.
560 These values may be used to regain those values as the effective user
561 or group ID after reverting to the real ID (see
562 .Xr setuid 2 ) .
563 (In POSIX.1, the saved set-user-ID and saved set-group-ID are optional,
564 and are used in setuid and setgid, but this does not work as desired
565 for the super-user.)
566 .It  Super-user
567 A process is recognized as a
568 .Em super-user
569 process and is granted special privileges if its effective user ID is 0.
570 .It  Special Processes
571 The processes with process IDs of 0, 1, and 2 are special.
572 Process 0 is the scheduler.  Process 1 is the initialization process
573 .Xr init 8 ,
574 and is the ancestor of every other process in the system.
575 It is used to control the process structure.
576 Process 2 is the paging daemon.
577 .It  Descriptor
578 An integer assigned by the system when a file is referenced
579 by
580 .Xr open 2
581 or
582 .Xr dup 2 ,
583 or when a socket is created by
584 .Xr pipe 2 ,
585 .Xr socket 2
586 or
587 .Xr socketpair 2 ,
588 which uniquely identifies an access path to that file or socket from
589 a given process or any of its children.
590 .It  File Name
591 Names consisting of up to 255
592 .Pq Dv MAXNAMELEN
593 characters may be used to name
594 an ordinary file, special file, or directory.
595 .Pp
596 These characters may be selected from the set of all
597 .Tn ASCII
598 character
599 excluding 0 (NUL) and the
600 .Tn ASCII
601 code for
602 .Ql \&/
603 (slash).
604 .Pp
605 Note that it is generally unwise to use
606 .Ql \&* ,
607 .Ql \&? ,
608 .Ql \&[
609 or
610 .Ql \&]
611 as part of
612 file names because of the special meaning attached to these characters
613 by the shell.
614 .It  Path Name
615 A path name is a
616 .Tn NUL Ns -terminated
617 character string starting with an
618 optional slash
619 .Ql \&/ ,
620 followed by zero or more directory names separated
621 by slashes, optionally followed by a file name.
622 The total length of a path name must be less than 1024
623 .Pq Dv MAXPATHLEN
624 characters.
625 .Pp
626 If a path name begins with a slash, the path search begins at the
627 .Em root
628 directory.
629 Otherwise, the search begins from the current working directory.
630 A slash by itself names the root directory.  An empty
631 pathname refers to the current directory.
632 .It  Directory
633 A directory is a special type of file that contains entries
634 that are references to other files.
635 Directory entries are called links.  By convention, a directory
636 contains at least two links,
637 .Ql .\&
638 and
639 .Ql \&.. ,
640 referred to as
641 .Em dot
642 and
643 .Em dot-dot
644 respectively.  Dot refers to the directory itself and
645 dot-dot refers to its parent directory.
646 .It "Root Directory and Current Working Directory"
647 Each process has associated with it a concept of a root directory
648 and a current working directory for the purpose of resolving path
649 name searches.  A process's root directory need not be the root
650 directory of the root file system.
651 .It  File Access Permissions
652 Every file in the file system has a set of access permissions.
653 These permissions are used in determining whether a process
654 may perform a requested operation on the file (such as opening
655 a file for writing).  Access permissions are established at the
656 time a file is created.  They may be changed at some later time
657 through the
658 .Xr chmod 2
659 call.
660 .Pp
661 File access is broken down according to whether a file may be: read,
662 written, or executed.  Directory files use the execute
663 permission to control if the directory may be searched.
664 .Pp
665 File access permissions are interpreted by the system as
666 they apply to three different classes of users: the owner
667 of the file, those users in the file's group, anyone else.
668 Every file has an independent set of access permissions for
669 each of these classes.  When an access check is made, the system
670 decides if permission should be granted by checking the access
671 information applicable to the caller.
672 .Pp
673 Read, write, and execute/search permissions on
674 a file are granted to a process if:
675 .Pp
676 The process's effective user ID is that of the super-user.
677 (Note:
678 even the super-user cannot execute a non-executable file.)
679 .Pp
680 The process's effective user ID matches the user ID of the owner
681 of the file and the owner permissions allow the access.
682 .Pp
683 The process's effective user ID does not match the user ID of the
684 owner of the file, and either the process's effective
685 group ID matches the group ID
686 of the file, or the group ID of the file is in
687 the process's group access list,
688 and the group permissions allow the access.
689 .Pp
690 Neither the effective user ID nor effective group ID
691 and group access list of the process
692 match the corresponding user ID and group ID of the file,
693 but the permissions for ``other users'' allow access.
694 .Pp
695 Otherwise, permission is denied.
696 .It  Sockets and Address Families
697 A socket is an endpoint for communication between processes.
698 Each socket has queues for sending and receiving data.
699 .Pp
700 Sockets are typed according to their communications properties.
701 These properties include whether messages sent and received
702 at a socket require the name of the partner, whether communication
703 is reliable, the format used in naming message recipients, etc.
704 .Pp
705 Each instance of the system supports some
706 collection of socket types; consult
707 .Xr socket 2
708 for more information about the types available and
709 their properties.
710 .Pp
711 Each instance of the system supports some number of sets of
712 communications protocols.  Each protocol set supports addresses
713 of a certain format.  An Address Family is the set of addresses
714 for a specific group of protocols.  Each socket has an address
715 chosen from the address family in which the socket was created.
716 .El
717 .Sh SEE ALSO
718 .Xr intro 3 ,
719 .Xr perror 3