summaryrefslogtreecommitdiffstats
path: root/games/ufoai/man
diff options
context:
space:
mode:
Diffstat (limited to 'games/ufoai/man')
-rw-r--r--games/ufoai/man/ufo.651
-rw-r--r--games/ufoai/man/ufo2map.6188
-rw-r--r--games/ufoai/man/ufoded.642
-rw-r--r--games/ufoai/man/ufomodel.650
-rw-r--r--games/ufoai/man/uforadiant.649
-rw-r--r--games/ufoai/man/ufoslicer.640
6 files changed, 420 insertions, 0 deletions
diff --git a/games/ufoai/man/ufo.6 b/games/ufoai/man/ufo.6
new file mode 100644
index 0000000000..8002578ef7
--- /dev/null
+++ b/games/ufoai/man/ufo.6
@@ -0,0 +1,51 @@
+.\" This man page was written by Markus Koschany in August 2013. It is provided
+.\" under the GNU General Public License 2 or (at your option) any later version.
+.TH ufo 6 "October 2021" "ufoai-2.5" "SlackBuilds.org"
+.SH NAME
+ufo \- UFO: Alien Invasion client
+.SH SYNOPSIS
+.PP
+\fBufo\fR [\fB+<internal command> \fIoption\fR \fIvalue\fP] ...
+.SH DESCRIPTION
+\fBufo\fP is the client for the strategy game UFO: Alien Invasion (\fBufoai\fR).
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display this help
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Disable console output
+.TP
+\fB+<internal command>\fR
+Options passed by "+<internal command>" are the same as the in-game console understands. For the in-game console press SHIFT+ESC.
+Use the in-game \fBcvarlist\fR to get a list of all available options for the game.
+.SS Internal commands
+.TP
+\fBsnd\_init\fR
+Set this to 0 to start without sound\&.
+.TP
+\fBvid\_fullscreen\fR
+Set this to 1 to start in fullscreen mode\&.
+
+.SH "FILES"
+All data files are part of a pk3 file in \fI/usr/share/games/ufoai/base/\fR. You can extract them (pk3 files are just zip files)
+and place them in the home directory of the user running the game. Use the path \fI~/.ufoai/<VERSION>/base/\fR to place
+these files. The files that are not located in the pk3 files have a higher priority than the files that are stored in the pk3
+files. So you are able to replace any file you want like this. You can also add new maps and other game content to the \fIbase/\fR
+directory in your users home directory to be able to use new game content.
+.TP
+\fB~/.ufoai/<VERSION>/base/config.cfg\fR
+Game configuration\&.
+.TP
+\fBkeys.cfg\fR
+Game key bindings\&.
+.SH EXAMPLES
+.TP
+\fBufo +snd_init 0 +vid_fullscreen 1\fR
+Start ufo without sound and in fullscreen mode.
+.SH "SEE ALSO"
+.PP
+\fBufoded\fR(6)
+\fBufo2map\fR(6)
+\fBufomodel\fR(6)
+\fBufoslicer\fR(6)
diff --git a/games/ufoai/man/ufo2map.6 b/games/ufoai/man/ufo2map.6
new file mode 100644
index 0000000000..21380c32f3
--- /dev/null
+++ b/games/ufoai/man/ufo2map.6
@@ -0,0 +1,188 @@
+.\" This man page was written by Markus Koschany in July 2013. It is provided
+.\" under the GNU General Public License 2 or (at your option) any later version.
+.TH ufo2map "6" "October 2021" "ufoai-2.5" "SlackBuilds.org"
+.SH NAME
+ufo2map \- UFO: Alien Invasion map compiler
+.SH SYNOPSIS
+.B ufo2map
+\fI<param1 <subparam1> <subparam2> <\fR...\fI>> <param2> <\fR...\fI> \fR[\fImap\fR]
+.SH DESCRIPTION
+This is the UFO: AI map compiler.
+.SH OPTIONS
+.SS "General options:"
+.TP
+\fB\-h\fR \fB\-\-help\fR
+: print (this) help and exit
+.TP
+\fB\-nice\fR <prio>
+: priority level [unix nice level from \fB\-20\fR to 19 where 19 is the lowest priority]
+.TP
+\fB\-nofootstep\fR
+: don't generate a footstep file
+.TP
+\fB\-tracefile\fR
+: generate two csv files describing the floors and walls found by the trace functions
+.TP
+\fB\-debugfile\fR (TODO)
+: generate a trace debug file. The client can load the file to highlight map obstructions
+.TP
+\fB\-stats\fR \fB\-\-statistics\fR
+: print statistics and quit. may be used with \fB\-check\fR or \fB\-fix\fR
+.TP
+\fB\-v\fR \fB\-\-verbosity\fR <int>
+: set verbosity. higher <int> gives more output
+if it is required, this should be the first option
+0 \- no stdout, 1 \- only check/fix messages, 2 \- (compile) only mapname
+2 \- (check/fix) mapname if findings, 4 \- normal output,
+5 \- extra output, 6 \- dump (a lot extra from BSPing)
+.TP
+\fB\-V\fR \fB\-\-version\fR
+: return Version and Revision level
+.TP
+\fB\-material\fR
+: generate a material (.mat) file, do not proceed to compilation
+.SS "Lighting options:"
+.TP
+\fB\-extra\fR
+: extra light samples
+.TP
+\fB\-nolighting\fR TYPE
+: don't perform the lighting calculations, where TYPE is one of day, night, all
+default is all
+.TP
+\fB\-quant\fR
+: lightquant \- lightmap resolution downscale (e.g. 4 = 1 << 4) (values between 1 and 6)
+.TP
+\fB\-scale\fR
+: global light scale factor
+.TP
+\fB\-saturation\fR
+: saturation factor (e.g. 1.5 \- default is 1.0)
+.TP
+\fB\-contrast\fR
+: contrast factor (e.g. 1.05, default is 1.0)
+.TP
+\fB\-t\fR \fB\-\-threads\fR
+: thread amount
+.SS "Binary space partitioning (BSPing) options:"
+.TP
+\fB\-block\fR <xl> <yl>
+:
+.HP
+\fB\-blocks\fR <xl> <yl> <xh> <yh>:
+.TP
+\fB\-subdivide\fR
+: subdivide brushes for better light effects (but higher polycount)
+.TP
+\fB\-surface\fR
+: surface light scaling (float value)
+.TP
+\fB\-entity\fR
+: entity light scaling (float value)
+.TP
+\fB\-fulldetail\fR
+: don't treat details (and trans surfaces) as details
+.TP
+\fB\-info\fR
+: print bsp file info
+.TP
+\fB\-micro\fR <float>
+: warn if a brush has a volume lower than the specified float.
+brushes are tested after CSG.
+.TP
+\fB\-nobackclip\fR
+: draw downward pointing faces. (so actors cannot see up through floors
+in first person view). default is to set SURF_NODRAW to downard faces.
+.TP
+\fB\-nocsg\fR
+:
+.TP
+\fB\-gamedir\fR
+: Add another game dir to the search directories
+.TP
+\fB\-nodetail\fR
+: skip detail brushes
+.TP
+\fB\-nomerge\fR
+: skip node face merging
+.TP
+\fB\-noprune\fR
+: don't prune (or cut) nodes
+.TP
+\fB\-noshare\fR
+:
+.TP
+\fB\-notjunc\fR
+:
+.TP
+\fB\-nowater\fR
+: skip water brushes in compilation
+.TP
+\fB\-noweld\fR
+:
+.TP
+\fB\-onlyents\fR
+: modify existing bsp file with entities from map file
+.TP
+\fB\-exportlightmaps\fR
+: write lightmaps into tga images
+.TP
+\fB\-verboseentities\fR
+: also be verbose about submodels (entities)
+.PP
+.SS Mapping options:
+.IP
+These options operate on map file only. No bsp file is created.
+Output prefixed by an asterisk (*) indicates operations that would change the map file.
+\fB\-check\fR : check source map, only print information.
+\fB\-fix\fR : same subparameters as \fB\-check\fR, changes the source map file.
+.IP
+subparameters for \fB\-check\fR and \fB\-fix\fR
+.TP
+all
+: performs all checks and fixes. This is the default.
+.TP
+bru brushes
+: includes 'lvl tex mfc mbr'. Performs all checks and fixes associated with brushes.
+.TP
+ent entities
+: performs all checks and fixes associated with entities.
+.TP
+con contained
+: checks for brushes contained entirely within other brushes. includes coincident duplicates.
+.TP
+isc intersection
+: report intersection between optimisable brushes from worldspawn and func_group entities
+.IP
+this is not included in all or bru as it is not always a bad thing
+.TP
+mbr microbrush <float>
+: test for brushes smaller than <float> unit^3. this is done without the csg
+.IP
+step, unlike the bsp \fB\-micro\fR option. default 1 unit^3.
+.TP
+lvl levelflags
+: if no levelflags for a brush or entity are set, all of them are set
+.TP
+flv filllevelflags
+: ensure set levelflag bits are uninterrupted
+.TP
+ndr nodraws
+: assigns SURF_NODRAW to hidden faces
+.TP
+tex textures
+: warns when no texture or error texture is assigned.
+.IP
+ensures special textures and content/surface flags are consistent.
+.TP
+mfc mixedfacecontents
+: ensures the contentflags are the same on each face of each brush.
+.TP
+zft zfighting
+: intersecting brushes with a common face: prevent textures shimmering together
+.SH "SEE ALSO"
+.PP
+\fBufo\fR(6)
+\fBufoded\fR(6)
+\fBufomodel\fR(6)
+\fBufoslicer\fR(6)
diff --git a/games/ufoai/man/ufoded.6 b/games/ufoai/man/ufoded.6
new file mode 100644
index 0000000000..2a5389b4e7
--- /dev/null
+++ b/games/ufoai/man/ufoded.6
@@ -0,0 +1,42 @@
+.\" This man page was written by Markus Koschany in August 2013. It is provided
+.\" under the GNU General Public License 2 or (at your option) any later version.
+.TH ufoded 6 "October 2021" "ufoai-2.5" "SlackBuilds.org"
+.SH NAME
+ufoded \- UFO: Alien Invasion dedicated server
+.SH SYNOPSIS
+.PP
+\fBufoded\fR [\fB+<internal command> \fIoption\fR \fIvalue\fP] ...
+.SH DESCRIPTION
+\fBufoded\fP is the dedicated server for the strategy game UFO: Alien Invasion.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display this help
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Disable console output
+.TP
+\fB+<internal command>\fR
+Options passed by "+<internal command>" are the same as the in-game console understands. For the in-game console press SHIFT+ESC.
+Use the in-game \fBcvarlist\fR to get a list of all available options for the game.
+.SH "FILES"
+All these files are part of a pk3 file in \fI/usr/share/games/ufoai/base/\fR. You can extract them (pk3 files are just zip files)
+and place them in the home directory of the user running the dedicated server. Use the path \fI~/.ufoai/<VERSION>/base/\fR to place
+these files. The files that are not located in the pk3 files have a higher priority than the files that are stored in the pk3
+files. So you are able to replace any file you want like this. You can also add new maps and other game content to the \fIbase/\fR
+directory in your users home directory to be able to use new content in the game.
+.TP
+\fBdedicated.cfg\fR
+Dedicated server config\&.
+.TP
+\fBautoexec.cfg\fR
+Commands that are executed when starting the dedicated server\&.
+.TP
+\fBmapcycle.txt\fR
+This defines the map cycle that the dedicated server will use\&.
+.SH SEE ALSO
+.PP
+\fBufo\fR(6)
+\fBufo2map\fR(6)
+\fBufomodel\fR(6)
+\fBufoslicer\fR(6)
diff --git a/games/ufoai/man/ufomodel.6 b/games/ufoai/man/ufomodel.6
new file mode 100644
index 0000000000..88011e411d
--- /dev/null
+++ b/games/ufoai/man/ufomodel.6
@@ -0,0 +1,50 @@
+.\" This man page was written by Markus Koschany in July 2013. It is provided
+.\" under the GNU General Public License 2 or (at your option) any later version.
+.TH ufomodel "6" "October 2021" "ufoai-2.5" "SlackBuilds.org"
+.SH NAME
+ufomodel \- optimizer for model files
+.SH DESCRIPTION
+UFO: Alien invasion developer tool to modify and optimize model files.
+.SH OPTIONS
+.TP
+\fB\-mdx\fR
+generate mdx files
+.TP
+\fB\-skinfix\fR
+fix skins for md2 models
+.TP
+\fB\-glcmds\fR
+remove the unused glcmds from md2 models
+.TP
+\fB\-check\fR
+perform general checks for all the models
+.TP
+\fB\-skinedit\fR <filename>
+edit skin of a model
+.TP
+\fB\-skinnum\fR <filename>
+edit the skin numbers of a model
+.TP
+\fB\-info\fR <filename>
+show model information
+.TP
+\fB\-overwrite\fR
+overwrite existing mdx files
+.TP
+\fB\-s\fR <float>
+sets the smoothness value for normal\-smoothing (in the range \fB\-1\fR.0 to 1.0)
+.TP
+\fB\-f\fR <filename>
+build tangentspace for the specified model file
+.TP
+\fB\-v\fR \fB\-\-verbose\fR
+print debug messages
+.TP
+\fB\-h\fR \fB\-\-help\fR
+show this help screen
+.SH "SEE ALSO"
+.PP
+\fBufo\fR(6)
+\fBufoded\fR(6)
+\fBufo2map\fR(6)
+\fBufoslicer\fR(6)
diff --git a/games/ufoai/man/uforadiant.6 b/games/ufoai/man/uforadiant.6
new file mode 100644
index 0000000000..d30368419a
--- /dev/null
+++ b/games/ufoai/man/uforadiant.6
@@ -0,0 +1,49 @@
+.TH UFORADIANT 6 "October 2021" "ufoai-2.5" "SlackBuilds.org"
+.SH NAME
+uforadiant \- UFO: Alien Invasion Mapeditor
+
+.SH SYNOPSIS
+.PP
+\fBuforadiant\fR
+
+.SH DESCRIPTION
+This manual page documents briefly the
+.B uforadiant
+command.
+.PP
+\fBuforadiant\fP is the map editor for the strategy game UFO: Alien Invasion.
+
+.SH OPTIONS
+.PP
+Options are passed to the gtk init function.
+
+.SH "FILES"
+.TP
+\fB~/.ufoai/radiant/settings.xml\fR
+Editor configuration\&.
+.TP
+\fB~/.ufoai/radiant/shortcuts.ini\fR
+Key bindings\&.
+.TP
+\fBbase/ufos/entities.ufo\fR
+This file is included in the 0ufos.pk3 in your system wide UFO:AI installation directory and defines the entities the editor can add to maps\&.
+
+.SH "SEE ALSO"
+.PP
+\fBufo\fR(6)
+
+.SH AUTHOR
+\fBuforadiant\fP was written by the UFO: Alien Invasion team and based on the GPLed release of GtkRadiant 1.5 by id Software.
+.PP
+This manual page was written by Florian Ludwig <dino@phidev.org>,
+for the Debian project (but may be used by others). It was
+modified slightly by B. Watson <urchlay@slackware.uk> for the SlackBuilds.org
+project.
+
+.SH "SEE ALSO"
+.PP
+\fBufo\fR(6)
+\fBufoded\fR(6)
+\fBufo2map\fR(6)
+\fBufomodel\fR(6)
+\fBufoslicer\fR(6)
diff --git a/games/ufoai/man/ufoslicer.6 b/games/ufoai/man/ufoslicer.6
new file mode 100644
index 0000000000..95b34efcbd
--- /dev/null
+++ b/games/ufoai/man/ufoslicer.6
@@ -0,0 +1,40 @@
+.\" This man page was written by Markus Koschany in July 2013. It is provided
+.\" under the GNU General Public License 2 or (at your option) any later version.
+.TH ufoslicer "6" "October 2021" "ufoai-2.5" "SlackBuilds.org"
+.SH NAME
+ufoslicer \- an UFO:AI map slicer
+.SH SYNOPSIS
+.B ufoslicer
+\fI\-t N \-s N \-c \-m bspfile\fR
+.SH DESCRIPTION
+.TP
+UFO Alien Invasion developer tool to slice map files.
+.SH OPTIONS
+.TP
+\fB\-t\fR N
+= use slice thickness of N units.
+.TP
+\fB\-s\fR N
+= use scale factor of N.
+.TP
+\fB\-c\fR
+= create a single contour map.
+.TP
+\fB\-m\fR
+= create multiple contour maps.
+.HP
+\fB\-h\fR|\-\-help = show this help screen.
+.PP
+.SH EXAMPLES
+ufoslicer \fB\-t\fR 64 \fB\-s\fR 8 maps/farm
+.PP
+The above command would slice the map "farm.bsp", moving by 64 units between slices and
+would create a 1/8th scale bitmap file.
+.PP
+The default for \fB\-t\fR is 64 units.
+.SH "SEE ALSO"
+.PP
+\fBufo\fR(6)
+\fBufoded\fR(6)
+\fBufo2map\fR(6)
+\fBufomodel\fR(6)