From a5f6d65c3788da7811c5655110cc6deb95f20999 Mon Sep 17 00:00:00 2001 From: Juhani Numminen Date: Sun, 29 Jan 2012 11:53:39 +0200 Subject: [PATCH] Add UNIX man pages to aid package creators. --- CMakeLists.txt | 2 ++ doc/minetest.6 | 67 ++++++++++++++++++++++++++++++++++++++++++++ doc/minetestserver.6 | 55 ++++++++++++++++++++++++++++++++++++ 3 files changed, 124 insertions(+) create mode 100644 doc/minetest.6 create mode 100644 doc/minetestserver.6 diff --git a/CMakeLists.txt b/CMakeLists.txt index f539b625d..feefa58c4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -63,6 +63,7 @@ elseif(UNIX) # Linux, BSD etc set(DATADIR "share/${PROJECT_NAME}") set(BINDIR "bin") set(DOCDIR "share/doc/${PROJECT_NAME}") + set(MANDIR "share/man") set(EXAMPLE_CONF_DIR "share/doc/${PROJECT_NAME}") set(XDG_APPS_DIR "share/applications") set(ICONDIR "share/icons") @@ -73,6 +74,7 @@ install(FILES "doc/changelog.txt" DESTINATION "${DOCDIR}") install(FILES "minetest.conf.example" DESTINATION "${DOCDIR}") if(UNIX) + install(FILES "doc/minetest.6" "doc/minetestserver.6" DESTINATION "${MANDIR}/man6") install(FILES "misc/minetest.desktop" DESTINATION "${XDG_APPS_DIR}") install(FILES "minetest-icon.svg" DESTINATION "${ICONDIR}/hicolor/scalable/apps") endif() diff --git a/doc/minetest.6 b/doc/minetest.6 new file mode 100644 index 000000000..ef425a6df --- /dev/null +++ b/doc/minetest.6 @@ -0,0 +1,67 @@ +.\" Minetest man page +.TH minetest 6 "29 January 2012" "" "" + +.SH NAME +minetest \- Multiplayer infinite-world block sandbox + +.SH SYNOPSIS +.B minetest +[ OPTION ... ] + +.SH DESCRIPTION +.B Minetest +is one of the first InfiniMiner/Minecraft(/whatever) inspired games (started October 2010), with a goal of taking the survival multiplayer gameplay to a slightly different direction. +.PP +The main design philosophy is to keep it technically simple, stable and portable. It will be kept lightweight enough to run on fairly old hardware. + +.SH OPTIONS +.TP +\-\-address +Address to connect to +.TP +\-\-config +Load configuration from specified file +.TP +\-\-disable\-unittests +Disable unit tests +.TP +\-\-enable\-unittests +Enable unit tests +.TP +\-\-help +Show allowed options +.TP +\-\-info\-on\-stderr +Print debug information to console +.TP +\-\-map\-dir +Map directory (where everything in the world is stored) +.TP +\-\-port +Set network port to connect to +.TP +\-\-random\-input +Enable random user input, for testing +.TP +\-\-server +Run server directly +.TP +\-\-speedtests +Run speed tests + +.SH BUGS +Please report all bugs to Perttu Ahola . + +.SH AUTHOR +.PP +Perttu Ahola +and contributors. +.PP +This man page was written by +Juhani Numminen . + +.SH WWW +http://c55.me/minetest/ + +.SH "SEE ALSO" +.BR minetestserver(6) \ No newline at end of file diff --git a/doc/minetestserver.6 b/doc/minetestserver.6 new file mode 100644 index 000000000..9540e2c42 --- /dev/null +++ b/doc/minetestserver.6 @@ -0,0 +1,55 @@ +.\" Minetestserver man page +.TH minetestserver 6 "29 January 2012" "" "" + +.SH NAME +minetestserver \- Minetest server + +.SH SYNOPSIS +.B minetestserver +[ OPTION ... ] + +.SH DESCRIPTION +.B Minetest +is one of the first InfiniMiner/Minecraft(/whatever) inspired games (started October 2010), with a goal of taking the survival multiplayer gameplay to a slightly different direction. +.PP +The main design philosophy is to keep it technically simple, stable and portable. It will be kept lightweight enough to run on fairly old hardware. + +.SH OPTIONS +.TP +\-\-config +Load configuration from specified file +.TP +\-\-disable\-unittests +Disable unit tests +.TP +\-\-enable\-unittests +Enable unit tests +.TP +\-\-help +Show allowed options +.TP +\-\-info\-on\-stderr +Print debug information to console +.TP +\-\-map\-dir +Map directory (where everything in the world is stored) +.TP +\-\-port +Set network port (UDP) to use + +.SH BUGS +Please report all bugs to Perttu Ahola . + +.SH AUTHOR +.PP +Perttu Ahola +and contributors. +.PP +This man page was written by +Juhani Numminen . + +.SH WWW +http://c55.me/minetest/ + +.SH "SEE ALSO" +.BR minetest(6) \ No newline at end of file