From 59fa217a7b7ec41aadd10e3128bbdabf54904b94 Mon Sep 17 00:00:00 2001 From: jn64 <23169302+jn64@users.noreply.github.com> Date: Fri, 9 Dec 2022 14:30:09 +0800 Subject: [PATCH 1/2] 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 --- dist/linux/Cemu.1.md | 85 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 dist/linux/Cemu.1.md diff --git a/dist/linux/Cemu.1.md b/dist/linux/Cemu.1.md new file mode 100644 index 000000000..08bf69fc2 --- /dev/null +++ b/dist/linux/Cemu.1.md @@ -0,0 +1,85 @@ +% 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_ + +# SEE ALSO + +Project homepage: + +_https://github.com/cemu-project/Cemu_ From 528fc53718d28a50db3377fcd246cb5fdd52c253 Mon Sep 17 00:00:00 2001 From: jn64 <23169302+jn64@users.noreply.github.com> Date: Fri, 9 Dec 2022 14:49:58 +0800 Subject: [PATCH 2/2] manpage sample output The roff manpage produced by pandoc is included in this commit, as well as a plaintext preview of what it would look like when viewed with 'man' in a terminal of 80 width. --- dist/linux/Cemu.1 | 73 +++++++++++++++++++++++++++++++++++++++++++ dist/linux/Cemu.1.txt | 71 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 144 insertions(+) create mode 100644 dist/linux/Cemu.1 create mode 100644 dist/linux/Cemu.1.txt diff --git a/dist/linux/Cemu.1 b/dist/linux/Cemu.1 new file mode 100644 index 000000000..110ead228 --- /dev/null +++ b/dist/linux/Cemu.1 @@ -0,0 +1,73 @@ +.\" Automatically generated by Pandoc 2.14.0.3 +.\" +.TH "CEMU" "1" "2022-12-09" "Cemu" "Wii U emulator" +.hy +.SH NAME +.PP +Cemu - Wii U emulator +.SH SYNOPSIS +.PP +\f[B]Cemu\f[R] [\f[I]OPTIONS\f[R]...] +.SH DESCRIPTION +.PP +\f[B]Cemu\f[R] is a Wii U emulator that is able to run most Wii U games +and homebrew in a playable state. +It\[aq]s written in C/C++ and is being actively developed with new +features and fixes to increase compatibility, convenience and usability. +.SH OPTIONS +.PP +If an option has argument \f[I]n\f[R], a value of 1 (or no argument) +enables the option. +A value of 0 disables the option. +.SS Launch options +.TP +\f[B]-g\f[R] \f[I]path\f[R], \f[B]--game\f[R] \f[I]path\f[R] +Path of game to launch +.TP +\f[B]-m\f[R] \f[I]path\f[R], \f[B]--mlc\f[R] \f[I]path\f[R] +Custom mlc folder location +.TP +\f[B]-f\f[R] [\f[I]n\f[R]], \f[B]--fullscreen\f[R] [\f[I]n\f[R]] +Launch games in fullscreen mode +.TP +\f[B]-u\f[R] [\f[I]n\f[R]], \f[B]--ud\f[R] [\f[I]n\f[R]] +Render output upside-down +.TP +\f[B]-a\f[R] \f[I]id\f[R], \f[B]--account\f[R] \f[I]id\f[R] +Persistent id of account +.TP +\f[B]--force-interpreter\f[R] [\f[I]n\f[R]] +Force interpreter CPU emulation and disable recompiler +.TP +\f[B]--act-url\f[R] \f[I]url\f[R] +URL prefix for account server +.TP +\f[B]--ecs-url\f[R] \f[I]url\f[R] +URL for ECS service +.TP +\f[B]-h\f[R], \f[B]--help\f[R] +Display a usage message and exit +.TP +\f[B]-v\f[R], \f[B]--version\f[R] +Display Cemu version and exit +.SS Extractor tool +.TP +\f[B]-e\f[R] \f[I]path\f[R], \f[B]--extract\f[R] \f[I]path\f[R] +Path to WUD or WUX file for extraction +.TP +\f[B]-p\f[R] \f[I]path\f[R], \f[B]--path\f[R] \f[I]path\f[R] +Path of file to extract (for example meta/meta.xml) +.TP +\f[B]-o\f[R] \f[I]path\f[R], \f[B]--output\f[R] \f[I]path\f[R] +Output path for extracted file +.SH BUGS +.PP +To report a bug, visit +\f[I]https://github.com/cemu-project/Cemu/issues\f[R] +.SH SEE ALSO +.PP +Project homepage: +.PP +\f[I]https://github.com/cemu-project/Cemu\f[R] +.SH AUTHORS +Exzap; Petergov. diff --git a/dist/linux/Cemu.1.txt b/dist/linux/Cemu.1.txt new file mode 100644 index 000000000..129b31383 --- /dev/null +++ b/dist/linux/Cemu.1.txt @@ -0,0 +1,71 @@ +CEMU(1) Wii U emulator CEMU(1) + +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 home‐ + brew in a playable state. It's written in C/C++ and is being actively + developed with new features and fixes to increase compatibility, conve‐ + nience 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 + +SEE ALSO + Project homepage: + + https://github.com/cemu-project/Cemu + +AUTHORS + Exzap; Petergov. + +Cemu 2022-12-09 CEMU(1)