Standardize command usage messages, part 2 (mostly arguments descriptions)

[xonotic/xonotic-data.pk3dir.git] / qcsrc / client / command / cl_cmd.qc

diff --git a/qcsrc/client/command/cl_cmd.qc b/qcsrc/client/command/cl_cmd.qc
index 2df0b83724bae31a65b592694abf580290a8addf..49683b50db3d934d9770facb4f13493576b178ff 100644 (file)
--- a/qcsrc/client/command/cl_cmd.qc
+++ b/qcsrc/client/command/cl_cmd.qc
@@ -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;
                }
        }