Merge pull request #244 from percona/pxb-3237-8.0

PXB-3237 Update xbcrypt options (8.0)

Author: patrickbirch

docs/xbcrypt-options.md

@@ -1,56 +1,69 @@
 # The xbcrypt command-line options
 
-The `xbcrypt` binary has the following command line options:
-
-### encrypt-algo
-
-usage: `-a` `--encrypt-algo`
+Usage: 
+ 
+```{.text .no-copy}
+$ xbcrypt[OPTIONS]
+```
 
-Defines the name of the encryption algorithm.
+The `xbcrypt` binary has the following command line options:
 
 ### decrypt
 
 usage: `-d`  `--decrypt`
 
 Decrypt data input to output.
 
+### encrypt-algo
+
+usage: `-a=name` `--encrypt-algo=name`
+
+Defines the name of the encryption algorithm.
+
 ### encrypt-chunk-size
 
-usage: `-s` `--encrypt-chunk-size`
+usage: `-s=#` `--encrypt-chunk-size=#`
 
 Defines the size of the working buffer for encryption in bytes. The default value is `64000`.
 
 ### encrypt-key
 
-usage: `-k` `--encrypt-key`
+usage: `-k=name` `--encrypt-key=name`
 
 The name of the encryption key.
 
 ### encrypt-key-file
 
-usage: `-f` `--encrypt-key-file`
+usage: `-f=name` `--encrypt-key-file=name`
 
 The name of the file that contains the encryption key.
 
 ### encrypt-threads
 
-usage: `--encrypt-threads`
+usage: `--encrypt-threads=#`
 
 This option specifies the number of worker threads used for
-parallel encryption/decryption.
+parallel encryption/decryption. The default value is 1.
 
 ### input
 
-usage: `-i` `--input`
+usage: `-i=name` `--input=name`
 
 Defines the name of the optional input file. If the name is not specified, the input reads from the standard input.
 
 ### output
 
-usage: `-o` `--output`
+usage: `-o=name` `--output=name`
 
 Defines the name of the optional output file. If this name is not specified, the output is written to the standard output.
 
+
+### read-buffer-size
+
+usage: `--read-buffer-size=#`
+
+Read the buffer size. The default value is 10MB. 
+
 ### verbose
 
 usage: `-v` `--verbose`