]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
man: make tilde and caret characters to render correctly
authorSami Kerola <kerolasa@iki.fi>
Sun, 30 Aug 2020 19:02:50 +0000 (20:02 +0100)
committerSami Kerola <kerolasa@iki.fi>
Sat, 14 Nov 2020 15:22:34 +0000 (15:22 +0000)
As mentioned in 'Generating optimal glyphs' title in the manual page
mentioned in reference:

    Where a proper caret (^) that renders well in both a terminal and PDF is
    required, use "\(ha".

    Using a naked "~" character results in a poor rendering in PDF.  Instead
    use "\(ti".

Reference: https://man7.org/linux/man-pages/man7/man-pages.7.html#STYLE_GUIDE
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
12 files changed:
disk-utils/fdisk.8
disk-utils/sfdisk.8
lib/terminal-colors.d.5
login-utils/login.1
misc-utils/blkid.8
misc-utils/hardlink.1
misc-utils/wipefs.8
sys-utils/losetup.8
sys-utils/mount.8
sys-utils/readprofile.8
text-utils/more.1
text-utils/pg.1

index b45e29abe026a565e5d0aa6996822abc516815e9..c6d334e7833d9dab34df48365daba73980f86acd 100644 (file)
@@ -195,7 +195,7 @@ The relative sizes are always aligned according to device I/O limits.  The
 +/-<size>{K,B,M,G,...} notation is recommended.
 
 For backward compatibility fdisk also accepts the suffixes KB=1000,
