diff options
| author | Lars Wirzenius <liw@sequoia-pgp.org> | 2022-06-13 15:08:11 +0300 |
|---|---|---|
| committer | Lars Wirzenius <liw@sequoia-pgp.org> | 2022-06-13 16:02:08 +0300 |
| commit | 3db2119c000a33a207c8188510d26deea7e15286 (patch) | |
| tree | b7347782379c87da967881d96243d982d172b23e /sq | |
| parent | 1a8e91681f1930eabb6aa044e003b43572046f03 (diff) | |
sq: fix up help text for "sq wkd generate" based on further feedback
Sponsored-by: pep.foundation
Diffstat (limited to 'sq')
| -rw-r--r-- | sq/src/sq-usage.rs | 23 | ||||
| -rw-r--r-- | sq/src/sq_cli.rs | 23 |
2 files changed, 26 insertions, 20 deletions
diff --git a/sq/src/sq-usage.rs b/sq/src/sq-usage.rs index 5a22ebcd..133cd370 100644 --- a/sq/src/sq-usage.rs +++ b/sq/src/sq-usage.rs @@ -1236,15 +1236,20 @@ //! the new keys will be inserted and it is updated and existing ones will be //! updated. //! -//! A WKD is per-domain, and can be advanced or direct. For a given domain, the -//! advanced URL uses a subdomain 'openpgpkey'. The advanced URL is preferred. The -//! direct URL must only be used if the subdomain doesn't exist. The advanced URL -//! allows web key directories for several domains on one web server. -//! -//! The contentes of the generated WKD must be copied to a web server so that they -//! are accessible as https://openpgpkey.example.com/.well-known/openpgp/... for the -//! advanced version, and https://example.com/.well-known/openpgp/... for the direct -//! version. sq does not copy files to the web server. +//! +//! +//! A WKD is per domain, and can be queried using the advanced or the direct +//! method. The advanced method uses a URL with a subdomain 'openpgpkey'. As per the +//! specification, the advanced method is to be preferred. The direct method may +//! only be used if the subdomain doesn't exist. The advanced method allows web key +//! directories for several domains on one web server. +//! +//! +//! +//! The contents of the generated WKD must be copied to a web server so that +//! they are accessible under https://openpgpkey.example.com/.well-known/openpgp/... +//! for the advanced version, and https://example.com/.well-known/openpgp/... for +//! the direct version. sq does not copy files to the web server. //! //! USAGE: //! sq wkd generate [OPTIONS] <WEB-ROOT> <FQDN> [CERT-RING] diff --git a/sq/src/sq_cli.rs b/sq/src/sq_cli.rs index 79016444..272beb6e 100644 --- a/sq/src/sq_cli.rs +++ b/sq/src/sq_cli.rs @@ -2071,17 +2071,18 @@ pub struct WkdGetCommand { long_about = "Generates a Web Key Directory for the given domain and keys. \ If the WKD exists, the new keys will be inserted and it \ is updated and existing ones will be updated. \ - \n\ - \n\ - A WKD is per-domain, and can be advanced or direct. For a given \ - domain, the advanced URL uses a subdomain 'openpgpkey'. The advanced \ - URL is preferred. The direct URL must only be used if the subdomain \ - doesn't exist. The advanced URL allows web key directories for several \ - domains on one web server. \ - \n\ - \n\ - The contentes of the generated WKD must be copied to a web server so that \ - they are accessible as https://openpgpkey.example.com/.well-known/openpgp/... \ + \n + \n + A WKD is per domain, and can be queried using the advanced or the \ + direct method. The advanced method uses a URL with a subdomain \ + 'openpgpkey'. As per the specification, the advanced method is to be \ + preferred. The direct method may only be used if the subdomain \ + doesn't exist. The advanced method allows web key directories for \ + several domains on one web server. \ + \n + \n + The contents of the generated WKD must be copied to a web server so that \ + they are accessible under https://openpgpkey.example.com/.well-known/openpgp/... \ for the advanced version, and https://example.com/.well-known/openpgp/... \ for the direct version. sq does not copy files to the web server.", after_help = |