diff options
| author | Justus Winter <justus@sequoia-pgp.org> | 2020-03-16 15:29:46 +0100 |
|---|---|---|
| committer | Justus Winter <justus@sequoia-pgp.org> | 2020-03-16 15:29:46 +0100 |
| commit | d8b3ac96daed4bc6939c3c2bb3df47247624bda5 (patch) | |
| tree | cab7c73b984e75ac04017c3bee1ff374627d5ffb /tool | |
| parent | d78db30735edd08f6cbe8b8f085759b5823fefdb (diff) | |
tool: Improve documentation.
Diffstat (limited to 'tool')
| -rw-r--r-- | tool/src/sq-usage.rs | 9 | ||||
| -rw-r--r-- | tool/src/sq_cli.rs | 7 |
2 files changed, 10 insertions, 6 deletions
diff --git a/tool/src/sq-usage.rs b/tool/src/sq-usage.rs index c4a1907d..420bcee2 100644 --- a/tool/src/sq-usage.rs +++ b/tool/src/sq-usage.rs @@ -715,7 +715,7 @@ //! updated and existing ones will be updated. //! //! USAGE: -//! sq wkd generate [FLAGS] <BASE-DIRECTORY> <DOMAIN> [KEYRING] +//! sq wkd generate [FLAGS] <WEB-ROOT> <DOMAIN> [KEYRING] //! //! FLAGS: //! -d, --direct_method Use the direct method. [default: advanced method] @@ -723,9 +723,10 @@ //! -V, --version Prints version information //! //! ARGS: -//! <BASE-DIRECTORY> The location to write the WKD to -//! <DOMAIN> The domain for the WKD. -//! <KEYRING> The keyring file with the keys to add to the WKD. +//! <WEB-ROOT> The location to write the WKD to. This must be the directory the webserver is serving the '.well- +//! known' directory from. +//! <DOMAIN> The domain for the WKD. +//! <KEYRING> The keyring file with the keys to add to the WKD. //! ``` //! //! ### Subcommand wkd get diff --git a/tool/src/sq_cli.rs b/tool/src/sq_cli.rs index 6bf26266..52e43c98 100644 --- a/tool/src/sq_cli.rs +++ b/tool/src/sq_cli.rs @@ -568,9 +568,12 @@ pub fn build() -> App<'static, 'static> { is updated and existing ones \ will be updated.") .arg(Arg::with_name("base_directory") - .value_name("BASE-DIRECTORY") + .value_name("WEB-ROOT") .required(true) - .help("The location to write the WKD to")) + .help("The location to write the WKD to. \ + This must be the directory the \ + webserver is serving the \ + '.well-known' directory from.")) .arg(Arg::with_name("domain") .value_name("DOMAIN") .help("The domain for the WKD.") |