FREECIV21-MANUAL(6)

NAME
freeciv21-manual - Write a manual for a Freeciv21 ruleset.

SYNOPSIS

freeciv21-manual [ -l|--log <FILE> ] [ -r|--ruleset <RULESET> ] [ -w|--wiki ] [ -h|--help ] [ -v|--version ]

DESCRIPTION

Freeciv21 is a free open source turn-based empire-building 4x strategy game, in which each player becomes the leader of a civilization. You compete against several opponents to build cities and use them to support a military and an economy. Players strive to complete an empire that survives all encounters with its neighbors to emerge victorious. Play begins at the dawn of history in 4,000 BCE.

Freeciv21 takes its roots in the well-known FOSS game Freeciv and extends it for more fun, with a revived focus on competitive multiplayer environments. Players can choose from over 500 nations and can play against the computer or other people in an active online community.

The code is maintained by the team over at Longturn.net and is based on the QT framework. The game supports both hex and square tiles and is easily modified to create custom rules.

This is a program to read a set of RULESET files and write a manual to a set of HTML files of the same name.

OPTIONS

The following options are accepted on the command line of the manual generator. They may not be combined as with other tools. For example: freeciv21-manual -rw civ2civ3 will not work. Instead you will need to enter each option separately, such as, freevic21-manual -r civ2civ3 -w.

-d, --debug <LEVEL>
    Set debug log level (fatal/critical/warning/info/debug). Default log level is info.

-F, --Fatal
    Raise a signal on failed assertion. An assertion is a code calculation error. With this set, the client process will SEGFAULT instead of issuing a warning message to the terminal console.

-l, --log <FILE>
    Use FILE as logfile.

-r, --ruleset <RULESET>
    Make manual for RULESET.

-w, --wiki
    Write manual in wiki format.

-h, --help
    Display help on command line options.

--help-all
    Display help including Qt specific options.

-v, --version
    Display version information.

USER
    Specifies the username of the current user.

BUGS

Please report bugs to the Freeciv21 bug tracker at <https://github.com/longturn/freeciv21/issues/new/choose>

MORE INFORMATION

See the Longturn home page at <https://longturn.net/>. You can also find the code repository at <https://github.com/longturn/freeciv21/>.

Author
Freeciv21 and Freeciv Contributors

Copyright
GPL-3.0-or-later, Freeciv21 and Freeciv Contributors