diff --git a/docs/cli-help.txt b/docs/cli-help.txt index a5607c70e..7a4bf58b9 100644 --- a/docs/cli-help.txt +++ b/docs/cli-help.txt @@ -57,19 +57,19 @@ optional arguments: certificate, specifies the new certificate's name. (default: None) --dry-run Perform a test run of the client, obtaining test - (invalid) certificates but not saving them to disk. This can - currently only be used with the 'certonly' and 'renew' - subcommands. Note: Although --dry-run tries to avoid - making any persistent changes on a system, it is not - completely side-effect free: if used with webserver - authenticator plugins like apache and nginx, it makes - and then reverts temporary config changes in order to - obtain test certificates, and reloads webservers to deploy - and then roll back those changes. It also calls --pre- - hook and --post-hook commands if they are defined - because they may be necessary to accurately simulate - renewal. --renew-hook commands are not called. - (default: False) + (invalid) certificates but not saving them to disk. + This can currently only be used with the 'certonly' + and 'renew' subcommands. Note: Although --dry-run + tries to avoid making any persistent changes on a + system, it is not completely side-effect free: if used + with webserver authenticator plugins like apache and + nginx, it makes and then reverts temporary config + changes in order to obtain test certificates, and + reloads webservers to deploy and then roll back those + changes. It also calls --pre-hook and --post-hook + commands if they are defined because they may be + necessary to accurately simulate renewal. --renew-hook + commands are not called. (default: False) --debug-challenges After setting up challenges, wait for user input before submitting to CA (default: False) --preferred-challenges PREF_CHALLS @@ -88,8 +88,8 @@ optional arguments: statistics about success rates by OS and plugin. If you wish to hide your server OS version from the Let's Encrypt server, set this to "". (default: - CertbotACMEClient/0.13.0 (Ubuntu 16.04.2 LTS) - Authenticator/XXX Installer/YYY) + CertbotACMEClient/0.14.0.dev0 (Debian GNU/Linux 9 + (stretch)) Authenticator/XXX Installer/YYY) automation: Arguments for automating execution & other tweaks @@ -171,8 +171,8 @@ testing: --test-cert, --staging Use the staging server to obtain or revoke test - (invalid) certificates; equivalent to --server - https://acme-staging.api.letsencrypt.org/directory + (invalid) certificates; equivalent to --server https + ://acme-staging.api.letsencrypt.org/directory (default: False) --debug Show tracebacks in case of errors, and allow certbot- auto execution on experimental platforms (default: @@ -190,7 +190,8 @@ testing: will still attempt to connect on port 80. (default: 80) --break-my-certs Be willing to replace or renew valid certificates with - invalid (testing/staging) certificates (default: False) + invalid (testing/staging) certificates (default: + False) paths: Arguments changing execution paths & servers @@ -271,7 +272,7 @@ renew: new certificates and keys; the shell variable $RENEWED_DOMAINS will contain a space-delimited list of renewed certificate domains (for example, - "example.com www.example.com") (default: None) + "example.com www.example.com" (default: None) --disable-hook-validation Ordinarily the commands specified for --pre-hook /--post-hook/--renew-hook will be checked for @@ -348,8 +349,8 @@ plugins: --installers Limit to installer plugins only. (default: None) update_symlinks: - Recreates certificate and key symlinks in /etc/letsencrypt/live, if you changed - them by hand or edited a renewal configuration file + Recreates certificate and key symlinks in /etc/letsencrypt/live, if you + changed them by hand or edited a renewal configuration file plugins: Plugin Selection: Certbot client supports an extensible plugins @@ -367,14 +368,16 @@ plugins: -i INSTALLER, --installer INSTALLER Installer plugin name (also used to find domains). (default: None) - --apache Obtain and install certificates using Apache (default: False) - --nginx Obtain and install certificates using Nginx (default: False) - --standalone Obtain certificates using a "standalone" webserver. (default: + --apache Obtain and install certificates using Apache (default: + False) + --nginx Obtain and install certificates using Nginx (default: + False) + --standalone Obtain certs using a "standalone" webserver. (default: False) --manual Provide laborious manual instructions for obtaining a certificate (default: False) - --webroot Obtain certificates by placing files in a webroot directory. - (default: False) + --webroot Obtain certificates by placing files in a webroot + directory. (default: False) nginx: Nginx Web Server plugin - Alpha