summaryrefslogtreecommitdiffstats
path: root/tool/src/sq-usage.rs
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2018-08-15 16:03:33 +0200
committerJustus Winter <justus@sequoia-pgp.org>2018-08-15 16:34:02 +0200
commit8ad003bf46987a1adee5bbd3c1c8370544be2147 (patch)
tree034a9ea783fea6585d2a1007579de2e7cf9440ef /tool/src/sq-usage.rs
parentd73691ea0a5735f010be6d52c635f383d8df65e5 (diff)
tool: Reorder subcommands.
Diffstat (limited to 'tool/src/sq-usage.rs')
-rw-r--r--tool/src/sq-usage.rs324
1 files changed, 162 insertions, 162 deletions
diff --git a/tool/src/sq-usage.rs b/tool/src/sq-usage.rs
index 19242601..8db6f589 100644
--- a/tool/src/sq-usage.rs
+++ b/tool/src/sq-usage.rs
@@ -18,125 +18,131 @@
//! -s, --store <STORE> Sets the store to use (default: 'default')
//!
//! SUBCOMMANDS:
+//! decrypt Decrypts an OpenPGP message
+//! encrypt Encrypts a message
+//! store Interacts with key stores
+//! keyserver Interacts with keyservers
//! autocrypt Autocrypt support
//! dearmor Removes ASCII Armor from a file
-//! decrypt Decrypts an OpenPGP message
//! dump Lists OpenPGP packets
//! enarmor Applies ASCII Armor to a file
-//! encrypt Encrypts a message
//! help Prints this message or the help of the given subcommand(s)
-//! keyserver Interacts with keyservers
//! list Lists key stores and known keys
//! split Splits a message into OpenPGP packets
-//! store Interacts with key stores
//! ```
//!
-//! ## Subcommand autocrypt
+//! ## Subcommand decrypt
//!
//! ```text
-//! Autocrypt support
+//! Decrypts an OpenPGP message
//!
//! USAGE:
-//! sq autocrypt [SUBCOMMAND]
+//! sq decrypt [FLAGS] [OPTIONS] [--] [FILE]
//!
//! FLAGS:
+//! --dump Print a packet dump to stderr
//! -h, --help Prints help information
+//! -x, --hex Print a hexdump (implies --dump)
//! -V, --version Prints version information
//!
-//! SUBCOMMANDS:
-//! decode Converts Autocrypt-encoded keys to OpenPGP TPKs
-//! help Prints this message or the help of the given subcommand(s)
+//! OPTIONS:
+//! -o, --output <FILE> Sets the output file to use
+//! --secret-key-file <TSK-FILE>... Secret key to decrypt with, given as a file (can be given multiple times)
+//!
+//! ARGS:
+//! <FILE> Sets the input file to use
//! ```
//!
-//! ### Subcommand autocrypt decode
+//! ## Subcommand encrypt
//!
//! ```text
-//! Converts Autocrypt-encoded keys to OpenPGP TPKs
+//! Encrypts a message
//!
//! USAGE:
-//! sq autocrypt decode [OPTIONS] [FILE]
+//! sq encrypt [FLAGS] [OPTIONS] [--] [FILE]
//!
//! FLAGS:
-//! -h, --help Prints help information
-//! -V, --version Prints version information
+//! -B, --binary Emit unencoded OpenPGP data
+//! -h, --help Prints help information
+//! -s, --symmetric Encrypt with a password (can be given multiple times)
+//! -V, --version Prints version information
//!
//! OPTIONS:
-//! -o, --output <FILE> Sets the output file to use
+//! -o, --output <FILE> Sets the output file to use
+//! -r, --recipient <LABEL>... Recipient to encrypt for (can be given multiple times)
+//! --recipient-key-file <TPK-FILE>... Recipient to encrypt for, given as a file (can be given multiple times)
//!
//! ARGS:
//! <FILE> Sets the input file to use
//! ```
//!
-//! ## Subcommand dearmor
+//! ## Subcommand store
//!
//! ```text
-//! Removes ASCII Armor from a file
+//! Interacts with key stores
//!
//! USAGE:
-//! sq dearmor [OPTIONS] [FILE]
+//! sq store [SUBCOMMAND]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
-//! OPTIONS:
-//! -o, --output <FILE> Sets the output file to use
-//!
-//! ARGS:
-//! <FILE> Sets the input file to use
+//! SUBCOMMANDS:
+//! add Add a key identified by fingerprint
+//! delete Deletes bindings or stores
+//! export Exports a key
+//! help Prints this message or the help of the given subcommand(s)
+//! import Imports a key
+//! list Lists keys in the store
+//! log Lists the keystore log
+//! stats Get stats for the given label
//! ```
//!
-//! ## Subcommand decrypt
+//! ### Subcommand store add
//!
//! ```text
-//! Decrypts an OpenPGP message
+//! Add a key identified by fingerprint
//!
//! USAGE:
-//! sq decrypt [FLAGS] [OPTIONS] [--] [FILE]
+//! sq store add <LABEL> <FINGERPRINT>
//!
//! FLAGS:
-//! --dump Print a packet dump to stderr
//! -h, --help Prints help information
-//! -x, --hex Print a hexdump (implies --dump)
//! -V, --version Prints version information
//!
-//! OPTIONS:
-//! -o, --output <FILE> Sets the output file to use
-//! --secret-key-file <TSK-FILE>... Secret key to decrypt with, given as a file (can be given multiple times)
-//!
//! ARGS:
-//! <FILE> Sets the input file to use
+//! <LABEL> Label to use
+//! <FINGERPRINT> Key to add
//! ```
//!
-//! ## Subcommand dump
+//! ### Subcommand store delete
//!
//! ```text
-//! Lists OpenPGP packets
+//! Deletes bindings or stores
//!
//! USAGE:
-//! sq dump [FLAGS] [OPTIONS] [FILE]
+//! sq store delete [FLAGS] [LABEL]
//!
//! FLAGS:
-//! -h, --help Prints help information
-//! -x, --hex Print a hexdump
-//! -V, --version Prints version information
-//!
-//! OPTIONS:
-//! -o, --output <FILE> Sets the output file to use
+//! -h, --help Prints help information
+//! --the-store Delete the whole store
+//! -V, --version Prints version information
//!
//! ARGS:
-//! <FILE> Sets the input file to use
+//! <LABEL> Delete binding with this label
//! ```
//!
-//! ## Subcommand enarmor
+//! ### Subcommand store export
//!
//! ```text
-//! Applies ASCII Armor to a file
+//! Exports a key
//!
//! USAGE:
-//! sq enarmor [OPTIONS] [FILE]
+//! sq store export [FLAGS] [OPTIONS] <LABEL>
//!
//! FLAGS:
+//! -B, --binary Emit unencoded OpenPGP data
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
@@ -144,324 +150,318 @@
//! -o, --output <FILE> Sets the output file to use
//!
//! ARGS:
-//! <FILE> Sets the input file to use
+//! <LABEL> Label to use
//! ```
//!
-//! ## Subcommand encrypt
+//! ### Subcommand store import
//!
//! ```text
-//! Encrypts a message
+//! Imports a key
//!
//! USAGE:
-//! sq encrypt [FLAGS] [OPTIONS] [--] [FILE]
+//! sq store import <LABEL> [FILE]
//!
//! FLAGS:
-//! -B, --binary Emit unencoded OpenPGP data
-//! -h, --help Prints help information
-//! -s, --symmetric Encrypt with a password (can be given multiple times)
-//! -V, --version Prints version information
-//!
-//! OPTIONS:
-//! -o, --output <FILE> Sets the output file to use
-//! -r, --recipient <LABEL>... Recipient to encrypt for (can be given multiple times)
-//! --recipient-key-file <TPK-FILE>... Recipient to encrypt for, given as a file (can be given multiple times)
+//! -h, --help Prints help information
+//! -V, --version Prints version information
//!
//! ARGS:
-//! <FILE> Sets the input file to use
+//! <LABEL> Label to use
+//! <FILE> Sets the input file to use
//! ```
//!
-//! ## Subcommand keyserver
+//! ### Subcommand store list
//!
//! ```text
-//! Interacts with keyservers
+//! Lists keys in the store
//!
//! USAGE:
-//! sq keyserver [OPTIONS] [SUBCOMMAND]
+//! sq store list
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
-//!
-//! OPTIONS:
-//! -s, --server <URI> Sets the keyserver to use
-//!
-//! SUBCOMMANDS:
-//! get Retrieves a key
-//! help Prints this message or the help of the given subcommand(s)
-//! send Sends a key
//! ```
//!
-//! ### Subcommand keyserver get
+//! ### Subcommand store log
//!
//! ```text
-//! Retrieves a key
+//! Lists the keystore log
//!
//! USAGE:
-//! sq keyserver get [FLAGS] [OPTIONS] <KEYID>
+//! sq store log [LABEL]
//!
//! FLAGS:
-//! -B, --binary Emit unencoded OpenPGP data
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
-//! OPTIONS:
-//! -o, --output <FILE> Sets the output file to use
-//!
//! ARGS:
-//! <KEYID> ID of the key to retrieve
+//! <LABEL> List messages related to this label
//! ```
//!
-//! ### Subcommand keyserver send
+//! ### Subcommand store stats
//!
//! ```text
-//! Sends a key
+//! Get stats for the given label
//!
//! USAGE:
-//! sq keyserver send [FILE]
+//! sq store stats <LABEL>
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! ARGS:
-//! <FILE> Sets the input file to use
+//! <LABEL> Label to use
//! ```
//!
-//! ## Subcommand list
+//! ## Subcommand keyserver
//!
//! ```text
-//! Lists key stores and known keys
+//! Interacts with keyservers
//!
//! USAGE:
-//! sq list [SUBCOMMAND]
+//! sq keyserver [OPTIONS] [SUBCOMMAND]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
+//! OPTIONS:
+//! -s, --server <URI> Sets the keyserver to use
+//!
//! SUBCOMMANDS:
-//! bindings Lists all bindings in all key stores
-//! help Prints this message or the help of the given subcommand(s)
-//! keys Lists all keys in the common key pool
-//! log Lists the server log
-//! stores Lists key stores
+//! get Retrieves a key
+//! help Prints this message or the help of the given subcommand(s)
+//! send Sends a key
//! ```
//!
-//! ### Subcommand list bindings
+//! ### Subcommand keyserver get
//!
//! ```text
-//! Lists all bindings in all key stores
+//! Retrieves a key
//!
//! USAGE:
-//! sq list bindings [PREFIX]
+//! sq keyserver get [FLAGS] [OPTIONS] <KEYID>
//!
//! FLAGS:
+//! -B, --binary Emit unencoded OpenPGP data
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
+//! OPTIONS:
+//! -o, --output <FILE> Sets the output file to use
+//!
//! ARGS:
-//! <PREFIX> List only bindings from stores with the given domain prefix
+//! <KEYID> ID of the key to retrieve
//! ```
//!
-//! ### Subcommand list keys
+//! ### Subcommand keyserver send
//!
//! ```text
-//! Lists all keys in the common key pool
+//! Sends a key
//!
//! USAGE:
-//! sq list keys
+//! sq keyserver send [FILE]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
+//!
+//! ARGS:
+//! <FILE> Sets the input file to use
//! ```
//!
-//! ### Subcommand list log
+//! ## Subcommand autocrypt
//!
//! ```text
-//! Lists the server log
+//! Autocrypt support
//!
//! USAGE:
-//! sq list log
+//! sq autocrypt [SUBCOMMAND]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
+//!
+//! SUBCOMMANDS:
+//! decode Converts Autocrypt-encoded keys to OpenPGP TPKs
+//! help Prints this message or the help of the given subcommand(s)
//! ```
//!
-//! ### Subcommand list stores
+//! ### Subcommand autocrypt decode
//!
//! ```text
-//! Lists key stores
+//! Converts Autocrypt-encoded keys to OpenPGP TPKs
//!
//! USAGE:
-//! sq list stores [PREFIX]
+//! sq autocrypt decode [OPTIONS] [FILE]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
+//! OPTIONS:
+//! -o, --output <FILE> Sets the output file to use
+//!
//! ARGS:
-//! <PREFIX> List only stores with the given domain prefix
+//! <FILE> Sets the input file to use
//! ```
//!
-//! ## Subcommand split
+//! ## Subcommand dearmor
//!
//! ```text
-//! Splits a message into OpenPGP packets
+//! Removes ASCII Armor from a file
//!
//! USAGE:
-//! sq split [OPTIONS] [FILE]
+//! sq dearmor [OPTIONS] [FILE]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! OPTIONS:
-//! -p, --prefix <FILE> Sets the prefix to use for output files (defaults to the input filename with a dash, or
-//! 'output')
+//! -o, --output <FILE> Sets the output file to use
//!
//! ARGS:
//! <FILE> Sets the input file to use
//! ```
//!
-//! ## Subcommand store
+//! ## Subcommand dump
//!
//! ```text
-//! Interacts with key stores
+//! Lists OpenPGP packets
//!
//! USAGE:
-//! sq store [SUBCOMMAND]
+//! sq dump [FLAGS] [OPTIONS] [FILE]
//!
//! FLAGS:
//! -h, --help Prints help information
+//! -x, --hex Print a hexdump
//! -V, --version Prints version information
//!
-//! SUBCOMMANDS:
-//! add Add a key identified by fingerprint
-//! delete Deletes bindings or stores
-//! export Exports a key
-//! help Prints this message or the help of the given subcommand(s)
-//! import Imports a key
-//! list Lists keys in the store
-//! log Lists the keystore log
-//! stats Get stats for the given label
+//! OPTIONS:
+//! -o, --output <FILE> Sets the output file to use
+//!
+//! ARGS:
+//! <FILE> Sets the input file to use
//! ```
//!
-//! ### Subcommand store add
+//! ## Subcommand enarmor
//!
//! ```text
-//! Add a key identified by fingerprint
+//! Applies ASCII Armor to a file
//!
//! USAGE:
-//! sq store add <LABEL> <FINGERPRINT>
+//! sq enarmor [OPTIONS] [FILE]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
+//! OPTIONS:
+//! -o, --output <FILE> Sets the output file to use
+//!
//! ARGS:
-//! <LABEL> Label to use
-//! <FINGERPRINT> Key to add
+//! <FILE> Sets the input file to use
//! ```
//!
-//! ### Subcommand store delete
+//! ## Subcommand list
//!
//! ```text
-//! Deletes bindings or stores
+//! Lists key stores and known keys
//!
//! USAGE:
-//! sq store delete [FLAGS] [LABEL]
+//! sq list [SUBCOMMAND]
//!
//! FLAGS:
-//! -h, --help Prints help information
-//! --the-store Delete the whole store
-//! -V, --version Prints version information
+//! -h, --help Prints help information
+//! -V, --version Prints version information
//!
-//! ARGS:
-//! <LABEL> Delete binding with this label
+//! SUBCOMMANDS:
+//! bindings Lists all bindings in all key stores
+//! help Prints this message or the help of the given subcommand(s)
+//! keys Lists all keys in the common key pool
+//! log Lists the server log
+//! stores Lists key stores
//! ```
//!
-//! ### Subcommand store export
+//! ### Subcommand list bindings
//!
//! ```text
-//! Exports a key
+//! Lists all bindings in all key stores
//!
//! USAGE:
-//! sq store export [FLAGS] [OPTIONS] <LABEL>
+//! sq list bindings [PREFIX]
//!
//! FLAGS:
-//! -B, --binary Emit unencoded OpenPGP data
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
-//! OPTIONS:
-//! -o, --output <FILE> Sets the output file to use
-//!
//! ARGS:
-//! <LABEL> Label to use
+//! <PREFIX> List only bindings from stores with the given domain prefix
//! ```
//!
-//! ### Subcommand store import
+//! ### Subcommand list keys
//!
//! ```text
-//! Imports a key
+//! Lists all keys in the common key pool
//!
//! USAGE:
-//! sq store import <LABEL> [FILE]
+//! sq list keys
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
-//!
-//! ARGS:
-//! <LABEL> Label to use
-//! <FILE> Sets the input file to use
//! ```
//!
-//! ### Subcommand store list
+//! ### Subcommand list log
//!
//! ```text
-//! Lists keys in the store
+//! Lists the server log
//!
//! USAGE:
-//! sq store list
+//! sq list log
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//! ```
//!
-//! ### Subcommand store log
+//! ### Subcommand list stores
//!
//! ```text
-//! Lists the keystore log
+//! Lists key stores
//!
//! USAGE:
-//! sq store log [LABEL]
+//! sq list stores [PREFIX]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
//! ARGS:
-//! <LABEL> List messages related to this label
+//! <PREFIX> List only stores with the given domain prefix
//! ```
//!
-//! ### Subcommand store stats
+//! ## Subcommand split
//!
//! ```text
-//! Get stats for the given label
+//! Splits a message into OpenPGP packets
//!
//! USAGE:
-//! sq store stats <LABEL>
+//! sq split [OPTIONS] [FILE]
//!
//! FLAGS:
//! -h, --help Prints help information
//! -V, --version Prints version information
//!
+//! OPTIONS:
+//! -p, --prefix <FILE> Sets the prefix to use for output files (defaults to the input filename with a dash, or
+//! 'output')
+//!
//! ARGS:
-//! <LABEL> Label to use
+//! <FILE> Sets the input file to use
//! ```
include!("sq.rs");