aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPetr Mrázek <peterix@users.noreply.github.com>2021-07-22 18:18:40 +0200
committerGitHub <noreply@github.com>2021-07-22 18:18:40 +0200
commit8ea500de68fa184ab1198f7a68c53987840014c3 (patch)
tree64295cd736bbec068166db7aaf1977890c48d690 /doc
parent9e9281f06ee212fd037dc309084203f0d06f234e (diff)
parenta6085db0aea69bc4379f1b47587f2ea18279d114 (diff)
downloadPrismLauncher-8ea500de68fa184ab1198f7a68c53987840014c3.tar.gz
PrismLauncher-8ea500de68fa184ab1198f7a68c53987840014c3.tar.bz2
PrismLauncher-8ea500de68fa184ab1198f7a68c53987840014c3.zip
Merge pull request #2997 from ChrisLane/man-page
Add man page doc
Diffstat (limited to 'doc')
-rw-r--r--doc/multimc.1.txt62
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/multimc.1.txt b/doc/multimc.1.txt
new file mode 100644
index 00000000..c2d93880
--- /dev/null
+++ b/doc/multimc.1.txt
@@ -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