util-linux/man-common
Christian Hesse e08e3d587c fix whitespace issue in ducumentation
This removes trailing whitespaces and fixes minor issues.
2021-05-10 15:53:50 +02:00
..
Makemodule.am build-sys: keep adoc files in dist_noinst_DATA 2021-05-05 13:35:30 +02:00
README.md fix whitespace issue in ducumentation 2021-05-10 15:53:50 +02:00
bugreports.adoc Add asciidoc man pages and some include files 2021-03-11 18:38:46 +01:00
footer-config.adoc Add asciidoc man pages and some include files 2021-03-11 18:38:46 +01:00
footer-lib.adoc Add asciidoc man pages and some include files 2021-03-11 18:38:46 +01:00
footer.adoc Add asciidoc man pages and some include files 2021-03-11 18:38:46 +01:00
manpage-stub.adoc fix whitespace issue in ducumentation 2021-05-10 15:53:50 +02:00
translation.adoc Add asciidoc man pages and some include files 2021-03-11 18:38:46 +01:00

README.md

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

To get the translated versions, add an extra option which includes translation.adoc:

            -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.

The footers of the asciidoc files already contain relative paths to the files in man-common.