Browse Source

Fix the man pages syntax

pull/39/head
Rodolphe Breard 4 years ago
parent
commit
d9fdc8cb08
  1. 5
      man/en/acmed.8
  2. 9
      man/en/acmed.toml.5
  3. 1
      man/en/tacd.8

5
man/en/acmed.8

@ -48,17 +48,19 @@ Specifies the location of the PID file
Add a root certificate to the trust store. This option can be used multiple times. Add a root certificate to the trust store. This option can be used multiple times.
.It Fl V, -version .It Fl V, -version
Prints version information Prints version information
.El
.Sh FILES .Sh FILES
.Bl -tag .Bl -tag
.It Pa /etc/acmed/acmed.toml .It Pa /etc/acmed/acmed.toml
Default Default
.Nm .Nm
configuration file. configuration file.
.El
.Sh SEE ALSO .Sh SEE ALSO
.Xr acmed.toml 5 , .Xr acmed.toml 5 ,
.Xr tacd 8 .Xr tacd 8
.Sh STANDARDS .Sh STANDARDS
.Bl
.Bl -hyphen
.It .It
.Rs .Rs
.%A R. Barnes .%A R. Barnes
@ -84,6 +86,7 @@ configuration file.
.%R RFC 8738 .%R RFC 8738
.%T Automated Certificate Management Environment (ACME) IP Identifier Validation Extension .%T Automated Certificate Management Environment (ACME) IP Identifier Validation Extension
.Re .Re
.El
.Sh AUTHORS .Sh AUTHORS
.An Rodolphe Bréard .An Rodolphe Bréard
.Aq rodolphe@breard.tf .Aq rodolphe@breard.tf

9
man/en/acmed.toml.5

@ -330,6 +330,7 @@ Period of time between the certificate renewal and its expiration date. The form
.Sx TIME PERIODS .Sx TIME PERIODS
section. Default is the value defined in the associated endpoint. section. Default is the value defined in the associated endpoint.
.El .El
.El
.Sh WRITING A HOOK .Sh WRITING A HOOK
When requesting a certificate from a CA using ACME, there are three steps that are hard to automatize. The first one is solving challenges in order to prove the ownership of every identifier to be included: it requires to interact with the configuration of other services, hence depends on how the infrastructure works. The second one is restarting all the services that use a given certificate, for the same reason. The last one is archiving: although several default methods can be implemented, sometimes admins wants or are required to do it in a different way. When requesting a certificate from a CA using ACME, there are three steps that are hard to automatize. The first one is solving challenges in order to prove the ownership of every identifier to be included: it requires to interact with the configuration of other services, hence depends on how the infrastructure works. The second one is restarting all the services that use a given certificate, for the same reason. The last one is archiving: although several default methods can be implemented, sometimes admins wants or are required to do it in a different way.
.Pp .Pp
@ -547,7 +548,7 @@ This hook is designed to solve the tls-alpn-01 challenge using
It requires It requires
.Xr pkill 1 .Xr pkill 1
to support the to support the
.Em Ar -F
.Em -F
option. option.
.Pp .Pp
.Xr tacd 8 .Xr tacd 8
@ -570,7 +571,7 @@ This hook is designed to solve the tls-alpn-01 challenge using
It requires It requires
.Xr pkill 1 .Xr pkill 1
to support the to support the
.Em Ar -F
.Em -F
option. option.
.Pp .Pp
.Xr tacd 8 .Xr tacd 8
@ -632,6 +633,7 @@ configuration file.
Default accounts private and public keys directory. Default accounts private and public keys directory.
.It Pa /etc/acmed/certs .It Pa /etc/acmed/certs
Default certificates and associated private keys directory. Default certificates and associated private keys directory.
.El
.Sh EXAMPLES .Sh EXAMPLES
The following example defines a typical endpoint, account and certificate for a domain, several subdomains and an IP address. The following example defines a typical endpoint, account and certificate for a domain, several subdomains and an IP address.
.Bd -literal -offset indent .Bd -literal -offset indent
@ -722,7 +724,6 @@ hooks = ["http-01-echo"]
env.HTTP_ROOT = "/srv/http" env.HTTP_ROOT = "/srv/http"
.Ed .Ed
.Pp .Pp
It is also possible to use It is also possible to use
.Xr sendmail 8 .Xr sendmail 8
in a hook in order to notif someone when the certificate request process is done. in a hook in order to notif someone when the certificate request process is done.
@ -746,7 +747,7 @@ status: {{status}}"""
.Xr acmed 8 , .Xr acmed 8 ,
.Xr tacd 8 .Xr tacd 8
.Sh STANDARDS .Sh STANDARDS
.Bl
.Bl -hyphen
.It .It
.Rs .Rs
.%A Tom Preston-Werner .%A Tom Preston-Werner

1
man/en/tacd.8

@ -85,6 +85,7 @@ Specify the log level. Possible values: error, warn, info, debug and trace.
Specifies the location of the PID file. Specifies the location of the PID file.
.It Fl V, -version .It Fl V, -version
Prints version information. Prints version information.
.El
.Sh SEE ALSO .Sh SEE ALSO
.Xr acmed.toml 5 .Xr acmed.toml 5
.Sh STANDARDS .Sh STANDARDS

Loading…
Cancel
Save