]> git.rm.cloudns.org Git - xonotic/xonotic-data.pk3dir.git/commitdiff
Standardize command usage messages, part 2 (mostly arguments descriptions)
authorterencehill <piuntn@gmail.com>
Wed, 10 Feb 2021 14:01:25 +0000 (15:01 +0100)
committerterencehill <piuntn@gmail.com>
Wed, 10 Feb 2021 14:01:25 +0000 (15:01 +0100)
15 files changed:
qcsrc/client/command/cl_cmd.qc
qcsrc/common/command/generic.qc
qcsrc/common/debug.qh
qcsrc/common/effects/effectinfo.qc
qcsrc/common/notifications/all.qh
qcsrc/common/turrets/all.qh
qcsrc/common/weapons/all.qc
qcsrc/common/weapons/all.qh
qcsrc/menu/command/menu_cmd.qc
qcsrc/server/cheats.qc
qcsrc/server/command/banning.qc
qcsrc/server/command/cmd.qc
qcsrc/server/command/common.qc
qcsrc/server/command/sv_cmd.qc
qcsrc/server/command/vote.qc

index 2df0b83724bae31a65b592694abf580290a8addf..49683b50db3d934d9770facb4f13493576b178ff 100644 (file)
@@ -109,14 +109,14 @@ void LocalCommand_boxparticles(int request, int argc)
                {
                        LOG_HELP(
                                "Usage:^3 cl_cmd boxparticles <effectname> <owner> <org_from> <org_to> <dir_from> <dir_to> <countmultiplier> <flags>\n"
-                               "  'effectname' is the name of a particle effect in effectinfo.txt\n"
-                               "  'owner' is the entity number of the owner (negative for csqc ent, positive for svqc ent)\n"
-                               "  'org_from' is the starting origin of the box\n"
-                               "  'org_to' is the ending origin of the box\n"
-                               "  'dir_from' is the minimum velocity\n"
-                               "  'dir_to' is the maximum velocity\n"
-                               "  'countmultiplier' defines a multiplier for the particle count (affects count only, not countabsolute or trailspacing)\n"
-                               "  'flags' can contain:\n"
+                               "  <effectname> is the name of a particle effect in effectinfo.txt\n"
+                               "  <owner> is the entity number of the owner (negative for csqc ent, positive for svqc ent)\n"
+                               "  <org_from> is the starting origin of the box\n"
+                               "  <org_to> is the ending origin of the box\n"
+                               "  <dir_from> is the minimum velocity\n"
+                               "  <dir_to> is the maximum velocity\n"
+                               "  <countmultiplier> defines a multiplier for the particle count (affects count only, not countabsolute or trailspacing)\n"
+                               "  <flags> can contain:\n"
                                "    1 to respect globals particles_alphamin, particles_alphamax (set right before via prvm_globalset client)\n"
                                "    2 to respect globals particles_colormin, particles_colormax (set right before via prvm_globalset client)\n"
                                "    4 to respect globals particles_fade (set right before via prvm_globalset client)\n"
@@ -161,7 +161,7 @@ void LocalCommand_create_scrshot_ent(int request)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 cl_cmd create_scrshot_ent [<path>]");
-                       LOG_HELP("  Where 'path' can be the subdirectory of data/data in which the file is saved.");
+                       LOG_HELP("  Where <path> can be the subdirectory of data/data in which the file is saved.");
                        return;
                }
        }
@@ -191,7 +191,7 @@ void LocalCommand_debugmodel(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 cl_cmd debugmodel <model>");
-                       LOG_HELP("  Where 'model' is a string of the model name to use for the debug model.");
+                       LOG_HELP("  Where <model> is a string of the model name to use for the debug model.");
                        return;
                }
        }
@@ -239,7 +239,7 @@ void LocalCommand_handlevote(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 cl_cmd handlevote <vote>");
-                       LOG_HELP("  Where 'vote' is the selection for either the current poll or uid2name.");
+                       LOG_HELP("  Where <vote> is the selection for either the current poll or uid2name.");
                        return;
                }
        }
