summaryrefslogtreecommitdiff
path: root/meshmc/doc
diff options
context:
space:
mode:
Diffstat (limited to 'meshmc/doc')
-rw-r--r--meshmc/doc/meshmc.1.txt64
1 files changed, 64 insertions, 0 deletions
diff --git a/meshmc/doc/meshmc.1.txt b/meshmc/doc/meshmc.1.txt
new file mode 100644
index 0000000000..eca32ed1de
--- /dev/null
+++ b/meshmc/doc/meshmc.1.txt
@@ -0,0 +1,64 @@
+MESHMC(1)
+==========
+:doctype: manpage
+
+
+NAME
+----
+meshmc - a launcher and instance manager for Minecraft.
+
+
+SYNOPSIS
+--------
+*meshmc* ['OPTIONS']
+
+
+DESCRIPTION
+-----------
+MeshMC 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 MeshMC.
+
+OPTIONS
+-------
+*-d, --dir*='DIRECTORY'::
+ Use 'DIRECTORY' as the MeshMC root.
+
+*-l, --launch*='INSTANCE_ID'::
+ Launch the instance specified by 'INSTANCE_ID'.
+
+*--alive*::
+ Write a small 'live.check' file after MeshMC 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/Project-Tick/MeshMC/issues>
+
+RESOURCES
+---------
+GitHub: <https://github.com/Project-Tick/MeshMC>
+
+Main website: <https://projecttick.org>
+
+AUTHORS
+-------
+peterix <peterix@gmail.com>
+
+// vim: syntax=asciidoc