util-linux/man-common
Milan Broz 033b5a521a Use https for project-related documentation.
Some browsers already force https use, fix links
for sites that can be easily redirected.

Signed-off-by: Milan Broz <gmazyland@gmail.com>
2022-11-05 10:43:49 +01:00
..
bugreports.adoc docs: update github URL 2021-11-03 13:58:21 +01:00
colors.adoc colors.adoc: format command name bold 2022-02-12 21:47:39 +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
help-version.adoc man pages: unify output of --help and --version 2022-02-01 20:49:24 +01:00
in-bytes.adoc docs: add man-common/in-bytes.adoc 2022-01-24 15:38:43 +01:00
Makemodule.am Add missing *.adoc files to Makemodule.am 2022-02-11 16:13:21 +01:00
manpage-stub.adoc man pages: unify output of --help and --version 2022-02-01 20:49:24 +01:00
README.md fix whitespace issue in ducumentation 2021-05-10 15:53:50 +02:00
translation.adoc Use https for project-related documentation. 2022-11-05 10:43:49 +01:00

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.