blob: edc054be6035cc724c8cee841be3af7db6f4ae20 [file] [log] [blame] [view]
@PLUGIN@ admin
=====================
NAME
----
@PLUGIN@ admin - Administrate the cookbook plugin
SYNOPSIS
--------
> ssh -p <port> <host> @PLUGIN@ admin
DESCRIPTION
-----------
Prints "Hello, cookbook administrator".
ACCESS
------
Any user who has configured an SSH key and has been granted
the `Administrate Cookbook` capability (provided by this plugin)
or the 'Administrate Server' capability.
SCRIPTING
---------
This command is intended to be used in scripts.
EXAMPLES
--------
Have the server say hello to the administrator.
> $ ssh -p 29418 review.example.com @PLUGIN@ admin
SEE ALSO
--------
* [Plugin Development](../../../Documentation/dev-plugins.html)
GERRIT
------
Part of [Gerrit Code Review](../../../Documentation/index.html)