]> git.jsancho.org Git - lugaru.git/blob - Dist/lugaru.6
Add manpage for Linux system installation
[lugaru.git] / Dist / lugaru.6
1 .\" Process this file with: groff -man -Tlatin1 lugaru.6
2 .\" Please report any issue with this man page at
3 .\" https://gitlab.com/osslugaru/lugaru/issues
4 .TH LUGARU 6 "December 2016" Linux
5 .SH NAME
6 Lugaru \- free and open source ninja rabbit fighting game
7 .SH DESCRIPTION
8 Lugaru (pronounced Loo-GAH-roo) is a cross-platform third-person action game.
9 The main character, Turner, is an anthropomorphic rebel bunny rabbit with
10 impressive combat skills. In his quest to find those responsible for
11 slaughtering his village, he uncovers a far-reaching conspiracy involving the
12 corrupt leaders of the rabbit republic and the starving wolves from a nearby
13 den. Turner takes it upon himself to fight against their plot and save his
14 fellow rabbits from slavery.
15 .SH SYNOPSIS
16 .B lugaru
17 .RI [ options ]
18 .SH OPTIONS
19 .TP
20 \fB\-h\fR, \fB\-\-help\fR
21 Print usage and exit.
22 .TP
23 \fB\-f\fR, \fB\-\-fullscreen\fR
24 Start the game in fullscreen mode.
25 .TP
26 \fB\-w\fR, \fB\-\-windowed\fR
27 Start the game in windowed mode (default).
28 .TP
29 \fB\-\-nomousegrab\fR
30 Disable mousegrab.
31 .TP
32 \fB\-\-mousegrab\fR
33 Enable mousegrab (default).
34 .TP
35 \fB\-\-nosound\fR
36 Disable sound.
37 .TP
38 \fB\-\-force\-alsa\fR
39 Force use of ALSA back\-end.
40 .TP
41 \fB\-\-force\-oss\fR
42 Force use of OSS back\-end.
43 .TP
44 \fB\-\-openal\-info\fR
45 Print info about OpenAL at launch.
46 .HP
47 \fB\-\-showresolutions\fR List the resolutions found by SDL at launch.
48 .SH FILES
49 XDG_CONFIG_HOME/lugaru/ or ~/.config/lugaru/
50 .RS
51 User-specific configuration folder, contains the config.txt file.
52 .RE
53 XDG_DATA_HOME/lugaru/ or ~/.local/share/lugaru/
54 .RS
55 User-specific data folder, contains saved user progress, screenshots and saved
56 maps.
57 .RE
58 /usr/share/doc/lugaru/
59 .RS
60 Additional documentation files and licensing information.
61 .RE
62 .SH "SEE ALSO"
63 See the project website at \fIhttps://osslugaru.gitlab.io/\fR and the source
64 code repository at \fIhttps://gitlab.com/osslugaru/lugaru\fR for more details.
65 .SH BUGS
66 Lugaru is a free and open source game and welcomes any kind of contributions.
67 In particular, you can report issues or make suggestions on Lugaru's issue
68 tracker at \fIhttps://gitlab.com/osslugaru/lugaru/issues\fR.
69 .SH AUTHOR
70 Man page written by RĂ©mi Verschelde <remi@verschelde.fr> on behalf of the
71 OSS Lugaru development team.