@@ -329,11 +329,11 @@ void LocalCommand_hud(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 cl_cmd hud <action> [<configname> | <radartoggle> | <layout>]");
-                       LOG_HELP("  Where 'action' is the command to complete,");
-                       LOG_HELP("  'configname' is the name to save to for \"save\" action,");
-                       LOG_HELP("  'radartoggle' is to maximize/minimize radar for \"radar\" action,");
-                       LOG_HELP("  and 'layout' is how to organize the scoreboard columns for \"scoreboard_columns_set\" action.");
-                       LOG_HELP("  Full list of commands here: \"configure, quickmenu, minigame, save, scoreboard_columns_help, scoreboard_columns_set, radar.\"");
+                       LOG_HELP("  Where <action> is the command to complete,");
+                       LOG_HELP("  <configname> is the name to save to for 'save' action,");
+                       LOG_HELP("  <radartoggle> is to maximize/minimize radar for 'radar' action,");
+                       LOG_HELP("  and <layout> is how to organize the scoreboard columns for 'scoreboard_columns_set' action.");
+                       LOG_HELP("  Full list of commands here: configure, quickmenu, minigame, save, scoreboard_columns_help, scoreboard_columns_set, radar.");
                        return;
                }
        }
@@ -357,8 +357,8 @@ void LocalCommand_localprint(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 cl_cmd localprint \"message\"");
-                       LOG_HELP("  'message' is the centerprint message to send to yourself.");
+                       LOG_HELP("Usage:^3 cl_cmd localprint \"<message>\"");
+                       LOG_HELP("  <message> is the centerprint message to send to yourself.");
                        return;
                }
        }
@@ -383,7 +383,7 @@ void LocalCommand_mv_download(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 cl_cmd mv_download <mapid>");
-                       LOG_HELP("  Where 'mapid' is the id number of the map to request an image of on the map vote selection menu.");
+                       LOG_HELP("  Where <mapid> is the id number of the map to request an image of on the map vote selection menu.");
                        return;
                }
        }
@@ -418,7 +418,7 @@ void LocalCommand_sendcvar(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 cl_cmd sendcvar <cvar>");
-                       LOG_HELP("  Where 'cvar' is the cvar to send to the server.");
+                       LOG_HELP("  Where <cvar> is the cvar to send to the server.");
                        return;
                }
        }
index f8189b9a4f7829c69198cc38338df4946760541a..5e339e85c4e90f6435540ce10e2c80bba225c2b9 100644 (file)
@@ -90,7 +90,7 @@ void GenericCommand_addtolist(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " addtolist <cvar> <value>");
-                       LOG_HELP("  Where 'cvar' is the cvar to add 'value' to.");
+                       LOG_HELP("  Where <cvar> is the cvar to add <value> to.");
                        LOG_HELP("See also: ^2removefromlist^7");
                        return;
                }
@@ -304,9 +304,9 @@ void GenericCommand_maplist(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " maplist <action> [<map>]");
-                       LOG_HELP("  Where 'action' is the command to complete,");
-                       LOG_HELP("  and 'map' is what it acts upon (for the 'add' and 'remove' actions).");
-                       LOG_HELP("  Full list of commands here: \"add, cleanup, remove, shuffle.\"");
+                       LOG_HELP("  Where <action> is the command to complete,");
+                       LOG_HELP("  and <map> is what it acts upon (for the 'add' and 'remove' actions).");
+                       LOG_HELP("  Full list of commands here: add, cleanup, remove, shuffle.");
                        return;
                }
        }
@@ -326,7 +326,7 @@ void GenericCommand_nextframe(int request, string command)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " nextframe <command>");
-                       LOG_HELP("  Where 'command' will be executed next frame of this VM");
+                       LOG_HELP("  Where <command> will be executed next frame of this VM");
                        return;
                }
        }
