slipenkomk/sequoia-sq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Use single quotes in examples, don't quote unnecessarily.

Browse Source
This commit is contained in:
Justus Winter 2024-01-11 17:48:37 +01:00
parent 43dc8fc19f
commit 6d18c95001
No known key found for this signature in database
GPG Key ID: 686F55B4AB2B3386
3 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/cli/key.rs
View File

@ -124,21 +124,21 @@ subkeys, and the binding signatures to the reference time.
"EXAMPLES:
# First, generate a key
$ sq key generate --userid \"<juliet@example.org>\" \\
$ sq key generate --userid '<juliet@example.org>' \\
--output juliet.key.pgp
# Then, extract the certificate for distribution
$ sq key extract-cert --output juliet.cert.pgp juliet.key.pgp
# Generate a key protecting it with a password
$ sq key generate --userid \"<juliet@example.org>\" --with-password
$ sq key generate --userid '<juliet@example.org>' --with-password
# Generate a key with multiple userids
$ sq key generate --userid \"<juliet@example.org>\" \\
--userid \"Juliet Capulet\"
$ sq key generate --userid '<juliet@example.org>' \\
--userid 'Juliet Capulet'
# Generate a key whose creation time is June 9, 2011 at midnight UTC
$ sq key generate --time 20110609 --userid \"Noam\" \\
$ sq key generate --time 20110609 --userid Noam \\
--output noam.pgp
",
)]
@ -280,7 +280,7 @@ supply a zero-length password when prompted for the new password.
"EXAMPLES:
# First, generate a key
$ sq key generate --userid \"<juliet@example.org>\" \\
$ sq key generate --userid '<juliet@example.org>' \\
--output juliet.key.pgp
# Then, encrypt the secrets in the key with a password.
@ -483,7 +483,7 @@ it to a keyserver.
after_help = "EXAMPLES:
# First, generate a key
$ sq key generate --userid \"<juliet@example.org>\" \\
$ sq key generate --userid '<juliet@example.org>' \\
--output juliet.key.pgp
# Then, extract the certificate for distribution
@ -549,16 +549,16 @@ binding signature to the specified time.
"EXAMPLES:
# First, generate a key:
$ sq key generate --userid \"<juliet@example.org>\" \\
$ sq key generate --userid '<juliet@example.org>' \\
--output juliet.key.pgp
# Then, add a User ID:
$ sq key userid add --userid \"Juliet\" juliet.key.pgp \\
$ sq key userid add --userid Juliet juliet.key.pgp \\
--output juliet-new.key.pgp
# Or, add a User ID whose creation time is set to June 28, 2022 at
# midnight UTC:
$ sq key userid add --userid \"Juliet\" --creation-time 20210628 \\
$ sq key userid add --userid Juliet --creation-time 20210628 \\
juliet.key.pgp --output juliet-new.key.pgp
",
)]
@ -760,11 +760,11 @@ signature.
"EXAMPLES:
# First, generate a key:
$ sq key generate --userid \"<juliet@example.org>\" \\
$ sq key generate --userid '<juliet@example.org>' \\
--output juliet.key.pgp
# Then, strip a User ID:
$ sq key userid strip --userid \"<juliet@example.org>\" \\
$ sq key userid strip --userid '<juliet@example.org>' \\
--output juliet-new.key.pgp juliet.key.pgp
",
)]
@ -988,7 +988,7 @@ time.
"EXAMPLES:
# First, generate a key
$ sq key generate --userid \"<juliet@example.org>\" \\
$ sq key generate --userid '<juliet@example.org>' \\
--output juliet.key.pgp
# Add a new Subkey for universal encryption which expires at the same

12
src/cli/link.rs
View File

@ -50,8 +50,8 @@ previous link.
",
after_help = "EXAMPLES:
# Link 0123456789ABCDEF and User ID \"<romeo@example.org>\".
$ sq link add 0123456789ABCDEF \"<romeo@example.org>\"
# Link 0123456789ABCDEF and User ID '<romeo@example.org>'.
$ sq link add 0123456789ABCDEF '<romeo@example.org>'
# Link the certificate 0123456789ABCDEF with its current set of
# self-signed User IDs as a trusted introducer for example.org.
@ -61,8 +61,8 @@ $ sq link add --ca example.org 0123456789ABCDEF
# self-signed User IDs as a trusted introducer.
$ sq link add --ca '*' 0123456789ABCDEF
# Retract the link between 0123456789ABCDEF and \"<romeo@example.org>\".
$ sq link retract 0123456789ABCDEF \"<romeo@example.org>\"
# Retract the link between 0123456789ABCDEF and '<romeo@example.org>'.
$ sq link retract 0123456789ABCDEF '<romeo@example.org>'
# Retract all links associated with 0123456789ABCDEF.
$ sq link retract 0123456789ABCDEF
@ -116,8 +116,8 @@ argument. It sets the link's creation time to the reference time.
"EXAMPLES:
# The user links 0123456789ABCDEF and the User ID
# \"<romeo@example.org>\".
$ sq link add 0123456789ABCDEF \"<romeo@example.org>\"
# '<romeo@example.org>'.
$ sq link add 0123456789ABCDEF '<romeo@example.org>'
# The user examines 0123456789ABCDEF and then accepts the certificate
# 0123456789ABCDEF with its current set of self-signed User IDs.

2
src/cli/wot.rs
View File

@ -274,7 +274,7 @@ $ sq --keyring keyring.pgp \\
wot path \\
8F17777118A33DDA9BA48E62AACB3243630052D9 \\
CBCD8F030588653EEDD7E2659B7DD433F254904A \\
\"Justus Winter <justus@sequoia-pgp.org>\"
'Justus Winter <justus@sequoia-pgp.org>'
"))]
Path {
#[command(flatten)]