diff options
| author | Michael Klishin <michael@novemberain.com> | 2017-06-28 18:13:02 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-28 18:13:02 +0300 |
| commit | 0cad86e34ee6144df8c62fde3f9113b39808ded1 (patch) | |
| tree | e249093eb33df3b20945c80632832cfa3f886dc2 /docs | |
| parent | 63503f124d50c7585c535d24d064eb10f7f4278a (diff) | |
| parent | 6b65e41330a40060919b0cc19b895a57348493a5 (diff) | |
| download | rabbitmq-server-git-0cad86e34ee6144df8c62fde3f9113b39808ded1.tar.gz | |
Merge pull request #1276 from rabbitmq/rabbitmq-server-ctl-decode
Add CTL commands to decode encoded value and list ciphers and hashes
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rabbitmqctl.1.xml | 61 |
1 files changed, 58 insertions, 3 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index f9d5f17511..2ec063266a 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -2167,9 +2167,9 @@ <varlistentry> <term>fraction</term> <listitem><para> - Limit relative to the total amount available RAM - as a non-negative floating point number. - Values lower than 1.0 can be dangerous and + Limit relative to the total amount available RAM + as a non-negative floating point number. + Values lower than 1.0 can be dangerous and should be used carefully. </para></listitem> </varlistentry> @@ -2249,6 +2249,61 @@ rabbitmqctl encode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 \ </variablelist> </listitem> </varlistentry> + + <varlistentry> + <!-- one-line formatting matters for rabbit_ctl_usage.erl code generation --> + <term><cmdsynopsis><command>decode</command> <arg choice="opt"><replaceable>value</replaceable></arg> <arg choice="opt"><replaceable>passphrase</replaceable></arg></cmdsynopsis> + </term> + <listitem> + <variablelist> + <varlistentry> + <term> + <cmdsynopsis> + <arg choice="opt"><replaceable>value</replaceable></arg> + <arg choice="opt"><replaceable>passphrase</replaceable></arg> + </cmdsynopsis> + </term> + <listitem> + <para> + Value to decrypt (as produced by the encode command) and passphrase. + </para> + <para role="example-prefix">For example:</para> + <screen role="example">rabbitmqctl decode '{encrypted,'<<"...">>}' mypassphrase</screen> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term><cmdsynopsis><command>list_hashes</command></cmdsynopsis></term> + <listitem> + <para> + Lists hash functions supported by encoding commands. + </para> + <para role="example-prefix">For example:</para> + <screen role="example">rabbitmqctl list_hashes</screen> + <para role="example"> + This command instructs the RabbitMQ broker to list all + hash functions supported by encoding commands. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><cmdsynopsis><command>list_ciphers</command></cmdsynopsis></term> + <listitem> + <para> + Lists cipher suites supported by encoding commands. + </para> + <para role="example-prefix">For example:</para> + <screen role="example">rabbitmqctl list_ciphers</screen> + <para role="example"> + This command instructs the RabbitMQ broker to list all + cipher suites supported by encoding commands. + </para> + </listitem> + </varlistentry> </variablelist> </refsect2> </refsect1> |