upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-05-28 04:34:11 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: generate a man page with a structure (#9561)

Browse source 
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.
This commit is contained in:
alexzorin 2023-02-04 06:35:15 +11:00 committed by GitHub
parent 71a14f5193
commit 724635bbbd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
certbot/docs/conf.py
View file

@ -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),
]

22
certbot/docs/man/certbot.rst
View file

@ -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