From: Andre Noll <maan@tuebingen.mpg.de>
Date: Sat, 18 May 2024 19:03:39 +0000 (+0200)
Subject: Add missing backslash escapes to suite file.
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=fdbaac6aec8f3900e0c3ea9d801396150c96c45c;p=misma.git

Add missing backslash escapes to suite file.

Hyphens in command line options should be backslash-escaped to prevent
man(1) from outputting a non-ascii hyphen character in utf8 mode as
this thwarts copy+paste and searching.

Distributions generally put

	.if '\*[.T]'utf8' \{\
	.  char ' \[aq]
	.  char - \-
	.  char ^ \[ha]
	.  char ` \[ga]
	.  char ~ \[ti]
	.\}

in /usr/lib/groff/site-tmac/man.local to deal with this brain damage,
but it does not hurt to properly escape the option dashes in the roff
sections of the man file. We can't do that in the other parts of the
suite file, however, as these backslashes would also show up in the
--detailed-help output.

See the PROBLEMS file in the groff source code and

	https://lwn.net/Articles/947941/

for details.
---

diff --git a/misma.suite.m4 b/misma.suite.m4
index c4ff51a..6a95dcb 100644
--- a/misma.suite.m4
+++ b/misma.suite.m4
@@ -352,16 +352,16 @@
 	.I origin
 	is the name of the thin logical volume (i.e., the second component
 	of the argument to
-	.I --origin)
+	.I \-\-origin)
 	and
 	.I seq
 	is a sequence number.
 .SS Snapshot Replacement Strategy
 	Assume that the arguments
 	to
-	.I --create-interval
+	.I \-\-create-interval
 	and
-	.I --max-age
+	.I \-\-max-age
 	correspond to
 	.I d
 	minutes and
@@ -430,7 +430,7 @@
 	A one-shot trim operation is started by invoking the
 	.B trim
 	subcommand while periodic trims may be configured via the
-	.I --trim-interval
+	.I \-\-trim\-interval
 	option of the
 	.B run
 	subcommand.
@@ -508,7 +508,7 @@
 
 	.RS 6
 	.EX
-		.B misma \-\-origin vg/tlv \-\-create-interval 1h \-\- run \-d
+		.B misma \-\-origin vg/tlv \-\-create\-interval 1h \-\- run \-d
 	.EE
 	.RE
 	.IP \(bu 2