@@ -360,7 +360,7 @@ void GenericCommand_removefromlist(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " removefromlist <cvar> <value>");
-                       LOG_HELP("  Where 'cvar' is the cvar to remove 'value' from.");
+                       LOG_HELP("  Where <cvar> is the cvar to remove <value> from.");
                        LOG_HELP("See also: ^2addtolist^7");
                        return;
                }
@@ -448,7 +448,7 @@ void GenericCommand_settemp(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " settemp <cvar> \"<arguments>\"");
-                       LOG_HELP("  Where 'cvar' is the cvar you want to temporarily set with 'arguments'.");
+                       LOG_HELP("  Where <cvar> is the cvar you want to temporarily set with <arguments>.");
                        LOG_HELP("See also: ^2settemp_restore^7");
                        return;
                }
index af173c61eb58221913cc1e9ff1cc49419c679c62..f59038bb10fa5e461ec72bd23bf8b9f693b271b2 100644 (file)
@@ -359,7 +359,7 @@ GENERIC_COMMAND(findent, "Search through entities for matching classname", false
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 " GetProgramCommandPrefix() " find <classname>");
-                       LOG_HELP("  Where 'classname' is the classname to search for.");
+                       LOG_HELP("  Where <classname> is the classname to search for.");
                        return;
                }
        }
@@ -381,7 +381,8 @@ GENERIC_COMMAND(findat, "Search through entities for matching origin", false)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 " GetProgramCommandPrefix() " findat \"x y z\"");
+                       LOG_HELP("Usage:^3 " GetProgramCommandPrefix() " findat <position>");
+                       LOG_HELP("  Where <position> is a vector \"x y z\"");
                        return;
                }
        }
index c0baddeb314de4b97fe2de90eaf32f7dd75e9f16..f4b0dbabcf37f3ac844bfa7627da22e5dbf51705 100644 (file)
@@ -314,7 +314,7 @@ GENERIC_COMMAND(dumpeffectinfo, "Dump all effectinfo to effectinfo_dump.txt", fa
         default:
         case CMD_REQUEST_USAGE: {
             LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " dumpeffectinfo [<filename>]");
-            LOG_HELP("  Where 'filename' is the file to write (default is effectinfo_dump.txt),");
+            LOG_HELP("  Where <filename> is the file to write (default is effectinfo_dump.txt),");
             LOG_HELP("  if supplied with '-' output to console as well as default,");
             LOG_HELP("  if left blank, it will only write to default.");
             return;
index 009b76c0b9d4c54db393864afe820369bdacc72e..e5df019579e20a77225b46ffc06859a2b9b22d79 100644 (file)
@@ -199,7 +199,7 @@ GENERIC_COMMAND(dumpnotifs, "Dump all notifications into notifications_dump.txt"
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " dumpnotifs [<filename>]");
-                       LOG_HELP("  Where 'filename' is the file to write (default is notifications_dump.cfg),");
+                       LOG_HELP("  Where <filename> is the file to write (default is notifications_dump.cfg),");
                        LOG_HELP("  if supplied with '-' output to console as well as default,");
                        LOG_HELP("  if left blank, it will only write to default.");
                        return;
index d9f5ce867ea22b699369789c8bf39e6b261ee00b..9304bf0252692689083945ddfe87f0d59b9d06f5 100644 (file)
@@ -101,7 +101,7 @@ GENERIC_COMMAND(dumpturrets, "Dump all turrets into turrets_dump.txt", false)
         case CMD_REQUEST_USAGE:
         {
             LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " dumpturrets [<filename>]");
-            LOG_HELP("  Where 'filename' is the file to write (default is turrets_dump.cfg),");
+            LOG_HELP("  Where <filename> is the file to write (default is turrets_dump.cfg),");
             LOG_HELP("  if supplied with '-' output to console as well as default,");
             LOG_HELP("  if left blank, it will only write to default.");
             return;
index c146bc3f30fd21cefae3287db21460029fdabb54..11ac0641a2c18be823715cd6c17df3d8f975bbb3 100644 (file)
@@ -655,7 +655,7 @@ CLIENT_COMMAND(weapon_find, "Show spawn locations of a weapon")
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 cl_cmd weapon_find <weapon>");
-                       LOG_HELP("  Where 'weapon' is the lowercase weapon name, 'all' or 'unowned'.");
+                       LOG_HELP("  Where <weapon> is the lowercase weapon name, 'all' or 'unowned'.");
                        return;
                }
        }
