doc/man/freeciv-modpack.6.in

   1 .\" Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   2 .\"   This program is free software; you can redistribute it and/or modify
   3 .\"   it under the terms of the GNU General Public License as published by
   4 .\"   the Free Software Foundation; either version 2, or (at your option)
   5 .\"   any later version.
   6 .\"
   7 .\"   This program is distributed in the hope that it will be useful,
   8 .\"   but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 .\"   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10 .\"   GNU General Public License for more details.
  11 .\"
  12 .TH FREECIV 6 "May 24th 2014"
  13 .SH NAME
  14 freeciv-mp-gtk3, freeciv-mp-qt, freeciv-mp-cli \
  15 \- Custom content installers for the Freeciv game
  16 .SH SYNOPSIS
  17 .B freeciv-modpack \
  18 [ \-d|\-\-debug \fIlevel_number\fP ] \
  19 [ \-h|\-\-help ] \
  20 [ \-i|\-\-install \fIURL\fP ] \
  21 [ \-L|\-\-List \fIURL\fP ] \
  22 [ \-p|\-\-prefix \fIdirectory\fP ] \
  23 [ \-v|\-\-version ] \
  24
  25 .SH DESCRIPTION
  26 Freeciv is a free turn-based multiplayer strategy game, in which each player
  27 becomes the leader of a civilization, fighting to obtain the ultimate goal:
  28 To become the greatest civilization.
  29
  30 Players of Civilization II\*R by Microprose\*R should feel at home, since one
  31 aim of Freeciv is to have compatible rules.
  32
  33 Freeciv is maintained by an international team of coders and enthusiasts, and is
  34 easily one of the most fun and addictive network games out there!
  35
  36 This is the custom content installer program - see also
  37 .IR freeciv-server (6)
  38 .IR freeciv-client (6)
  39 \&.
  40
  41 This program allows users to select and download add-on content
  42 ("modpacks") for Freeciv from the Internet, either from a list
  43 maintained by the Freeciv team, or by using a URL obtained by other
  44 means. It takes care of installing the files in the correct place
  45 under the user's home directory for this version of Freeciv; it does
  46 not install anything for system-wide use.
  47
  48 This manual page only lists the command line arguments. For details
  49 regarding the options when using
  50 .B freeciv-modpack
  51 see the documentation at
  52 .UR @WIKI_URL@
  53 the Freeciv website
  54 .UE
  55 as well as the documentation which is part of the Freeciv distribution.
  56 .SH OPTIONS
  57 All options have a short
  58 form (single hyphen and single letter) and a long form (double hyphen
  59 and a complete word); their effects are identical.
  60 .TP
  61 .BI "\-d \fIlevel_number\fP, \-\-debug \fIlevel_number\fP"
  62 Sets the amount of debugging information to be logged.
  63 Acceptable values for the \fIlevel_number\fP are:
  64
  65 \fB0\fP    for fatal messages only.
  66
  67 \fB1\fP    for fatal and error messages.
  68
  69 \fB2\fP    for fatal, error and warning messages
  70
  71 \fB3\fP    for fatal, error, warning and normal messages (default).
  72
  73 \fB4\fP    for fatal, error, warning, normal, and verbose messages.
  74
  75 .TP
  76 .BI "\-h, \-\-help"
  77 Prints a short summary of the command line options.
  78 .TP
  79 .BI "\-i \fIURL\fP, \-\-install \fIURL\fP"
  80 Automatically install modpack from a given URL.
  81 .TP
  82 .BI "\-L \fIURL\fP, \-\-List \fIURL\fP"
  83 Gets modpack list from given URL, rather than the standard location on the
  84 Freeciv team's servers.
  85 .TP
  86 .BI "\-p \fIdirectory\fP, \-\-prefix \fIdirectory\fP"
  87 Installs modpacks under given directory hierarchy.
  88 .TP
  89 .BI "\-v, \-\-version"
  90 Prints the version number and exits.
  91 .SH FILES
  92 .B freeciv modpack installer
  93 installs files to the following subdirectories of the user's home directory
  94 (or another directory specified with \fI\-\-prefix\fP), as appropriate:
  95
  96 \(bu
  97 .I .freeciv/scenarios/
  98
  99 \(bu
 100 .I .freeciv/@DATASUBDIR@/
 101
 102 .B freeciv-mp-cli
 103 is version of the modpack installer usable from command line. By default
 104 it lists modpacks from the default list or from list specified with
 105 \fI\-\-List\fP. One can then run it again by giving appropriate
 106 URL from the list for \fI\-\-install\fP parameter.
 107
 108 .SH ENVIRONMENT
 109 .B freeciv modpack installer
 110 accepts these environment variables:
 111 .TP
 112 .BI HOME
 113 Specifies the user's home directory.
 114 .TP
 115 .BI http_proxy
 116 Set this variable accordingly when using a proxy.
 117 .TP
 118 \fBLANG\fP  or  \fBLANGUAGE\fP
 119 Sets the language and locale on some platforms.
 120 .TP
 121 \fBLC_ALL\fP  or  \fBLC_CTYPE\fP
 122 Similar to LANG (see documentation for your system).
 123 .TP
 124 .BI USER
 125 Specifies the username of the current user.
 126 .SH BUGS
 127 Please report bugs to
 128 .UR @BUG_URL@
 129 the Freeciv bug tracker
 130 .UE
 131 \&.
 132
 133 .SH "MORE INFO"
 134 See the
 135 .UR @WIKI_URL@
 136 Freeciv homepage
 137 .UE
 138 \&.
 139
 140 Updates and new info is first posted there.
 141 .SH AUTHORS
 142 The Freeciv Team <@MAIL_ADDRESS@>.
 143
 144 .SH "SEE ALSO"
 145 .IR freeciv-server (6)
 146 .IR freeciv-client (6)