diff options
author | Remi Ferrand <remi.ferrand@cc.in2p3.fr> | 2014-12-25 21:49:18 +0100 |
---|---|---|
committer | Remi Ferrand <remi.ferrand@cc.in2p3.fr> | 2014-12-25 23:29:58 +0100 |
commit | 00946da85420b3a0b9091858641a335272f0b53a (patch) | |
tree | 7964efca7ea50a8c99768d0d4a22827bf3fefc3f /docs | |
parent | 5db6d172fe9e173e611d17213e2973734acd3186 (diff) |
[github#3] Support summary with subcommand.
* If a summary option is specified with a subcommand other than
`ALL`, create a subcommand specific summary.
* Adapt existing test suite.
* Adapt existing summary option documentation.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/remctld.pod | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/docs/remctld.pod b/docs/remctld.pod index dc68e17..6443043 100644 --- a/docs/remctld.pod +++ b/docs/remctld.pod @@ -297,18 +297,15 @@ summary to standard output. If remctld receives the command C<help> with no arguments, and no C<help> command is defined in the configuration file, the server will look through the configuration for any command with a C<summary> option set. If this -option is set, the I<subcommand> is C<ALL>, and the user is authorized to -run the command, the server will run the specified I<executable> with the -argument I<arg>, sending the output back to the user. It will do this for -every command in the configuration that meets the above criteria. +option is set, and the user is authorized to run the command, the server +will run the specified I<executable> with the argument I<arg>, sending the +output back to the user. It will do this for every command in the +configuration that meets the above criteria. This allows display of a summary of available commands to the user based on which commands that user is authorized to run. It's a lightweight form of service discovery. Also see the C<help> option. -As mentioned above, this option is only meaningful on configuration lines -with a I<subcommand> of C<ALL>. - =item user=(I<username> | I<uid>) [3.1] Run this command as the specified user, which can be given as either |