man/ronin-decrypt.1 in ronin-2.0.5 vs man/ronin-decrypt.1 in ronin-2.1.0.rc1

- old
+ new

@@ -1,105 +1,90 @@ -.\" Generated by kramdown-man 0.1.8 +.\" Generated by kramdown-man 1.0.1 .\" https://github.com/postmodern/kramdown-man#readme .TH ronin-decrypt 1 "2023-02-01" Ronin "User Manuals" -.LP +.SH NAME +.PP +ronin\-decrypt \- Decrypts data .SH SYNOPSIS -.LP -.HP +.PP \fBronin decrypt\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB] -.LP .SH DESCRIPTION -.LP .PP Encrypts data\. -.LP .SH ARGUMENTS -.LP .TP \fIFILE\fP The optional file to read and decrypt\. If no \fIFILE\fP arguments are given, input will be read from \fBstdin\fR\. -.LP .SH OPTIONS -.LP .TP -\fB-k\fR, \fB--key\fR \fISTRING\fP +\fB\-k\fR, \fB\-\-key\fR \fISTRING\fP The raw key string for the cipher\. -.LP .TP -\fB-K\fR, \fB--key-file\fR \fIFILE\fP +\fB\-K\fR, \fB\-\-key\-file\fR \fIFILE\fP Reads the key string from the file\. -.LP .TP -\fB-c\fR, \fB--cipher\fR \fINAME\fP -The cipher to decrypt with\. See \fB--list-ciphers\fR for a list of supported -ciphers\. Default to \fBaes-256-cbc\fR if not given\. -.LP +\fB\-c\fR, \fB\-\-cipher\fR \fINAME\fP +The cipher to decrypt with\. See \fB\-\-list\-ciphers\fR for a list of supported +ciphers\. Default to \fBaes\-256\-cbc\fR if not given\. .TP -\fB-P\fR, \fB--password\fR \fIPASSWORD\fP +\fB\-P\fR, \fB\-\-password\fR \fIPASSWORD\fP The password to decrypt with\. -.LP .TP -\fB-H\fR, \fB--hash\fR \fBmd5\fR\[or]\fBsha1\fR\[or]\fBsha256\fR\[or]\fBsha512\fR +\fB\-H\fR, \fB\-\-hash\fR \fBmd5\fR\[or]\fBsha1\fR\[or]\fBsha256\fR\[or]\fBsha512\fR The hash algorithm to use for the password\. Default to \fBsha256\fR if not given\. -.LP .TP -\fB--iv\fR \fISTRING\fP +\fB\-\-iv\fR \fISTRING\fP Sets the Initial Vector (IV) value of the cipher\. -.LP .TP -\fB--padding\fR \fINUM\fP +\fB\-\-padding\fR \fINUM\fP Sets the padding size, in bytes, of the decryption cipher\. -.LP .TP -\fB-b\fR, \fB--block-size\fR \fINUM\fP +\fB\-b\fR, \fB\-\-block\-size\fR \fINUM\fP The size, in bytes, to read data in\. Default to \fB16384\fR if not given\. -.LP .TP -\fB--list-ciphers\fR +\fB\-\-list\-ciphers\fR List the supported ciphers and exits\. -.LP .TP -\fB-h\fR, \fB--help\fR +\fB\-h\fR, \fB\-\-help\fR Print help information\. -.LP .SH EXAMPLES -.LP .PP Decrypt a file using AES\-256 (CBC mode) with a password: -.LP -.nf - \[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-password \[dq]\.\.\.\[dq] encrypted\.bin -.fi -.LP .PP +.RS 4 +.EX +\[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-password \[dq]\.\.\.\[dq] encrypted\.bin +.EE +.RE +.PP Decrypt a file using a raw key string: -.LP -.nf - \[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-key \[dq]12345abcdef\.\.\.\[dq] encrypted\.bin -.fi -.LP .PP +.RS 4 +.EX +\[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-key \[dq]12345abcdef\.\.\.\[dq] encrypted\.bin +.EE +.RE +.PP Decrypt a file using a raw key read from a file: -.LP -.nf - \[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-key\-file key\.bin encrypted\.bin -.fi -.LP .PP +.RS 4 +.EX +\[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-key\-file key\.bin encrypted\.bin +.EE +.RE +.PP Specifying a custom IV (initialization vector): -.LP -.nf - \[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-key \[dq]\.\.\.\[dq] \-\-iv \[dq]\.\.\.\[dq] encrypted\.bin -.fi -.LP +.PP +.RS 4 +.EX +\[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-key \[dq]\.\.\.\[dq] \-\-iv \[dq]\.\.\.\[dq] encrypted\.bin +.EE +.RE .SH AUTHOR -.LP .PP Postmodern .MT postmodern\.mod3\[at]gmail\.com .ME -.LP .SH SEE ALSO -.LP .PP -ronin\-encrypt(1) \ No newline at end of file +.BR ronin\-encrypt (1)