index 9ca40e73d62b0e06d524de04559e323a43f4a9c2..6b3f7577f6fde976716c9376b1e41ba3625e437b 100644 (file)
@@ -83,7 +83,7 @@ GENERIC_COMMAND(dumpweapons, "Dump all weapons into weapons_dump.txt", false) //
         case CMD_REQUEST_USAGE:
         {
             LOG_HELP("Usage:^3 ", GetProgramCommandPrefix(), " dumpweapons [<filename>]");
-            LOG_HELP("  Where 'filename' is the file to write (default is weapons_dump.cfg),");
+            LOG_HELP("  Where <filename> is the file to write (default is weapons_dump.cfg),");
             LOG_HELP("  if supplied with '-' output to console as well as default,");
             LOG_HELP("  if left blank, it will only write to default.");
             return;
index 6bab3ed8eb3be3248e937b292c0d88de15faeec9..3b7304f3142fa7cc67108a18221847b55a456699 100644 (file)
@@ -46,10 +46,10 @@ void GameCommand(string theCommand)
        if (argv(0) == "help" || argc == 0)
        {
                LOG_HELP(_("Usage:^3 menu_cmd <command> [<item>], where possible commands are:"));
-               LOG_HELP(_("  'sync' reloads all cvars on the current menu page"));
-               LOG_HELP(_("  'directmenu' shows the menu window named 'item' (or the menu window containing an item named 'item')"));
-               LOG_HELP(_("   if 'item' is not specified it shows the list of available items in the console"));
-               LOG_HELP(_("  'dumptree' dumps the state of the menu as a tree to the console"));
+               LOG_HELP(_("  <sync> reloads all cvars on the current menu page"));
+               LOG_HELP(_("  <directmenu> shows the menu window named <item> (or the menu window containing an item named 'item')"));
+               LOG_HELP(_("   if <item> is not specified it shows the list of available items in the console"));
+               LOG_HELP(_("  <dumptree> dumps the state of the menu as a tree to the console"));
 
                LOG_HELP("\nGeneric commands shared by all programs:");
                GenericCommand_macro_help();
index edf15e473d97b040f35ad7c6671939a8e7875412..a66726428b9eca1ffc524e2d10c443e5a66f9398 100644 (file)
@@ -310,8 +310,8 @@ float CheatCommand(entity this, int argc)
                                break;
                        }
                        sprint(this, "Usage:^3 sv_cheats 1; restart; cmd pointparticles <effectname> <position> <velocity> <countmultiplier>\n");
-                       sprint(this, "  Where 'position' is a number from 0 to 1 representing distance on the crosshair line,\n");
-                       sprint(this, "  and 'velocity' is a vector \"x y z\"\n");
+                       sprint(this, "  Where <position> is a number from 0 to 1 representing distance on the crosshair line,\n");
+                       sprint(this, "  and <velocity> is a vector \"x y z\"\n");
                        break;
                case "trailparticles":
                        IS_CHEAT(this, 0, argc, 0);
@@ -372,7 +372,7 @@ float CheatCommand(entity this, int argc)
                        else
                        {
                                sprint(this, "Usage:^3 sv_cheats 1; restart; cmd make <modelname> <mode>\n");
-                               sprint(this, "  where 'mode' can be 0, 1 or 2\n");
+                               sprint(this, "  where <mode> can be 0, 1 or 2\n");
                        }
                        break;
                case "penalty":
index 728c344a1bf429f368fce23cad55c959eb59d7db..a73b09646f983467c7d5efa59d1ebc7896db5d1b 100644 (file)
@@ -42,9 +42,9 @@ void BanCommand_ban(int request, int argc, string command)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 sv_cmd ban <address> [<bantime>] [<reason>]");
-                       LOG_HELP("  'address' is the IP address or range of the player to ban,");
-                       LOG_HELP("  'bantime' is the amount of time that the ban is active (default if not provided),");
-                       LOG_HELP("  and 'reason' is the string to label the ban with as reason for banning.");
+                       LOG_HELP("  <address> is the IP address or range of the player to ban,");
+                       LOG_HELP("  <bantime> is the amount of time that the ban is active (default if not provided),");
+                       LOG_HELP("  and <reason> is the string to label the ban with as reason for banning.");
                        LOG_HELP("See also: ^2banlist, kickban, unban^7");
                        return;
                }
