From c4189929427bdb5e2b919f78542517925ac5af29 Mon Sep 17 00:00:00 2001 From: Filippo Valsorda Date: Fri, 15 Jan 2021 14:26:33 +0100 Subject: [PATCH] cmd/age: touch up help text --- README.md | 20 ++++++++++---------- cmd/age/age.go | 22 +++++++++++----------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 6d0f17bd..61b72c5d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ It features small explicit keys, no config options, and UNIX-style composability $ age-keygen -o key.txt Public key: age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p $ tar cvz ~/data | age -r age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p > data.tar.gz.age -$ age -d -i key.txt data.tar.gz.age > data.tar.gz +$ age --decrypt -i key.txt data.tar.gz.age > data.tar.gz ``` The format specification is at [age-encryption.org/v1](https://age-encryption.org/v1). To discuss the spec or other age related topics, please email [the mailing list](https://groups.google.com/d/forum/age-dev) at age-dev@googlegroups.com. age was designed by [@Benjojo12](https://twitter.com/Benjojo12) and [@FiloSottile](https://twitter.com/FiloSottile). @@ -21,9 +21,9 @@ An alternative interoperable Rust implementation is available at [github.com/str ``` Usage: - age (-r RECIPIENT | -R PATH)... [-a] [-o OUTPUT] [INPUT] - age --passphrase [-a] [-o OUTPUT] [INPUT] - age --decrypt [-i KEY]... [-o OUTPUT] [INPUT] + age (-r RECIPIENT | -R PATH)... [--armor] [-o OUTPUT] [INPUT] + age --passphrase [--armor] [-o OUTPUT] [INPUT] + age --decrypt [-i PATH]... [-o OUTPUT] [INPUT] Options: -o, --output OUTPUT Write the result to the file at path OUTPUT. @@ -32,21 +32,21 @@ Options: -r, --recipient RECIPIENT Encrypt to the specified RECIPIENT. Can be repeated. -R, --recipients-file PATH Encrypt to recipients listed at PATH. Can be repeated. -d, --decrypt Decrypt the input to the output. - -i, --identity KEY Use the private key file at path KEY. Can be repeated. + -i, --identity PATH Use the identity file at PATH. Can be repeated. INPUT defaults to standard input, and OUTPUT defaults to standard output. -RECIPIENT can be an age public key, as generated by age-keygen, ("age1...") +RECIPIENT can be an age public key generated by age-keygen ("age1...") or an SSH public key ("ssh-ed25519 AAAA...", "ssh-rsa AAAA..."). Recipient files contain one or more recipients, one per line. Empty lines and lines starting with "#" are ignored as comments. "-" may be used to read recipients from standard input. -KEY is a path to a file with age secret keys, one per line (ignoring "#" -prefixed comments and empty lines), or to an SSH key file. Multiple keys -can be provided, and any unused ones will be ignored. "-" may be used to -read keys from standard input. +Identity files contain one or more secret keys ("AGE-SECRET-KEY-1..."), +one per line, or an SSH key. Empty lines and lines starting with "#" are +ignored as comments. Multiple key files can be provided, and any unused ones +will be ignored. "-" may be used to read identities from standard input. ``` ### Multiple recipients diff --git a/cmd/age/age.go b/cmd/age/age.go index 1577cc79..acfa1f87 100644 --- a/cmd/age/age.go +++ b/cmd/age/age.go @@ -32,9 +32,9 @@ func (f *multiFlag) Set(value string) error { } const usage = `Usage: - age (-r RECIPIENT | -R PATH)... [-a] [-o OUTPUT] [INPUT] - age --passphrase [-a] [-o OUTPUT] [INPUT] - age --decrypt [-i KEY]... [-o OUTPUT] [INPUT] + age (-r RECIPIENT | -R PATH)... [--armor] [-o OUTPUT] [INPUT] + age --passphrase [--armor] [-o OUTPUT] [INPUT] + age --decrypt [-i PATH]... [-o OUTPUT] [INPUT] Options: -o, --output OUTPUT Write the result to the file at path OUTPUT. @@ -43,27 +43,27 @@ Options: -r, --recipient RECIPIENT Encrypt to the specified RECIPIENT. Can be repeated. -R, --recipients-file PATH Encrypt to recipients listed at PATH. Can be repeated. -d, --decrypt Decrypt the input to the output. - -i, --identity KEY Use the private key file at path KEY. Can be repeated. + -i, --identity PATH Use the identity file at PATH. Can be repeated. INPUT defaults to standard input, and OUTPUT defaults to standard output. -RECIPIENT can be an age public key, as generated by age-keygen, ("age1...") +RECIPIENT can be an age public key generated by age-keygen ("age1...") or an SSH public key ("ssh-ed25519 AAAA...", "ssh-rsa AAAA..."). Recipient files contain one or more recipients, one per line. Empty lines and lines starting with "#" are ignored as comments. "-" may be used to read recipients from standard input. -KEY is a path to a file with age secret keys, one per line (ignoring "#" -prefixed comments and empty lines), or to an SSH key file. Multiple keys -can be provided, and any unused ones will be ignored. "-" may be used to -read keys from standard input. +Identity files contain one or more secret keys ("AGE-SECRET-KEY-1..."), +one per line, or an SSH key. Empty lines and lines starting with "#" are +ignored as comments. Multiple key files can be provided, and any unused ones +will be ignored. "-" may be used to read identities from standard input. Example: $ age-keygen -o key.txt Public key: age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p $ tar cvz ~/data | age -r age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p > data.tar.gz.age - $ age -d -i key.txt -o data.tar.gz data.tar.gz.age` + $ age --decrypt -i key.txt -o data.tar.gz data.tar.gz.age` // Version can be set at link time to override debug.BuildInfo.Main.Version, // which is "(devel)" when building from within the module. See @@ -179,7 +179,7 @@ func main() { if name != "-" { if decryptFlag { // TODO: buffer the output and check it's printable. - } else if !armorFlag { + } else if !armorFlag { // If the output wouldn't be armored, refuse to send binary to // the terminal unless explicitly requested with "-o -". logFatalf("Error: refusing to output binary to the terminal.\n" +