Standardize command usage messages:

[xonotic/xonotic-data.pk3dir.git] / qcsrc / server / command / sv_cmd.qc

diff --git a/qcsrc/server/command/sv_cmd.qc b/qcsrc/server/command/sv_cmd.qc
index 508b8b6b9b91b7238d89e684011f72ea170d29d3..a8f83956e753b4786a8afb0a76d0c76415b8aa3e 100644 (file)
--- a/qcsrc/server/command/sv_cmd.qc
+++ b/qcsrc/server/command/sv_cmd.qc
@@ -144,7 +144,7 @@ void GameCommand_adminmsg(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd adminmsg clients \"message\" [infobartime]");
+                       LOG_HELP("Usage:^3 sv_cmd adminmsg <clients> \"<message>\" [<infobartime>]");
                        LOG_HELP("  'clients' is a list (separated by commas) of player entity ID's or nicknames");
                        LOG_HELP("  If infobartime is provided, the message will be sent to infobar.");
                        LOG_HELP("  Otherwise, it will just be sent as a centerprint message.");
@@ -196,7 +196,7 @@ void GameCommand_allspec(int request, int argc)
                default:
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd allspec [reason]");
+                       LOG_HELP("Usage:^3 sv_cmd allspec [<reason>]");
                        LOG_HELP("  Where 'reason' is an optional argument for explanation of allspec command.");
                        LOG_HELP("See also: ^2moveplayer, shuffleteams^7");
                        return;
@@ -228,7 +228,7 @@ void GameCommand_anticheat(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd anticheat client");
+                       LOG_HELP("Usage:^3 sv_cmd anticheat <client>");
                        LOG_HELP("  'client' is the entity number or name of the player.");
                        return;
                }
@@ -430,10 +430,10 @@ void GameCommand_bot_cmd(int request, int argc, string command)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd bot_cmd client command [argument]");
+                       LOG_HELP("Usage:^3 sv_cmd bot_cmd <client> <command> [<arguments>]");
                        LOG_HELP("  'client' can be either the name of the bot or a progressive number (not the entity number!)");
                        LOG_HELP("           can also be '*' or 'all' to allow sending the command to all the bots");
-                       LOG_HELP("  For full list of commands, see bot_cmd help [command].");
+                       LOG_HELP("  For full list of commands, see bot_cmd help [<command>].");
                        LOG_HELP("Examples: sv_cmd bot_cmd 1 cc \"say something\"");
                        LOG_HELP("          sv_cmd bot_cmd 1 presskey jump");
                        LOG_HELP("          sv_cmd bot_cmd * pause");
@@ -459,7 +459,7 @@ void GameCommand_cointoss(int request, int argc)
                default:
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd cointoss [result1 result2]");
+                       LOG_HELP("Usage:^3 sv_cmd cointoss [<result1> <result2>]");
                        LOG_HELP("  Where 'result1' and 'result2' are user created options.");
                        return;
                }
