Skip to contentSkip to conversation

man1/*: 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 man1/*: ffix, change '-' to '\-' for options

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

---
 man1/locale.1       | 8 ++++----
 man1/memusage.1     | 2 +-
 man1/memusagestat.1 | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)
man1/locale.1 +4 -4
index 587795728..5506354bd 100644
@@ -58,7 +58,7 @@ the behavior is as follows:
 .BR \-a ", " \-\-all\-locales
 Display a list of all available locales.
 The
-.B -v
+.B \-v
 option causes the
 .B LC_IDENTIFICATION
 metadata about each locale to be included in the output.
@@ -66,7 +66,7 @@ metadata about each locale to be included in the output.
 .BR \-m ", " \-\-charmaps
 Display the available charmaps (character set description files).
 To display the current character set for the locale, use
-\fBlocale -c charmap\fR.
+\fBlocale \-c charmap\fR.
 .PP
 The
 .B locale
@@ -195,8 +195,8 @@ in the shell profile file so that the custom locale will be used in the
 subsequent user sessions:
 .PP
 .EX
-$ \fBmkdir -p $HOME/.locale\fP
-$ \fBI18NPATH=./wrk/ localedef -f UTF-8 -i fi_SE $HOME/.locale/fi_SE.UTF-8\fP
+$ \fBmkdir \-p $HOME/.locale\fP
+$ \fBI18NPATH=./wrk/ localedef \-f UTF-8 \-i fi_SE $HOME/.locale/fi_SE.UTF-8\fP
 $ \fBLOCPATH=$HOME/.locale LC_ALL=fi_SE.UTF-8 date\fP
 $ \fBecho "export LOCPATH=\e$HOME/.locale" >> $HOME/.bashrc\fP
 $ \fBecho "export LANG=fi_SE.UTF-8" >> $HOME/.bashrc\fP
man1/memusage.1 +1 -1
index 9292fb8f0..ce50e6f16 100644
@@ -55,7 +55,7 @@ can also be intercepted.
 can output the collected data in textual form, or it can use
 .BR memusagestat (1)
 (see the
-.B -p
+.B \-p
 option,  below)
 to create a PNG file containing graphical representation
 of the collected data.
man1/memusagestat.1 +2 -2
index 411622446..a1c40cd86 100644
@@ -31,7 +31,7 @@ creates a PNG file containing a graphical representation of the
 memory profiling data in the file
 .IR datafile ;
 that file is generated via the
-.I -d
+.I \-d
 (or
 .IR --data )
 option of
@@ -41,7 +41,7 @@ The red line in the graph shows the heap usage (allocated memory)
 and the green line shows the stack usage.
 The x-scale is either the number of memory-handling function calls or
 (if the
-.I -t
+.I \-t
 option is specified)
 time.
 .SH OPTIONS
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.

Patch applied. (And thanks for splitting these patches into sections; it makes the patches smaller and therefore easier to review).

Cheers,

Michael

Quoted 76 lines
---
 man1/locale.1       | 8 ++++----
 man1/memusage.1     | 2 +-
 man1/memusagestat.1 | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)
man1/locale.1 +4 -4
index 587795728..5506354bd 100644
@@ -58,7 +58,7 @@ the behavior is as follows:
 .BR \-a ", " \-\-all\-locales
 Display a list of all available locales.
 The
-.B -v
+.B \-v
 option causes the
 .B LC_IDENTIFICATION
 metadata about each locale to be included in the output.
@@ -66,7 +66,7 @@ metadata about each locale to be included in the output.
 .BR \-m ", " \-\-charmaps
 Display the available charmaps (character set description files).
 To display the current character set for the locale, use
-\fBlocale -c charmap\fR.
+\fBlocale \-c charmap\fR.
 .PP
 The
 .B locale
@@ -195,8 +195,8 @@ in the shell profile file so that the custom locale will be used in the
 subsequent user sessions:
 .PP
 .EX
-$ \fBmkdir -p $HOME/.locale\fP
-$ \fBI18NPATH=./wrk/ localedef -f UTF-8 -i fi_SE $HOME/.locale/fi_SE.UTF-8\fP
+$ \fBmkdir \-p $HOME/.locale\fP
+$ \fBI18NPATH=./wrk/ localedef \-f UTF-8 \-i fi_SE $HOME/.locale/fi_SE.UTF-8\fP
 $ \fBLOCPATH=$HOME/.locale LC_ALL=fi_SE.UTF-8 date\fP
 $ \fBecho "export LOCPATH=\e$HOME/.locale" >> $HOME/.bashrc\fP
 $ \fBecho "export LANG=fi_SE.UTF-8" >> $HOME/.bashrc\fP
man1/memusage.1 +1 -1
index 9292fb8f0..ce50e6f16 100644
@@ -55,7 +55,7 @@ can also be intercepted.
 can output the collected data in textual form, or it can use
 .BR memusagestat (1)
 (see the
-.B -p
+.B \-p
 option,  below)
 to create a PNG file containing graphical representation
 of the collected data.
man1/memusagestat.1 +2 -2
index 411622446..a1c40cd86 100644
@@ -31,7 +31,7 @@ creates a PNG file containing a graphical representation of the
 memory profiling data in the file
 .IR datafile ;
 that file is generated via the
-.I -d
+.I \-d
 (or
 .IR --data )
 option of
@@ -41,7 +41,7 @@ The red line in the graph shows the heap usage (allocated memory)
 and the green line shows the stack usage.
 The x-scale is either the number of memory-handling function calls or
 (if the
-.I -t
+.I \-t
 option is specified)
 time.
 .SH OPTIONS
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/