@@ -109,10 +109,10 @@ void BanCommand_kickban(int request, int argc, string command)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 sv_cmd kickban <client> [<bantime>] [<masksize>] [<reason>]");
-                       LOG_HELP("  'client' is the entity number or name of the player to ban,");
-                       LOG_HELP("  'bantime' is the amount of time that the ban is active (default if not provided),");
-                       LOG_HELP("  'masksize' is the range of the IP address (1-thru-4, default if not provided),");
-                       LOG_HELP("  and 'reason' is the string to label the ban with as reason for banning.");
+                       LOG_HELP("  <client> is the entity number or name of the player to ban,");
+                       LOG_HELP("  <bantime> is the amount of time that the ban is active (default if not provided),");
+                       LOG_HELP("  <masksize> is the range of the IP address (1-thru-4, default if not provided),");
+                       LOG_HELP("  and <reason> is the string to label the ban with as reason for banning.");
                        LOG_HELP("See also: ^2ban, banlist, unban^7");
                        return;
                }
@@ -147,7 +147,7 @@ void BanCommand_mute(int request, int argc, string command)  // TODO: Add a sort
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 sv_cmd mute <client>");
-                       LOG_HELP("  'client' is the entity number or name of the player to mute.");
+                       LOG_HELP("  <client> is the entity number or name of the player to mute.");
                        LOG_HELP("See also: ^2unmute^7");
                        return;
                }
@@ -193,7 +193,7 @@ void BanCommand_unban(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 sv_cmd unban <banid>");
-                       LOG_HELP("  Where 'banid' is the ID of the ban of which to remove.");
+                       LOG_HELP("  Where <banid> is the ID of the ban of which to remove.");
                        LOG_HELP("See also: ^2ban, banlist, kickban^7");
                        return;
                }
@@ -228,7 +228,7 @@ void BanCommand_unmute(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 sv_cmd unmute <client>");
-                       LOG_HELP("  'client' is the entity number or name of the player to unmute.");
+                       LOG_HELP("  <client> is the entity number or name of the player to unmute.");
                        LOG_HELP("See also: ^2mute^7");
                        return;
                }
index b9acbfddf93d819a38aa5c912230082046b81125..1b2959f40d39b018d690f1afc65a888bef7bc9ed 100644 (file)
@@ -84,7 +84,7 @@ void ClientCommand_autoswitch(entity caller, int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd autoswitch <selection>\n");
-                       sprint(caller, "  Where 'selection' controls if autoswitch is on or off.\n");
+                       sprint(caller, "  Where <selection> controls if autoswitch is on or off.\n");
                        return;
                }
        }
@@ -127,7 +127,7 @@ void ClientCommand_clientversion(entity caller, int request, int argc)  // inter
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd clientversion <version>\n");
-                       sprint(caller, "  Where 'version' is the game version reported by caller.\n");
+                       sprint(caller, "  Where <version> is the game version reported by caller.\n");
                        return;
                }
        }
@@ -152,7 +152,7 @@ void ClientCommand_mv_getpicture(entity caller, int request, int argc)  // inter
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd mv_getpicture <mapid>\n");
-                       sprint(caller, "  Where 'mapid' is the id number of the map to request an image of on the map vote selection menu.\n");
+                       sprint(caller, "  Where <mapid> is the id number of the map to request an image of on the map vote selection menu.\n");
                        return;
                }
        }
