doc: port man pages to doclifter

Problem reported by Eric S. Raymond (Bug#31803).
* man/test.x: Add SYNOPSIS section, since help2man
understandably gets confused by the square brackets.
* src/ln.c (usage): Omit parenthetical "(Nth form)" in usage,
as it confuses doclifter.

diff --git a/man/test.x b/man/test.x
index 8d5bcff5267c9afd058bb2aa1c1183bac5dc21a6..a7aaf2c828c9557daad218a24912c35837283715 100644 (file)
--- a/man/test.x
+++ b/man/test.x
@@ -1,4 +1,19 @@
 [NAME]
 test \- check file types and compare values
+[SYNOPSIS]
+.B test
+.I EXPRESSION
+.br
+.B test
+.br
+.\" Quote the square brackets to help doclifter (Bug#31803).
+.B "["
+.I EXPRESSION
+.B "]"
+.br
+.B "[ ]"
+.br
+.B "["
+.I OPTION
 [DESCRIPTION]
 .\" Add any additional description here

diff --git a/src/ln.c b/src/ln.c
index 604493bfc499189ca12224c4bb562cc69b796cb9..7bbd42f71b117e379357703383c8c1fb9917b550 100644 (file)
--- a/src/ln.c
+++ b/src/ln.c
@@ -376,10 +376,10 @@ usage (int status)
   else
     {
       printf (_("\
-Usage: %s [OPTION]... [-T] TARGET LINK_NAME   (1st form)\n\
-  or:  %s [OPTION]... TARGET                  (2nd form)\n\
-  or:  %s [OPTION]... TARGET... DIRECTORY     (3rd form)\n\
-  or:  %s [OPTION]... -t DIRECTORY TARGET...  (4th form)\n\
+Usage: %s [OPTION]... [-T] TARGET LINK_NAME\n\
+  or:  %s [OPTION]... TARGET\n\
+  or:  %s [OPTION]... TARGET... DIRECTORY\n\
+  or:  %s [OPTION]... -t DIRECTORY TARGET...\n\
 "),
               program_name, program_name, program_name, program_name);
       fputs (_("\