]> git.ipfire.org Git - thirdparty/coreutils.git/commitdiff
doc: man: consistently format -X[OPTIONAL] form
authorPádraig Brady <P@draigBrady.com>
Wed, 1 Oct 2025 20:20:20 +0000 (21:20 +0100)
committerPádraig Brady <P@draigBrady.com>
Thu, 2 Oct 2025 09:14:16 +0000 (10:14 +0100)
This is significant for the date, od, and pr commands
which have options of the form -X[OPTIONAL], which change like:

  diff -r man.orig/date.1 man/date.1
  < \fB\-I[FMT]\fR, \fB\-\-iso\-8601\fR[=\fI\,FMT\/\fR]
  > \fB\-I\fR[\fI\,FMT\/\fR], \fB\-\-iso\-8601\fR[=\fI\,FMT\/\fR]

  diff -r man.orig/od.1 man/od.1
  < \fB\-w[BYTES]\fR, \fB\-\-width\fR[=\fI\,BYTES\/\fR]
  > \fB\-w\fR[\fI\,BYTES\/\fR], \fB\-\-width\fR[=\fI\,BYTES\/\fR]

* man/help2man (convert_options): Support options of the form
-X[PARAM], so that we now consistently format them (in italics).

man/help2man

index da03e14da729e762e73f8495e5337a04c88588a4..e021ff8dc50007a0165d42905b1961a05f247b7f 100755 (executable)
@@ -803,7 +803,9 @@ sub convert_option
     local $_ = '\fB' . shift;
 
     s/-/\x83/g;
-    unless (s/\[=(.*)\]$/\\fR[=\\fI$1\\fR]/)
+    unless (
+        s/\x83(\w)\[(.*)\]/\x83$1\\fR[\\fI$2\\fR]/ or  # short form [optional]
+        s/\[=(.*)\]$/\\fR[=\\fI$1\\fR]/)               # long form [optional]
     {
        s/=(.)/\\fR=\\fI$1/;
        s/ (.)/ \\fI$1/;