History

Karel Zak d8d54e4bfc build-sys: keep adoc files in dist_noinst_DATA * rename MANPAGES_EXTRA= to ADOCFILES_COMMON= * keep track about individual adoc files by dist_noinst_DATA= This variable is not effected by automake conditions, so the files are always distributed. Signed-off-by: Karel Zak <kzak@redhat.com>		2021-05-05 13:35:30 +02:00
..
Makemodule.am	build-sys: keep adoc files in dist_noinst_DATA	2021-05-05 13:35:30 +02:00
README.md	Asciidoc: Convert man-common/README to Markdown	2021-03-29 20:19:59 +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 misspellings	2021-04-22 20:31:05 -03: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.