Skip to content

Commit 1770207

Browse files
committed
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
1 parent 5a143c7 commit 1770207

File tree

1 file changed

+85
-0
lines changed

1 file changed

+85
-0
lines changed

dist/linux/Cemu.1.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
% CEMU(1) Cemu | Wii U emulator
2+
% Exzap; Petergov
3+
% 2022-12-09
4+
5+
# NAME
6+
7+
Cemu - Wii U emulator
8+
9+
# SYNOPSIS
10+
11+
**Cemu** [_OPTIONS_...]
12+
13+
# DESCRIPTION
14+
15+
**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.
16+
17+
# OPTIONS
18+
19+
If an option has argument _n_, a value of 1 (or no argument) enables the option. A value of 0 disables the option.
20+
21+
## Launch options
22+
23+
**-g** _path_, **--game** _path_
24+
25+
: Path of game to launch
26+
27+
**-m** _path_, **--mlc** _path_
28+
29+
: Custom mlc folder location
30+
31+
**-f** [_n_], **--fullscreen**[=_n_]
32+
33+
: Launch games in fullscreen mode
34+
35+
**-u** [_n_], **--ud**[=_n_]
36+
37+
: Render output upside-down
38+
39+
**-a** [_id_], **--account**[=_id_]
40+
41+
: Persistent id of account
42+
43+
**--force-interpreter**[=_n_]
44+
45+
: Force interpreter CPU emulation and disable recompiler
46+
47+
**--act-url**[=_url_]
48+
49+
: URL prefix for account server
50+
51+
**--ecs-url**[=_url_]
52+
53+
: URL for ECS service
54+
55+
**-h**, **--help**
56+
57+
: Display a usage message and exit
58+
59+
**-v**, **--version**
60+
61+
: Display Cemu version and exit
62+
63+
## Extractor tool
64+
65+
**-e** [_path_], **--extract**[=_path_]
66+
67+
: Path to WUD or WUX file for extraction
68+
69+
**-p** [_path_], **--path**[=_path_]
70+
71+
: Path of file to extract (for example meta/meta.xml)
72+
73+
**-o** [_path_], **--output**[=_path_]
74+
75+
: Output path for extracted file
76+
77+
# BUGS
78+
79+
To report a bug, visit _https://github.com/cemu-project/Cemu/issues_
80+
81+
# SEE ALSO
82+
83+
Project homepage:
84+
85+
_https://github.com/cemu-project/Cemu_

0 commit comments

Comments
 (0)