From 79326e6287153c5eb1ecf03a12101bf8e46bf69b Mon Sep 17 00:00:00 2001 From: Juhani Numminen Date: Fri, 27 Jan 2012 14:56:45 +0200 Subject: [PATCH] Add descriptions to command line arguments --- src/main.cpp | 27 ++++++++++++++++++--------- src/servermain.cpp | 18 ++++++++++++------ 2 files changed, 30 insertions(+), 15 deletions(-) diff --git a/src/main.cpp b/src/main.cpp index 6cb9cf984..2875474f1 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1085,22 +1085,31 @@ int main(int argc, char *argv[]) // List all allowed options core::map allowed_options; - allowed_options.insert("help", ValueSpec(VALUETYPE_FLAG)); + allowed_options.insert("help", ValueSpec(VALUETYPE_FLAG, + "Show allowed options")); allowed_options.insert("server", ValueSpec(VALUETYPE_FLAG, "Run server directly")); allowed_options.insert("config", ValueSpec(VALUETYPE_STRING, "Load configuration from specified file")); - allowed_options.insert("port", ValueSpec(VALUETYPE_STRING)); - allowed_options.insert("address", ValueSpec(VALUETYPE_STRING)); - allowed_options.insert("random-input", ValueSpec(VALUETYPE_FLAG)); - allowed_options.insert("disable-unittests", ValueSpec(VALUETYPE_FLAG)); - allowed_options.insert("enable-unittests", ValueSpec(VALUETYPE_FLAG)); - allowed_options.insert("map-dir", ValueSpec(VALUETYPE_STRING)); + allowed_options.insert("port", ValueSpec(VALUETYPE_STRING, + "Set network port to connect to")); + allowed_options.insert("address", ValueSpec(VALUETYPE_STRING, + "Address to connect to")); + allowed_options.insert("random-input", ValueSpec(VALUETYPE_FLAG, + "Enable random user input, for testing")); + allowed_options.insert("disable-unittests", ValueSpec(VALUETYPE_FLAG, + "Disable unit tests")); + allowed_options.insert("enable-unittests", ValueSpec(VALUETYPE_FLAG, + "Enable unit tests")); + allowed_options.insert("map-dir", ValueSpec(VALUETYPE_STRING, + "Map directory (where everything in the world is stored)")); #ifdef _WIN32 allowed_options.insert("dstream-on-stderr", ValueSpec(VALUETYPE_FLAG)); #endif - allowed_options.insert("speedtests", ValueSpec(VALUETYPE_FLAG)); - allowed_options.insert("info-on-stderr", ValueSpec(VALUETYPE_FLAG)); + allowed_options.insert("speedtests", ValueSpec(VALUETYPE_FLAG, + "Run speed tests")); + allowed_options.insert("info-on-stderr", ValueSpec(VALUETYPE_FLAG, + "Print debug information to console")); Settings cmd_args; diff --git a/src/servermain.cpp b/src/servermain.cpp index 3ef1d9479..7a05bb964 100644 --- a/src/servermain.cpp +++ b/src/servermain.cpp @@ -203,14 +203,20 @@ int main(int argc, char *argv[]) // List all allowed options core::map allowed_options; - allowed_options.insert("help", ValueSpec(VALUETYPE_FLAG)); + allowed_options.insert("help", ValueSpec(VALUETYPE_FLAG, + "Show allowed options")); allowed_options.insert("config", ValueSpec(VALUETYPE_STRING, "Load configuration from specified file")); - allowed_options.insert("port", ValueSpec(VALUETYPE_STRING)); - allowed_options.insert("disable-unittests", ValueSpec(VALUETYPE_FLAG)); - allowed_options.insert("enable-unittests", ValueSpec(VALUETYPE_FLAG)); - allowed_options.insert("map-dir", ValueSpec(VALUETYPE_STRING)); - allowed_options.insert("info-on-stderr", ValueSpec(VALUETYPE_FLAG)); + allowed_options.insert("port", ValueSpec(VALUETYPE_STRING, + "Set network port (UDP) to use")); + allowed_options.insert("disable-unittests", ValueSpec(VALUETYPE_FLAG, + "Disable unit tests")); + allowed_options.insert("enable-unittests", ValueSpec(VALUETYPE_FLAG, + "Enable unit tests")); + allowed_options.insert("map-dir", ValueSpec(VALUETYPE_STRING, + "Map directory (where everything in the world is stored)")); + allowed_options.insert("info-on-stderr", ValueSpec(VALUETYPE_FLAG, + "Print debug information to console")); Settings cmd_args; -- 2.25.1