33#define SYN_ORIG_(String) "*" String
35#define SYN_TRANS_(String) ('*' == String[0] ? String + 1 : _(String))
43 char *(*extra_help_func)(
const char *cmdname);
56 N_(
"Start the game, or restart after loading a savegame."),
57 N_(
"This command starts the game. When starting a new game, "
58 "it should be used after all human players have connected, and "
59 "AI players have been created (if required), and any desired "
60 "changes to initial server options have been made. "
61 "After 'start', each human player will be able to "
62 "choose their nation, and then the game will begin. "
63 "This command is also required after loading a savegame "
64 "for the game to recommence. Once the game is running this command "
65 "is no longer available, since it would have no effect."),
NULL,
74 "help <command-name>\n"
75 "help <option-name>"),
76 N_(
"Show help about server commands and server options."),
77 N_(
"With no arguments gives some introductory help. "
78 "With argument \"commands\" or \"options\" gives respectively "
79 "a list of all commands or all options. "
80 "Otherwise the argument is taken as a command name or option name, "
81 "and help is given for that command or option. For options, the help "
82 "information includes the current and default values for that option. "
83 "The argument may be abbreviated where unambiguous."),
NULL,
94 "list ignored users\n"
95 "list map image definitions\n"
102 N_(
"Show a list of various things."),
104 N_(
"Show a list of:\n"
106 " - the player colors,\n"
107 " - connections to the server,\n"
108 " - all player delegations,\n"
109 " - your ignore list,\n"
110 " - the list of defined map images,\n"
111 " - the list of the players in the game,\n"
112 " - the available rulesets (for 'read' command),\n"
113 " - the available scenarios,\n"
114 " - the available nation sets in this ruleset,\n"
115 " - the teams of players or\n"
116 " - the running votes.\n"
117 "The argument may be abbreviated, and defaults to 'players' if "
124 N_(
"Quit the game and shutdown the server."),
NULL,
NULL,
129 N_(
"cut <connection-name>"),
130 N_(
"Cut a client's connection to server."),
131 N_(
"Cut specified client's connection to the server, removing that client "
132 "from the game. If the game has not yet started that client's player "
133 "is removed from the game, otherwise there is no effect on the player. "
134 "Note that this command now takes connection names, not player names."),
141 "explain <option-name>"),
142 N_(
"Explain server options."),
143 N_(
"The 'explain' command gives a subset of the functionality of 'help', "
144 "and is included for backward compatibility. With no arguments it "
145 "gives a list of options (like 'help options'), and with an argument "
146 "it gives help for a particular option (like 'help <option-name>')."),
153 "show <option-name>\n"
154 "show <option-prefix>\n"
162 N_(
"Show server options."),
163 N_(
"With no arguments, shows vital server options (or available options, "
164 "when used by clients). With an option name argument, show only the "
165 "named option, or options with that prefix. With \"all\", it shows "
166 "all options. With \"vital\", \"situational\" or \"rare\", a set of "
167 "options with this level. With \"changed\", it shows only the options "
168 "which have been modified, while with \"locked\" all settings locked "
169 "by the ruleset will be listed. With \"ruleset\", it will show the "
170 "current ruleset directory name."),
NULL,
175 N_(
"wall <message>"),
176 N_(
"Send message to all connections."),
177 N_(
"For each connected client, pops up a window showing the message "
183 N_(
"connectmsg <message>"),
184 N_(
"Set message to show to connecting players."),
185 N_(
"Set message to send to clients when they connect.\n"
186 "Empty message means that no message is sent."),
NULL,
191 N_(
"vote yes|no|abstain [vote number]"),
195 N_(
"A player with basic level access issuing a control level command "
196 "starts a new vote for the command. The /vote command followed by "
197 "\"yes\", \"no\", or \"abstain\", and optionally a vote number, "
198 "gives your vote. If you do not add a vote number, your vote applies "
199 "to the latest vote. You can only suggest one vote at a time. "
200 "The vote will pass immediately if more than half of the voters "
201 "who have not abstained vote for it, or fail immediately if at "
202 "least half of the voters who have not abstained vote against it."),
208 N_(
"debug diplomacy <player>\n"
210 "debug tech <player>\n"
211 "debug city <x> <y>\n"
212 "debug units <x> <y>\n"
216 N_(
"Turn on or off AI debugging of given entity."),
217 N_(
"Print AI debug information about given entity and turn continuous "
218 "debugging output for this entity on or off."),
NULL,
223 N_(
"set <option-name> <value>"),
224 N_(
"Set server option."),
226 N_(
"Set an option on the server. The syntax and legal values depend "
227 "on the option; see the help for each option. Some options are "
228 "\"bitwise\", in that they consist of a choice from a set of values; "
229 "separate these with |, for instance, '/set topology wrapx|iso'. For "
230 "these options, use syntax like '/set topology \"\"' to set no "
236 N_(
"team <player> <team>"),
237 N_(
"Change a player's team affiliation."),
238 N_(
"A team is a group of players that start out allied, with shared "
239 "vision and embassies, and fight together to achieve team victory "
240 "with averaged individual scores. Each player is always a member "
241 "of a team (possibly the only member). This command changes which "
242 "team a player is a member of. Use \"\" if names contain whitespace."),
248 N_(
"rulesetdir <directory>"),
249 N_(
"Choose new ruleset directory or modpack."),
255 N_(
"metamessage <meta-line>"),
256 N_(
"Set metaserver info line."),
257 N_(
"This command is deprecated. Set metamessage setting directly instead. "
258 "Command sets user defined metaserver info line. If parameter is omitted, "
259 "previously set metamessage will be removed. For most of the time "
260 "user defined metamessage will be used instead of automatically "
261 "generated messages, if it is available."),
NULL,
266 N_(
"metapatches <meta-line>"),
267 N_(
"Set metaserver patches line."),
NULL,
NULL,
273 "metaconnection d|down\n"
274 "metaconnection p|persistent\n"
276 N_(
"Control metaserver connection."),
277 N_(
"'metaconnection ?' reports on the status of the connection to metaserver. "
278 "'metaconnection down' or 'metac d' brings the metaserver connection down. "
279 "'metaconnection up' or 'metac u' brings the metaserver connection up. "
280 "'metaconnection persistent' or 'metac p' is like 'up', but keeps trying after failures. "),
286 N_(
"metaserver <address>"),
287 N_(
"Set address (URL) for metaserver to report to."),
NULL,
NULL,
292 N_(
"aitoggle <player-name>"),
293 N_(
"Toggle AI status of player."),
NULL,
NULL,
298 N_(
"take [connection-name] <player-name>"),
299 N_(
"Take over a player's place in the game."),
301 N_(
"Only the console and connections with cmdlevel 'hack' can force "
302 "other connections to take over a player. If you're not one of these, "
303 "only the <player-name> argument is allowed. If '-' is given for the "
304 "player name and the connection does not already control a player, one "
305 "is created and assigned to the connection. The 'allowtake' option "
306 "controls which players may be taken and in what circumstances."),
312 N_(
"observe [connection-name] [player-name]"),
313 N_(
"Observe a player or the whole game."),
315 N_(
"Only the console and connections with cmdlevel 'hack' can force "
316 "other connections to observe a player. If you're not one of these, "
317 "only the [player-name] argument is allowed. If the console gives no "
318 "player-name or the connection uses no arguments, then the connection "
319 "is attached to a global observer. The 'allowtake' option controls "
320 "which players may be observed and in what circumstances."),
NULL,
325 N_(
"detach <connection-name>"),
326 N_(
"Detach from a player."),
327 N_(
"Only the console and connections with cmdlevel 'hack' can force "
328 "other connections to detach from a player."),
NULL,
333 N_(
"create <player-name> [ai type]"),
334 N_(
"Create an AI player with a given name."),
336 N_(
"With the 'create' command a new player with the given name is "
338 "If 'player-name' is empty, a random name will be assigned when the "
339 "game begins. Until then the player will be known by a name derived "
341 "The 'ai type' parameter can be used to select which AI module will be "
342 "used for the created player. This requires that the respective module "
343 "has been loaded or built in to the server.\n"
344 "If the game has already started, the new player will have no units or "
345 "cities; also, if no free player slots are available, the slot of a "
346 "dead player can be reused (removing all record of that player from the "
347 "running game)."),
NULL,
353 N_(
"Set yourself in away mode. The AI will watch your back."),
360 "restricted <player-name>"),
368 "novice <player-name>"),
376 "easy <player-name>"),
384 "normal <player-name>"),
392 "hard <player-name>"),
400 "cheating <player-name>"),
409 "experimental <player-name>"),
419 "cmdlevel <level> new\n"
420 "cmdlevel <level> first\n"
421 "cmdlevel <level> <connection-name>"),
422 N_(
"Query or set command access level access."),
423 N_(
"The command access level controls which server commands are available "
424 "to users via the client chatline. The available levels are:\n"
425 " none - no commands\n"
426 " info - informational or observer commands only\n"
427 " basic - commands available to players in the game\n"
428 " ctrl - commands that affect the game and users\n"
429 " admin - commands that affect server operation\n"
430 " hack - *all* commands - dangerous!\n"
431 "With no arguments, the current command access levels are reported. "
432 "With a single argument, the level is set for all existing "
433 "connections, and the default is set for future connections. "
434 "If 'new' is specified, the level is set for newly connecting clients. "
435 "If 'first come' is specified, the 'first come' level is set; it will be "
436 "granted to the first client to connect, or if there are connections "
437 "already, the first client to issue the 'first' command. "
438 "If a connection name is specified, the level is set for that "
440 "Command access levels do not persist if a client disconnects, "
441 "because some untrusted person could reconnect with the same name. "
442 "Note that this command now takes connection names, not player names."
449 N_(
"If there is none, become the game organizer with increased permissions."),
455 N_(
"timeoutincrease <turn> <turninc> <value> <valuemult>"),
456 N_(
"See \"/help timeoutincrease\"."),
457 N_(
"Every <turn> turns, add <value> to timeout timer, then add <turninc> "
458 "to <turn> and multiply <value> by <valuemult>. Use this command in "
459 "concert with the option \"timeout\". Defaults are 0 0 0 1"),
NULL,
465 "cancelvote <vote number>\n"
468 N_(
"Cancel a running vote."),
470 N_(
"With no arguments this command removes your own vote. If you have "
471 "an admin access level, you can cancel any vote by vote number, or "
472 "all votes with the \'all\' argument."),
NULL,
477 N_(
"ignore [type=]<pattern>"),
478 N_(
"Block all messages from users matching the pattern."),
479 N_(
"The given pattern will be added to your ignore list; you will not "
480 "receive any messages from users matching this pattern. The type "
481 "may be either \"user\", \"host\", or \"ip\". The default type "
482 "(if omitted) is to match against the username. The pattern supports "
483 "unix glob style wildcards, i.e., * matches zero or more character, ? "
484 "exactly one character, [abc] exactly one of 'a' 'b' or 'c', etc. "
485 "To access your current ignore list, issue \"/list ignore\"."),
NULL,
490 N_(
"unignore <range>"),
491 N_(
"Remove ignore list entries."),
492 N_(
"The ignore list entries in the given range will be removed; "
493 "you will be able to receive messages from the respective users. "
494 "The range argument may be a single number or a pair of numbers "
495 "separated by a dash '-'. If the first number is omitted, it is "
496 "assumed to be 1; if the last is omitted, it is assumed to be "
497 "the last valid ignore list index. To access your current ignore "
498 "list, issue \"/list ignore\"."),
NULL,
503 N_(
"playercolor <player-name> <color>\n"
504 "playercolor <player-name> reset"),
505 N_(
"Define the color of a player."),
506 N_(
"This command sets the color of a specific player, overriding any color "
507 "assigned according to the 'plrcolormode' setting.\n"
508 "The color is defined using hexadecimal notation (hex) for the "
509 "combination of Red, Green, and Blue color components (RGB), similarly "
510 "to HTML. For each component, the lowest (darkest) value is 0 (in "
511 "hex: 00), and the highest value is 255 (in hex: FF). The color "
512 "definition is simply the three hex values concatenated together "
513 "(RRGGBB). For example, the following command sets Caesar to pure red:\n"
514 " playercolor Caesar ff0000\n"
515 "Before the game starts, this command can only be used if the "
516 "'plrcolormode' setting is set to 'PLR_SET'; a player's color can be "
517 "unset again by specifying 'reset'.\n"
518 "Once the game has started and colors have been assigned, this command "
519 "changes the player color in any mode; 'reset' cannot be used.\n"
520 "To list the player colors, use 'list colors'."),
NULL,
525 N_(
"playernation <player-name> [nation] [is-male] [leader] [style]"),
526 N_(
"Define the nation of a player."),
527 N_(
"This command sets the nation, leader name, style, and gender of a "
528 "specific player.\nThe gender parameter should be 1 if male, "
529 "otherwise 0. Omitting any of the player settings will reset the "
530 "player to defaults.\n"
531 "This command may not be used once the game has started."),
NULL,
537 N_(
"End the game immediately in a draw."),
NULL,
NULL,
543 N_(
"Concede the game."),
544 N_(
"This tells everyone else that you concede the game, and if all "
545 "but one player (or one team) have conceded the game in this way "
546 "then the game ends."),
NULL,
551 N_(
"remove <player-name>"),
552 N_(
"Fully remove player from game."),
553 N_(
"This *completely* removes a player from the game, including "
554 "all cities and units etc. Use with care!"),
NULL,
561 N_(
"Save game to file."),
562 N_(
"Save the current game to file <file-name>. If no file-name "
563 "argument is given saves to \"<auto-save name prefix><year>m.sav[.gz]\". "
564 "To reload a savegame created by 'save', start the server with "
565 "the command-line argument:\n"
566 " '--file <filename>' or '-f <filename>'\n"
567 "and use the 'start' command once players have reconnected."),
NULL,
573 "scensave <file-name>"),
574 N_(
"Save game to file as scenario."),
575 N_(
"Save the current game to file <file-name> as scenario. If no file-name "
576 "argument is given saves to \"<auto-save name prefix><year>m.sav[.gz]\". "
577 "To reload a savegame created by 'scensave', start the server with "
578 "the command-line argument:\n"
579 " '--file <filename>' or '-f <filename>'\n"
580 "and use the 'start' command once players have reconnected."),
NULL,
587 N_(
"Load game from file."),
588 N_(
"Load a game from <file-name>. Any current data including players, "
589 "rulesets and server options are lost."),
NULL,
594 N_(
"read <file-name>"),
595 N_(
"Process server commands from file."),
NULL,
NULL,
600 N_(
"write <file-name>"),
601 N_(
"Write current settings as server commands to file."),
NULL,
NULL,
606 SYN_ORIG_(
"reset [game|ruleset|script|default]"),
607 N_(
"Reset all server settings."),
608 N_(
"Reset all settings if it is possible. The following levels are "
610 " game - using the values defined at the game start\n"
611 " ruleset - using the values defined in the ruleset\n"
612 " script - using default values and rereading the start script\n"
613 " default - using default values\n"),
NULL,
618 N_(
"default <option name>"),
619 N_(
"Set option to its default value"),
620 N_(
"Reset the option to its default value. If the default ever changes "
621 "in a future version, the option's value will follow that change."),
627 N_(
"lua cmd <script line>\n"
628 "lua unsafe-cmd <script line>\n"
629 "lua file <script file>\n"
630 "lua unsafe-file <script file>\n"
631 "lua <script line> (deprecated)"),
632 N_(
"Evaluate a line of Freeciv script or a Freeciv script file in the "
635 N_(
"Subcommands with the 'unsafe' prefix run the script in an instance "
636 "separate from the ruleset. This instance doesn't restrict access "
637 "to Lua functions that can be used to hack the computer running "
638 "the Freeciv server. Access to it is therefore limited to the console "
639 "and connections with cmdlevel 'hack'"),
NULL,
645 N_(
"Cut a connection and disallow reconnect."),
646 N_(
"The connection given by the 'user' argument will be cut from the "
647 "server and not allowed to reconnect. The time the user wouldn't be "
648 "able to reconnect is controlled by the 'kicktime' setting."),
NULL,
653 N_(
"delegate to <username> [player-name]\n"
654 "delegate cancel [player-name]\n"
655 "delegate take <player-name>\n"
657 "delegate show <player-name>"),
658 N_(
"Delegate control to another user."),
659 N_(
"Delegation allows a user to nominate another user who can temporarily "
660 "take over control of their player while they are away.\n"
661 "'delegate to <username>': allow <username> to 'delegate take' your "
663 "'delegate cancel': nominated user can no longer take your player.\n"
664 "'delegate take <player-name>': take control of a player who has been "
665 "delegated to you. (Behaves like 'take', except that the 'allowtake' "
666 "restrictions are not enforced.)\n"
667 "'delegate restore': relinquish control of a delegated player (opposite "
668 "of 'delegate take') and restore your previous view, if any. (This also "
669 "happens automatically if the player's owner reconnects.)\n"
670 "'delegate show': show who control of your player is currently "
671 "delegated to, if anyone.\n"
672 "The [player-name] argument can only be used by connections with "
673 "cmdlevel 'admin' or above to force the corresponding change of the "
674 "delegation status."),
NULL,
679 N_(
"aicmd <player> <command>"),
680 N_(
"Execute AI command"),
681 N_(
"Execute a command in the context of the AI for the given player"),
688 "fcdb lua <script>"),
689 N_(
"Manage the authentication database."),
690 N_(
"The argument 'reload' causes the database script file to be re-read "
691 "after a change, while the argument 'lua' evaluates a line of Lua "
692 "script in the context of the Lua instance for the database."),
NULL,
697 N_(
"mapimg define <mapdef>\n"
698 "mapimg show <id>|all\n"
699 "mapimg create <id>|all\n"
700 "mapimg delete <id>|all\n"
702 N_(
"Create image files of the world/player map."),
708 N_(
"lock <setting>"),
709 N_(
"Lock setting so that non-admins can't change it."),
715 N_(
"unlock <setting>"),
716 N_(
"Unlock setting so that non-admins can change it."),
723 N_(
"Switch server output between 'RFC-style' and normal style."),
NULL,
NULL,
729 N_(
"Simply returns the id of the server."),
NULL,
NULL,
static struct command commands[]
enum cmd_echo command_echo(const struct command *pcommand)
#define SYN_TRANS_(String)
const char * command_name_by_number(int i)
const char * command_name(const struct command *pcommand)
int command_vote_percent(const struct command *pcommand)
#define SYN_ORIG_(String)
const struct command * command_by_number(int i)
int command_vote_flags(const struct command *pcommand)
const char * command_short_help(const struct command *pcommand)
char * command_extra_help(const struct command *pcommand)
enum cmdlevel command_level(const struct command *pcommand)
const char * command_synopsis(const struct command *pcommand)
char * ai_level_help(const char *cmdname)
#define fc_assert(condition)
#define fc_assert_ret_val(condition, val)
char * mapimg_help(const char *cmdname)