source: abuse/trunk/doc/abuse.6.in @ 670

Last change on this file since 670 was 610, checked in by Sam Hocevar, 12 years ago

doc: put manual pages in the doc/ directory.

File size: 3.3 KB
Line 
1.\" Abuse-SDL is (C) 2000-2001 Anthony Kruize <trandor@labyrinth.net.au>
2.\" Abuse is (C) Dave Taylor and Jonathan Clarke
3.\"
4.TH abuse 6 Abuse\ @VERSION@
5.SH NAME
6abuse \- The Abuse game, by Crack dot Com and the Abuse community.
7
8.SH SYNOPSIS
9.B abuse
10[options]
11
12.SH DESCRIPTION
13.B Abuse
14is a port of the classic Crack dot Com side-scroller shoot-em-up Abuse.
15It uses the Simple DirectMedia Layer API to draw its graphics and play sound.
16.PP
17.B Abuse
18has the following additional features over the original game:
19.PP
20Stereo sound with panning.
21.br
22Runs at any colour depth from 8bpp to 32bpp.
23.br
24Can use a mousewheel for changing weapons.
25.br
26Scaling to any resolution.
27.br
28Can use OpenGL for hardware accelerated scaling and anti-aliasing.
29.br
30Customizable keys.
31
32
33.SH REQUIREMENTS
34.B Abuse
35requires the following:
36.IP
37SDL 1.1.6 or above.
38.IP
39SDL-Mixer.
40
41.SH OPTIONS
42The following command-line options are available:
43.TP
44.B -fullscreen
45Run Abuse in fullscreen mode.
46.TP
47.B -doublebuf
48Use double-buffering when blitting to the screen.
49This is slower but can reduce image tearing or other artifacts.
50Only use if you notice any display problems.
51.TP
52.B -mono
53Use mono sound like the original Abuse. This is faster.
54.TP
55.B -nosound
56Disable sound altogether.
57.TP
58.B -scale <arg>
59Scale the window by
60.I <arg>
61amount.
62.TP
63.B -gl
64Enable OpenGL support.
65.TP
66.B -antialias
67Enable anti-aliasing. (Only with -gl)
68
69.SH CONFIGURATION
70.B Abuse
71can load its settings from a configuration file stored in the user's home
72directory. The file is located at ($HOME/.abuse/abuserc).  If either the
73directory or the configuration file don't exist they will be created
74automatically with default values.
75.LP
76The configuration file contains various settings for adjusting how
77.B Abuse
78behaves.  Except for key settings, most of the options have an equivalent
79command-line option. Lines starting with a semi-colon(;) are ignored as
80comments.
81.LP
82The following options are available:
83.TP
84.B fullscreen = 1 | 0
85Set starting in fullscreen mode 'on' or 'off'.
86.TP
87.B doublebuf = 1 | 0
88Turn double buffering 'on' or 'off'.
89.TP
90.B mono = 1 | 0
91Turn mono audio to 'on' or 'off'.
92.TP
93.B grabmouse = 1 | 0
94Set locking the mouse to the window 'on' or 'off'.
95.TP
96.B scale = <amount>
97Scale the game by the specified amount.
98.TP
99.B gl = 1 | 0
100Turn OpenGL support 'on' or 'off'.
101.TP
102.B antialias = 1 | 0
103Turn anti-aliasing 'on' or 'off'.
104.TP
105.B nosdlparachute = 1 | 0
106Turn SDL handling segfaults to either 'on' or 'off'.
107For debugging purposes only.
108.LP
109The following options are for setting the keys used in the game.
110Valid values are any letter of the alphabet or number.
111Special keys like the cursor-keys include:
112.IP
113LEFT, RIGHT, UP, DOWN, CTRL_L, CTRL_R, ALT_L, ALT_R, SHIFT_L, SHIFT_R,
114BACKSPACE, INSERT, DELETE, PAGEUP, PAGEDOWN, TAB
115.TP
116.B left = <key>
117Move character left.
118.TP
119.B right = <key>
120Move character right.
121.TP
122.B up = <key>
123Jump or climb up ladders.
124.TP
125.B down = <key>
126Use switches, doors, teleports or climb down ladders.
127.TP
128.B fire = <key>
129Fire currently selected weapon.
130.TP
131.B weapprev = <key>
132Switch to the previous available weapon.
133.TP
134.B weapnext = <key>
135Switch to the next available weapon.
136
137.SH FILES
138~/.abuse/abuserc - Abuse configuration file.
139
140.SH SEE ALSO
141abuse-tool(6)
142
143.SH AUTHORS
144Sam Hocevar <sam@hocevar.net>, Anthony Kruize <trandor@labyrinth.net.au>
145See also the AUTHORS file included with Abuse.
Note: See TracBrowser for help on using the repository browser.