aboutsummaryrefslogtreecommitdiff
path: root/program_info
diff options
context:
space:
mode:
authorSefa Eyeoglu <contact@scrumplex.net>2022-04-10 22:09:59 +0200
committerSefa Eyeoglu <contact@scrumplex.net>2022-04-10 23:01:00 +0200
commitfa2b3bcc633ce6f658d659fb3c0a87ddb6bc91ba (patch)
treec0c911fea0541a0fc1761f15a981f96f33114eec /program_info
parent620555d2103dbfaa51e621b35290392899713a40 (diff)
downloadPrismLauncher-fa2b3bcc633ce6f658d659fb3c0a87ddb6bc91ba.tar.gz
PrismLauncher-fa2b3bcc633ce6f658d659fb3c0a87ddb6bc91ba.tar.bz2
PrismLauncher-fa2b3bcc633ce6f658d659fb3c0a87ddb6bc91ba.zip
feat: install manpage
Diffstat (limited to 'program_info')
-rw-r--r--program_info/CMakeLists.txt1
-rw-r--r--program_info/polymc.6.txt64
2 files changed, 65 insertions, 0 deletions
diff --git a/program_info/CMakeLists.txt b/program_info/CMakeLists.txt
index f9d7621d..9c243826 100644
--- a/program_info/CMakeLists.txt
+++ b/program_info/CMakeLists.txt
@@ -11,6 +11,7 @@ set(Launcher_DesktopFileName "org.polymc.PolyMC.desktop" PARENT_SCOPE)
set(Launcher_Desktop "program_info/org.polymc.PolyMC.desktop" PARENT_SCOPE)
set(Launcher_MetaInfo "program_info/org.polymc.PolyMC.metainfo.xml" PARENT_SCOPE)
+set(Launcher_ManPage "program_info/polymc.6.txt" PARENT_SCOPE)
set(Launcher_SVG "program_info/org.polymc.PolyMC.svg" PARENT_SCOPE)
set(Launcher_Branding_ICNS "program_info/polymc.icns" PARENT_SCOPE)
set(Launcher_Branding_WindowsRC "program_info/polymc.rc" PARENT_SCOPE)
diff --git a/program_info/polymc.6.txt b/program_info/polymc.6.txt
new file mode 100644
index 00000000..8f126cce
--- /dev/null
+++ b/program_info/polymc.6.txt
@@ -0,0 +1,64 @@
+POLYMC(1)
+==========
+:doctype: manpage
+
+
+NAME
+----
+polymc - a launcher and instance manager for Minecraft.
+
+
+SYNOPSIS
+--------
+*polymc* ['OPTIONS']
+
+
+DESCRIPTION
+-----------
+PolyMC 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 PolyMC.
+
+OPTIONS
+-------
+*-d, --dir*='DIRECTORY'::
+ Use 'DIRECTORY' as the PolyMC root.
+
+*-l, --launch*='INSTANCE_ID'::
+ Launch the instance specified by 'INSTANCE_ID'.
+
+*--alive*::
+ Write a small 'live.check' file after PolyMC 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/PolyMC/PolyMC/issues>
+
+RESOURCES
+---------
+GitHub: <https://github.com/PolyMC/PolyMC>
+
+Main website: <https://polymc.org>
+
+AUTHORS
+-------
+PolyMC Contributors
+
+// vim: syntax=asciidoc