From: Mario Blättermann <mario.blaettermann@gmail.com>
Date: Mon, 29 Mar 2021 18:19:59 +0000 (+0200)
Subject: Asciidoc: Convert man-common/README to Markdown
X-Git-Tag: v2.37-rc2~51^2~6
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=7f29a25af94fe2deaddd201e9b407169a14c1aec;p=thirdparty%2Futil-linux.git

Asciidoc: Convert man-common/README to Markdown
---

diff --git a/man-common/README b/man-common/README.md
similarity index 57%
rename from man-common/README
rename to man-common/README.md
index a5bce000d6..f9a9b8daa9 100644
--- a/man-common/README
+++ b/man-common/README.md
@@ -1,16 +1,18 @@
+# Working with the Asciidoc files
+
 To get the groff version from an asciidoc man page (example for a dummy man page filename.1.adoc): 
 
-asciidoctor -b manpage \
-            -a release-version=2.37 \
-            -a adjtime_path=/etc/adjtime \
-            -a docdir=/usr/share/doc \
-            -a runstatedir=/run \
-            -D output_directory \
-            filename.1.adoc
+    asciidoctor -b manpage \
+                -a release-version=2.37 \
+                -a adjtime_path=/etc/adjtime \
+                -a docdir=/usr/share/doc \
+                -a runstatedir=/run \
+                -D output_directory \
+                filename.1.adoc
             
 To get the translated versions, add an extra option which includes translation.adoc:
 
-            -a translation
+                -a translation
             
 The "-a" options are applicable to certain man pages. However, if the mentioned
 variable is unused, they don't produce an error message.