@@ -242,7 +242,7 @@ void ClientCommand_wpeditor(entity caller, int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd wpeditor <action>\n");
-                       sprint(caller, "  Where 'action' can be:\n");
+                       sprint(caller, "  Where <action> can be:\n");
                        sprint(caller, "   ^2spawn^7: spawns a waypoint at player's position\n");
                        sprint(caller, "   ^2remove^7: removes player's nearest waypoint\n");
                        sprint(caller, "   ^2unreachable^7: reveals waypoints and items unreachable from the current position and spawnpoints without a nearest waypoint\n");
@@ -429,7 +429,7 @@ void ClientCommand_say(entity caller, int request, int argc, string command)
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd say <message>\n");
-                       sprint(caller, "  Where 'message' is the string of text to say.\n");
+                       sprint(caller, "  Where <message> is the string of text to say.\n");
                        return;
                }
        }
@@ -450,7 +450,7 @@ void ClientCommand_say_team(entity caller, int request, int argc, string command
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd say_team <message>\n");
-                       sprint(caller, "  Where 'message' is the string of text to say.\n");
+                       sprint(caller, "  Where <message> is the string of text to say.\n");
                        return;
                }
        }
@@ -529,8 +529,8 @@ void ClientCommand_selectteam(entity caller, int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd selectteam <team>\n");
-                       sprint(caller, "  Where 'team' is the prefered team to try and join.\n");
-                       sprint(caller, "  Full list of options here: \"red, blue, yellow, pink, auto\"\n");
+                       sprint(caller, "  Where <team> is the prefered team to try and join.\n");
+                       sprint(caller, "  Full list of options here: red, blue, yellow, pink, auto.\n");
                        return;
                }
        }
@@ -554,7 +554,7 @@ void ClientCommand_selfstuff(entity caller, int request, string command)
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd selfstuff <command>\n");
-                       sprint(caller, "  Where 'command' is the string to be stuffed to your client.\n");
+                       sprint(caller, "  Where <command> is the string to be stuffed to your client.\n");
                        return;
                }
        }
@@ -588,7 +588,7 @@ void ClientCommand_sentcvar(entity caller, int request, int argc, string command
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd sentcvar <cvar>\n");
-                       sprint(caller, "  Where 'cvar' is the cvar plus arguments to send to the server.\n");
+                       sprint(caller, "  Where <cvar> is the cvar plus arguments to send to the server.\n");
                        return;
                }
        }
@@ -638,7 +638,7 @@ void ClientCommand_spectate(entity caller, int request)
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd spectate [<client>]\n");
-                       sprint(caller, "  Where 'client' can be the player to spectate.\n");
+                       sprint(caller, "  Where <client> can be the player to spectate.\n");
                        return;
                }
        }
@@ -662,7 +662,7 @@ void ClientCommand_suggestmap(entity caller, int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd suggestmap <map>\n");
-                       sprint(caller, "  Where 'map' is the name of the map to suggest.\n");
+                       sprint(caller, "  Where <map> is the name of the map to suggest.\n");
                        return;
                }
        }
@@ -719,7 +719,7 @@ void ClientCommand_tell(entity caller, int request, int argc, string command)
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd tell <client> <message>\n");
-                       sprint(caller, "  Where 'client' is the entity number or name of the player to send 'message' to.\n");
+                       sprint(caller, "  Where <client> is the entity number or name of the player to send <message> to.\n");
                        return;
                }
        }
@@ -765,9 +765,9 @@ void ClientCommand_voice(entity caller, int request, int argc, string command)
                case CMD_REQUEST_USAGE:
                {
                        sprint(caller, "\nUsage:^3 cmd voice <voicetype> [<message>]\n");
-                       sprint(caller, "  'voicetype' is the type of voice message, it can be one of these:\n");
+                       sprint(caller, "  <voicetype> is the type of voice message, it can be one of these:\n");
                        sprint(caller, sprintf("   %s\n", allvoicesamples));
-                       sprint(caller, "  and 'message' is the text message to send.\n");
+                       sprint(caller, "  and <message> is the text message to send.\n");
                        return;
                }
        }
