[master] Merge branch trac5262

1 files changed, 14 insertions, 4 deletions

diff --git a/doc/guide/shell.xml b/doc/guide/shell.xml
index 778d5c5f87..c8632735b0 100644
--- a/doc/guide/shell.xml
+++ b/doc/guide/shell.xml
@@ -25,7 +25,7 @@
     <title>Shell Usage</title>
     <para><command>kea-shell</command> is run as follows:
 <screen>
-kea-shell [--host hostname] [--port number] [--timeout seconds] [command]
+kea-shell [--host hostname] [--port number] [--timeout seconds] [--service service-name] [command]
 </screen>
     where:
     </para>
@@ -53,6 +53,15 @@ kea-shell [--host hostname] [--port number] [--timeout seconds] [command]
 
       <listitem>
         <simpara>
+          <command>--service <replaceable>serive-name</replaceable></command> specifies the
+          target of a command. If not given, CA will be used as target.  May be used more
+          than once to specify multiple targets.
+        </simpara>
+      </listitem>
+
+
+      <listitem>
+        <simpara>
           <command>command</command> specifies the command to be sent. If not specified,
           <command>list-commands</command> command is used.
         </simpara>
@@ -89,18 +98,19 @@ kea-shell [--host hostname] [--port number] [--timeout seconds] [command]
 
     <para>The following shows a simple example of usage:
 <screen>
-$ <userinput>kea-shell --host 192.0.2.1 --port 8001 list-commands</userinput>
+$ <userinput>kea-shell --host 192.0.2.1 --port 8001 --service dhcp4 list-commands</userinput>
 ^D
 </screen>
     After the command line is entered, the program waits for command parameters to be entered.
     Since <command>list-commands</command> does not take any
     arguments, CTRL-D (represented in the above example by "^D") is pressed to indicate end
     of file (and so terminate the parameter input). The Shell will then contact
-    the CA and print out the list of available commands returned.
+    the CA and print out the list of available commands returned for the service named <command>dhcp4</command>.
     </para>
 
     <para>It is envisaged that Kea Shell will be most frequently used in scripts. The next example
-    shows a simple scripted execution. It sends the command "config-write" to the CA, along
+    shows a simple scripted execution. It sends the command "config-write" to the CA
+    (<command> --service </command> parameter hasn't been used), along
     with the parameters specified in param.json. The result will be stored in result.json.
 <screen>
 $ cat param.json