doc/man/freeciv-manual.6.in

   1 .TH FREECIV "6" "January 2012" "Debian" "User Commands"
   2 .SH NAME
   3 freeciv-manual - Generate HTML manual for
   4 .IR freeciv-server(6)
   5 .SH SYNOPSIS
   6 .B freeciv-manual
   7 [\fIoption \fR...]
   8 .TP
   9 \fB\-d\fR, \fB\-\-debug\fR NUM
  10 Set debug log level (0 to 4)
  11 .TP
  12 \fB\-h\fR, \fB\-\-help\fR
  13 Print a summary of the options
  14 .TP
  15 \fB\-l\fR, \fB\-\-log\fR FILE
  16 Use FILE as logfile
  17 .HP
  18 \fB\-r\fR, \fB\-\-ruleset\fR RULESET Make manual for RULESET
  19 .TP
  20 \fB\-v\fR, \fB\-\-version\fR
  21 Print the version number
  22 .SH DESCRIPTION
  23 \fBfreeciv-manual\fR generates a subset of documentation for
  24 .IR freeciv-server(6)
  25 and the game rules of a selected ruleset that it runs. Currently it
  26 generates 7 files:
  27 .TP
  28 .BI "manual1.html"
  29 Server options
  30
  31 .TP
  32 .BI "manual2.html"
  33 Server commands
  34
  35 .TP
  36 .BI "manual3.html"
  37 Terrain
  38
  39 .TP
  40 .BI "manual4.html"
  41 Buildings
  42
  43 .TP
  44 .BI "manual5.html"
  45 Wonders
  46
  47 .TP
  48 .BI "manual6.html"
  49 Governments
  50
  51 .TP
  52 .BI "manual7.html"
  53 Unit types
  54
  55 .SH BUGS
  56 This tool is currently only really of use to the Freeciv maintainers,
  57 as a starting point for pages on the main Freeciv wiki; it's not very
  58 useful to end users.
  59
  60 Known shortcomings include that it is missing many ruleset features,
  61 and is hardcoded to output a mixture of MediaWiki markup and HTML.
  62
  63 .SH "REPORTING BUGS"
  64 Report bugs at @BUG_URL@
  65 (but see above caveats).
  66 .SH "SEE ALSO"
  67 .IR freeciv-server (6)
  68 and the Client Manual at the Freeciv homepage.