diff --git a/certbot/docs/conf.py b/certbot/docs/conf.py index de9e287fc..5102e7a1e 100644 --- a/certbot/docs/conf.py +++ b/certbot/docs/conf.py @@ -286,7 +286,7 @@ latex_documents = [ man_pages = [ ('index', 'certbot', u'Certbot Documentation', [project], 7), - ('man/certbot', 'certbot', u'certbot script documentation', + ('man/certbot', 'certbot', u"Automatically configure HTTPS using Let's Encrypt", [project], 1), ] diff --git a/certbot/docs/man/certbot.rst b/certbot/docs/man/certbot.rst index 2f25504b0..cc690d2da 100644 --- a/certbot/docs/man/certbot.rst +++ b/certbot/docs/man/certbot.rst @@ -1,3 +1,23 @@ :orphan: -.. literalinclude:: ../cli-help.txt +======= +certbot +======= + +Synopsis +======== +The objective of Certbot, Let's Encrypt, and the ACME (Automated Certificate Management +Environment) protocol is to make it possible to set up an HTTPS server and have it automatically +obtain a browser-trusted certificate, without any human intervention. This is accomplished by +running a certificate management agent on the web server. + +This agent is used to: + +- Automatically prove to the Let's Encrypt CA that you control the website +- Obtain a browser-trusted certificate and set it up on your web server +- Keep track of when your certificate is going to expire, and renew it +- Help you revoke the certificate if that ever becomes necessary. + +Options +======= +.. literalinclude:: ../cli-help.txt \ No newline at end of file