mirror of
https://github.com/certbot/certbot.git
synced 2026-07-23 14:23:53 +02:00
alexzorinandGitHub
724635bbbd
If you looked at [the Debian man page for Certbot](https://manpages.debian.org/bullseye/certbot/certbot.1.en.html) or [the FreeBSD one](https://man.freebsd.org/cgi/man.cgi?query=certbot&sektion=1&apropos=0&manpath=FreeBSD+13.1-RELEASE+and+Ports), you will notice that the entire document is in the "NAME" section. It looks weird in particular on the [FreeBSD man page listing](https://man.freebsd.org/cgi/man.cgi?query=certbot&apropos=1&sektion=0&manpath=FreeBSD+13.1-RELEASE+and+Ports&arch=default&format=html). This PR adds some structure to the man page by adding a new "Synopsis" section (lifted from the Certbot snap's synopsis) and shoving the `certbot --help all` output into a new "Options" section. I think this should be sustainable for us, without having to worry about the man page in particular. Fixes #9560.
23 lines
751 B
ReStructuredText
23 lines
751 B
ReStructuredText
:orphan:
|
|
|
|
=======
|
|
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 |