mirror of
https://github.com/cemu-project/Cemu.git
synced 2024-11-29 12:34:17 +01:00
59fa217a7b
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 |
||
---|---|---|
.. | ||
appimage.sh | ||
Cemu.1.md | ||
info.cemu.Cemu.desktop | ||
info.cemu.Cemu.metainfo.xml | ||
info.cemu.Cemu.png |