summaryrefslogtreecommitdiff
path: root/php
diff options
context:
space:
mode:
authorRuss Allbery <rra@stanford.edu>2009-02-18 17:55:03 -0800
committerRuss Allbery <rra@stanford.edu>2009-02-18 17:55:03 -0800
commit5d63e75a3828f9231545eb6cb047c1e2fce6fb3b (patch)
tree53b89ba22faa19a3a5fdc7fdd70d8a9f70534ab7 /php
parent81f65dcb27cc0ba8a7fbea39592dcfe138b2210b (diff)
Use command and subcommand for components of a remctl command
Use command and subcommand as the names for the first two parameters to the remctl client and the first two strings in a remctl command instead of the unintuitive "type" and "service" terminology borrowed from sysctl. This only changes documentation and some internal variable names; no external APIs should be affected.
Diffstat (limited to 'php')
-rw-r--r--php/README14
1 files changed, 7 insertions, 7 deletions
diff --git a/php/README b/php/README
index d4f1e48..3b1bf82 100644
--- a/php/README
+++ b/php/README
@@ -28,13 +28,13 @@ SIMPLIFIED INTERFACE
remctl(HOSTNAME, PORT, PRINCIPAL, COMMAND)
Runs COMMAND on the remote system and returns an object containing
- the results. COMMAND should be an array of the type, the service,
- and any parameters. HOSTNAME is the remote host to connect to.
- PORT is the port; pass 0 to use the default library behavior (first
- try 4373 and then fall back to 4444). PRINCIPAL is the principal of
- the server to use for authentication; pass in the empty string to
- use the default of host/HOSTNAME with the realm determined by
- domain-realm mapping.
+ the results. COMMAND should be an array of the command, the
+ subcommand, and any parameters. HOSTNAME is the remote host to
+ connect to. PORT is the port; pass 0 to use the default library
+ behavior (first try 4373 and then fall back to 4444). PRINCIPAL is
+ the principal of the server to use for authentication; pass in the
+ empty string to use the default of host/HOSTNAME with the realm
+ determined by domain-realm mapping.
The return value of remctl() is an object which will have the following
properties: