diff options
author | Russ Allbery <rra@stanford.edu> | 2010-05-02 18:43:56 -0700 |
---|---|---|
committer | Russ Allbery <rra@stanford.edu> | 2010-05-02 18:43:56 -0700 |
commit | 1d8fddb0854bce716c145a6783c0ff9a3058b4f7 (patch) | |
tree | 876cdb5adceb249134949a9e600167ee188314bd /ruby | |
parent | 00a10fbee30015435364fb39ac71479ab87e8003 (diff) |
Tweak ruby/README formatting
faq2html was unhappy with some of the formatting of ruby/README, so
tweak it a little to make it happier.
Diffstat (limited to 'ruby')
-rw-r--r-- | ruby/README | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/ruby/README b/ruby/README index f6469ed..79c9e00 100644 --- a/ruby/README +++ b/ruby/README @@ -1,4 +1,4 @@ - Ruby interface to remctl + Ruby interface to remctl OVERVIEW @@ -24,6 +24,7 @@ SIMPLIFIED INTERFACE the results. Arguments: + * host: string, the host to connect to * args: array containing strings making up the command @@ -37,11 +38,13 @@ SIMPLIFIED INTERFACE Returns an object of type Remctl::Result with the following attributes: + * stdout: string, the standard output from the command * stderr: string, the standard error from the command * status: integer, the exit status of the command Exceptions: + * ArgumentError, TypeError: an invalid argument was supplied * NoMemError: memory allocation failed while making the call * Remctl::Error: an error occurred in the remctl communication @@ -82,6 +85,7 @@ FULL INTERFACE Remctl.default_principal respectively. Arguments: + * host (required): string, the host to connect to * port (optional): unsigned short, the port to connect to * principal (optional): string, authentication identity of host @@ -96,6 +100,7 @@ FULL INTERFACE determined by the domain-realm mapping) is used. Exceptions: + * ArgumentError, TypeError: an invalid argument was supplied * NoMemError: memory allocation failed while allocating the object * Remctl::Error: a network or authentication error occurred @@ -118,10 +123,12 @@ FULL INTERFACE via standard input. Arguments: + * args (required): An array of arguments. Each must respond to #to_s. Exceptions: + * TypeError: an invalid argument was supplied * Remctl::Error: a network or authentication error occurred * Remctl::NotOpen: no connection currently open @@ -138,6 +145,7 @@ FULL INTERFACE #output is called without another call to #command. The members of the returned array are, in order: + * type: symbol, :output, :status, :error, or :done * output: string, the returned output or error * stream: integer, 1 for stdout or 2 for stderr for an output token @@ -157,6 +165,7 @@ FULL INTERFACE change. Exceptions: + * Remctl::NotOpen: no connection currently open r.close() @@ -170,6 +179,7 @@ FULL INTERFACE Raises Remctl::Error in the event that remctl_open() fails. Exceptions: + * NoMemError: memory allocation failed while making the call * Remctl::Error: a network or authentication error occurred |