~ubuntu-branches/ubuntu/trusty/redeclipse-data/trusty

« back to all changes in this revision

Viewing changes to doc/man/redeclipse.6.am

  • Committer: Package Import Robot
  • Author(s): Martin Erik Werner
  • Date: 2012-09-01 21:11:53 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20120901211153-8913lu8fs7qukj6y
Tags: 1.3.1-1
* New upstream development snapshot
* XZ compression for orig tarball
* Standards-Version 3.9.3
  - Set final DEP-5 Format: link

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH @CAPPNAME@ 6 2012-08-31 "Red Eclipse 1.3" "Red Eclipse Manual"
 
2
 
 
3
 
 
4
.SH NAME
 
5
 
 
6
@APPNAME@ \- script to launch the Red Eclipse FPS game client
 
7
 
 
8
 
 
9
.SH SYNOPSIS
 
10
 
 
11
.SY @APPNAME@
 
12
'\" Filesystem options
 
13
.OP \-h\fRhomedir
 
14
.OP \-p\fRpackagedir
 
15
.OP \-o\fRsauerdir
 
16
.OP \-g\fRlogfile
 
17
 
 
18
'\" Video options
 
19
.OP \-df\fR{0|1}
 
20
.OP \-dw\fRwidth
 
21
.OP \-dh\fRheight
 
22
.OP \-du\fR{0..3}
 
23
.OP \-dv\fR{0|1}
 
24
.OP \-da\fRsamples
 
25
.OP \-dc\fRdepth
 
26
.OP \-dd\fRdepth
 
27
.OP \-ds\fRbits
 
28
 
 
29
'\" General options
 
30
.OP \-x\fR'command(s)'
 
31
.OP \-k\fR{0|1}
 
32
.OP \-v\fR{0..4}
 
33
.OP \-\-help
 
34
 
 
35
'\" Server options
 
36
.OP \-ss\fR{0..3}
 
37
.OP \-sm\fRservermaster
 
38
.OP \-sa\fRservermasterport
 
39
 
 
40
 
 
41
.SH DESCRIPTION
 
42
 
 
43
Red Eclipse is a single-player and multi-player first-person ego-shooter, built as a total conversion of Cube Engine 2, which lends itself toward a balanced gameplay, with a general theme of agility in a variety of environments.
 
44
.PP
 
45
.B @APPNAME@
 
46
is a script which executes the
 
47
.BR @APPNAME@
 
48
binary from the
 
49
.I @LIBEXECDIR@/@APPNAME@
 
50
directory.
 
51
.PP
 
52
The recommended way to change the settings of the client are to edit the
 
53
.I config.cfg
 
54
and
 
55
.I init.cfg
 
56
files in the home directory.
 
57
.PP
 
58
The @APPNAME@ client starts a local loopback server upon launch which it uses to connect to for singleplayer, hence many of the server options are accepted by the @APPNAME@ binary as well (see
 
59
.BR @APPNAME@-server (6)).
 
60
To edit the specific settings related to the loopback server, use the
 
61
.I localexec.cfg
 
62
and
 
63
.I localinit.cfg
 
64
files in the home directory.
 
65
 
 
66
 
 
67
.SH CAVEATS
 
68
 
 
69
Many of these options will, if used, be permanently saved in the init.cfg file.
 
70
 
 
71
 
 
72
.SH OPTIONS
 
73
 
 
74
.SS Filesystem options
 
75
 
 
76
.TP
 
77
.BI \-h homedir
 
78
Sets your home directory to
 
79
.IR homedir .
 
80
Red Eclipse will look for files in this directory in addition the normal installation directory. All user files will be written to the home directory. Defaults to
 
81
.IR $HOME/.@APPNAME@/ .
 
82
 
 
83
.TP
 
84
.BI \-p packagedir
 
85
Includes the data files found in
 
86
.IR packagedir .
 
87
Can be used for adding additional mods. Packages will be loaded in the order specified. By default @APPNAME@ only includes data files in its working directory
 
88
.IR @DATADIR@/@APPNAME@/data/ ,
 
89
and in the
 
90
.I temp
 
91
subdirectory of the home directory.
 
92
 
 
93
.TP
 
94
.BI \-o sauerdir
 
95
Sets the path to your Sauerbraten directory. If Red Eclipse can find your Sauerbraten directory, you can load and play Sauerbraten maps from withing Red Eclipse.
 
96
 
 
97
.TP
 
98
.BI \-g logfile
 
99
Output log to
 
100
.IR logfile .
 
101
Path is set relative to
 
102
.IR homedir
 
103
unless a leading \'\fB/\fR' is used
 
104
 
 
105
.SS Video options
 
106
 
 
107
.TP
 
108
.BR \-df {0|1}
 
109
Turns fullscreen mode on or off. 0 to disable, 1 to enable. Defaults to 1.
 
110
.IP
 
111
This configuration is stored in init.cfg
 
112
 
 
113
.TP
 
114
.BI \-dw width
 
115
Sets screen width to
 
116
.IR width .
 
117
If height not specified, also sets height to 3/4 of width. min is 320.
 
118
.IP
 
119
This configuration is stored in init.cfg
 
120
 
 
121
.TP
 
122
.BI \-dh height
 
123
Sets screen height to
 
124
.IR height .
 
125
If width not specified, also sets width to 4/3 of height. min is 320.
 
126
.IP
 
127
This configuration is stored in init.cfg
 
128
 
 
129
.TP
 
130
.BR \-du {0..3}
 
131
Set shader quality. 0 for none, 1 for shaders with fastest quality, max is 3. Defaults to 1 where hardware supports it.
 
132
.IP
 
133
This configuration is stored in init.cfg
 
134
 
 
135
.TP
 
136
.BR \-dv {0|1}
 
137
Turns vertical sync on or off. 0 to disable, 1 to enable. Defaults to 0.
 
138
.IP
 
139
This configuration is stored in init.cfg
 
140
 
 
141
.TP
 
142
.BI \-da samples
 
143
Sets full-scene anti-aliasing (FSAA) to
 
144
.I samples
 
145
samples.
 
146
.IP
 
147
This configuration is stored in init.cfg
 
148
 
 
149
.TP
 
150
.BI \-dc depth
 
151
Sets colour depth (bits per pixel) to
 
152
.IR depth .
 
153
.IP
 
154
This configuration is stored in init.cfg
 
155
 
 
156
.TP
 
157
.BI \-ds bits
 
158
Sets stencil buffer bits to
 
159
.IR bits .
 
160
.IP
 
161
This configuration is stored in init.cfg
 
162
 
 
163
.TP
 
164
.BI \-dd depth
 
165
Sets z-buffer depth to
 
166
.IR depth .
 
167
.IP
 
168
This configuration is stored in init.cfg
 
169
 
 
170
.SS General options
 
171
 
 
172
.TP
 
173
.B \-x\fR'\fIcommand1\fR; \fIcommand2\fR; \fI...\fR'
 
174
.
 
175
Executes a list of commands once Red Eclipse has started up.
 
176
 
 
177
.TP
 
178
.BR \-k {0|1}
 
179
Enables or disables kid mode, which reduces blood and death effects somewhat. 1 enables reduced gore, defaults to 0.
 
180
.IP
 
181
This configuration is stored in init.cfg
 
182
 
 
183
.TP
 
184
.BR \-v {0..4}
 
185
Sets verbosity. This affects how much information is printed to the console. 0 is the least verbose, 4 is the most verbose, defaults to 0.
 
186
.IP
 
187
This configuration is stored in init.cfg
 
188
 
 
189
.TP
 
190
.B \-\-help
 
191
Display this manpage
 
192
 
 
193
.SS Server options
 
194
 
 
195
.TP
 
196
.BI \-ss {0..3}
 
197
Sets the server type of the local server. 0 for local only, 1 for private, 2 for public, 3 for dedicated. Defaults to 1. If set as dedicated (3) @APPNAME@ will act similarly to @APPNAME@-server and not start the GUI.
 
198
 
 
199
.TP
 
200
.BI \-sm servermaster
 
201
Connects to
 
202
.I servermaster
 
203
to get the list of available servers, defaults to play.redeclipse.net.
 
204
 
 
205
.TP
 
206
.BI \-sa servermasterport
 
207
Contacts the master server using port
 
208
.IR servermasterport ,
 
209
defaults to 28800.
 
210
 
 
211
 
 
212
.SH EXAMPLES
 
213
 
 
214
.B @APPNAME@ -p$HOME/mod/data
 
215
.RS 4
 
216
Load data from an additional directory.
 
217
.RE
 
218
 
 
219
.B @APPNAME@ -h$HOME/@APPNAME@_configs/
 
220
.RS 4
 
221
Reads and writes the configuration files to the specified directory instead of
 
222
.IR $HOME/.@APPNAME@/ .
 
223
.RE
 
224
 
 
225
.B @APPNAME@ -x'mode 7; trialweapon 0; map hinder'
 
226
.RS 4
 
227
Sets game mode to time trial, trialmode weapon to empty hands, and starts a game on the map "hinder".
 
228
.RE
 
229
 
 
230
 
 
231
.SH AUTHORS
 
232
 
 
233
Red Eclipse's main developers are Quinton "quin" Reeves and Lee "eihrul" Salzman
 
234
.PP
 
235
This manual page was written by Martin Erik Werner <martinerikwerner@gmail.com>
 
236
 
 
237
 
 
238
.SH HISTORY
 
239
 
 
240
Red Eclipse was forked as a continuation of the game Bloodfrontier, which in turn was based on the Cube2 engine and the Sauerbraten game. Red Eclipse and Sauerbraten are now developed in parallel.
 
241
 
 
242
 
 
243
.SH "SEE ALSO"
 
244
 
 
245
.BR @APPNAME@-server (6).