Use a single-font-style macro (".B", ".I") for a single argument. Remove unneeded quotation marks ("). The output from "nroff" and "groff" is unchanged, except for 1) some punctuation marks are now printed in regular type 2) '\(en' (en-dash) is used to indicate a range of numbers or letters, instead of '-' or '\-' Signed-off-by: Bjarni Ingi Gislason <bjarniig@xxxxxxxxx> --- man7/sched.7 | 66 ++++++++++++++++++++++++------------------------ man7/sigevent.7 | 6 ++--- man7/signal.7 | 14 +++++----- man7/sock_diag.7 | 12 ++++----- man7/socket.7 | 54 +++++++++++++++++++-------------------- man7/spufs.7 | 16 ++++++------ man7/standards.7 | 2 +- man7/suffixes.7 | 8 +++--- man7/symlink.7 | 10 ++++---- 9 files changed, 94 insertions(+), 94 deletions(-) diff --git a/man7/sched.7 b/man7/sched.7 index 6ddc53bd0..da73b6e23 100644 --- a/man7/sched.7 +++ b/man7/sched.7 @@ -253,10 +253,10 @@ before which it should finish execution, and a which is the CPU time necessary for executing the job. The moment when a task wakes up because a new job has to be executed is called the -.IR "arrival time" +.I arrival time (also referred to as the request time or release time). The -.IR "start time" +.I start time is the time at which a task starts its execution. The .I "absolute deadline" @@ -291,7 +291,7 @@ usual practice is to set Runtime to something bigger than the average computation time (or worst-case execution time for hard real-time tasks), Deadline to the relative deadline, and Period to the period of the task. Thus, for -.BR SCHED_DEADLINE +.B SCHED_DEADLINE scheduling, we have: .PP .in +4n @@ -311,7 +311,7 @@ The three deadline-scheduling parameters correspond to the .IR sched_runtime , .IR sched_deadline , and -.IR sched_period +.I sched_period fields of the .I sched_attr structure; see @@ -321,7 +321,7 @@ These fields express values in nanoseconds. .\" "make sched_period the same as sched_deadline". .\" This needs to be documented. If -.IR sched_period +.I sched_period is specified as 0, then it is made the same as .IR sched_deadline . .PP @@ -363,12 +363,12 @@ Runtime divided by its Period. .PP In order to fulfill the guarantees that are made when a thread is admitted to the -.BR SCHED_DEADLINE +.B SCHED_DEADLINE policy, -.BR SCHED_DEADLINE +.B SCHED_DEADLINE threads are the highest priority (user controllable) threads in the system; if any -.BR SCHED_DEADLINE +.B SCHED_DEADLINE thread is runnable, it will preempt any thread scheduled under one of the other policies. .PP @@ -417,9 +417,9 @@ The nice value is an attribute that can be used to influence the CPU scheduler to favor or disfavor a process in scheduling decisions. It affects the scheduling of -.BR SCHED_OTHER +.B SCHED_OTHER and -.BR SCHED_BATCH +.B SCHED_BATCH (see below) processes. The nice value can be modified using .BR nice (2), @@ -441,7 +441,7 @@ Very early Linux kernels (Before Linux 2.0) had the range \-infinity..15. .\" Since kernel 1.3.43, Linux has the range \-20..19. .PP The degree to which the nice value affects the relative scheduling of -.BR SCHED_OTHER +.B SCHED_OTHER processes likewise varies across UNIX systems and across Linux kernel versions. .PP @@ -458,7 +458,7 @@ and makes high nice values (\-20) deliver most of the CPU to applications that require it (e.g., some audio applications). .PP On Linux, the -.BR RLIMIT_NICE +.B RLIMIT_NICE resource limit can be used to define a limit to which an unprivileged process's nice value can be raised; see .BR setrlimit (2) @@ -520,7 +520,7 @@ or specifying the .B SCHED_FLAG_RESET_ON_FORK flag in -.IR attr.sched_flags +.I attr.sched_flags when calling .BR sched_setattr (2). .PP @@ -532,7 +532,7 @@ and .PP The reset-on-fork feature is intended for media-playback applications, and can be used to prevent applications evading the -.BR RLIMIT_RTTIME +.B RLIMIT_RTTIME resource limit (see .BR getrlimit (2)) by creating multiple child processes. @@ -545,7 +545,7 @@ If the calling thread has a scheduling policy of or .BR SCHED_RR , the policy is reset to -.BR SCHED_OTHER +.B SCHED_OTHER in child processes. .IP * If the calling process has a negative nice value, @@ -553,7 +553,7 @@ the nice value is reset to zero in child processes. .PP After the reset-on-fork flag has been enabled, it can be reset only if the thread has the -.BR CAP_SYS_NICE +.B CAP_SYS_NICE capability. This flag is disabled in child processes created by .BR fork (2). @@ -574,7 +574,7 @@ whose policy is being changed. A thread must be privileged .RB ( CAP_SYS_NICE ) in order to set or modify a -.BR SCHED_DEADLINE +.B SCHED_DEADLINE policy. .PP Since Linux 2.6.12, the @@ -606,21 +606,21 @@ as long as the effective user ID of the thread making the change matches the real or effective user ID of the target thread. .IP * Special rules apply for the -.BR SCHED_IDLE +.B SCHED_IDLE policy. In Linux kernels before 2.6.39, an unprivileged thread operating under this policy cannot change its policy, regardless of the value of its -.BR RLIMIT_RTPRIO +.B RLIMIT_RTPRIO resource limit. In Linux kernels since 2.6.39, .\" commit c02aa73b1d18e43cfd79c2f193b225e84ca497c8 an unprivileged thread can switch to either the -.BR SCHED_BATCH +.B SCHED_BATCH or the -.BR SCHED_OTHER +.B SCHED_OTHER policy so long as its nice value falls within the range permitted by its -.BR RLIMIT_NICE +.B RLIMIT_NICE resource limit (see .BR getrlimit (2)). .PP @@ -639,7 +639,7 @@ A nonblocking infinite loop in a thread scheduled under the .BR SCHED_FIFO , .BR SCHED_RR , or -.BR SCHED_DEADLINE +.B SCHED_DEADLINE policy can potentially block all other threads from accessing the CPU forever. Prior to Linux 2.6.25, the only way of preventing a runaway real-time @@ -651,7 +651,7 @@ real-time applications that do not block or terminate as expected. Since Linux 2.6.25, there are other techniques for dealing with runaway real-time and deadline processes. One of these is to use the -.BR RLIMIT_RTTIME +.B RLIMIT_RTTIME resource limit to set a ceiling on the CPU time that a real-time process may consume. See @@ -666,7 +666,7 @@ Reserving CPU time in this fashion allows some CPU time to be allocated to (say) a root shell that can be used to kill a runaway process. Both of these files specify time values in microseconds: .TP -.IR /proc/sys/kernel/sched_rt_period_us +.I /proc/sys/kernel/sched_rt_period_us This file specifies a scheduling period that is equivalent to 100% CPU bandwidth. The value in this file can range from 1 to @@ -674,7 +674,7 @@ The value in this file can range from 1 to giving an operating range of 1 microsecond to around 35 minutes. The default value in this file is 1,000,000 (1 second). .TP -.IR /proc/sys/kernel/sched_rt_runtime_us +.I /proc/sys/kernel/sched_rt_runtime_us The value in this file specifies how much of the "period" time can be used by all real-time and deadline scheduled processes on the system. @@ -715,7 +715,7 @@ desktop performance in the face of multiprocess, CPU-intensive workloads such as building the Linux kernel with large numbers of parallel build processes (i.e., the .BR make (1) -.BR \-j +.B \-j flag). .PP This feature operates in conjunction with the @@ -725,7 +725,7 @@ On a running system, this feature is enabled or disabled via the file .IR /proc/sys/kernel/sched_autogroup_enabled ; a value of 0 disables the feature, while a value of 1 enables it. The default value in this file is 1, unless the kernel was booted with the -.IR noautogroup +.I noautogroup parameter. .PP A new autogroup is created when a new session is created via @@ -837,10 +837,10 @@ When scheduling non-real-time processes (i.e., those scheduled under the .BR SCHED_OTHER , .BR SCHED_BATCH , and -.BR SCHED_IDLE +.B SCHED_IDLE policies), the CFS scheduler employs a technique known as "group scheduling", if the kernel was configured with the -.BR CONFIG_FAIR_GROUP_SCHED +.B CONFIG_FAIR_GROUP_SCHED option (which is typical). .PP Under group scheduling, threads are scheduled in "task groups". @@ -891,8 +891,8 @@ Conversely, for two processes that are (for example) the sole CPU-bound processes in different sessions (e.g., different terminal windows, each of whose jobs are tied to different autogroups), -.IR "modifying the nice value of the process in one of the sessions" -.IR "has no effect" +.I modifying the nice value of the process in one of the sessions +.I has no effect in terms of the scheduler's decisions relative to the process in the other session. .\" More succinctly: the nice(1) command is in many cases a no-op since @@ -1004,4 +1004,4 @@ The Linux kernel source files .IR Documentation/scheduler/sched-rt-group.txt , .IR Documentation/scheduler/sched-design-CFS.txt , and -.IR Documentation/scheduler/sched-nice-design.txt +.I Documentation/scheduler/sched-nice-design.txt diff --git a/man7/sigevent.7 b/man7/sigevent.7 index 3333ddb77..406dbd6ea 100644 --- a/man7/sigevent.7 +++ b/man7/sigevent.7 @@ -72,10 +72,10 @@ The field specifies how notification is to be performed. This field can have one of the following values: .TP 8 -.BR SIGEV_NONE +.B SIGEV_NONE A "null" notification: don't do anything when the event occurs. .TP -.BR SIGEV_SIGNAL +.B SIGEV_SIGNAL Notify the process by sending the signal specified in .IR sigev_signo . .IP @@ -107,7 +107,7 @@ structure. The same information is also available if the signal is accepted using .BR sigwaitinfo (2). .TP -.BR SIGEV_THREAD +.B SIGEV_THREAD Notify the process by invoking .I sigev_notify_function "as if" it were the start function of a new thread. diff --git a/man7/signal.7 b/man7/signal.7 index 5a1bdc8c4..0d8c1a489 100644 --- a/man7/signal.7 +++ b/man7/signal.7 @@ -514,7 +514,7 @@ the call fails with the error .PP Which of these two behaviors occurs depends on the interface and whether or not the signal handler was established using the -.BR SA_RESTART +.B SA_RESTART flag (see .BR sigaction (2)). The details vary across UNIX systems; @@ -523,7 +523,7 @@ below, the details for Linux. If a blocked call to one of the following interfaces is interrupted by a signal handler, then the call is automatically restarted after the signal handler returns if the -.BR SA_RESTART +.B SA_RESTART flag was used; otherwise the call fails with the error .BR EINTR : .\" The following system calls use ERESTARTSYS, @@ -578,9 +578,9 @@ File locking interfaces: .BR flock (2) and the -.BR F_SETLKW +.B F_SETLKW and -.BR F_OFD_SETLKW +.B F_OFD_SETLKW operations of .BR fcntl (2) .IP * @@ -644,7 +644,7 @@ has been set on the socket using .BR recvfrom (2), .BR recvmmsg (2) (also with a non-NULL -.IR timeout +.I timeout argument), and .BR recvmsg (2). @@ -699,7 +699,7 @@ but gives a success return: the number of seconds remaining to sleep. .SS Interruption of system calls and library functions by stop signals On Linux, even in the absence of signal handlers, certain blocking interfaces can fail with the error -.BR EINTR +.B EINTR after the process is stopped by one of the stop signals and then resumed via .BR SIGCONT . @@ -717,7 +717,7 @@ has been set on the socket using .BR recvfrom (2), .BR recvmmsg (2) (also with a non-NULL -.IR timeout +.I timeout argument), and .BR recvmsg (2). diff --git a/man7/sock_diag.7 b/man7/sock_diag.7 index 955325982..060c630f9 100644 --- a/man7/sock_diag.7 +++ b/man7/sock_diag.7 @@ -96,7 +96,7 @@ It should be set to the appropriate constant for .B AF_INET and -.BR AF_INET6, +.B AF_INET6, and to 0 otherwise. .PP If the @@ -104,7 +104,7 @@ If the field of the .I "struct nlmsghdr" header has the -.BR NLM_F_DUMP +.B NLM_F_DUMP flag set, it means that a list of sockets is being requested; otherwise it is a query about an individual socket. .\" @@ -275,7 +275,7 @@ described below in the subsection "Socket memory information". .PP The following attributes are reported back without any specific request: .TP -.BR UNIX_DIAG_SHUTDOWN +.B UNIX_DIAG_SHUTDOWN The payload associated with this attribute is __u8 value which represents bits of .BR shutdown (2) @@ -321,7 +321,7 @@ or .TP .I udiag_state This is set to one of -.BR TCP_LISTEN +.B TCP_LISTEN or .BR TCP_ESTABLISHED . .TP @@ -589,7 +589,7 @@ This is the socket inode number. The payload associated with .B UNIX_DIAG_MEMINFO and -.BR INET_DIAG_SKMEMINFO +.B INET_DIAG_SKMEMINFO netlink attributes is an array of the following __u32 values: .TP .B SK_MEMINFO_RMEM_ALLOC @@ -633,7 +633,7 @@ sockets. .PP .B UNIX_DIAG_MEMINFO and -.BR INET_DIAG_SKMEMINFO +.B INET_DIAG_SKMEMINFO were introduced in Linux 3.6. .SH CONFORMING TO The NETLINK_SOCK_DIAG API is Linux-specific. diff --git a/man7/socket.7 b/man7/socket.7 index 478fa364c..c41c692d6 100644 --- a/man7/socket.7 +++ b/man7/socket.7 @@ -256,7 +256,7 @@ to determine the domain of a particular socket address. To allow any type of socket address to be passed to interfaces in the sockets API, the type -.IR "struct sockaddr" +.I struct sockaddr is defined. The purpose of this type is purely to allow casting of domain-specific socket address types to a "generic" type, @@ -325,7 +325,7 @@ If the value returned by the filter is greater than or equal to the packet's data length, the packet is allowed to proceed unmodified. .IP The argument for -.BR SO_ATTACH_FILTER +.B SO_ATTACH_FILTER is a .I sock_fprog structure, defined in @@ -341,11 +341,11 @@ struct sock_fprog { .in .IP The argument for -.BR SO_ATTACH_BPF +.B SO_ATTACH_BPF is a file descriptor returned by the .BR bpf (2) system call and must refer to a program of type -.BR BPF_PROG_TYPE_SOCKET_FILTER. +.B BPF_PROG_TYPE_SOCKET_FILTER. .IP These options may be set multiple times for a given socket, each time replacing the previous filter program. @@ -358,14 +358,14 @@ Both classic and extended BPF are explained in the kernel source file .TP .BR SO_ATTACH_REUSEPORT_CBPF ", " SO_ATTACH_REUSEPORT_EBPF For use with the -.BR SO_REUSEPORT +.B SO_REUSEPORT option, these options allow the user to set a classic BPF .RB ( SO_ATTACH_REUSEPORT_CBPF ) or an extended BPF .RB ( SO_ATTACH_REUSEPORT_EBPF ) program which defines how packets are assigned to the sockets in the reuseport group (that is, all sockets which have -.BR SO_REUSEPORT +.B SO_REUSEPORT set and are using the same local address to receive packets). .IP The BPF program must return an index between 0 and N\-1 representing @@ -373,7 +373,7 @@ the socket which should receive the packet (where N is the number of sockets in the group). If the BPF program returns an invalid index, socket selection will fall back to the plain -.BR SO_REUSEPORT +.B SO_REUSEPORT mechanism. .IP Sockets are numbered in the order in which they are added to the group @@ -391,13 +391,13 @@ position. These options may be set repeatedly at any time on any socket in the group to replace the current BPF program used by all sockets in the group. .IP -.BR SO_ATTACH_REUSEPORT_CBPF +.B SO_ATTACH_REUSEPORT_CBPF takes the same argument type as -.BR SO_ATTACH_FILTER +.B SO_ATTACH_FILTER and -.BR SO_ATTACH_REUSEPORT_EBPF +.B SO_ATTACH_REUSEPORT_EBPF takes the same argument type as -.BR SO_ATTACH_BPF. +.BR SO_ATTACH_BPF . .IP UDP support for this feature is available since Linux 4.5; TCP support is available since Linux 4.6. @@ -429,7 +429,7 @@ The .I optlen argument should contain the buffer size available to receive the device name and is recommended to be -.BR IFNAMSIZ +.B IFNAMSIZ bytes. The real device name length is reported back in the .I optlen @@ -463,7 +463,7 @@ capability or an effective user ID of 0. These two options, which are synonyms, may be used to remove the classic or extended BPF program attached to a socket with either -.BR SO_ATTACH_FILTER +.B SO_ATTACH_FILTER or .BR SO_ATTACH_BPF . The option value is ignored. @@ -567,26 +567,26 @@ it always lingers in the background. When set, this option will prevent changing the filters associated with the socket. These filters include any set using the socket options -.BR SO_ATTACH_FILTER, -.BR SO_ATTACH_BPF, -.BR SO_ATTACH_REUSEPORT_CBPF +.BR SO_ATTACH_FILTER , +.BR SO_ATTACH_BPF , +.B SO_ATTACH_REUSEPORT_CBPF and .BR SO_ATTACH_REUSEPORT_EPBF . .IP The typical use case is for a privileged process to set up a raw socket (an operation that requires the -.BR CAP_NET_RAW +.B CAP_NET_RAW capability), apply a restrictive filter, set the -.BR SO_LOCK_FILTER +.B SO_LOCK_FILTER option, and then either drop its privileges or pass the socket file descriptor to an unprivileged process via a UNIX domain socket. .IP Once the -.BR SO_LOCK_FILTER +.B SO_LOCK_FILTER option has been enabled, attempts to change or remove the filter attached to a socket, or to disable the -.BR SO_LOCK_FILTER +.B SO_LOCK_FILTER option will fail with the error .BR EPERM . .TP @@ -638,7 +638,7 @@ This option, which is currently supported only for sockets, sets the value of the "peek offset" for the .BR recv (2) system call when used with -.BR MSG_PEEK +.B MSG_PEEK flag. .IP When this option is set to a negative value @@ -646,7 +646,7 @@ When this option is set to a negative value traditional behavior is provided: .BR recv (2) with the -.BR MSG_PEEK +.B MSG_PEEK flag will peek data from the front of the queue. .IP When the option is set to a value greater than or equal to zero, @@ -659,7 +659,7 @@ so that a subsequent peek will return the next data in the queue. If data is removed from the front of the queue via a call to .BR recv (2) (or similar) without the -.BR MSG_PEEK +.B MSG_PEEK flag, the "peek offset" will be decreased by the number of bytes removed. In other words, receiving data without the .B MSG_PEEK @@ -670,7 +670,7 @@ retrieved had the data not been removed. .IP For datagram sockets, if the "peek offset" points to the middle of a packet, the data returned will be marked with the -.BR MSG_TRUNC +.B MSG_TRUNC flag. .IP The following example serves to illustrate the use of @@ -791,7 +791,7 @@ will be the amount of data transferred; if no data has been transferred and the timeout has been reached, then \-1 is returned with .I errno set to -.BR EAGAIN +.B EAGAIN or .BR EWOULDBLOCK , .\" in fact to EAGAIN @@ -931,7 +931,7 @@ file determines how long and .BR poll (2) will busy poll when they operate on sockets with -.BR SO_BUSY_POLL +.B SO_BUSY_POLL set and no events to report are found. .IP In both cases, @@ -1062,7 +1062,7 @@ signals when I/O becomes possible or urgent data is available. The argument is a pointer to a .IR pid_t . For further details, see the description of -.BR F_SETOWN +.B F_SETOWN in .BR fcntl (2). .TP diff --git a/man7/spufs.7 b/man7/spufs.7 index 5b02c6ba9..70966479c 100644 --- a/man7/spufs.7 +++ b/man7/spufs.7 @@ -326,13 +326,13 @@ to .BR EINVAL . Otherwise, a four-byte value is placed in the data buffer. This value is the number of elements that can be read from (for -.IR mbox_stat +.I mbox_stat and .IR ibox_stat ) or written to (for .IR wbox_stat ) the respective mailbox without blocking or returning an -.BR EAGAIN +.B EAGAIN error. .RE .TP @@ -408,7 +408,7 @@ the flag. .RE .TP -.IR /fpcr +.I /fpcr This file provides access to the Floating Point Status and Control Register (fcpr) as a binary, four-byte file. The operations on the @@ -490,17 +490,17 @@ The signal notification register will either be replaced with the input data or will be updated to the bitwise OR operation of the old value and the input data, depending on the contents of the -.IR signal1_type +.I signal1_type or -.IR signal2_type +.I signal2_type files respectively. .RE .TP .IR /signal1_type ", " /signal2_type These two files change the behavior of the -.IR signal1 +.I signal1 and -.IR signal2 +.I signal2 notification files. They contain a numeric ASCII string which is read as either "1" or "0". @@ -624,7 +624,7 @@ These files are not present on contexts that have been created with the .B SPU_CREATE_NOSCHED flag. .TP -.IR /cntl +.I /cntl This file provides access to the SPU Run Control and SPU status registers, as an ASCII string. The following operations are supported: diff --git a/man7/standards.7 b/man7/standards.7 index 6161d9a8e..499abed71 100644 --- a/man7/standards.7 +++ b/man7/standards.7 @@ -45,7 +45,7 @@ stack and the sockets API. 4.2BSD was released in 1983. .IP Earlier major BSD releases included -.IR 3BSD +.I 3BSD (1980), .I 4BSD (1980), diff --git a/man7/suffixes.7 b/man7/suffixes.7 index 0aaba137c..cc0312867 100644 --- a/man7/suffixes.7 +++ b/man7/suffixes.7 @@ -64,10 +64,10 @@ Suffix File type .S assembler source with \fBcpp\fP(1) directives .Y file compressed using yabba .Z file compressed using \fBcompress\fP(1) - .[0-\9]+gf TeX generic font files - .[0\-9]+pk TeX packed font files - .[1\-9] manual page for the corresponding section - .[1\-9][a-z] manual page for section plus subsection + .[0\(en9]+gf TeX generic font files + .[0\(en9]+pk TeX packed font files + .[1\(en9] manual page for the corresponding section + .[1\(en9][a\(enz] manual page for section plus subsection .a static object code library .ad X application default resource file .ada Ada source (may be body, spec, or combination) diff --git a/man7/symlink.7 b/man7/symlink.7 index 9f5bddd5d..da787a107 100644 --- a/man7/symlink.7 +++ b/man7/symlink.7 @@ -107,7 +107,7 @@ and can't be changed. (Note that there are some "magic" symbolic links in the .I /proc directory tree\(emfor example, the -.IR /proc/[pid]/fd/* +.I /proc/[pid]/fd/* files\(emthat have different permissions.) .\" .\" The @@ -126,11 +126,11 @@ files\(emthat have different permissions.) Using the combination of the .B O_PATH and -.BR O_NOFOLLOW +.B O_NOFOLLOW flags to .BR open (2) yields a file descriptor that can be passed as the -.IR dirfd +.I dirfd argument in system calls such as .BR fstatat (2), .BR fchownat (2), @@ -143,7 +143,7 @@ in order to operate on the symbolic link itself .PP By default (i.e., if the -.BR AT_SYMLINK_FOLLOW +.B AT_SYMLINK_FOLLOW flag is not specified), if .BR name_to_handle_at (2) is applied to a symbolic link, it yields a handle for the symbolic link @@ -500,7 +500,7 @@ the command acts a little differently. If you do not specify the .IR \-F , -.IR \-d +.I \-d or .I \-l options, -- 2.20.1