index 34088bd9da2c82c6b6bc30e0e561692c57c0806f..8040742c8046118e8890cca4e0ddb1a2914fd3a2 100644 (file)
@@ -464,8 +464,8 @@ void CommonCommand_editmob(int request, entity caller, int argc)
                case CMD_REQUEST_USAGE:
                {
                        print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " editmob <command> [<arguments>]"));
-                       print_to(caller, "  Where 'command' can be butcher spawn skin movetarget kill name");
-                       print_to(caller, "  spawn, skin, movetarget and name require 'arguments'");
+                       print_to(caller, "  Where <command> can be butcher spawn skin movetarget kill name");
+                       print_to(caller, "  spawn, skin, movetarget and name require <arguments>");
                        print_to(caller, "  spawn also takes arguments list and random");
                        print_to(caller, "  Monster will follow owner if third argument of spawn command is not defined");
                        return;
@@ -490,8 +490,8 @@ void CommonCommand_info(int request, entity caller, int argc)
                default:
                case CMD_REQUEST_USAGE:
                {
-                       print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " info request"));
-                       print_to(caller, "  Where 'request' is the suffixed string appended onto the request for cvar.");
+                       print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " info <request>"));
+                       print_to(caller, "  Where <request> is the suffixed string appended onto the request for cvar.");
                        return;
                }
        }
@@ -832,7 +832,7 @@ void CommonCommand_who(int request, entity caller, int argc)
                case CMD_REQUEST_USAGE:
                {
                        print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " who [<separator>]"));
-                       print_to(caller, "  Where 'separator' is the optional string to separate the values with, default is a space.");
+                       print_to(caller, "  Where <separator> is the optional string to separate the values with, default is a space.");
                        return;
                }
        }
index a8f83956e753b4786a8afb0a76d0c76415b8aa3e..111fc1878588b07e5b44d9e8f12c421db1673468 100644 (file)
@@ -145,8 +145,8 @@ void GameCommand_adminmsg(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        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("  <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.");
                        LOG_HELP("Examples: adminmsg 2,4 \"this infomessage will last for ten seconds\" 10");
                        LOG_HELP("          adminmsg 2,5 \"this message will be a centerprint\"");
@@ -197,7 +197,7 @@ void GameCommand_allspec(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 sv_cmd allspec [<reason>]");
-                       LOG_HELP("  Where 'reason' is an optional argument for explanation of allspec command.");
+                       LOG_HELP("  Where <reason> is an optional argument for explanation of allspec command.");
                        LOG_HELP("See also: ^2moveplayer, shuffleteams^7");
                        return;
                }
@@ -229,7 +229,7 @@ void GameCommand_anticheat(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 sv_cmd anticheat <client>");
-                       LOG_HELP("  'client' is the entity number or name of the player.");
+                       LOG_HELP("  <client> is the entity number or name of the player.");
                        return;
                }
        }
@@ -431,7 +431,7 @@ void GameCommand_bot_cmd(int request, int argc, string command)
                case CMD_REQUEST_USAGE:
                {
                        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("  <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("Examples: sv_cmd bot_cmd 1 cc \"say something\"");
@@ -460,7 +460,7 @@ void GameCommand_cointoss(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 sv_cmd cointoss [<result1> <result2>]");
-                       LOG_HELP("  Where 'result1' and 'result2' are user created options.");
+                       LOG_HELP("  Where <result1> and <result2> are user created options.");
                        return;
                }
        }
@@ -501,9 +501,9 @@ void GameCommand_database(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        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.\"");
+                       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.");
                        return;
                }
        }
