glest-source/zetaglest.6
2018-09-15 13:21:35 -05:00

463 lines
12 KiB
Groff

.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5.
.TH ZETAGLEST "6" "September 2018" "zetaglest v0.8.02" "Games"
.SH NAME
zetaglest \- 3D\ multi-player\ real\ time\ strategy\ game
.SH SYNOPSIS
.B zetaglest
[\fI\,OPTION\/\fR]... \fI\,VALUE\/\fR...
.SH DESCRIPTION
Options for running zetaglest from the command line
.HP
\fB\-\-help\fR
.IP
display usage
.HP
\fB\-\-autostart\-lastgame\fR
.IP
Automatically starts a game with the last settings played
.HP
\fB\-\-load\-saved\-game\fR=\fI\,FILE\/\fR
.IP
Loads the last saved game.
.IP
FILE \- optional name of the saved game file to load.
If FILE is not specified, the last game that was saved is loaded
.HP
\fB\-\-auto\-test\fR=\fI\,x\/\fR,y,z
.IP
Run in auto test mode
.IP
x \- optional maximum # seconds to play.
.IP
If 'x' is not specified the default is 1200 seconds (20 minutes).
.IP
y \- optional game settings file to play.
.IP
If 'y' is not specified (or is empty) then auto test cycles
through playing scenarios.
.IP
z \- the word 'exit' indicating the game should exit after the game
.IP
is finished or the time runs out. If 'z' is not specified
(or is empty) then auto test continues to cycle.
.HP
\fB\-\-connect\fR=\fI\,x\/\fR:y
.IP
Auto connect to host server at IP or hostname x using port y.
Shortcut version of using \fB\-\-connecthost\fR and \fB\-\-use\-ports\fR.
*NOTE: to automatically connect to the first LAN host you may use:
.HP
\fB\-\-connect\fR=\fI\,auto\-connect\/\fR
.HP
\fB\-\-connecthost\fR=\fI\,x\/\fR
.IP
Auto connect to host server at IP or hostname x.
*NOTE: to automatically connect to the first LAN host you may use
.HP
\fB\-\-connecthost\fR=\fI\,auto\-connect\/\fR
.HP
\fB\-\-starthost\fR
.IP
Auto create a host server.
.HP
\fB\-\-headless\-server\-mode\fR=\fI\,x\/\fR,x
.IP
Run as a headless server.
Where 'x' is an optional comma delimited command list of one or
more of the following:
.TP
exit
\- the application quits after all players have disconnected
.TP
vps
\- commands from the local console are NOT read (for some vps's)
.TP
lan
\- prevents broadcasting the hosting server to the masterserver
(for local LAN games).
.HP
\fB\-\-headless\-server\-status\fR
.IP
Check the current status of a headless server
.HP
\fB\-\-use\-ports\fR=\fI\,x\/\fR,y,z
.IP
Force hosted games to listen internally on port 'x', externally on
port 'y' and for game status on port 'z'
.IP
\&'x' \- internal listening port on the local machine
\&'y' \- external port on the router/proxy from which to forward connections
.IP
to the internal port
.IP
\&'z' \- game status port on the local machine from which to listen
.IP
for status requests
.IP
NOTE: If enabled, the FTP Server port's will be set to x+1 to x+9.
.HP
\fB\-\-server\-title\fR=\fI\,x\/\fR
.IP
Set server title.
.HP
\fB\-\-load\-scenario\fR=\fI\,x\/\fR
.IP
Auto load a scenario by scenario name.
.HP
\fB\-\-load\-mod\fR=\fI\,x\/\fR
.IP
Auto load a mod by mod pathname.
.HP
\fB\-\-preview\-map\fR=\fI\,Map\/\fR,Tileset
.IP
Auto Preview a map by map name. (tileset is optional)
.HP
\fB\-\-version\fR
.IP
Displays the version string of this program.
.HP
\fB\-\-opengl\-info\fR
.IP
Displays your video driver's OpenGL info.
.HP
\fB\-\-sdl\-info\fR
.IP
Displays your SDL version information.
.HP
\fB\-\-lua\-info\fR
.IP
Displays your LUA version information.
.HP
\fB\-\-lua\-debug\fR
.IP
Displays LUA debug information.
.HP
\fB\-\-curl\-info\fR
.IP
Displays your CURL version information.
.HP
\fB\-\-xerces\-info\fR
.IP
Displays your XERCES version information.
.HP
\fB\-\-validate\-techtrees\fR=\fI\,x=purgeunused=purgeduplicates=gitdelete=hideduplicates\/\fR
.IP
Display a report detailing any known problems related to
your selected techtrees game data.
.TP
x
\- comma\-delimited list of techtrees to validate
.TP
purgeunused
\- optional parameter telling the validation to delete
.IP
extra files in the techtree that are not used
.TP
purgeduplicates \- optional parameter telling the validation to merge
duplicate files in the techtree
.TP
gitdelete
\- optional parameter telling the validation to call
.IP
\&'git rm' on duplicate and unused files in the techtree
.TP
hideduplicates
\- optional parameter telling the validation to NOT
.TP
SHOW duplicate files in the techtree
*NOTE: This only applies when files are purged due to
the above flags being set.
.IP
example:
.IP
zetaglest \fB\-\-validate\-techtrees\fR=\fI\,zetapack\/\fR,vbros_pack_5
.PP
\fB\-\-validate\-factions\fR=\fI\,x=purgeunused=purgeduplicates=hideduplicates\/\fR
.IP
Display a report detailing any known problems related to
.IP
your selected factions game data.
.IP
Where x is a comma\-delimited list of factions to validate.
.IP
Where 'purgeunused' is an optional parameter telling the
.IP
validation to delete extra files in the faction that are
.IP
not used.
.IP
Where 'purgeduplicates' is an optional parameter telling the
.IP
validation to merge duplicate files in the faction.
.IP
Where 'hideduplicates' is an optional parameter telling the
.IP
validation to NOT SHOW duplicate files in the techtree.
.IP
*NOTE: leaving the list empty is the same as running:
.IP
\fB\-\-validate\-techtrees\fR
.IP
example: zetaglest \fB\-\-validate\-factions\fR=\fI\,tech\/\fR,egypt
.PP
\fB\-\-validate\-scenario\fR=\fI\,x=purgeunused=gitdelete\/\fR
.IP
Display a report detailing any known problems related to
.IP
your selected scenario game data.
.IP
Where x is a single scenario to validate.
.IP
Where 'purgeunused' is an optional parameter telling the
.IP
validation to delete extra files in the scenario that
.IP
are not used.
.IP
example: zetaglest \fB\-\-validate\-scenario\fR=\fI\,stranded\/\fR
.PP
\fB\-\-validate\-tileset\fR=\fI\,x=purgeunused=gitdelete\/\fR
.IP
Display a report detailing any known problems related to
.IP
your selected tileset game data.
.IP
Where x is a single tileset to validate.
.IP
Where 'purgeunused' is an optional parameter telling the
.IP
validation to delete extra files in the tileset that
.IP
are not used.
.IP
example: zetaglest \fB\-\-validate\-tileset\fR=\fI\,desert2\/\fR
.PP
\fB\-\-translate\-techtrees\fR=\fI\,x\/\fR
.IP
Produces a default lng file for the specified techtree to
.IP
prepare for translation into other languages.
.IP
Where x is a techtree name.
.PP
\fB\-\-list\-maps\fR=\fI\,x\/\fR Display a list of game content: maps.
.IP
Where x is an optional name filter.
.IP
example: zetaglest \fB\-\-list\-maps\fR=\fI\,island\/\fR*
.PP
\fB\-\-list\-techtrees\fR=\fI\,showfactions\/\fR
.IP
Display a list of game content: techtrees.
.IP
Where 'showfactions' is an optional parameter to display
.IP
factions in each techtree.
.IP
example: zetaglest \fB\-\-list\-techtrees\fR=\fI\,showfactions\/\fR
.PP
\fB\-\-list\-scenarios\fR=\fI\,x\/\fR Display a list of game content: scenarios.
.IP
Where x is an optional name filter.
.IP
example: zetaglest \fB\-\-list\-scenarios\fR=\fI\,beginner\/\fR*
.PP
\fB\-\-list\-tilesets\fR=\fI\,x\/\fR Display a list of game content: tilesets.
.IP
Where x is an optional name filter.
.IP
example: zetaglest \fB\-\-list\-tilesets\fR=\fI\,f\/\fR*
.PP
\fB\-\-list\-tutorials\fR=\fI\,x\/\fR Display a list of game content: tutorials.
.IP
Where x is an optional name filter.
.IP
example: zetaglest \fB\-\-list\-tutorials=\fR*
.PP
\fB\-\-data\-path\fR=\fI\,x\/\fR Sets the game data path to x.
.IP
example:
.IP
zetaglest \fB\-\-data\-path=\fR/usr/local/game_data/
.PP
\fB\-\-ini\-path\fR=\fI\,x\/\fR Sets the game ini path to x.
.IP
example: zetaglest \fB\-\-ini\-path=\fR~/game_config/
.PP
\fB\-\-log\-path\fR=\fI\,x\/\fR Sets the game logs path to x.
.IP
example: zetaglest \fB\-\-log\-path=\fR~/game_logs/
.PP
\fB\-\-font\-path\fR=\fI\,x\/\fR Sets the game fonts path to x.
.IP
example: zetaglest \fB\-\-font\-path=\fR~/myfonts/
.PP
\fB\-\-show\-ini\-settings\fR=\fI\,x\/\fR Display merged ini settings information.
.IP
Where x is an optional property name to filter (default
.IP
shows all).
.IP
example:
.IP
zetaglest \fB\-\-show\-ini\-settings\fR=\fI\,DebugMode\/\fR
.PP
\fB\-\-convert\-models\fR=\fI\,x=textureformat=keepsmallest\/\fR
.IP
Convert a model file or folder to the current g3d version
.IP
format.
.IP
Where x is a filename or folder containing the g3d model(s).
.IP
Where 'textureformat' is an optional supported texture
.IP
format to convert to (tga,bmp,jpg,png).
.IP
Where 'keepsmallest' is an optional flag indicating to keep
.IP
the original texture if its filesize is smaller than the
.IP
converted format.
.IP
example:
.IP
zetaglest \fB\-\-convert\-models\fR=\fI\,techs\/\fR/zetapack/factions/tech/
.IP
units/castle/models/castle.g3d=png=keepsmallest
.PP
\fB\-\-use\-language\fR=\fI\,x\/\fR Force the language to be the language specified
.IP
by x. Where x is a language filename or ISO639\-1 code.
.IP
example: zetaglest \fB\-\-use\-language\fR=\fI\,english\/\fR
.IP
example: zetaglest \fB\-\-use\-language\fR=\fI\,en\/\fR
.PP
\fB\-\-show\-map\-crc\fR=\fI\,x\/\fR Show the calculated CRC for the map named x.
.IP
Where x is a map name.
.IP
example: zetaglest \fB\-\-show\-map\-crc\fR=\fI\,four_rivers\/\fR
.PP
\fB\-\-show\-tileset\-crc\fR=\fI\,x\/\fR Show the calculated CRC for the tileset named x.
.IP
Where x is a tileset name.
.IP
example: zetaglest \fB\-\-show\-tileset\-crc\fR=\fI\,forest\/\fR
.PP
\fB\-\-show\-techtree\-crc\fR=\fI\,x\/\fR Show the calculated CRC for the techtree named x.
.IP
Where x is a techtree name.
.IP
example: zetaglest \fB\-\-show\-techtree\-crc\fR=\fI\,zetapack\/\fR
.PP
\fB\-\-show\-scenario\-crc\fR=\fI\,x\/\fR Show the calculated CRC for the scenario named x.
.IP
Where x is a scenario name.
.IP
example: zetaglest \fB\-\-show\-scenario\-crc\fR=\fI\,storming\/\fR
.PP
\fB\-\-show\-path\-crc\fR=\fI\,x=y\/\fR Show the calculated CRC for files in the path
.IP
located in x using file filter y.
.IP
Where x is a path name and y is file(s) filter.
.IP
example: zetaglest \fB\-\-show\-path\-crc\fR=\fI\,techs\/\fR/=zetapack.7z
.PP
\fB\-\-disable\-backtrace\fR Disables stack backtrace on errors.
.PP
\fB\-\-disable\-sigsegv\-handler\fR
.IP
Disables the sigsegv error handler.
.PP
\fB\-\-disable\-vbo\fR Disables trying to use Vertex Buffer Objects.
.PP
\fB\-\-disable\-vertex\-interpolation\fR
.IP
Disables interpolating animations to make them smoother.
.PP
\fB\-\-disable\-sound\fR Disables the sound system.
.PP
\fB\-\-enable\-legacyfonts\fR Enables using the legacy font system.
.PP
\fB\-\-resolution\fR=\fI\,x\/\fR Override the video resolution.
.IP
Where x is a string with the following format: 'width x height'.
.IP
example: zetaglest \fB\-\-resolution\fR=\fI\,1024x768\/\fR
.PP
\fB\-\-colorbits\fR=\fI\,x\/\fR Override the video colorbits.
.IP
Where x is a valid colorbits value supported by your video
.IP
driver.
.IP
example: zetaglest \fB\-\-colorbits\fR=\fI\,32\/\fR
.PP
\fB\-\-depthbits\fR=\fI\,x\/\fR Override the video depthbits.
.IP
Where x is a valid depthbits value supported by your video
.IP
driver.
.IP
example: zetaglest \fB\-\-depthbits\fR=\fI\,24\/\fR
.PP
\fB\-\-fullscreen\fR=\fI\,x\/\fR Override the video fullscreen mode.
.IP
Where x either true or false.
.IP
example: zetaglest \fB\-\-fullscreen\fR=\fI\,true\/\fR
.PP
\fB\-\-set\-gamma\fR=\fI\,x\/\fR Override the video gamma (contrast) value.
.IP
Where x is a floating point value.
.IP
example: zetaglest \fB\-\-set\-gamma\fR=\fI\,1\/\fR.5
.PP
\fB\-\-use\-font\fR=\fI\,x\/\fR Override the font to use.
.IP
Where x is the path and name of a font file supported by
.IP
freetype2.
.IP
example:
.IP
zetaglest \fB\-\-use\-font=\fR$APPLICATIONDATAPATH/data/core/fonts/Vera.ttf
.PP
\fB\-\-font\-basesize\fR=\fI\,x\/\fR Override the font base size.
.IP
Where x is the numeric base font size to use.
.IP
example: zetaglest \fB\-\-font\-basesize\fR=\fI\,5\/\fR
.PP
\fB\-\-disable\-videos\fR Disables video playback.
.PP
\fB\-\-disable\-opengl\-checks\fR
.IP
Disables opengl capability checks (for corrupt or flaky video
.IP
drivers).
.PP
\fB\-\-create\-data\-archives\fR=\fI\,x=y\/\fR
.IP
Compress selected game data into archives for network sharing.
.IP
Where x is one of the following data items to compress:
.IP
techtrees, tilesets or all.
.IP
Where y = include_main to include main (non mod) data.
.IP
example: zetaglest \fB\-\-create\-data\-archives\fR=\fI\,all\/\fR
.PP
\fB\-\-steam\fR=\fI\,x=y\/\fR
.IP
Run with Steam Client Integration.
.PP
\fB\-\-verbose\fR Displays verbose information in the console.
.PP
Compiled using: GNUC: 60300 [64bit] platform: Linux\-X64 endianness: little
version: [v0.8.02] \- using STREFLOP [SSE] \- [no\-denormals]