diff --git a/doc/guide/ctrl-channel.xml b/doc/guide/ctrl-channel.xml index 2ba8adaf02..5e918c4012 100644 --- a/doc/guide/ctrl-channel.xml +++ b/doc/guide/ctrl-channel.xml @@ -45,9 +45,9 @@ { "command": "foo", "arguments": { - "param1": "value1", - "param2": "value2", - ... + "param1": "value1", + "param2": "value2", + ... } } @@ -64,9 +64,9 @@ "result": 0|1, "text": "textual description", "arguments": { - "argument1": "value1", - "argument2": "value2", - ... + "argument1": "value1", + "argument2": "value2", + ... } } @@ -218,9 +218,9 @@ will be sent to Kea and the responses received from Kea printed to standard outp list-commands - The list-commands command retrieves a list of all - commands supported by the server. It does not take any arguments. - An example command may look like this: + The list-commands command retrieves a list of all + commands supported by the server. It does not take any arguments. + An example command may look like this: { "command": "list-commands", @@ -229,9 +229,9 @@ will be sent to Kea and the responses received from Kea printed to standard outp - The server will respond with a list of all supported commands. The - arguments element will be a list of strings. Each string will convey - one supported command. + The server will respond with a list of all supported commands. The + arguments element will be a list of strings. Each string will convey + one supported command. @@ -282,7 +282,7 @@ will be sent to Kea and the responses received from Kea printed to standard outp reload is triggered via a signal, the server will use the configuration stored in its configuration file. - The server's response will contain a numeric code, "result" (0 for success, + The server's response will contain a numeric code, "result" (0 for success, non-zero on failure), and a string, "text", describing the outcome: {"result": 0, "text": "Configuration successful." } @@ -298,10 +298,10 @@ will be sent to Kea and the responses received from Kea printed to standard outp shutdown - The shutdown command instructs the server to initiate - its shutdown procedure. It is the equivalent of sending a SIGTERM signal - to the process. This command does not take any arguments. An example - command may look like this: + The shutdown command instructs the server to initiate + its shutdown procedure. It is the equivalent of sending a SIGTERM signal + to the process. This command does not take any arguments. An example + command may look like this: { "command": "shutdown", @@ -310,8 +310,8 @@ will be sent to Kea and the responses received from Kea printed to standard outp - The server will respond with a confirmation that the shutdown procedure - has been initiated. + The server will respond with a confirmation that the shutdown procedure + has been initiated.