From f75ad3d437ec08cdbbeb32bdc15c94cabec56f71 Mon Sep 17 00:00:00 2001 From: =?utf8?q?R=C3=A9mi=20Verschelde?= Date: Wed, 7 Dec 2016 22:03:07 +0100 Subject: [PATCH] Add manpage for Linux system installation Fixes #28. --- CMakeLists.txt | 1 + Dist/lugaru.6 | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+) create mode 100644 Dist/lugaru.6 diff --git a/CMakeLists.txt b/CMakeLists.txt index 7a1055e..84a24ed 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -257,6 +257,7 @@ if(LINUX) #install(FILES ${CMAKE_SOURCE_DIR}/Dist/lugaru.appdata.xml DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/appdata) install(FILES ${CMAKE_SOURCE_DIR}/Dist/lugaru.desktop DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/applications) install(FILES ${CMAKE_SOURCE_DIR}/Dist/lugaru.png DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/128x128/apps) + install(FILES ${CMAKE_SOURCE_DIR}/Dist/lugaru.6 DESTINATION ${CMAKE_INSTALL_MANDIR}/man6) else(SYSTEM_INSTALL) message(WARNING "You are installing Lugaru without having enabled the SYSTEM_INSTALL option. It will default to looking for the data in the 'Data' directory next to the binary.") install(PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/lugaru DESTINATION ${CMAKE_INSTALL_PREFIX}) diff --git a/Dist/lugaru.6 b/Dist/lugaru.6 new file mode 100644 index 0000000..53f73b8 --- /dev/null +++ b/Dist/lugaru.6 @@ -0,0 +1,71 @@ +.\" Process this file with: groff -man -Tlatin1 lugaru.6 +.\" Please report any issue with this man page at +.\" https://gitlab.com/osslugaru/lugaru/issues +.TH LUGARU 6 "December 2016" Linux +.SH NAME +Lugaru \- free and open source ninja rabbit fighting game +.SH DESCRIPTION +Lugaru (pronounced Loo-GAH-roo) is a cross-platform third-person action game. +The main character, Turner, is an anthropomorphic rebel bunny rabbit with +impressive combat skills. In his quest to find those responsible for +slaughtering his village, he uncovers a far-reaching conspiracy involving the +corrupt leaders of the rabbit republic and the starving wolves from a nearby +den. Turner takes it upon himself to fight against their plot and save his +fellow rabbits from slavery. +.SH SYNOPSIS +.B lugaru +.RI [ options ] +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +Print usage and exit. +.TP +\fB\-f\fR, \fB\-\-fullscreen\fR +Start the game in fullscreen mode. +.TP +\fB\-w\fR, \fB\-\-windowed\fR +Start the game in windowed mode (default). +.TP +\fB\-\-nomousegrab\fR +Disable mousegrab. +.TP +\fB\-\-mousegrab\fR +Enable mousegrab (default). +.TP +\fB\-\-nosound\fR +Disable sound. +.TP +\fB\-\-force\-alsa\fR +Force use of ALSA back\-end. +.TP +\fB\-\-force\-oss\fR +Force use of OSS back\-end. +.TP +\fB\-\-openal\-info\fR +Print info about OpenAL at launch. +.HP +\fB\-\-showresolutions\fR List the resolutions found by SDL at launch. +.SH FILES +XDG_CONFIG_HOME/lugaru/ or ~/.config/lugaru/ +.RS +User-specific configuration folder, contains the config.txt file. +.RE +XDG_DATA_HOME/lugaru/ or ~/.local/share/lugaru/ +.RS +User-specific data folder, contains saved user progress, screenshots and saved +maps. +.RE +/usr/share/doc/lugaru/ +.RS +Additional documentation files and licensing information. +.RE +.SH "SEE ALSO" +See the project website at \fIhttps://osslugaru.gitlab.io/\fR and the source +code repository at \fIhttps://gitlab.com/osslugaru/lugaru\fR for more details. +.SH BUGS +Lugaru is a free and open source game and welcomes any kind of contributions. +In particular, you can report issues or make suggestions on Lugaru's issue +tracker at \fIhttps://gitlab.com/osslugaru/lugaru/issues\fR. +.SH AUTHOR +Man page written by Rémi Verschelde on behalf of the +OSS Lugaru development team. -- 2.39.2