@@ -500,7 +500,7 @@ void GameCommand_database(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd database action filename");
+                       LOG_HELP("Usage:^3 sv_cmd database <action> <filename>");
                        LOG_HELP("  Where 'action' is the command to complete,");
                        LOG_HELP("  and 'filename' is what it acts upon.");
                        LOG_HELP("  Full list of commands here: \"save, dump, load.\"");
@@ -538,7 +538,7 @@ void GameCommand_defer_clear(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd defer_clear client");
+                       LOG_HELP("Usage:^3 sv_cmd defer_clear <client>");
                        LOG_HELP("  'client' is the entity number or name of the player.");
                        LOG_HELP("See also: ^2defer_clear_all^7");
                        return;
@@ -593,7 +593,7 @@ void GameCommand_delrec(int request, int argc)  // perhaps merge later with reco
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd delrec ranking [map]");
+                       LOG_HELP("Usage:^3 sv_cmd delrec <ranking> [<map>]");
                        LOG_HELP("  'ranking' is which ranking level to clear up to, ");
                        LOG_HELP("  it will clear all records up to nth place.");
                        LOG_HELP("  if 'map' is not provided it will use current map.");
@@ -751,7 +751,7 @@ void GameCommand_gametype(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd gametype mode");
+                       LOG_HELP("Usage:^3 sv_cmd gametype <mode>");
                        LOG_HELP("  Where 'mode' is the gametype mode to switch to.");
                        LOG_HELP("See also: ^2gotomap^7");
                        return;
@@ -817,7 +817,7 @@ void GameCommand_gettaginfo(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd gettaginfo model frame index [command one] [command two]");
+                       LOG_HELP("Usage:^3 sv_cmd gettaginfo <model> <frame> <index> [<command1>] [<command2>]");
                        LOG_HELP("See also: ^2bbox, trace^7");
                        return;
                }
@@ -900,7 +900,7 @@ void GameCommand_gotomap(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd gotomap map");
+                       LOG_HELP("Usage:^3 sv_cmd gotomap <map>");
                        LOG_HELP("  Where 'map' is the *.bsp file to change to.");
                        LOG_HELP("See also: ^2gametype^7");
                        return;
@@ -1097,7 +1097,7 @@ void GameCommand_moveplayer(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd moveplayer clients destination");
+                       LOG_HELP("Usage:^3 sv_cmd moveplayer <clients> <destination>");
                        LOG_HELP("  'clients' is a list (separated by commas) of player entity ID's or nicknames");
                        LOG_HELP("  'destination' is what to send the player to, be it team or spectating");
                        LOG_HELP("  Full list of destinations here: \"spec, spectator, red, blue, yellow, pink, auto.\"");
@@ -1222,7 +1222,7 @@ void GameCommand_setbots(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd setbots botnumber");
+                       LOG_HELP("Usage:^3 sv_cmd setbots <botnumber>");
                        LOG_HELP("  Where 'botnumber' is the amount of bots to set bot_number cvar to.");
                        LOG_HELP("See also: ^2bot_cmd^7");
                        return;
@@ -1333,7 +1333,7 @@ void GameCommand_stuffto(int request, int argc)
                                LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                        case CMD_REQUEST_USAGE:
                        {
-                               LOG_HELP("Usage:^3 sv_cmd stuffto client \"command\"");
+                               LOG_HELP("Usage:^3 sv_cmd stuffto <client> \"<command>\"");
                                LOG_HELP("  'client' is the entity number or name of the player,");
                                LOG_HELP("  and 'command' is the command to be sent to that player.");
                                return;
@@ -1514,9 +1514,9 @@ void GameCommand_trace(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd trace command [startpos endpos] [endpos_height]");
-                       LOG_HELP("  Where startpos and endpos are parameters for 'walk' and 'showline' commands,");
-                       LOG_HELP("  'endpos_height' is an optional parameter for 'walk' command,");
+                       LOG_HELP("Usage:^3 sv_cmd trace <command> [<startpos> <endpos>] [<endpos_height>]");
+                       LOG_HELP("  Where startpos and endpos are parameters for the 'walk' and 'showline' commands,");
+                       LOG_HELP("  'endpos_height' is an optional parameter for the 'walk' command,");
                        LOG_HELP("  Full list of commands here: \"debug, debug2, walk, showline.\"");
                        LOG_HELP("See also: ^2bbox, gettaginfo^7");
                        return;
@@ -1582,7 +1582,7 @@ void GameCommand_warp(int request, int argc)
                default:
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 sv_cmd warp [level]");
+                       LOG_HELP("Usage:^3 sv_cmd warp [<level>]");
                        LOG_HELP("  'level' is the level to change campaign mode to.");
                        LOG_HELP("  if 'level' is not provided it will change to the next level.");
                        return;
@@ -1711,8 +1711,8 @@ void GameCommand(string command)
                        LOG_HELP("\nGeneric commands shared by all programs:");
                        GenericCommand_macro_help();
 
-                       LOG_HELP("\nUsage:^3 sv_cmd COMMAND...^7, where possible commands are listed above.\n"
-                               "For help about a specific command, type sv_cmd help COMMAND");
+                       LOG_HELP("\nUsage:^3 sv_cmd <command>^7, where possible commands are listed above.\n"
+                               "For help about a specific command, type sv_cmd help <command>");
 
                        return;
                }