summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRuss Allbery <eagle@eyrie.org>2016-09-05 10:40:18 -0700
committerRuss Allbery <eagle@eyrie.org>2016-09-05 10:42:12 -0700
commit1a63657382391f595d60e6aa6a49a1bd76fdbf33 (patch)
tree3e4aace47db926ef9b9f423dada2d60d8cc396b7 /docs
parent515092587b4958eb74df2f35fffac8e38cc2d494 (diff)
parent00946da85420b3a0b9091858641a335272f0b53a (diff)
Merge branch 'feature/summary_with_a_subcommand' of https://github.com/ccin2p3/remctl into ccin2p3-feature/summary_with_a_subcommand
Diffstat (limited to 'docs')
-rw-r--r--docs/remctld.pod11
1 files changed, 4 insertions, 7 deletions
diff --git a/docs/remctld.pod b/docs/remctld.pod
index 5d7fcfa..3a0c7fa 100644
--- a/docs/remctld.pod
+++ b/docs/remctld.pod
@@ -313,18 +313,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