about summary refs log tree commit diff stats
path: root/src/command
diff options
context:
space:
mode:
authorJames Booth <boothj5@gmail.com>2015-08-08 22:38:50 +0100
committerJames Booth <boothj5@gmail.com>2015-08-08 22:38:50 +0100
commit103f80c2275900ccca7d226251ef3aff7267df16 (patch)
tree95a8954f28b3e63f77a59a577dd31a5aec442bc2 /src/command
parent406b821b35797081936be3a5c51a35ac23a1ca92 (diff)
downloadprofani-tty-103f80c2275900ccca7d226251ef3aff7267df16.tar.gz
Updated /help help
Diffstat (limited to 'src/command')
-rw-r--r--src/command/command.c7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/command/command.c b/src/command/command.c
index b2a4c438..f6205169 100644
--- a/src/command/command.c
+++ b/src/command/command.c
@@ -133,7 +133,12 @@ static struct cmd_t command_defs[] =
         CMD_SYN(
             "/help [<area>|<command>]")
         CMD_DESC(
-            "Help on using Profanity. Passing no arguments list help areas.")
+            "Help on using Profanity. Passing no arguments list help areas. "
+            "For command help, optional arguments are shown using square brackets e.g. [argument], "
+            "arguments representing variables rather than a literal name are surrounded by angle brackets "
+            "e.g. <argument>. "
+            "Arguments that may be one of a number of values are separated by a pipe "
+            "e.g. val1|val2|val3.")
         CMD_ARGS(
             { "<area>",    "Summary help for commands in a certain area of functionality." },
             { "<command>", "Full help for a specific command, for example '/help connect'." })