mirror of https://github.com/cemu-project/Cemu.git synced 2025-12-26 07:37:01 +00:00

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

1.5 KiB

Raw Blame History

% CEMU(1) Cemu | Wii U emulator % Exzap; Petergov % 2022-12-09

NAME

Cemu - Wii U emulator

SYNOPSIS

Cemu [OPTIONS...]

DESCRIPTION

Cemu is a Wii U emulator that is able to run most Wii U games and homebrew in a playable state. It's written in C/C++ and is being actively developed with new features and fixes to increase compatibility, convenience and usability.

OPTIONS

If an option has argument n, a value of 1 (or no argument) enables the option. A value of 0 disables the option.

Launch options

-g path, --game path: Path of game to launch
-m path, --mlc path: Custom mlc folder location
-f [n], --fullscreen [n]: Launch games in fullscreen mode
-u [n], --ud [n]: Render output upside-down
-a id, --account id: Persistent id of account
--force-interpreter [n]: Force interpreter CPU emulation and disable recompiler
--act-url url: URL prefix for account server
--ecs-url url: URL for ECS service
-h, --help: Display a usage message and exit
-v, --version: Display Cemu version and exit

Extractor tool

-e path, --extract path: Path to WUD or WUX file for extraction
-p path, --path path: Path of file to extract (for example meta/meta.xml)
-o path, --output path: Output path for extracted file

BUGS

To report a bug, visit https://github.com/cemu-project/Cemu/issues

1.5 KiB Raw Blame History