-MB=1000*1000, and so on for GB, TB, PB, EB, ZB and YB. These 10^N suffixes
+MB=1000*1000, and so on for GB, TB, PB, EB, ZB and YB. These 10\(haN suffixes
 are deprecated.
 
 .SH SCRIPT FILES
index 9d0f6a1853645096a2c06509c0a9f04e42538859..0c1453e8d8563b47f7409d7702081edf329e40bb 100644 (file)
@@ -237,7 +237,7 @@ the partition table.
 .TP
 .BR \-b , " \-\-backup"
 Back up the current partition table sectors before starting the partitioning.
-The default backup file name is ~/sfdisk-<device>-<offset>.bak; to use another
+The default backup file name is \(ti/sfdisk-<device>-<offset>.bak; to use another
 name see option \fB\-O\fR, \fB\-\-backup\-file\fR.
 .TP
 .BR \-\-color [ =\fIwhen ]
@@ -284,7 +284,7 @@ option \fB\-N\fR in order to be processed on one specific partition only.
 
 The optional \fIpath\fR specifies log file name. The log file contains information
 about all read/write operations on the partition data. The word "@default" as
-a \fIpath\fR forces sfdisk to use ~/sfdisk-<devname>.move for the log.  The log is
+a \fIpath\fR forces sfdisk to use \(ti/sfdisk-<devname>.move for the log.  The log is
 optional since v2.35.
 
 Note that this operation is risky and not atomic. \fBDon't forget to backup your data!\fR
@@ -587,7 +587,7 @@ This can later be restored by:
 If you want to do a full (binary) backup of all sectors where the
 partition table is stored,
 then use the \fB\-\-backup\fR option.  It writes the sectors to
-~/sfdisk-<device>-<offset>.bak files.  The default name of the backup file can
+\(ti/sfdisk-<device>-<offset>.bak files.  The default name of the backup file can
 be changed with the \fB\-\-backup\-file\fR option.  The backup files
 contain only raw data from the \fIdevice\fR.
 Note that the same concept of backup files is used by
@@ -602,7 +602,7 @@ The GPT header can later be restored by:
 .RS
 .sp
 .nf
-.B "dd  if=~/sfdisk-sda-0x00000200.bak  of=/dev/sda  \e"
+.B "dd  if=\(ti/sfdisk-sda-0x00000200.bak  of=/dev/sda  \e"
 .B "  seek=$((0x00000200))  bs=1  conv=notrunc"
 .fi
 .sp
index b1be822f6bd44b606e8f8c1b37aa36ee23abe507..4e06f8dd4ae5768d359030b8bbc91465b2da1971 100644 (file)
@@ -121,7 +121,7 @@ lb l.
 \e?    Delete (ASCII 127)
 \e_    Space
 \e\e   Backslash (\e)
-\e^    Caret (^)
+\e\(ha Caret (\(ha)
 \e#    Hash mark (#)
 .TE
 .RE
index be770d19b0525f77b6aeec0dfd730f2c23e71a34..5db19d7a72b45bac21d5589f6b022b0834d7bcc2 100644 (file)
@@ -285,7 +285,7 @@ if the file exists in the user\'s home directory.
 The default is to check
 .I /etc\:/hushlogins
 and if it does not exist then
-.I ~/.hushlogin
+.I \(ti/.hushlogin
 .PP
 If the
 .B HUSHLOGIN_FILE
index 57a3b754f2f7341be429375c5bf8f7b5313a1342..82417521a05186387e50818093a682690a6c7870 100644 (file)
@@ -112,7 +112,7 @@ devices previously scanned but not necessarily available at this time), specify
 .TP
 \fB\-d\fR, \fB\-\-no\-encoding\fR
 Don't encode non-printing characters.  The non-printing characters are encoded
-by ^ and M- notation by default.  Note that the \fB\-\-output udev\fR output format uses
+by \(ha and M- notation by default.  Note that the \fB\-\-output udev\fR output format uses
 a different encoding which cannot be disabled.
 .TP
 \fB\-D\fR, \fB\-\-no\-part\-details\fR
@@ -219,7 +219,7 @@ This output format is \fBDEPRECATED\fR.
 print key=value pairs for easy import into the environment; this output format
 is automatically enabled when I/O Limits (\fB\-\-info\fR option) are requested.
 
-The non-printing characters are encoded by ^ and M- notation and all
+The non-printing characters are encoded by \(ha and M- notation and all
 potentially unsafe characters are escaped.
 .RE
 .TP
index de26d34b74fb1cf9e10b903583a7fba5c3b9c6cd..21cc7e8c4a80cc2e55b3d39d18d0a660f7d5d7e5 100644 (file)
@@ -58,7 +58,7 @@ Historically \fBhardlink\fR silently excluded any names beginning with
 ".in.", as well as any names beginning with "." followed by exactly 6
 other characters. That prior behavior can be achieved by specifying
 .br
-\-x '^(\\.in\\.|\\.[^.]{6}$)'
+\-x '\(ha(\\.in\\.|\\.[\(ha.]{6}$)'
 .SH AUTHORS
 \fBhardlink\fR was written by Jakub Jelinek <jakub@redhat.com> and later modified by
 Ruediger Meier <ruediger.meier@ga-group.nl> and Karel Zak <kzak@redhat.com> for util-linux.
index cf45fe379477a3ea2de20b5a4c70c3ea75c6034e..9de6f9450e1c48c919afe73c5ec459fc84559da2 100644 (file)
@@ -138,10 +138,10 @@ Prints information about sda and all partitions on sda.
 .TP
 .B wipefs \-\-all \-\-backup /dev/sdb
 Erases all signatures from the device /dev/sdb and creates a signature backup
-file ~/wipefs-sdb-<offset>.bak for each signature.
+file \(ti/wipefs-sdb-<offset>.bak for each signature.
 .TP
-.B dd if=~/wipefs-sdb-0x00000438.bak of=/dev/sdb seek=$((0x00000438)) bs=1 conv=notrunc
-Restores an ext2 signature from the backup file  ~/wipefs-sdb-0x00000438.bak.
+.B dd if=\(ti/wipefs-sdb-0x00000438.bak of=/dev/sdb seek=$((0x00000438)) bs=1 conv=notrunc
+Restores an ext2 signature from the backup file \(ti/wipefs-sdb-0x00000438.bak.
 .SH AUTHORS
 Karel Zak <kzak@redhat.com>
 .SH SEE ALSO
index 3d03e513f60a2b2b47c26de272e4bb0b30de5235..cee17f19e4c91ae89730c2ccb86f50e210be9681 100644 (file)
@@ -205,8 +205,8 @@ loop control device
 The following commands can be used as an example of using the loop device.
 .nf
 .IP
-# dd if=/dev/zero of=~/file.img bs=1024k count=10
-# losetup \-\-find \-\-show ~/file.img
+# dd if=/dev/zero of=\(ti/file.img bs=1024k count=10
+# losetup \-\-find \-\-show \(ti/file.img
 /dev/loop0
 # mkfs \-t ext2 /dev/loop0
 # mount /dev/loop0 /mnt
index d5fa55f43b68ce636e114315370ed38f7ca6cf40..282a9cbbe472d65dce3c4485c7223e48f9a5fb23 100644 (file)
@@ -1716,7 +1716,7 @@ Other users can change timestamp.
 .PP
 The default is set from `dmask' option. (If the directory is writable,
 .BR utime (2)
-is also allowed.  I.e.\& \s+3~\s0dmask & 022)
+is also allowed.  I.e.\& \s+3\(ti\s0dmask & 022)
 
 Normally
 .BR utime (2)
@@ -2512,7 +2512,7 @@ This option is obsolete.
 .B nonumtail
 First try to make a short name without sequence number,
 before trying
-.IR name\s+3~\s0num.ext .
+.IR name\s+3\(ti\s0num.ext .
 .TP
 .B utf8
 UTF8 is the filesystem safe 8-bit encoding of Unicode that is used by the
@@ -2789,7 +2789,7 @@ libmount private runtime directory
 table of mounted filesystems or symlink to
 .I /proc/mounts
 .TP
-.I /etc/mtab\s+3~\s0
+.I /etc/mtab\s+3\(ti\s0
 lock file (unused on systems with
 .I mtab
 symlink)
index b987abb7fb98e069da217a11ed8ddce46d91ff41..b3dc94a50f50ec54549cbff927caab0d28a23d25 100644 (file)
@@ -136,7 +136,7 @@ Look at all the kernel information, with ram addresses:
 .fi
 Browse a `frozen' profile buffer for a non current kernel:
 .nf
-   readprofile \-p ~/profile.freeze \-m /zImage.map.gz
+   readprofile \-p \(ti/profile.freeze \-m /zImage.map.gz
 
 .fi
 Request profiling at 2kHz per CPU, and reset the profiling buffer:
index 046c2c4c6685dc891e5d328aa14c30e7566c4de4..066adf489f9b7e0df1cf435b8ce575bc182c4177 100644 (file)
@@ -63,7 +63,7 @@ the bell when an illegal key is pressed.
 .TP
 .BR \-l , " \-\-logical"
 Do not pause after any line containing a
-.B \&^L
+.B \&\(haL
 (form feed).
 .TP
 .BR \-f , " \-\-no\-pause"
@@ -122,7 +122,7 @@ are based on
 .BR vi (1).
 Some commands may be preceded by a decimal number, called k in the
 descriptions below.  In the following descriptions,
-.B ^X
+.B \(haX
 means
 .BR control-X .
 .PP
@@ -143,7 +143,7 @@ becomes new default.
 .B RETURN
 Display next k lines of text.  Defaults to 1.  Argument becomes new default.
 .TP
-.BR d \ or \ \&^D
+.BR d \ or \ \&\(haD
 Scroll k lines.  Default is current scroll size, initially 11.  Argument
 becomes new default.
 .TP
@@ -156,7 +156,7 @@ Skip forward k lines of text.  Defaults to 1.
 .B f
 Skip forward k screenfuls of text.  Defaults to 1.
 .TP
-.BR b \ or \ \&^B
+.BR b \ or \ \&\(haB
 Skip backwards k screenfuls of text.  Defaults to 1.  Only works with files,
 not pipes.
 .TP
@@ -194,7 +194,7 @@ nor
 .B EDITOR
 is defined.
 .TP
-.B \&^L
+.B \&(haL
 Redraw screen.
 .TP
 .B :n
index 1200ab81a0c2593c3c2f99e770a47ab3d6d0e2a9..529cbbc8a5f6fc2fd6f3775fccd476a2a5e18549 100644 (file)
@@ -106,7 +106,7 @@ otherwise relative to the beginning.
 .IB i <Enter>
 Display the next or the indicated page.
 .TP
-\fIi\fR\fBd\fR or \fB^D\fR
+\fIi\fR\fBd\fR or \fB(haD\fR
 Display the next halfpage.  If
 .I i
 is given, it is always interpreted relative to the current position.
@@ -127,7 +127,7 @@ except that
 .I i
 becomes the new page size.
 .TP
-.BR . " or " ^L
+.BR . " or " (haL
 Redraw the screen.
 .TP
 .B $
@@ -143,7 +143,7 @@ No wrap-around is performed.
 .I i
 must be a positive number.
 .TP
-\fIi\fR\fB?\fR\fIpattern\fR\fB?\fR or \fIi\fR\fB^\fR\fIpattern\fR\fB^\fR
+\fIi\fR\fB?\fR\fIpattern\fR\fB?\fR or \fIi\fR\fB(ha\fR\fIpattern\fR\fB(ha\fR
 Search backward until the first or the \fIi\fR-th
 occurrence of the Basic Regular Expression
 .I pattern