criu/Documentation
Kir Kolyshkin 23374b7798 criu(8): fix for asciidoctor
Commit 0493724c8e added support for using asciidoctor
(instead of asciidoc + xmlto) to generate man pages.

For some reason, asciidoctor does not deal well with some
complex formatting that we use for options such as --external,
leading to literal ’ and ' appearing in the man page instead
of italic formatting. For example:

> --inherit-fd fd[’N']:’resource'

(here both N and resource should be in italic).

Asciidoctor documentation (asciidoctor --help syntax) tells:

> == Text Formatting
>
> .Constrained (applied at word boundaries)
> *strong importance* (aka bold)
> _stress emphasis_ (aka italic)
> `monospaced` (aka typewriter text)
> "`double`" and '`single`' typographic quotes
> +passthrough text+ (substitutions disabled)
> `+literal text+` (monospaced with substitutions disabled)
>
> .Unconstrained (applied anywhere)
> **C**reate+**R**ead+**U**pdate+**D**elete
> fan__freakin__tastic
> ``mono``culture

so I had to carefully replace *bold* with **bold** and
'italic' with __italic__ to make it all work.

Tested with both terminal and postscript output, with both
asciidoctor and asciidoc+xmlto.

TODO: figure out how to fix examples (literal multi-line text),
since asciidoctor does not display it in monospaced font (this
is only true for postscript/pdf output so low priority).

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
2020-02-04 12:39:44 -08:00
..
.gitattributes docs: Initial commit 2012-01-29 00:09:32 +04:00
.gitignore .gitignore: update to recent changes 2017-03-14 21:03:22 +03:00
asciidoc.conf docs: Initial commit 2012-01-29 00:09:32 +04:00
compel.txt Documentation: Create man page for libcompel 2019-09-07 15:59:53 +03:00
crit.txt crit: added crit manpage 2016-12-12 11:34:22 +03:00
criu.txt criu(8): fix for asciidoctor 2020-02-04 12:39:44 -08:00
custom.xsl Documentation: enable monospaced font in PS/PDF 2016-09-27 17:06:02 +03:00
HOWTO.cross-compile Documentation: Add a hint about docker build 2020-02-04 12:39:04 -08:00
Makefile doc/Makefile: don't hide xmlto stderr 2020-02-04 12:39:44 -08:00