Cemu/dist/linux
jn64 59fa217a7b Draft manpage (pandoc Markdown)
While Markdown isn't the best fit for writing manpages,
it's the easiest for future contributions/maintenance.
However, pandoc is a heavy dependency for producing
a single manpage. Other tools [1] could be evaluated.

The only pandoc-isms are the title block [2]
(first 3 lines) which will rarely change,
and the definition lists ':' for options
which is self-explanatory.

The Markdown source is intentionally not hard wrapped.
pandoc automatically hard wraps the roff man output
(which may be further re-wrapped by manpage viewers).

To produce the manpage (outputs a file Cemu.1):

    pandoc -s -f markdown-smart -t man Cemu.1.md -o Cemu.1

Preview from Markdown without writing to file:

    pandoc -s -f markdown-smart -t man Cemu.1.md | man -l -

markdown-smart *disables* the smart typography extension
to avoid mangling '--'. [3]

[1]: https://drewdevault.com/2018/05/13/scdoc.html
[2]: https://pandoc.org/MANUAL.html#extension-pandoc_title_block
[3]: https://pandoc.org/MANUAL.html#extensions
2022-12-09 15:25:59 +08:00
..
appimage.sh AppImage: Fix resource path (#517) 2022-11-21 13:14:34 +01:00
Cemu.1.md Draft manpage (pandoc Markdown) 2022-12-09 15:25:59 +08:00
info.cemu.Cemu.desktop Fix capitalization of Cemu executable in .desktop file 2022-10-23 23:32:36 +02:00
info.cemu.Cemu.metainfo.xml Fix metainfo 2022-10-12 15:23:04 +02:00
info.cemu.Cemu.png CI: Add AppImage Build (#452) 2022-11-04 15:07:17 +01:00