Skip to content

Commit 3eb114e

Browse files
author
Daniil Fedotov
committed
Update man entries for encode and decode commands correspond to commands API.
1 parent b7f3904 commit 3eb114e

File tree

1 file changed

+10
-23
lines changed

1 file changed

+10
-23
lines changed

docs/rabbitmqctl.8

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1811,34 +1811,14 @@ floating point number.
18111811
Values lower than 1.0 can be dangerous and should be used carefully.
18121812
.El
18131813
.\" ------------------------------------
1814-
.It Cm encode Oo Fl -decode Oc Oo Ar value Oc Oo Ar passphrase Oc Oo Fl -list-ciphers Oc Oo Fl -list-hashes Oc Oo Fl -cipher Ar cipher Oc Oo Fl -hash Ar hash Oc Op Fl -iterations Ar iterations
1814+
.It Cm encode Ar value Ar passphrase Oo Fl -cipher Ar cipher Oc Oo Fl -hash Ar hash Oc Op Fl -iterations Ar iterations
18151815
.Bl -tag -width Ds
1816-
.It Fl -decode
1817-
Flag to decrypt the input value.
1818-
.Pp
1819-
For example:
1820-
.sp
1821-
.Dl rabbitmqctl encode --decode '{encrypted,<<"...">>}' mypassphrase
18221816
.It Ar value Ar passphrase
1823-
Value to encrypt/decrypt and passphrase.
1817+
Value to encrypt and passphrase.
18241818
.Pp
18251819
For example:
18261820
.sp
18271821
.Dl rabbitmqctl encode '<<"guest">>' mypassphrase
1828-
.sp
1829-
.Dl rabbitmqctl encode --decode '{encrypted,<<"...">>}' mypassphrase
1830-
.It Fl -list-ciphers
1831-
Flag to list the supported ciphers.
1832-
.Pp
1833-
For example:
1834-
.sp
1835-
.Dl rabbitmqctl encode --list-ciphers
1836-
.It Fl -list-hashes
1837-
Flag to list the supported hash algorithms.
1838-
.Pp
1839-
For example:
1840-
.sp
1841-
.Dl rabbitmqctl encode --list-hashes
18421822
.It Fl -cipher Ar cipher Fl -hash Ar hash Fl -iterations Ar iterations
18431823
Options to specify the encryption settings.
18441824
They can be used independently.
@@ -1848,14 +1828,21 @@ For example:
18481828
.Dl rabbitmqctl encode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '<<"guest">>' mypassphrase
18491829
.El
18501830
.\" ------------------------------------
1851-
.It Cm decode Ar value Ar passphrase
1831+
.It Cm decode Ar value Ar passphrase Oo Fl -cipher Ar cipher Oc Oo Fl -hash Ar hash Oc Op Fl -iterations Ar iterations
18521832
.Bl -tag -width Ds
18531833
.It Ar value Ar passphrase
18541834
Value to decrypt (as produced by the encode command) and passphrase.
18551835
.Pp
18561836
For example:
18571837
.sp
18581838
.Dl rabbitmqctl decode '{encrypted, <<"...">>}' mypassphrase
1839+
.It Fl -cipher Ar cipher Fl -hash Ar hash Fl -iterations Ar iterations
1840+
Options to specify the decryption settings.
1841+
They can be used independently.
1842+
.Pp
1843+
For example:
1844+
.sp
1845+
.Dl rabbitmqctl decode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '{encrypted,<<"...">>} mypassphrase
18591846
.El
18601847
.\" ------------------------------------
18611848
.It Cm list_hashes

0 commit comments

Comments
 (0)