summaryrefslogtreecommitdiff
path: root/meshmc/branding/meshmc.6.scd.in
diff options
context:
space:
mode:
Diffstat (limited to 'meshmc/branding/meshmc.6.scd.in')
-rw-r--r--meshmc/branding/meshmc.6.scd.in82
1 files changed, 82 insertions, 0 deletions
diff --git a/meshmc/branding/meshmc.6.scd.in b/meshmc/branding/meshmc.6.scd.in
new file mode 100644
index 0000000000..1a3d63898e
--- /dev/null
+++ b/meshmc/branding/meshmc.6.scd.in
@@ -0,0 +1,82 @@
+@MeshMC_AppBinaryName@(6)
+
+
+# NAME
+
+@MeshMC_AppBinaryName@ - a launcher and instance manager for Minecraft.
+
+
+# SYNOPSIS
+
+*@MeshMC_AppBinaryName@* [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.
+
+*--show*=INSTANCE_ID
+ Show the configuration window of 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).
+
+# ENVIRONMENT
+
+The behavior of the launcher can be customized by the following environment
+variables, besides other common Qt variables:
+
+*QT_LOGGING_RULES*
+ Specifies which logging categories are shown in the logs. One can
+ enable/disable multiple categories by separating them with a semicolon (;).
+
+ The specific syntax, and alternatives to this setting, can be found at
+ https://doc.qt.io/qt-6/qloggingcategory.html#configuring-categories.
+
+*QT_MESSAGE_PATTERN*
+ Specifies the format in which the console output will be shown.
+
+ Available options, as well as syntax, can be viewed at
+ https://doc.qt.io/qt-6/qtglobal.html#qSetMessagePattern.
+
+# EXIT STATUS
+
+*0*
+ Success
+
+*1*
+ Failure (syntax or usage error; configuration error; unexpected error).
+
+# BUGS
+
+@MeshMC_BUG_TRACKER_URL@
+
+# RESOURCES
+
+GitHub: @MeshMC_Git@
+
+Main website: https://@MeshMC_Domain@
+
+# AUTHORS
+
+@MeshMC_Authors@