Add manpage doc

This commit is contained in:
Chris Lane 2020-02-08 16:58:45 +00:00
parent 9b74e73ad3
commit a6085db0ae
No known key found for this signature in database
GPG Key ID: D13377F969CCE9C4

62
doc/multimc.1.txt Normal file
View File

@ -0,0 +1,62 @@
MULTIMC(1)
==========
:doctype: manpage
NAME
----
multimc - a launcher and instance manager for Minecraft.
SYNOPSIS
--------
*multimc* ['OPTIONS']
DESCRIPTION
-----------
MultiMC 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 MultiMC.
OPTIONS
-------
*-d, --dir*='DIRECTORY'::
Use 'DIRECTORY' as the MultiMC root.
*-l, --launch*='INSTANCE_ID'::
Launch the instance specified by 'INSTANCE_ID'.
*--alive*::
Write a small 'live.check' file after MultiMC starts.
*-h, --help*::
Display help text and exit.
*-v, --version*::
Display program version and exit.
EXIT STATUS
-----------
*0*::
Success
*1*::
Failure (syntax or usage error; configuration error; unexpected error).
BUGS
----
<https://github.com/MultiMC/MultiMC5/issues>
RESOURCES
---------
GitHub: <https://github.com/MultiMC/MultiMC5>
Main website: <https://multimc.org>
AUTHORS
-------
peterix <peterix@gmail.com>
// vim: syntax=asciidoc