summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>2021-01-27 14:41:57 -0500
committerJustus Winter <justus@sequoia-pgp.org>2021-01-28 12:03:28 +0100
commitdf68717078073cf03018d5de61237c6e88b61fcd (patch)
tree1f7f9384e5df8885706c7ce828c80e883252e9f5
parentc06d94f9d66190de4b116faa07cb235d6d3c8f96 (diff)
sq: Align example usage with synopsis.
The synopsis clearly places TARGET-KEY *after* the options. But the example places it haphazardly within the options, which is harder to read and understand. Even if the original example works, the goal of the example should be to make it easy to see what is happening in a standard usage, not to show off the flexibility of the parser.
-rw-r--r--sq/sq-key-adopt.12
-rw-r--r--sq/src/sq-usage.rs2
-rw-r--r--sq/src/sq_cli.rs2
3 files changed, 3 insertions, 3 deletions
diff --git a/sq/sq-key-adopt.1 b/sq/sq-key-adopt.1
index f0f69dfc..82a5abeb 100644
--- a/sq/sq-key-adopt.1
+++ b/sq/sq-key-adopt.1
@@ -43,7 +43,7 @@ Adds keys to TARGET\-KEY
.SH EXAMPLES
.TP
Adopt an subkey into the new cert
-\fB$ sq key adopt \-\-keyring juliet\-old.pgp juliet\-new.pgp \-\-key 0123456789ABCDEF\fR
+\fB$ sq key adopt \-\-keyring juliet\-old.pgp \-\-key 0123456789ABCDEF \-\- juliet\-new.pgp\fR
.SH SEE ALSO
For the full documentation see <https://docs.sequoia\-pgp.org/sq/>.
diff --git a/sq/src/sq-usage.rs b/sq/src/sq-usage.rs
index 9372cc0b..bd51059b 100644
--- a/sq/src/sq-usage.rs
+++ b/sq/src/sq-usage.rs
@@ -507,7 +507,7 @@
//! EXAMPLES:
//!
//! # Adopt an subkey into the new cert
-//! $ sq key adopt --keyring juliet-old.pgp juliet-new.pgp --key 0123456789ABCDEF
+//! $ sq key adopt --keyring juliet-old.pgp --key 0123456789ABCDEF -- juliet-new.pgp
//! ```
//!
//! ## Subcommand keyring
diff --git a/sq/src/sq_cli.rs b/sq/src/sq_cli.rs
index 2ba0faea..8a4a1d6e 100644
--- a/sq/src/sq_cli.rs
+++ b/sq/src/sq_cli.rs
@@ -569,7 +569,7 @@ feasible.
"EXAMPLES:
# Adopt an subkey into the new cert
-$ sq key adopt --keyring juliet-old.pgp juliet-new.pgp --key 0123456789ABCDEF
+$ sq key adopt --keyring juliet-old.pgp --key 0123456789ABCDEF -- juliet-new.pgp
")
.arg(Arg::with_name("keyring")
.short("r").long("keyring").value_name("KEY-RING")