From: Michael Kerrisk Date: Sat, 3 Dec 2016 20:13:59 +0000 (+0100) Subject: docs: various pages: Format pathnames as italic (.I) X-Git-Tag: v2.30-rc1~352^2~14 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=46f057ed37e06d74df3e2d4471cab935f9671edf;p=thirdparty%2Futil-linux.git docs: various pages: Format pathnames as italic (.I) In the majority of pages, pathnames are formatted as Italic, which is the norm. However, there are several cases where they are formatted as bold. This patch fixes a number of those exceptions. Signed-off-by: Michael Kerrisk --- diff --git a/disk-utils/cfdisk.8 b/disk-utils/cfdisk.8 index d6ad327fea..3a285205ab 100644 --- a/disk-utils/cfdisk.8 +++ b/disk-utils/cfdisk.8 @@ -22,7 +22,7 @@ cfdisk \- display or manipulate a disk partition table .B cfdisk is a curses-based program for partitioning any block device. The default device is -.BR /dev/sda . +.IR /dev/sda . Note that .B cfdisk diff --git a/disk-utils/fsck.8 b/disk-utils/fsck.8 index 819c69f5ba..c4a5ca1b0b 100644 --- a/disk-utils/fsck.8 +++ b/disk-utils/fsck.8 @@ -36,7 +36,7 @@ If no filesystems are specified on the command line, and the option is not specified, .B fsck will default to checking filesystems in -.B /etc/fstab +.I /etc/fstab serially. This is equivalent to the .B \-As options. @@ -160,13 +160,13 @@ They must have the format If an options specifier is present, then only filesystems which contain .I fs-option in their mount options field of -.B /etc/fstab +.I /etc/fstab will be checked. If the options specifier is prefixed by a negation operator, then only those filesystems that do not have .I fs-option in their mount options field of -.B /etc/fstab +.I /etc/fstab will be checked. .sp For example, if @@ -174,7 +174,7 @@ For example, if appears in .IR fslist , then only filesystems listed in -.B /etc/fstab +.I /etc/fstab with the .B ro option will be checked. @@ -261,7 +261,7 @@ normally does not check whether the device actually exists before calling a filesystem specific checker. Therefore non-existing devices may cause the system to enter filesystem repair mode during boot if the filesystem specific checker returns a fatal error. The -.B /etc/fstab +.I /etc/fstab mount option .B nofail may be used to have @@ -373,7 +373,7 @@ environment variable is used to find filesystem checkers. .B FSTAB_FILE This environment variable allows the system administrator to override the standard location of the -.B /etc/fstab +.I /etc/fstab file. It is also useful for developers who are testing .BR fsck . .TP diff --git a/lib/terminal-colors.d.5 b/lib/terminal-colors.d.5 index f4217a5d8d..98b6d15049 100644 --- a/lib/terminal-colors.d.5 +++ b/lib/terminal-colors.d.5 @@ -170,11 +170,11 @@ Any other use of the hash character is not interpreted as introducing a comment. .SH FILES -.B $XDG_CONFIG_HOME/terminal-colors.d +.I $XDG_CONFIG_HOME/terminal-colors.d .br -.B $HOME/.config/terminal-colors.d +.I $HOME/.config/terminal-colors.d .br -.B /etc/terminal-colors.d +.I /etc/terminal-colors.d .SH ENVIRONMENT .IP TERMINAL_COLORS_DEBUG=all diff --git a/login-utils/chfn.1 b/login-utils/chfn.1 index bf837eab68..0cb5f28b87 100644 --- a/login-utils/chfn.1 +++ b/login-utils/chfn.1 @@ -72,7 +72,7 @@ Display version information and exit. .SH CONFIG FILE ITEMS .B chfn reads the -.BR /etc\:/login.defs (5) +.IR /etc\:/login.defs (5) configuration file. Note that the configuration file could be distributed with another package (e.g. shadow-utils). The following configuration items are relevant for diff --git a/login-utils/last.1 b/login-utils/last.1 index 2b0c1e5209..ccb8895099 100644 --- a/login-utils/last.1 +++ b/login-utils/last.1 @@ -28,7 +28,7 @@ last, lastb \- show a listing of last logged in users .SH DESCRIPTION .B last searches back through the -.B /var/log/wtmp +.I /var/log/wtmp file (or the file designated by the .B \-f option) and displays a list of all users logged in (and out) since that @@ -61,7 +61,7 @@ will show a log of all the reboots since the log file was created. is the same as .BR last , except that by default it shows a log of the -.BR /var/log/btmp +.IR /var/log/btmp file, which contains all the bad login attempts. .SH OPTIONS .TP @@ -79,7 +79,7 @@ back into a hostname. Tell .B last to use a specific \fIfile\fR instead of -.BR /var/log/wtmp . +.IR /var/log/wtmp . The .B \-\-file option can be given multiple times, and all of the specified files will be diff --git a/login-utils/login.1 b/login-utils/login.1 index d74e96220c..3043e3251c 100644 --- a/login-utils/login.1 +++ b/login-utils/login.1 @@ -67,9 +67,9 @@ option is given), else it will be initialized to the terminal type on your tty. .PP Then the user's shell is started. If no shell is specified for the user in -.BR /etc\:/passwd , +.IR /etc\:/passwd , then -.B /bin\:/sh +.I /bin\:/sh is used. If there is no directory specified in .IR /etc\:/passwd , then @@ -136,7 +136,7 @@ Display version information and exit. .SH CONFIG FILE ITEMS .B login reads the -.BR /etc\:/login.defs (5) +.IR /etc\:/login.defs (5) configuration file. Note that the configuration file could be distributed with another package (e.g. shadow-utils). The following configuration items are relevant for diff --git a/login-utils/sulogin.8 b/login-utils/sulogin.8 index 9bc2effce9..fbf8bca743 100644 --- a/login-utils/sulogin.8 +++ b/login-utils/sulogin.8 @@ -38,7 +38,7 @@ If the root account is locked and --force is specified, no password is required. .B sulogin will be connected to the current terminal, or to the optional \fItty\fR device that can be specified on the command line (typically -.BR /dev/console ). +.IR /dev/console ). .PP When the user exits from the single-user shell, or presses control\-D at the prompt, the system will continue to boot. diff --git a/misc-utils/getopt.1 b/misc-utils/getopt.1 index 62fd8aa878..06e1e54d9f 100644 --- a/misc-utils/getopt.1 +++ b/misc-utils/getopt.1 @@ -416,9 +416,9 @@ if it is called with Example scripts for (ba)sh and (t)csh are provided with the .BR getopt (1) distribution, and are optionally installed in -.BR /usr/share/getopt/ +.IR /usr/share/getopt/ or -.BR /usr/share/doc/ +.IR /usr/share/doc/ in the util-linux subdirectory. .SH ENVIRONMENT .IP POSIXLY_CORRECT diff --git a/misc-utils/lsblk.8 b/misc-utils/lsblk.8 index 1450e92cac..c727351ea9 100644 --- a/misc-utils/lsblk.8 +++ b/misc-utils/lsblk.8 @@ -134,7 +134,7 @@ The .B lsblk command needs to be able to look up each block device by major:minor numbers, which is done by using -.BR /sys/dev/block . +.IR /sys/dev/block . This sysfs block directory appeared in kernel 2.6.27 (October 2008). In case of problems with a new enough kernel, check that CONFIG_SYSFS was enabled at the time of the kernel build. diff --git a/misc-utils/whereis.1 b/misc-utils/whereis.1 index 6cdec70b2e..ac2068d56d 100644 --- a/misc-utils/whereis.1 +++ b/misc-utils/whereis.1 @@ -127,12 +127,12 @@ is specified, the option will output the hard-coded paths that the command was able to find on the system. .SH EXAMPLE To find all files in -.B /usr/\:bin +.I /usr/\:bin which are not documented in -.B /usr/\:man/\:man1 +.I /usr/\:man/\:man1 or have no source in -.BR /usr/\:src : +.IR /usr/\:src : .IP .B cd /usr/bin .br diff --git a/sys-utils/fstab.5 b/sys-utils/fstab.5 index ab32383beb..30c2cd4ab4 100644 --- a/sys-utils/fstab.5 +++ b/sys-utils/fstab.5 @@ -35,7 +35,7 @@ .SH NAME fstab \- static information about the filesystems .SH SYNOPSIS -.B /etc/fstab +.I /etc/fstab .SH DESCRIPTION The file .B fstab diff --git a/sys-utils/mount.8 b/sys-utils/mount.8 index 36e7ce6500..d1ef9083f8 100644 --- a/sys-utils/mount.8 +++ b/sys-utils/mount.8 @@ -57,7 +57,7 @@ mount \- mount a filesystem .SH DESCRIPTION All files accessible in a Unix system are arranged in one big tree, the file hierarchy, rooted at -.BR / . +.IR / . These files can be spread out over several devices. The .B mount command serves to attach the filesystem found on some device @@ -143,8 +143,10 @@ unique, especially if you move, share or copy the device. Use to verify that the UUIDs are really unique in your system. The recommended setup is to use tags (e.g.\& \fBLABEL=\fIlabel\fR) rather than -.B /dev/disk/by-{label,uuid,partuuid,partlabel} -udev symlinks in the /etc/fstab file. Tags are +.I /dev/disk/by-{label,uuid,partuuid,partlabel} +udev symlinks in the +.I /etc/fstab +file. Tags are more readable, robust and portable. The .BR mount (8) command internally uses udev @@ -418,7 +420,7 @@ to the other mirror. A slave mount receives propagation from its master, but not vice versa. A private mount carries no propagation abilities. An unbindable mount is a private mount which cannot be cloned through a bind operation. The detailed semantics are documented in -.B Documentation/filesystems/sharedsubtree.txt +.I Documentation/filesystems/sharedsubtree.txt file in the kernel source tree. Supported operations are: diff --git a/sys-utils/readprofile.8 b/sys-utils/readprofile.8 index c01e3ca69c..59c930b3dd 100644 --- a/sys-utils/readprofile.8 +++ b/sys-utils/readprofile.8 @@ -11,7 +11,7 @@ This manpage documents version 2.0 of the program. The .B readprofile command uses the -.B /proc/profile +.I /proc/profile information to print ascii data on standard output. The output is organized in three columns: the first is the number of clock ticks, the second is the name of the C function in the kernel where those @@ -42,7 +42,7 @@ only the decimal number is printed. .TP \fB\-m\fR, \fB\-\-mapfile\fR \fImapfile\fR Specify a mapfile, which by default is -.BR /usr/src/linux/System.map . +.IR /usr/src/linux/System.map . You should specify the map file on cmdline if your current kernel isn't the last one you compiled, or if you keep System.map elsewhere. If the name of the map file ends with `.gz' it is decompressed on the @@ -58,10 +58,10 @@ resets the profiling buffer, and requires superuser privileges. .TP \fB\-p\fR, \fB\-\-profile\fR \fIpro-file\fR Specify a different profiling buffer, which by default is -.B /proc/profile. +.IR /proc/profile . Using a different pro-file is useful if you want to `freeze' the kernel profiling at some time and read it later. The -.B /proc/profile +.I /proc/profile file can be copied using `cat' or `cp'. There is no more support for compressed profile buffers, like in .B readprofile-1.1, @@ -70,7 +70,7 @@ because the program needs to know the size of the buffer in advance. \fB\-r\fR, \fB\-\-reset\fR Reset the profiling buffer. This can only be invoked by root, because -.B /proc/profile +.I /proc/profile is readable by everybody but writable only by the superuser. However, you can make .B readprofile @@ -124,7 +124,7 @@ Request profiling at 2kHz per CPU, and reset the profiling buffer: .LP .B readprofile only works with an 1.3.x or newer kernel, because -.B /proc/profile +.I /proc/profile changed in the step from 1.2 to 1.3 .LP This program only works with ELF kernels. The change for a.out diff --git a/sys-utils/renice.1 b/sys-utils/renice.1 index c4b6834d5c..7cd9e89096 100644 --- a/sys-utils/renice.1 +++ b/sys-utils/renice.1 @@ -100,7 +100,7 @@ else in the system wants to), 0 (the ``base'' scheduling priority), anything negative (to make things go very fast). .SH FILES .TP -.B /etc/passwd +.I /etc/passwd to map user names to user IDs .SH SEE ALSO .BR nice (1), diff --git a/sys-utils/umount.8 b/sys-utils/umount.8 index 8abfc1b676..96cfed0615 100644 --- a/sys-utils/umount.8 +++ b/sys-utils/umount.8 @@ -202,14 +202,14 @@ Note that \fI/etc/mtab\fR is currently deprecated and helper= and another userspace mount options are maintained by libmount. .SH FILES .TP -.B /etc/mtab +.I /etc/mtab table of mounted filesystems (deprecated and usually replaced by symlink to /proc/mounts) .TP -.B /etc/fstab +.I /etc/fstab table of known filesystems .TP -.B /proc/self/mountinfo +.I /proc/self/mountinfo table of mounted filesystems generated by kernel. .SH ENVIRONMENT .IP LIBMOUNT_FSTAB= diff --git a/term-utils/agetty.8 b/term-utils/agetty.8 index 3dbbb8944c..fb7f1c1766 100644 --- a/term-utils/agetty.8 +++ b/term-utils/agetty.8 @@ -405,19 +405,19 @@ This is thingol.orcan.dk (Linux i386 1.1.9) 18:29:30 .SH FILES .na .TP -.B /var/run/utmp +.I /var/run/utmp the system status file. .TP -.B /etc/issue +.I /etc/issue printed before the login prompt. .TP -.B /etc/os-release /usr/lib/os-release +.I /etc/os-release /usr/lib/os-release operating system identification data. .TP -.B /dev/console +.I /dev/console problem reports (if syslog(3) is not used). .TP -.B /etc/inittab +.I /etc/inittab \fIinit\fP(8) configuration file for SysV-style init daemon. .SH BUGS .ad