diff options
| author | swurl <swurl@swurl.xyz> | 2021-12-23 18:14:30 -0500 |
|---|---|---|
| committer | swirl <swurl@swurl.xyz> | 2021-12-23 18:18:37 -0500 |
| commit | df7f5754b609eae6a505331b37e4f878e06e52cb (patch) | |
| tree | 10e381a22b64621c65866b4ca48a83c14cda7852 /doc/polymc.1.txt | |
| parent | 7fa72e8cd5630e7a964d3e18a9812adca83c4ef2 (diff) | |
| download | PrismLauncher-df7f5754b609eae6a505331b37e4f878e06e52cb.tar.gz PrismLauncher-df7f5754b609eae6a505331b37e4f878e06e52cb.tar.bz2 PrismLauncher-df7f5754b609eae6a505331b37e4f878e06e52cb.zip | |
pre-emptive work on PolyMC "rebranding"
Diffstat (limited to 'doc/polymc.1.txt')
| -rw-r--r-- | doc/polymc.1.txt | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/polymc.1.txt b/doc/polymc.1.txt new file mode 100644 index 00000000..9ba34662 --- /dev/null +++ b/doc/polymc.1.txt @@ -0,0 +1,66 @@ +POLYMC(1) +========== +:doctype: manpage + + +NAME +---- +polymc - a launcher and instance manager for Minecraft. + + +SYNOPSIS +-------- +*polymc* ['OPTIONS'] + + +DESCRIPTION +----------- +PolyMC is a custom launcher for Minecraft that allows you to easily manage +multiple installations of Minecraft at once. It also allows you to easily +install and remove mods by simply dragging and dropping. +Here are the current features of PolyMC. + +OPTIONS +------- +*-d, --dir*='DIRECTORY':: + Use 'DIRECTORY' as the PolyMC root. + +*-l, --launch*='INSTANCE_ID':: + Launch the instance specified by 'INSTANCE_ID'. + +*--alive*:: + Write a small 'live.check' file after PolyMC starts. + +*-h, --help*:: + Display help text and exit. + +*-v, --version*:: + Display program version and exit. +*-a, --profile*='PROFILE':: + Use the account specified by 'PROFILE' (only valid in combination with --launch). + +EXIT STATUS +----------- +*0*:: + Success + +*1*:: + Failure (syntax or usage error; configuration error; unexpected error). + +BUGS +---- +<https://github.com/PolyMC/PolyMC/issues> + +RESOURCES +--------- +GitHub: <https://github.com/PolyMC/PolyMC> + +Main website: <https://polymc.org> + +AUTHORS +------- +peterix <peterix@gmail.com> + +swurl <swurl@swurl.xyz> + +// vim: syntax=asciidoc |