From d9c1ae6480015d55ce590b78e9db906e4b22c609 Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Sat, 12 May 2007 13:12:02 +0000 Subject: [PATCH] Use bold for function name, not underline. --- man2/getcontext.2 | 18 ++++++++++++------ man2/kill.2 | 6 ++++-- man2/shmop.2 | 4 +++- man2/sigaltstack.2 | 4 +++- man2/syslog.2 | 8 ++++++-- man2/uname.2 | 3 ++- man3/clearenv.3 | 7 +++++-- man3/exit.3 | 4 +++- man3/flockfile.3 | 9 +++++++-- man3/gethostbyname.3 | 4 +++- man3/getutent.3 | 12 ++++++++---- man3/mkfifo.3 | 4 +++- man3/strptime.3 | 3 ++- man3/termios.3 | 5 +++-- man3/tmpfile.3 | 3 ++- man3/unlocked_stdio.3 | 8 ++++++-- man5/resolv.conf.5 | 2 +- man5/utmp.5 | 8 +++++--- man7/signal.7 | 4 ++-- 19 files changed, 80 insertions(+), 36 deletions(-) diff --git a/man2/getcontext.2 b/man2/getcontext.2 index 5c7ac70fa..7b3cfc1bf 100644 --- a/man2/getcontext.2 +++ b/man2/getcontext.2 @@ -123,10 +123,12 @@ appropriately. None defined. .SH NOTES The earliest incarnation of this mechanism was the -\fIsetjmp\fP(3)/\fIlongjmp\fP(3) mechanism. +.BR setjmp (3)/ longjmp (3) +mechanism. Since that does not define the handling of the signal context, the next stage was the -\fIsigsetjmp\fP(3)/\fIsiglongjmp\fP(3) pair. +.BR sigsetjmp (3)/ siglongjmp (3) +pair. The present mechanism gives much more control. On the other hand, there is no easy way to detect whether a return from @@ -139,10 +141,14 @@ variable won't do since registers are restored. .LP When a signal occurs, the current user context is saved and a new context is created by the kernel for the signal handler. -Do not leave the handler using \fIlongjmp\fP(3): it is undefined -what would happen with contexts. -Use \fIsiglongjmp\fP(3) or -\fIsetcontext\fP() instead. +Do not leave the handler using +.BR longjmp (3): +it is undefined what would happen with contexts. +Use +.BR siglongjmp (3) +or +.BR setcontext () +instead. .SH "CONFORMING TO" SUSv2, POSIX.1-2001. .SH "SEE ALSO" diff --git a/man2/kill.2 b/man2/kill.2 index 545cc85c1..3fb6f87d6 100644 --- a/man2/kill.2 +++ b/man2/kill.2 @@ -120,9 +120,11 @@ Linux allows a process to signal itself, but on Linux the call POSIX.1-2001 requires that if a process sends a signal to itself, and the sending thread does not have the signal blocked, and no other thread -has it unblocked or is waiting for it in \fIsigwait\fP(3), at least one +has it unblocked or is waiting for it in +.BR sigwait (3), +at least one unblocked signal must be delivered to the sending thread before the -\fIkill\fP(). +.BR kill (). .SH BUGS In 2.6 kernels up to and including 2.6.7, there was a bug that meant that when sending signals to a process group, diff --git a/man2/shmop.2 b/man2/shmop.2 index d47198925..449934df0 100644 --- a/man2/shmop.2 +++ b/man2/shmop.2 @@ -277,7 +277,9 @@ the type of the \fIshmaddr\fP argument was changed from .I "char *" into .IR "const void *" , -and the returned type of \fIshmat\fP() from +and the returned type of +.BR shmat () +from .I "char *" into .IR "void *" . diff --git a/man2/sigaltstack.2 b/man2/sigaltstack.2 index 4f727b6ae..063bf8591 100644 --- a/man2/sigaltstack.2 +++ b/man2/sigaltstack.2 @@ -195,7 +195,9 @@ For backwards compatibility, glibc also provides All new applications should be written using .BR sigaltstack (). .SH HISTORY -4.2BSD had a \fIsigstack\fP() system call. +4.2BSD had a +.BR sigstack () +system call. It used a slightly different struct, and had the major disadvantage that the caller had to know the direction of stack growth. diff --git a/man2/syslog.2 b/man2/syslog.2 index 452de0d05..24a80e203 100644 --- a/man2/syslog.2 +++ b/man2/syslog.2 @@ -87,7 +87,9 @@ Only function 3 is allowed to non-root processes. The kernel has a cyclic buffer of length LOG_BUF_LEN (4096, since 1.3.54: 8192, since 2.1.113: 16384; in recent kernels the size can be set at compile time) in which messages given as argument -to the kernel function \fIprintk\fP() are stored +to the kernel function +.BR printk () +are stored (regardless of their loglevel). The call @@ -123,7 +125,9 @@ only executes the `clear ring buffer' command. .B The loglevel .br -The kernel routine \fIprintk\fP() will only print a message on the +The kernel routine +.BR printk () +will only print a message on the console, if it has a loglevel less than the value of the variable .IR console_loglevel . This variable initially has the value DEFAULT_CONSOLE_LOGLEVEL (7), diff --git a/man2/uname.2 b/man2/uname.2 index 091a22722..e3c0c77c4 100644 --- a/man2/uname.2 +++ b/man2/uname.2 @@ -109,7 +109,8 @@ Clearly, it is a bad idea to use any of these constants; just use sizeof(...). Often 257 is chosen in order to have room for an internet hostname. .LP -There have been three Linux system calls \fIuname\fP(). +There have been three Linux system calls +.BR uname (). The first one used length 9, the second one used 65, the third one also uses 65 but adds the \fIdomainname\fP field. diff --git a/man3/clearenv.3 b/man3/clearenv.3 index 82194a58f..c985bf616 100644 --- a/man3/clearenv.3 +++ b/man3/clearenv.3 @@ -52,11 +52,14 @@ Various Unix variants (DG/UX, HP-UX, QNX, ...). POSIX.9 (bindings for FORTRAN77). POSIX.1-1996 did not accept .BR clearenv () -and \fIputenv\fP(3), +and +.BR putenv (3), but changed its mind and scheduled these functions for some later issue of this standard (cf. B.4.6.1). However, POSIX.1-2001 -only adds \fIputenv\fP(3), and rejected +only adds +.BR putenv (3), +and rejected .BR clearenv (). .SH NOTES Used in security-conscious applications. diff --git a/man3/exit.3 b/man3/exit.3 index 44bba81a6..41842c9bd 100644 --- a/man3/exit.3 +++ b/man3/exit.3 @@ -105,7 +105,9 @@ it is not interested in the exit status, but is not waiting, the exiting process turns into a "zombie" process (which is nothing but a container for the single byte representing the exit status) so that the parent can learn the exit status when -it later calls one of the \fIwait\fP(2) functions. +it later calls one of the +.BR wait (2) +functions. .LP If the implementation supports the SIGCHLD signal, this signal is sent to the parent. diff --git a/man3/flockfile.3 b/man3/flockfile.3 index 461595c10..cda59aed4 100644 --- a/man3/flockfile.3 +++ b/man3/flockfile.3 @@ -63,8 +63,13 @@ other threads from coming in between. If the reason for doing this was to achieve greater efficiency, one does the I/O with the non-locking versions of the stdio functions: with -\fIgetc_unlocked\fP(3) and \fIputc_unlocked\fP(3) instead of -\fIgetc\fP(3) and \fIputc\fP(3). +.BR getc_unlocked (3) +and +.BR putc_unlocked (3) +instead of +.BR getc (3) +and +.BR putc (3). .LP The .BR flockfile () diff --git a/man3/gethostbyname.3 b/man3/gethostbyname.3 index 48ebbbe5e..cbff63fbe 100644 --- a/man3/gethostbyname.3 +++ b/man3/gethostbyname.3 @@ -128,7 +128,9 @@ and .BR AF_INET6 . The host address argument is a pointer to a struct of a type depending on the address type, for example a \fBstruct in_addr *\fP (probably -obtained via a call to \fIinet_addr\fP()) for address type AF_INET. +obtained via a call to +.BR inet_addr (3)) +for address type AF_INET. .PP The .BR sethostent () diff --git a/man3/getutent.3 b/man3/getutent.3 index 260406d89..c37ee8754 100644 --- a/man3/getutent.3 +++ b/man3/getutent.3 @@ -192,11 +192,15 @@ main(int argc, char *argv[]) .SH "CONFORMING TO" XPG2, SVr4. .LP -In XPG2 and SVID 2 the function \fIpututline\fP() is documented -to return void, and that is what it does on many systems +In XPG2 and SVID 2 the function +.BR pututline () +is documented to return void, and that is what it does on many systems (AIX, HP-UX, Linux libc5). -HP-UX introduces a new function \fI_pututline\fP() with the prototype -given above for \fIpututline\fP() (also found in Linux libc5). +HP-UX introduces a new function +.BR _pututline () +with the prototype given above for +.BR pututline () +(also found in Linux libc5). .LP All these functions are obsolete now on non-Linux systems. POSIX.1-2001, following SUSv1, diff --git a/man3/mkfifo.3 b/man3/mkfifo.3 index 031dea4cc..8539e8050 100644 --- a/man3/mkfifo.3 +++ b/man3/mkfifo.3 @@ -59,7 +59,9 @@ See .BR fifo (7) for non-blocking handling of FIFO special files. .SH "RETURN VALUE" -On success \fImkfifo\fP() returns 0. +On success +.BR mkfifo () +returns 0. In the case of an error, \-1 is returned (in which case, \fIerrno\fP is set appropriately). .SH ERRORS diff --git a/man3/strptime.3 b/man3/strptime.3 index a4e4ec389..adf090049 100644 --- a/man3/strptime.3 +++ b/man3/strptime.3 @@ -330,7 +330,8 @@ An RFC-822/ISO 8601 standard time zone specification. .B %Z The timezone name. .LP -Similarly, because of GNU extensions to \fIstrftime\fP(3), +Similarly, because of GNU extensions to +.BR strftime (3), %k is accepted as a synonym for %H, and %l should be accepted as a synonym for %I, and %P is accepted as a synonym for %p. Finally diff --git a/man3/termios.3 b/man3/termios.3 index c291694f7..99fe02ce6 100644 --- a/man3/termios.3 +++ b/man3/termios.3 @@ -417,8 +417,9 @@ Recognized when ICANON is set, and then not passed as input. End-of-file character. More precisely: this character causes the pending tty buffer to be sent to the waiting user program without waiting for end-of-line. -If it is the first character of the line, the \fIread\fP(2) in the -user program returns 0, which signifies end-of-file. +If it is the first character of the line, the +.BR read (2) +in the user program returns 0, which signifies end-of-file. Recognized when ICANON is set, and then not passed as input. .TP .B VMIN diff --git a/man3/tmpfile.3 b/man3/tmpfile.3 index ac7d7c574..b5c6d81ab 100644 --- a/man3/tmpfile.3 +++ b/man3/tmpfile.3 @@ -77,7 +77,8 @@ SVr4, 4.3BSD, C89, C99, SUSv2, POSIX.1-2001. An error message may be written to \fIstdout\fP if the stream cannot be opened. .LP -The standard does not specify the directory that \fItmpfile\fP() +The standard does not specify the directory that +.BR tmpfile () will use. Glibc will try the path prefix \fIP_tmpdir\fP defined in \fI\fP, and if that fails the directory \fI/tmp\fP. diff --git a/man3/unlocked_stdio.3 b/man3/unlocked_stdio.3 index 777f54559..03af74fe6 100644 --- a/man3/unlocked_stdio.3 +++ b/man3/unlocked_stdio.3 @@ -73,8 +73,12 @@ of locks set by others) and hence are thread-unsafe. See .BR flockfile (3). .SH "CONFORMING TO" -The four functions \fIgetc_unlocked\fP(), \fIgetchar_unlocked\fP(), -\fIputc_unlocked\fP(), \fIputchar_unlocked\fP() are in POSIX.1-2001. +The four functions +.BR getc_unlocked (), +.BR getchar_unlocked (), +.BR putc_unlocked (), +.BR putchar_unlocked () +are in POSIX.1-2001. The nonstandard .BR *_unlocked () diff --git a/man5/resolv.conf.5 b/man5/resolv.conf.5 index b1acb7f5f..9bf5bf900 100644 --- a/man5/resolv.conf.5 +++ b/man5/resolv.conf.5 @@ -60,7 +60,7 @@ Most queries for names within this domain can use short names relative to the local domain. If no \fBdomain\fP entry is present, the domain is determined from the local host name returned by -\fIgethostname\fP(2); +.BR gethostname (2); the domain part is taken to be everything after the first `.'. Finally, if the host name does not contain a domain part, the root domain is assumed. diff --git a/man5/utmp.5 b/man5/utmp.5 index 09bcf75dc..afd39a06a 100644 --- a/man5/utmp.5 +++ b/man5/utmp.5 @@ -167,7 +167,8 @@ will mark it as \fBDEAD_PROCESS\fP on exiting and it is advised that they null \fIut_line\fP, \fIut_time\fP, \fIut_user\fP, and \fIut_host\fP as well. .PP -\fIxdm\fP(8) should not create a utmp record, because there is no +.BR xdm (8) +should not create a utmp record, because there is no assigned terminal. Letting it create one will result in errors, such as 'finger: cannot stat /dev/machine.dom'. @@ -260,8 +261,9 @@ System V has no \fIut_host\fP or \fIut_addr_v6\fP fields. Unlike various other systems, where utmp logging can be disabled by removing the file, utmp must always exist on Linux. -If you want to disable \fIwho\fP(1) then -do not make utmp world readable. +If you want to disable +.BR who (1) +then do not make utmp world readable. .PP Note that the utmp struct from libc5 has changed in libc6. Because of this, diff --git a/man7/signal.7 b/man7/signal.7 index 66061f903..bff10ec18 100644 --- a/man7/signal.7 +++ b/man7/signal.7 @@ -132,12 +132,12 @@ SIGHUP \01 Term Hangup detected on controlling terminal SIGINT \02 Term Interrupt from keyboard SIGQUIT \03 Core Quit from keyboard SIGILL \04 Core Illegal Instruction -SIGABRT \06 Core Abort signal from \fIabort\fP(3) +SIGABRT \06 Core Abort signal from \fBabort\fP(3) SIGFPE \08 Core Floating point exception SIGKILL \09 Term Kill signal SIGSEGV 11 Core Invalid memory reference SIGPIPE 13 Term Broken pipe: write to pipe with no readers -SIGALRM 14 Term Timer signal from \fIalarm\fP(2) +SIGALRM 14 Term Timer signal from \fBalarm\fP(2) SIGTERM 15 Term Termination signal SIGUSR1 30,10,16 Term User\-defined signal 1 SIGUSR2 31,12,17 Term User\-defined signal 2