Fixes #6691: Add support for command options or arguments

Normation · Jun 3, 2015 · 8b54a0c · 8b54a0c
1 parent 254ee06
commit 8b54a0c
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -22,11 +22,13 @@ a new pull request to add it to share/command in this repository.
 A command must have the following properties :
 - be called agent-<command> or server-<command>
 - parameters will not include the 'agent', 'server' or <command> given in the command line
-- the executable must contain a string with a single line of the form
+- the executable must contain a string with a single line of the form:
+
 
     # @description <brief command description>
 
-- the executable may also contain a single or multi-line string of the form
+- the executable may also contain a single or multi-line string of the form:
+
 
     # @man <detailed command description>
 

diff --git a/share/commands/agent-enable b/share/commands/agent-enable
@@ -1,5 +1,10 @@
 #!/bin/sh
 # @description re-enable a disabled rudder-agent
+# @man +
+# @man +
+# @man *Options*:
+# @man +
+# @man *-s*: start rudder-agent in addition to enabling it
 
 while getopts "s" opt; do
   case $opt in
@@ -38,4 +43,3 @@ else
     echo "rudder-agent has been enabled but not started, wait for next cron run"
   fi
 fi
-
diff --git a/share/commands/server-debug b/share/commands/server-debug
@@ -5,6 +5,10 @@
 # @man to the port the debug server is listening on (5310 by default).
 # @man +
 # @man Use Ctrl+C to stop the debug server.
+# @man +
+# @man *Arguments*:
+# @man +
+# @man *node*: IP or hostname of the host you want to debug
 
 DEBUG_PORT=5310