Skip to contentSkip to conversation

man2/*: ffix, change '-' to '\-' for options

PATCH In review Bjarni Ingi Gislason 2 participants 2 messages Jul 1, 2020 – Jul 2, 2020 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 man2/*: ffix, change '-' to '\-' for options

Change '-' to '\-' for the prefix of names to indicate an option.

---
 man2/alloc_hugepages.2   | 2 +-
 man2/listxattr.2         | 6 +++---
 man2/mkdir.2             | 4 ++--
 man2/open.2              | 2 +-
 man2/ptrace.2            | 2 +-
 man2/sched_setaffinity.2 | 2 +-
 man2/seccomp.2           | 2 +-
 man2/stat.2              | 2 +-
 man2/unshare.2           | 2 +-
 9 files changed, 12 insertions(+), 12 deletions(-)
man2/alloc_hugepages.2 +1 -1
index 14ed0516a..a5e6cb138 100644
@@ -146,5 +146,5 @@ boot parameter.
 .\".PP
 .\" requires CONFIG_HUGETLB_PAGE (under "Processor type and features")
 .\" and CONFIG_HUGETLBFS (under "Filesystems").
-.\" mount -t hugetlbfs hugetlbfs /huge
+.\" mount \-t hugetlbfs hugetlbfs /huge
 .\" SHM_HUGETLB
man2/listxattr.2 +3 -3
index 28b55c1e1..40fcf377c 100644
@@ -203,9 +203,9 @@ and then listing the attributes with the example program.
 .in +4n
 .EX
 $ \fBtouch /tmp/foo\fP
-$ \fBsetfattr -n user.fred -v chocolate /tmp/foo\fP
-$ \fBsetfattr -n user.frieda -v bar /tmp/foo\fP
-$ \fBsetfattr -n user.empty /tmp/foo\fP
+$ \fBsetfattr \-n user.fred \-v chocolate /tmp/foo\fP
+$ \fBsetfattr \-n user.frieda \-v bar /tmp/foo\fP
+$ \fBsetfattr \-n user.empty /tmp/foo\fP
 $ \fB./listxattr /tmp/foo\fP
 user.fred: chocolate
 user.frieda: bar
man2/mkdir.2 +2 -2
index 6411080fc..e01062869 100644
@@ -66,9 +66,9 @@ The newly created directory will be owned by the effective user ID of the
 process.
 If the directory containing the file has the set-group-ID
 bit set, or if the filesystem is mounted with BSD group semantics
-.RI ( "mount -o bsdgroups"
+.RI ( "mount \-o bsdgroups"
 or, synonymously
-.IR "mount -o grpid" ),
+.IR "mount \-o grpid" ),
 the new directory will inherit the group ownership from its parent;
 otherwise it will be owned by the effective group ID of the process.
 .PP
man2/open.2 +1 -1
index eb75437ff..9ab75516c 100644
@@ -1192,7 +1192,7 @@ does not support
 refers to a regular file that is too large to be opened.
 The usual scenario here is that an application compiled
 on a 32-bit platform without
-.I -D_FILE_OFFSET_BITS=64
+.I \-D_FILE_OFFSET_BITS=64
 tried to open a file whose size exceeds
 .I (1<<31)-1
 bytes;
man2/ptrace.2 +1 -1
index 1233ee994..4d50d2f70 100644
@@ -2270,7 +2270,7 @@ to the tracee after
 returns.
 This is an ordinary signal (similar to one which can be
 generated by
-.IR "kill -TRAP" ),
+.IR "kill \-TRAP" ),
 not a special kind of ptrace-stop.
 Employing
 .B PTRACE_GETSIGINFO
man2/sched_setaffinity.2 +1 -1
index 6b54d202e..00a0ce65c 100644
@@ -324,7 +324,7 @@ system has two cores, each with two CPUs:
 .PP
 .in +4n
 .EX
-$ \fBlscpu | egrep -i 'core.*:|socket'\fP
+$ \fBlscpu | egrep \-i 'core.*:|socket'\fP
 Thread(s) per core:    2
 Core(s) per socket:    2
 Socket(s):             1
man2/seccomp.2 +1 -1
index 731e775f4..14b3b443c 100644
@@ -940,7 +940,7 @@ numbers on this architecture:
 .PP
 .in +4n
 .EX
-$ \fBuname -m\fP
+$ \fBuname \-m\fP
 x86_64
 $ \fBsyscall_nr() {
     cat /usr/src/linux/arch/x86/syscalls/syscall_64.tbl | \e
man2/stat.2 +1 -1
index a5f983b67..ad85e17d7 100644
@@ -432,7 +432,7 @@ or
 .IR blkcnt_t .
 This error can occur when, for example,
 an application compiled on a 32-bit platform without
-.I -D_FILE_OFFSET_BITS=64
+.I \-D_FILE_OFFSET_BITS=64
 calls
 .BR stat ()
 on a file whose size exceeds
man2/unshare.2 +1 -1
index 720c43ca1..4b7dbb89a 100644
@@ -474,7 +474,7 @@ new shell are in separate mount namespaces:
 .EX
 $ \fBreadlink /proc/$$/ns/mnt\fP
 mnt:[4026531840]
-$ \fBsudo ./unshare -m /bin/bash\fP
+$ \fBsudo ./unshare \-m /bin/bash\fP
 # \fBreadlink /proc/$$/ns/mnt\fP
 mnt:[4026532325]
 .EE
Signature · 1 line
2.27.0
#1 lore raw
Quoted 1 line · Bjarni Ingi Gislason

Change '-' to '\-' for the prefix of names to indicate an option.

Thanks. Patch applied.

Cheers,

Michael

Quoted 136 lines
---
 man2/alloc_hugepages.2   | 2 +-
 man2/listxattr.2         | 6 +++---
 man2/mkdir.2             | 4 ++--
 man2/open.2              | 2 +-
 man2/ptrace.2            | 2 +-
 man2/sched_setaffinity.2 | 2 +-
 man2/seccomp.2           | 2 +-
 man2/stat.2              | 2 +-
 man2/unshare.2           | 2 +-
 9 files changed, 12 insertions(+), 12 deletions(-)
man2/alloc_hugepages.2 +1 -1
index 14ed0516a..a5e6cb138 100644
@@ -146,5 +146,5 @@ boot parameter.
 .\".PP
 .\" requires CONFIG_HUGETLB_PAGE (under "Processor type and features")
 .\" and CONFIG_HUGETLBFS (under "Filesystems").
-.\" mount -t hugetlbfs hugetlbfs /huge
+.\" mount \-t hugetlbfs hugetlbfs /huge
 .\" SHM_HUGETLB
man2/listxattr.2 +3 -3
index 28b55c1e1..40fcf377c 100644
@@ -203,9 +203,9 @@ and then listing the attributes with the example program.
 .in +4n
 .EX
 $ \fBtouch /tmp/foo\fP
-$ \fBsetfattr -n user.fred -v chocolate /tmp/foo\fP
-$ \fBsetfattr -n user.frieda -v bar /tmp/foo\fP
-$ \fBsetfattr -n user.empty /tmp/foo\fP
+$ \fBsetfattr \-n user.fred \-v chocolate /tmp/foo\fP
+$ \fBsetfattr \-n user.frieda \-v bar /tmp/foo\fP
+$ \fBsetfattr \-n user.empty /tmp/foo\fP
 $ \fB./listxattr /tmp/foo\fP
 user.fred: chocolate
 user.frieda: bar
man2/mkdir.2 +2 -2
index 6411080fc..e01062869 100644
@@ -66,9 +66,9 @@ The newly created directory will be owned by the effective user ID of the
 process.
 If the directory containing the file has the set-group-ID
 bit set, or if the filesystem is mounted with BSD group semantics
-.RI ( "mount -o bsdgroups"
+.RI ( "mount \-o bsdgroups"
 or, synonymously
-.IR "mount -o grpid" ),
+.IR "mount \-o grpid" ),
 the new directory will inherit the group ownership from its parent;
 otherwise it will be owned by the effective group ID of the process.
 .PP
man2/open.2 +1 -1
index eb75437ff..9ab75516c 100644
@@ -1192,7 +1192,7 @@ does not support
 refers to a regular file that is too large to be opened.
 The usual scenario here is that an application compiled
 on a 32-bit platform without
-.I -D_FILE_OFFSET_BITS=64
+.I \-D_FILE_OFFSET_BITS=64
 tried to open a file whose size exceeds
 .I (1<<31)-1
 bytes;
man2/ptrace.2 +1 -1
index 1233ee994..4d50d2f70 100644
@@ -2270,7 +2270,7 @@ to the tracee after
 returns.
 This is an ordinary signal (similar to one which can be
 generated by
-.IR "kill -TRAP" ),
+.IR "kill \-TRAP" ),
 not a special kind of ptrace-stop.
 Employing
 .B PTRACE_GETSIGINFO
man2/sched_setaffinity.2 +1 -1
index 6b54d202e..00a0ce65c 100644
@@ -324,7 +324,7 @@ system has two cores, each with two CPUs:
 .PP
 .in +4n
 .EX
-$ \fBlscpu | egrep -i 'core.*:|socket'\fP
+$ \fBlscpu | egrep \-i 'core.*:|socket'\fP
 Thread(s) per core:    2
 Core(s) per socket:    2
 Socket(s):             1
man2/seccomp.2 +1 -1
index 731e775f4..14b3b443c 100644
@@ -940,7 +940,7 @@ numbers on this architecture:
 .PP
 .in +4n
 .EX
-$ \fBuname -m\fP
+$ \fBuname \-m\fP
 x86_64
 $ \fBsyscall_nr() {
     cat /usr/src/linux/arch/x86/syscalls/syscall_64.tbl | \e
man2/stat.2 +1 -1
index a5f983b67..ad85e17d7 100644
@@ -432,7 +432,7 @@ or
 .IR blkcnt_t .
 This error can occur when, for example,
 an application compiled on a 32-bit platform without
-.I -D_FILE_OFFSET_BITS=64
+.I \-D_FILE_OFFSET_BITS=64
 calls
 .BR stat ()
 on a file whose size exceeds
man2/unshare.2 +1 -1
index 720c43ca1..4b7dbb89a 100644
@@ -474,7 +474,7 @@ new shell are in separate mount namespaces:
 .EX
 $ \fBreadlink /proc/$$/ns/mnt\fP
 mnt:[4026531840]
-$ \fBsudo ./unshare -m /bin/bash\fP
+$ \fBsudo ./unshare \-m /bin/bash\fP
 # \fBreadlink /proc/$$/ns/mnt\fP
 mnt:[4026532325]
 .EE
Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/