diff options
| author | Michael Kerrisk <mtk.manpages@gmail.com> | 2007-05-11 23:29:44 +0000 |
|---|---|---|
| committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2007-05-11 23:29:44 +0000 |
| commit | 63f6a20a1acb380057d1940f286bde6d6758e51d (patch) | |
| tree | 72eab8754dc590cf636af3370daab53228e8a02c | |
| parent | ee6e96c1b63b4cc60cbb2fc752c3883921e1419f (diff) | |
| download | man-pages-63f6a20a1acb380057d1940f286bde6d6758e51d.tar.gz | |
Add section numbers to page xrefs
| -rw-r--r-- | man7/environ.7 | 8 | ||||
| -rw-r--r-- | man7/epoll.7 | 4 | ||||
| -rw-r--r-- | man7/futex.7 | 4 | ||||
| -rw-r--r-- | man7/inotify.7 | 34 | ||||
| -rw-r--r-- | man7/ip.7 | 2 | ||||
| -rw-r--r-- | man7/locale.7 | 40 | ||||
| -rw-r--r-- | man7/mq_overview.7 | 4 | ||||
| -rw-r--r-- | man7/packet.7 | 2 | ||||
| -rw-r--r-- | man7/pthreads.7 | 6 | ||||
| -rw-r--r-- | man7/pty.7 | 4 | ||||
| -rw-r--r-- | man7/sem_overview.7 | 2 | ||||
| -rw-r--r-- | man7/socket.7 | 38 | ||||
| -rw-r--r-- | man7/svipc.7 | 30 | ||||
| -rw-r--r-- | man7/tcp.7 | 10 | ||||
| -rw-r--r-- | man7/termio.7 | 4 | ||||
| -rw-r--r-- | man7/unix.7 | 4 |
16 files changed, 98 insertions, 98 deletions
diff --git a/man7/environ.7 b/man7/environ.7 index ac90444571..cfd822fdce 100644 --- a/man7/environ.7 +++ b/man7/environ.7 @@ -154,10 +154,10 @@ to be used with \fBgethostbyname\fP(3). give time zone information used by .BR tzset (3) and through that by functions like -.BR ctime (), -.BR localtime (), -.BR mktime (), -.BR strftime (). +.BR ctime (2), +.BR localtime (2), +.BR mktime (2), +.BR strftime (2). See also .BR tzselect (1). .LP diff --git a/man7/epoll.7 b/man7/epoll.7 index a84eee6114..ab0429e67c 100644 --- a/man7/epoll.7 +++ b/man7/epoll.7 @@ -363,7 +363,7 @@ Suppose you receive 100 events from .BR epoll_wait (2), and in event #47 a condition causes event #13 to be closed. If you remove the structure and -.BR close () +.BR close (2) the fd for event #13, then your event cache might still say there are events waiting for that fd causing confusion. @@ -371,7 +371,7 @@ confusion. One solution for this is to call, during the processing of event 47, .BR epoll_ctl ( EPOLL_CTL_DEL ) to delete fd 13 and -.BR close (), +.BR close (2), then mark its associated data structure as removed and link it to a cleanup list. If you find another diff --git a/man7/futex.7 b/man7/futex.7 index 645de63b06..a958b25013 100644 --- a/man7/futex.7 +++ b/man7/futex.7 @@ -42,7 +42,7 @@ futexes are also optimised for this situation. In its bare form, a futex is an aligned integer which is only touched by atomic assembler instructions. Processes can share this integer using -.BR mmap (), +.BR mmap (2), via shared memory segments or because they share memory space, in which case the application is commonly called multithreaded. .SH "SEMANTICS" @@ -71,7 +71,7 @@ and request that the kernel wait for another process to up the futex. This is done using the FUTEX_WAIT operation. .PP The -.BR futex () +.BR futex (2) system call can optionally be passed a timeout specifying how long the kernel should wait for the futex to be upped. diff --git a/man7/inotify.7 b/man7/inotify.7 index 3dd4c4d316..9ead9b24cc 100644 --- a/man7/inotify.7 +++ b/man7/inotify.7 @@ -33,12 +33,12 @@ When a directory is monitored, inotify will return events for the directory itself, and for files inside the directory. The following system calls are used with this API: -.BR inotify_init (), -.BR inotify_add_watch (), -.BR inotify_rm_watch (), -.BR read (), +.BR inotify_init (2), +.BR inotify_add_watch (2), +.BR inotify_rm_watch (2), +.BR read (2), and -.BR close (). +.BR close (2). .BR inotify_init (2) creates an inotify instance and returns a file descriptor @@ -50,11 +50,11 @@ Each item ("watch") in the watch list specifies the pathname of a file or directory, along with some set of events that the kernel should monitor for the file referred to by that pathname. -.BR inotify_add_watch () +.BR inotify_add_watch (2) either creates a new watch item, or modifies an existing watch. Each watch has a unique "watch descriptor", an integer returned by -.BR inotify_add_watch () +.BR inotify_add_watch (2) when the watch is created. .BR inotify_rm_watch (2) @@ -71,11 +71,11 @@ To determine what events have occurred, an application from the inotify file descriptor. If no events have so far occurred, then, assuming a blocking file descriptor, -.BR read () +.BR read (2) will block until at least one event occurs. Each successful -.BR read () +.BR read (2) returns a buffer containing one or more of the following structures: .in +0.25i .nf @@ -94,7 +94,7 @@ struct inotify_event { .I wd identifies the watch for which this event occurs. It is one of the watch descriptors returned by a previous call to -.BR inotify_add_watch (). +.BR inotify_add_watch (2). .I mask contains bits that describe the event that occurred (see below). @@ -141,11 +141,11 @@ inotify events. The following bits can be specified in .I mask when calling -.BR inotify_add_watch () +.BR inotify_add_watch (2) and may be returned in the .I mask field returned by -.BR read (): +.BR read (2): .in +0.25i .TS lB lB @@ -181,7 +181,7 @@ macro is defined as a bit mask of all of the above events. This macro can be used as the .I mask argument when calling -.BR inotify_add_watch (). +.BR inotify_add_watch (2). Two additional convenience macros are .BR IN_MOVE , @@ -195,7 +195,7 @@ IN_CLOSE_WRITE|IN_CLOSE_NOWRITE. The following further bits can be specified in .I mask when calling -.BR inotify_add_watch (): +.BR inotify_add_watch (2): .in +0.25i .TS lB lB @@ -213,13 +213,13 @@ IN_ONLYDIR Only watch \fIpathname\fP if it is a directory The following bits may be set in the .I mask field returned by -.BR read (): +.BR read (2): .in +0.25i .TS lB lB lB l. Bit Description -IN_IGNORED Watch was removed explicitly (\fBinotify_rm_watch\fP()) +IN_IGNORED Watch was removed explicitly (\fBinotify_rm_watch\fP(2)) or automatically (file was deleted, or file system was unmounted) IN_ISDIR Subject of this event is a directory @@ -271,7 +271,7 @@ correct order on the inotify file descriptor. The .B FIONREAD -.BR ioctl () +.BR ioctl (2) returns the number of bytes available to read from an inotify file descriptor. @@ -783,7 +783,7 @@ to the network. .TP .BR ip_nonlocal_bind " (Boolean; default: disabled)" If set, allows processes to -.BR bind () +.BR bind (2) to non-local IP addresses, which can be quite useful, but may break some applications. .\" diff --git a/man7/locale.7 b/man7/locale.7 index 29b61155d5..a912ad4ad9 100644 --- a/man7/locale.7 +++ b/man7/locale.7 @@ -46,23 +46,23 @@ declares data types, functions and macros which are useful in this task. .PP The functions it declares are -.BR setlocale () +.BR setlocale (3) to set the current locale, and -.BR localeconv () +.BR localeconv (3) to get information about number formatting. .PP There are different categories for local information a program might need; they are declared as macros. Using them as the first argument to the -.BR setlocale () +.BR setlocale (3) function, it is possible to set one of these to the desired locale: .TP .B LC_COLLATE This is used to change the behaviour of the functions -.BR strcoll () +.BR strcoll (3) and -.BR strxfrm (), +.BR strxfrm (3), which are used to compare strings in the local alphabet. For example, the German sharp s is sorted as "ss". @@ -70,31 +70,31 @@ the German sharp s is sorted as "ss". .B LC_CTYPE This changes the behaviour of the character handling and classification functions, such as -.BR isupper () +.BR isupper (3) and -.BR toupper (), +.BR toupper (3), and the multi\-byte character functions such as -.BR mblen () +.BR mblen (3) or -.BR wctomb (). +.BR wctomb (3). .TP .B LC_MONETARY changes the information returned by -.BR localeconv () +.BR localeconv (3) which describes the way numbers are usually printed, with details such as decimal point versus decimal comma. This information is internally used by the function -.BR strfmon (). +.BR strfmon (3). .TP .B LC_MESSAGES changes the language messages are displayed in and how an affirmative or negative answer looks like. The GNU C-library contains the -.BR gettext (), -.BR ngettext (), +.BR gettext (3), +.BR ngettext (3), and -.BR rpmatch () +.BR rpmatch (3) functions to ease the use of these information. The GNU gettext family of functions also obey the environment variable @@ -102,17 +102,17 @@ functions also obey the environment variable .TP .B LC_NUMERIC changes the information used by the -.BR printf () +.BR printf (3) and -.BR scanf () +.BR scanf (3) family of functions, when they are advised to use the locale-settings. This information can also be read with the -.BR localeconv () +.BR localeconv (3) function. .TP .B LC_TIME changes the behaviour of the -.BR strftime () +.BR strftime (3) function to display the current time in a locally acceptable form; for example, most of Europe uses a 24\-hour clock versus the 12\-hour clock used in the United States. @@ -124,7 +124,7 @@ All of the above. .\" LC_PAPER, LC_TELEPHONE. These need to be documented. .PP If the second argument to -.BR setlocale () +.BR setlocale (3) is empty string, .BR """""" , for the default locale, it is determined using the following steps: @@ -147,7 +147,7 @@ is used. Values about local numeric formatting is made available in a .I struct lconv returned by the -.BR localeconv () +.BR localeconv (3) function, which has the following declaration: .in +0.25i .nf diff --git a/man7/mq_overview.7 b/man7/mq_overview.7 index fd48c3088b..9d390459f1 100644 --- a/man7/mq_overview.7 +++ b/man7/mq_overview.7 @@ -41,7 +41,7 @@ which is used to refer to the open message queue in later calls. Each message queue is identified by a name of the form .IR /somename . Two processes can operate on the same queue by passing the same name to -.BR mq_open (). +.BR mq_open (3). Messages are transferred to and from a queue using .BR mq_send (3) @@ -118,7 +118,7 @@ This option is enabled by default. .SS Persistence POSIX message queues have kernel persistence: if not removed by -.BR mq_unlink (), +.BR mq_unlink (3), a message queue will exist until the system is shut down. .SS Linking Programs using the POSIX message queue API must be compiled with diff --git a/man7/packet.7 b/man7/packet.7 index 865782263b..c1e8d1a1f3 100644 --- a/man7/packet.7 +++ b/man7/packet.7 @@ -361,7 +361,7 @@ Socket filters are not documented. The .I MSG_TRUNC -.BR recvmsg () +.BR recvmsg (2) extension is an ugly hack and should be replaced by a control message. There is currently no way to get the original destination address of packets via SOCK_DGRAM. diff --git a/man7/pthreads.7 b/man7/pthreads.7 index b4c384a189..8ad2a17543 100644 --- a/man7/pthreads.7 +++ b/man7/pthreads.7 @@ -61,7 +61,7 @@ root directory interval timers .RB ( setitimer (2)) and POSIX timers -.RB ( timer_create ()) +.RB ( timer_create (3)) .IP \- 3 nice value .RB ( setpriority (2)) @@ -82,7 +82,7 @@ thread ID (the data type) .IP \- 3 signal mask -.RB ( pthread_sigmask ()) +.RB ( pthread_sigmask (3)) .IP \- 3 the .I errno @@ -139,7 +139,7 @@ The notable features of this implementation are the following: .IP \- 3 In addition to the main (initial) thread, and the threads that the program creates using -.BR pthread_create (), +.BR pthread_create (3), the implementation creates a "manager" thread. This thread handles thread creation and termination. (Problems can result if this thread is inadvertently killed.) diff --git a/man7/pty.7 b/man7/pty.7 index ea11779b8b..3fe954ce89 100644 --- a/man7/pty.7 +++ b/man7/pty.7 @@ -118,11 +118,11 @@ for "pty" in the name of the master) can then be opened. .SH "NOTES" A description of the .B TIOCPKT -.BR ioctl (), +.BR ioctl (2), which controls packet mode operation, can be found in .BR tty_ioctl (4). -The BSD ioctl()s TIOCSTOP, TIOCSTART, TIOCUCNTL, TIOCREMOTE have +The BSD ioctl(2)s TIOCSTOP, TIOCSTART, TIOCUCNTL, TIOCREMOTE have not been implemented under Linux. .SH "FILES" .I /dev/ptmx diff --git a/man7/sem_overview.7 b/man7/sem_overview.7 index 6cc2ca5fef..b692dec95f 100644 --- a/man7/sem_overview.7 +++ b/man7/sem_overview.7 @@ -94,7 +94,7 @@ a complete implementation of POSIX semaphores is provided. .SS Persistence POSIX named semaphores have kernel persistence: if not removed by -.BR sem_unlink (), +.BR sem_unlink (3), a semaphore will exist until the system is shut down. .SS Linking Programs using the POSIX semaphores API must be compiled with diff --git a/man7/socket.7 b/man7/socket.7 index f2683f2d87..d49d0bb6ed 100644 --- a/man7/socket.7 +++ b/man7/socket.7 @@ -175,9 +175,9 @@ T} .PP An alternative to -.BR poll () +.BR poll (2) and -.BR select () +.BR select (2) is to let the kernel inform the application about events via a .B SIGIO @@ -207,12 +207,12 @@ for all sockets: .B SO_ACCEPTCONN Returns a value indicating whether or not this socket has been marked to accept connections with -.BR listen (). +.BR listen (2). The value 0 indicates that this is not a listening socket, the value 1 indicates that this is a listening socket. Can only be read with -.BR getsockopt (). +.BR getsockopt (2). .TP .B SO_BINDTODEVICE Bind this socket to a particular device like \(lqeth0\(rq, @@ -261,7 +261,7 @@ capability or an effective user ID of 0. .B SO_ERROR Get and clear the pending socket error. Only valid as a -.BR getsockopt (). +.BR getsockopt (2). Expects an integer. .TP .B SO_DONTROUTE @@ -341,7 +341,7 @@ Argument is a .I ucred structure. Only valid as a -.BR getsockopt (). +.BR getsockopt (2). .TP .B SO_PRIORITY Set the protocol-defined priority for all packets to be sent on @@ -361,9 +361,9 @@ Sets or gets the maximum socket receive buffer in bytes. The kernel doubles this value (to allow space for bookkeeping overhead) when it is set using .\" Most (all?) other implementations do not do this -- MTK, Dec 05 -.BR setsockopt (), +.BR setsockopt (2), and this doubled value is returned by -.BR getsockopt (). +.BR getsockopt (2). The default value is set by the .B rmem_default sysctl and the maximum allowed value is set by the @@ -446,9 +446,9 @@ Sets or gets the maximum socket send buffer in bytes. The kernel doubles this value (to allow space for bookkeeping overhead) when it is set using .\" Most (all?) other implementations do not do this -- MTK, Dec 05 -.BR setsockopt (), +.BR setsockopt (2), and this doubled value is returned by -.BR getsockopt (). +.BR getsockopt (2). The default value is set by the .B wmem_default sysctl and the maximum allowed value is set by the @@ -486,7 +486,7 @@ Gets the socket type as an integer (like .BR SOCK_STREAM ). Can only be read with -.BR getsockopt (). +.BR getsockopt (2). .SH SIGNALS When writing onto a connection-oriented socket that has been shut down (by the local or the remote end) @@ -501,10 +501,10 @@ flag. .PP When requested with the .B FIOSETOWN -.BR fcntl () +.BR fcntl (2) or .B SIOCSPGRP -.BR ioctl (), +.BR ioctl (2), .B SIGIO is sent when an I/O event occurs. It is possible to use @@ -514,7 +514,7 @@ or in the signal handler to find out which socket the event occurred on. An alternative (in Linux 2.2) is to set a realtime signal using the .B F_SETSIG -.BR fcntl (); +.BR fcntl (2); the handler of the real time signal will be called with the file descriptor in the .I si_fd @@ -595,7 +595,7 @@ last packet that was received while .B SO_TIMESTAMP was not set, or it fails if no such packet has been received, (i.e., -.BR ioctl () +.BR ioctl (2) returns \-1 with .I errno set to @@ -643,16 +643,16 @@ or 0 when none is set. .PP Valid -.BR fcntl () +.BR fcntl (2) operations: .TP .BR FIOGETOWN The same as the SIOCGPGRP -.BR ioctl (). +.BR ioctl (2). .TP .BR FIOSETOWN The same as the SIOCSPGRP -.BR ioctl (). +.BR ioctl (2). .SH NOTES Linux assumes that half of the send/receive buffer is used for internal kernel structures; thus the sysctls are twice what can be observed @@ -660,7 +660,7 @@ on the wire. Linux will only allow port re-use with the SO_REUSEADDR option when this option was set both in the previous program that performed a -.BR bind () +.BR bind (2) to the port and in the program that wants to re-use the port. This differs from some implementations (e.g., FreeBSD) where only the later program needs to set the SO_REUSEADDR option. diff --git a/man7/svipc.7 b/man7/svipc.7 index 5f3e80ad62..0fc0d1b402 100644 --- a/man7/svipc.7 +++ b/man7/svipc.7 @@ -155,19 +155,19 @@ containing the following members: .br .B pid_t msg_lspid; -/* PID of last msgsnd() call */ +/* PID of last msgsnd(2) call */ .br .B pid_t msg_lrpid; -/* PID of last msgrcv() call */ +/* PID of last msgrcv(2) call */ .br .B time_t msg_stime; -/* last msgsnd() time */ +/* last msgsnd(2) time */ .br .B time_t msg_rtime; -/* last msgrcv() time */ +/* last msgrcv(2) time */ .br .B time_t msg_ctime; @@ -187,22 +187,22 @@ queue. .TP .B msg_lspid ID of the process that performed the last -.BR msgsnd () +.BR msgsnd (2) system call. .TP .B msg_lrpid ID of the process that performed the last -.BR msgrcv () +.BR msgrcv (2) system call. .TP .B msg_stime Time of the last -.BR msgsnd () +.BR msgsnd (2) system call. .TP .B msg_rtime Time of the last -.BR msgcv () +.BR msgcv (2) system call. .TP .B msg_ctime @@ -241,12 +241,12 @@ set. .TP .B sem_otime Time of last -.BR semop () +.BR semop (2) system call. .TP .B sem_ctime Time of last -.BR semctl () +.BR semctl (2) system call that changed a member of the above structure or of one semaphore belonging to the set. .TP @@ -347,9 +347,9 @@ ID of the process that created the shared memory segment. .TP .B shm_lpid ID of the last process that executed a -.BR shmat () +.BR shmat (2) or -.BR shmdt () +.BR shmdt (2) system call. .TP .B shm_nattch @@ -357,17 +357,17 @@ Number of current alive attaches for this shared memory segment. .TP .B shm_atime Time of the last -.BR shmat () +.BR shmat (2) system call. .TP .B shm_dtime Time of the last -.BR shmdt () +.BR shmdt (2) system call. .TP .B shm_ctime Time of the last -.BR shmctl () +.BR shmctl (2) system call that changed .BR shmid_ds . .SH "SEE ALSO" diff --git a/man7/tcp.7 b/man7/tcp.7 index 1adfaba4dc..7823669744 100644 --- a/man7/tcp.7 +++ b/man7/tcp.7 @@ -52,9 +52,9 @@ socket for each incoming connection can be accepted using .BR accept (2). A socket which has had -.BR accept () +.BR accept (2) or -.BR connect () +.BR connect (2) successfully called on it is fully specified and may transmit data. Data cannot be transmitted on listening or @@ -105,9 +105,9 @@ kernel structures, and the sysctl variables reflect the larger sizes compared to the actual TCP windows. On individual connections, the socket buffer size must be set prior to the -.BR listen () +.BR listen (2) or -.BR connect () +.BR connect (2) calls in order to have it take effect. See .BR socket (7) @@ -887,7 +887,7 @@ IPv6 is not described. .\" or put into a separate page. .SH VERSIONS Support for Explicit Congestion Notification, zero-copy -.BR sendfile (), +.BR sendfile (2), reordering support and some SACK extensions (DSACK) were introduced in 2.4. Support for forward acknowledgement (FACK), TIME_WAIT recycling, diff --git a/man7/termio.7 b/man7/termio.7 index 42def74f09..c3fbd32d73 100644 --- a/man7/termio.7 +++ b/man7/termio.7 @@ -39,10 +39,10 @@ version of this interface, under the name The POSIX.1 data structure differs slightly from the System V version, and POSIX.1 defined a suite of functions to replace the various -.BR ioctl () +.BR ioctl (2) operations that existed in System V. (This was done because -.BR ioctl () +.BR ioctl (2) was unstandardised, and its variadic third argument does not allow argument type checking.) diff --git a/man7/unix.7 b/man7/unix.7 index 0d17fe96f0..31fef116b7 100644 --- a/man7/unix.7 +++ b/man7/unix.7 @@ -214,9 +214,9 @@ reference to it is closed. To pass file descriptors or credentials over a SOCK_STREAM, you need to send or receive at least one byte of non-ancillary data in the same -.BR sendmsg () +.BR sendmsg (2) or -.BR recvmsg () +.BR recvmsg (2) call. Unix domain stream sockets do not support the notion of out-of-band data. |
