gerrit/Documentation/cmd-plugin-ls.txt
Michael Ochmann e2d76a1c23 Fix broken synopsis formatting in documentation
Most of the cmd-xxxx.txt pages were still using the legacy 'italics'
asciidoc [1], which caused the synopsis sections to render like this:

'ssh' -p <port> 'gerrit some-command'

Furthermore, the line breaks and indentations were not rendered.

Replaced the legacy 'italics" with _italics_ in all synopsis sections
and changed the block type to [verse]. Verse blocks preserve indents
and line breaks (like <pre> in HTML), but still allow text formatting.

Fixed also some other minor mistakes and formatting errors.

[1] http://asciidoctor.org/docs/migration/#migration-cheatsheet

Change-Id: I457c5e42e3758789f29541d38d6f6c2e25532897
Signed-off-by: Michael Ochmann <michael.ochmann@sap.com>
2016-07-06 10:54:42 +02:00

48 lines
1.0 KiB
Plaintext

= plugin ls
== NAME
plugin ls - List the installed plugins.
== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit plugin ls_
[--all | -a]
[--format {text | json | json_compact}]
--
== DESCRIPTION
List the installed plugins and show their version and status.
== ACCESS
* The caller must be a member of a group that is granted the
link:access-control.html#capability_viewPlugins[View Plugins]
capability or the link:access-control.html#capability_administrateServer[
Administrate Server] capability.
* link:config-gerrit.html#plugins.allowRemoteAdmin[plugins.allowRemoteAdmin]
must be enabled in `$site_path/etc/gerrit.config`.
== SCRIPTING
This command is intended to be used in scripts.
== OPTIONS
--all::
-a::
List all plugins, including disabled plugins.
--format::
What output format to display the results in.
+
--
`text`:: Simple text based format.
`json`:: Map of JSON objects describing each project.
`json_compact`:: Minimized JSON output.
--
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------