gerrit/Documentation/cmd-close-connection.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

40 lines
723 B
Plaintext

= gerrit close-connection
== NAME
gerrit close-connection - Close the specified SSH connection
== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit close-connection_ <SESSION_ID>
[--wait]
--
== DESCRIPTION
Close an SSH connection.
The connection closing is done asynchronously by default. Use `--wait` option to
wait for connection to close.
An error message will be displayed if no connection with the specified session
ID is found.
== ACCESS
Caller must be a member of the privileged 'Administrators' group.
== SCRIPTING
Intended for interactive use only.
OPTIONS
-------
`--wait`
: Wait for connection to close before exiting.
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------