Add UNIX man pages to aid package creators.

This commit is contained in:
Juhani Numminen 2012-01-29 11:53:39 +02:00 committed by Perttu Ahola
parent 79326e6287
commit a5f6d65c37
3 changed files with 124 additions and 0 deletions

@ -63,6 +63,7 @@ elseif(UNIX) # Linux, BSD etc
set(DATADIR "share/${PROJECT_NAME}") set(DATADIR "share/${PROJECT_NAME}")
set(BINDIR "bin") set(BINDIR "bin")
set(DOCDIR "share/doc/${PROJECT_NAME}") set(DOCDIR "share/doc/${PROJECT_NAME}")
set(MANDIR "share/man")
set(EXAMPLE_CONF_DIR "share/doc/${PROJECT_NAME}") set(EXAMPLE_CONF_DIR "share/doc/${PROJECT_NAME}")
set(XDG_APPS_DIR "share/applications") set(XDG_APPS_DIR "share/applications")
set(ICONDIR "share/icons") set(ICONDIR "share/icons")
@ -73,6 +74,7 @@ install(FILES "doc/changelog.txt" DESTINATION "${DOCDIR}")
install(FILES "minetest.conf.example" DESTINATION "${DOCDIR}") install(FILES "minetest.conf.example" DESTINATION "${DOCDIR}")
if(UNIX) if(UNIX)
install(FILES "doc/minetest.6" "doc/minetestserver.6" DESTINATION "${MANDIR}/man6")
install(FILES "misc/minetest.desktop" DESTINATION "${XDG_APPS_DIR}") install(FILES "misc/minetest.desktop" DESTINATION "${XDG_APPS_DIR}")
install(FILES "minetest-icon.svg" DESTINATION "${ICONDIR}/hicolor/scalable/apps") install(FILES "minetest-icon.svg" DESTINATION "${ICONDIR}/hicolor/scalable/apps")
endif() endif()

67
doc/minetest.6 Normal file

@ -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 <value>
Address to connect to
.TP
\-\-config <value>
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 <value>
Map directory (where everything in the world is stored)
.TP
\-\-port <value>
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 <celeron55@gmail.com>.
.SH AUTHOR
.PP
Perttu Ahola <celeron55@gmail.com>
and contributors.
.PP
This man page was written by
Juhani Numminen <juhaninumminen0@gmail.com>.
.SH WWW
http://c55.me/minetest/
.SH "SEE ALSO"
.BR minetestserver(6)

55
doc/minetestserver.6 Normal file

@ -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 <value>
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 <value>
Map directory (where everything in the world is stored)
.TP
\-\-port <value>
Set network port (UDP) to use
.SH BUGS
Please report all bugs to Perttu Ahola <celeron55@gmail.com>.
.SH AUTHOR
.PP
Perttu Ahola <celeron55@gmail.com>
and contributors.
.PP
This man page was written by
Juhani Numminen <juhaninumminen0@gmail.com>.
.SH WWW
http://c55.me/minetest/
.SH "SEE ALSO"
.BR minetest(6)