@@ -539,7 +539,7 @@ void GameCommand_defer_clear(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 sv_cmd defer_clear <client>");
-                       LOG_HELP("  'client' is the entity number or name of the player.");
+                       LOG_HELP("  <client> is the entity number or name of the player.");
                        LOG_HELP("See also: ^2defer_clear_all^7");
                        return;
                }
@@ -594,9 +594,9 @@ void GameCommand_delrec(int request, int argc)  // perhaps merge later with reco
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 sv_cmd delrec <ranking> [<map>]");
-                       LOG_HELP("  'ranking' is which ranking level to clear up to, ");
+                       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.");
+                       LOG_HELP("  if <map> is not provided it will use current map.");
                        return;
                }
        }
@@ -752,7 +752,7 @@ void GameCommand_gametype(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 sv_cmd gametype <mode>");
-                       LOG_HELP("  Where 'mode' is the gametype mode to switch to.");
+                       LOG_HELP("  Where <mode> is the gametype mode to switch to.");
                        LOG_HELP("See also: ^2gotomap^7");
                        return;
                }
@@ -901,7 +901,7 @@ void GameCommand_gotomap(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP("Usage:^3 sv_cmd gotomap <map>");
-                       LOG_HELP("  Where 'map' is the *.bsp file to change to.");
+                       LOG_HELP("  Where <map> is the *.bsp file to change to.");
                        LOG_HELP("See also: ^2gametype^7");
                        return;
                }
@@ -1098,9 +1098,9 @@ void GameCommand_moveplayer(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        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.\"");
+                       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.");
                        LOG_HELP("Examples: sv_cmd moveplayer 1,3,5 red");
                        LOG_HELP("          sv_cmd moveplayer 2 spec");
                        LOG_HELP("See also: ^2allspec, shuffleteams^7");
@@ -1223,7 +1223,7 @@ void GameCommand_setbots(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        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("  Where <botnumber> is the amount of bots to set bot_number cvar to.");
                        LOG_HELP("See also: ^2bot_cmd^7");
                        return;
                }
@@ -1334,8 +1334,8 @@ void GameCommand_stuffto(int request, int argc)
                        case CMD_REQUEST_USAGE:
                        {
                                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.");
+                               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;
                        }
                }
@@ -1506,7 +1506,7 @@ void GameCommand_trace(int request, int argc)
                                        }
                                }
 
-                                       // no default case, just go straight to invalid
+                               // no default case, just go straight to invalid
                        }
                }
 
@@ -1515,9 +1515,9 @@ void GameCommand_trace(int request, int argc)
                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 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("  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;
                }
@@ -1583,8 +1583,8 @@ void GameCommand_warp(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        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.");
+                       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;
                }
        }
index 48981090859ebcf03b8be90f6ce7009429dc9955..2c915863ef98add4e2aee3bf65f9c663e95112d0 100644 (file)
@@ -898,7 +898,7 @@ void VoteCommand_call(int request, entity caller, int argc, string vote_command)
                case CMD_REQUEST_USAGE:
                {
                        print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote call <command>"));
-                       print_to(caller, "  Where 'command' is the command to request a vote upon.");
+                       print_to(caller, "  Where <command> is the command to request a vote upon.");
                        print_to(caller, strcat("Examples: ", GetCommandPrefix(caller), " vote call gotomap dance"));
                        print_to(caller, strcat("          ", GetCommandPrefix(caller), " vote call endmatch"));
                        return;
@@ -1014,8 +1014,8 @@ void VoteCommand_master(int request, entity caller, int argc, string vote_comman
                case CMD_REQUEST_USAGE:
                {
                        print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote master [<action> [<command> | <password>]]"));
-                       print_to(caller, "  If 'action' is left blank, it calls a vote for you to become master.");
-                       print_to(caller, "  Otherwise it can be either 'do' (to run 'command') or 'login' as master.");
+                       print_to(caller, "  If <action> is left blank, it calls a vote for you to become master.");
+                       print_to(caller, "  Otherwise it can be either 'do' (to run <command>) or 'login' as master.");
                        return;
                }
        }