pre-emptive work on PolyMC "rebranding"

This commit is contained in:
swurl
2021-12-23 18:14:30 -05:00
committed by swirl
parent 7fa72e8cd5
commit df7f5754b6
2 changed files with 37 additions and 31 deletions

66
doc/polymc.1.txt Normal file
View File

@ -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