Merge pull request #2997 from ChrisLane/man-page

Add man page doc
This commit is contained in:
Petr Mrázek 2021-07-22 18:18:40 +02:00 committed by GitHub
commit 8ea500de68
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

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