Hyphens and Other Manpage Typography, 4/4: literal ASCII hyphens.

From: Peter Samuelson <peter@p12n.org>

nroff formats "-" as the very short hyphen used for hyphenated terms
and for splitting a word across two lines.  When you want a literal
ASCII "-", like for typing on a command line, you're supposed to use
"\-" instead.

Yeah, it sounds pedantic, but it actually makes a difference.  With
modern Unicode-capable terminals, "man" actually renders these with
different characters, so if you try to search for "--create" in your
favorite pager, you won't find it unless the nroff source says
"\-\-create".  This discrepancy doesn't generally show up with
non-Unicode terminals.

Signed-Off-By: Peter Samuelson <peter@p12n.org>

1 files changed, 20 insertions, 20 deletions

diff --git a/mdadm.conf.5 b/mdadm.conf.5
index b51dc698..5961da7a 100644
--- a/mdadm.conf.5
+++ b/mdadm.conf.5
@@ -105,7 +105,7 @@ when the array was created.  This must match the name stored in the
 superblock on a device for that device to be included in the array.
 Not all superblock formats support names.
 .TP
-.B super-minor=
+.B super\-minor=
 The value is an integer which indicates the minor number that was
 stored in the superblock when the array was created. When an array is
 created as /dev/mdX, then the minor number X is stored.
@@ -121,33 +121,33 @@ listed there must also be listed on a DEVICE line.
 The value is a raid level.  This is not normally used to
 identify an array, but is supported so that the output of
 
-.B "mdadm --examine --scan"
+.B "mdadm \-\-examine \-\-scan"
 
 can be use directly in the configuration file.
 .TP
-.B num-devices=
+.B num\-devices=
 The value is the number of devices in a complete active array.  As with
 .B level=
 this is mainly for compatibility with the output of
 
-.BR "mdadm --examine --scan" .
+.BR "mdadm \-\-examine \-\-scan" .
 
 .TP
 .B spares=
 The value is a number of spare devices to expect the array to have.
-.B mdadm --monitor
+.B mdadm \-\-monitor
 will report an array if it is found to have fewer than this number of
 spares when
-.B --monitor
+.B \-\-monitor
 starts or when
-.B --oneshot
+.B \-\-oneshot
 is used.
 
 .TP
-.B spare-group=
+.B spare\-group=
 The value is a textual name for a group of arrays.  All arrays with
 the same
-.B spare-group
+.B spare\-group
 name are considered to be part of the same group.  The significance of
 a group of arrays is that
 .B mdadm
@@ -179,15 +179,15 @@ found.  When assembling the array,
 will provide this file to the
 .B md
 driver as the bitmap file.  This has the same function as the
-.B --bitmap-file
+.B \-\-bitmap\-file
 option to
-.BR --assemble .
+.BR \-\-assemble .
 
 .TP
 .B metadata=
 Specify the metadata format that the array has.  This is mainly
 recognised for comparability with the output of
-.BR "mdadm -Es" .
+.BR "mdadm \-Es" .
 
 .RE
 
@@ -199,9 +199,9 @@ line gives an E-mail address that alerts should be
 sent to when
 .M mdadm
 is running in
-.B --monitor
+.B \-\-monitor
 mode (and was given the
-.B --scan
+.B \-\-scan
 option).  There should only be one
 .B MAILADDR
 line and it should have only one address.
@@ -226,7 +226,7 @@ commandline.  It is only settable via the config file.
 The
 .B program
 line gives the name of a program to be run when
-.B "mdadm --monitor"
+.B "mdadm \-\-monitor"
 detects potentially interesting events on any of the arrays that it
 is monitoring.  This program gets run with two or three arguments, they
 being the Event, the md device, and possibly the related component
@@ -259,7 +259,7 @@ of 0600.
 .TP
 .B auto=
 This corresponds to the
-.B --auto
+.B \-\-auto
 flag to mdadm.  Give
 .BR yes ,
 .BR md ,
@@ -315,11 +315,11 @@ ARRAY /dev/md2 devices=/dev/hda1,/dev/hdb1
 .br
 ARRAY /dev/md4 uuid=b23f3c6d:aec43a9f:fd65db85:369432df
 .br
-           spare-group=group1
+           spare\-group=group1
 .br
 ARRAY /dev/md5 uuid=19464854:03f71b1b:e0df2edd:246cc977
 .br
-           spare-group=group1
+           spare\-group=group1
 .br
 # /dev/md/home is created if need to be a partitionable md array
 .br
@@ -331,9 +331,9 @@ ARRAY /dev/md/home UUID=9187a482:5dde19d9:eea3cc4a:d646ab8b
 
 MAILADDR root@mydomain.tld
 .br
-PROGRAM /usr/sbin/handle-mdadm-events
+PROGRAM /usr/sbin/handle\-mdadm\-events
 .br
-CREATE group=system mode=0640 auto=part-8
+CREATE group=system mode=0640 auto=part\-8
 .br
 HOMEHOST <system>