Standardize command usage messages:

[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 15419f96697fe8f9b4e6aa22cb8710b1087fc13f..2df0b83724bae31a65b592694abf580290a8addf 100644 (file)
--- a/qcsrc/client/command/cl_cmd.qc
+++ b/qcsrc/client/command/cl_cmd.qc
@@ -108,9 +108,9 @@ void LocalCommand_boxparticles(int request, int argc)
                case CMD_REQUEST_USAGE:
                {
                        LOG_HELP(
-                               "Usage:^3 cl_cmd boxparticles effectname own org_from org_to, dir_from, dir_to, countmultiplier, flags\n"
+                               "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"
-                               "  'own' is the entity number of the owner (negative for csqc ent, positive for svqc ent)\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"
@@ -160,7 +160,7 @@ void LocalCommand_create_scrshot_ent(int request)
                default:
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 cl_cmd create_scrshot_ent [path]");
+                       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.");
                        return;
                }
@@ -190,7 +190,7 @@ void LocalCommand_debugmodel(int request, int argc)
                default:
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 cl_cmd debugmodel model");
+                       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.");
                        return;
                }
@@ -238,7 +238,7 @@ void LocalCommand_handlevote(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 cl_cmd handlevote vote");
+                       LOG_HELP("Usage:^3 cl_cmd handlevote <vote>");
                        LOG_HELP("  Where 'vote' is the selection for either the current poll or uid2name.");
                        return;
                }
@@ -328,11 +328,11 @@ void LocalCommand_hud(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 cl_cmd hud action [configname | radartoggle | layout]");
+                       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 control hud_panel_radar_maximized for \"radar\" action,");
-                       LOG_HELP("  and 'layout' is how to organize the scoreboard columns for the set 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;
                }
@@ -382,7 +382,7 @@ void LocalCommand_mv_download(int request, int argc)
                        LOG_INFOF("Incorrect parameters for ^2%s^7", argv(0));
                case CMD_REQUEST_USAGE:
                {
-                       LOG_HELP("Usage:^3 cl_cmd mv_download mapid");
+                       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.");
                        return;
                }
@@ -518,8 +518,8 @@ void GameCommand(string command)
                        LOG_HELP("\nGeneric commands shared by all programs:");
                        GenericCommand_macro_help();
 
-                       LOG_HELP("\nUsage:^3 cl_cmd COMMAND...^7, where possible commands are listed above.");
-                       LOG_HELP("For help about a specific command, type cl_cmd help COMMAND");
+                       LOG_HELP("\nUsage:^3 cl_cmd <command>^7, where possible commands are listed above.");
+                       LOG_HELP("For help about a specific command, type cl_cmd help <command>");
 
                        return;
                }