]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
Asciidoc: Convert man-common/README to Markdown
authorMario Blättermann <mario.blaettermann@gmail.com>
Mon, 29 Mar 2021 18:19:59 +0000 (20:19 +0200)
committerMario Blättermann <mario.blaettermann@gmail.com>
Mon, 29 Mar 2021 18:19:59 +0000 (20:19 +0200)
man-common/README.md [moved from man-common/README with 57% similarity]

similarity index 57%
rename from man-common/README
rename to man-common/README.md
index a5bce000d61f18ddd87f32f2af6b274b6d046c27..f9a9b8daa90179adbf2ae9702552c602fde30ec6 100644 (file)
@@ -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.