mirrors/prosody
1
0
Fork 0
mirror of https://github.com/bjc/prosody.git synced 2025-04-04 21:57:45 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

man prosodyctl: Highlight subcommands

Browse source
This commit is contained in:
Kim Alvefur 2017-10-23 12:46:11 +02:00
parent b8d1d533fd
commit 63e10c1c27
2 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

14
man/prosodyctl.man
View file

@ -93,33 +93,33 @@ and private keys for use with Prosody.
Commands are of the form \f[C]prosodyctl\ cert\ subcommand\f[]. Commands are of the form \f[C]prosodyctl\ cert\ subcommand\f[].
Commands take a list of hosts to be included in the certificate. Commands take a list of hosts to be included in the certificate.
.TP .TP
.B request hosts .B \f[C]request\ hosts\f[]
Create a certificate request (CSR) file for submission to a certificate Create a certificate request (CSR) file for submission to a certificate
authority. authority.
Multiple hosts can be given, sub\-domains are automatically included. Multiple hosts can be given, sub\-domains are automatically included.
.RS .RS
.RE .RE
.TP .TP
.B generate hosts .B \f[C]generate\ hosts\f[]
Generate a self\-signed certificate. Generate a self\-signed certificate.
.RS .RS
.RE .RE
.TP .TP
.B key host [size] .B \f[C]key\ host\ [size]\f[]
Generate a private key of \[aq]size\[aq] bits (defaults to 2048). Generate a private key of \[aq]size\[aq] bits (defaults to 2048).
Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if
needed. needed.
.RS .RS
.RE .RE
.TP .TP
.B config hosts .B \f[C]config\ hosts\f[]
Produce a config file for the list of hosts. Produce a config file for the list of hosts.
Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if
needed. needed.
.RS .RS
.RE .RE
.TP .TP
.B import hosts paths .B \f[C]import\ hosts\ paths\f[]
Copy certificates for hosts into the certificate path and reload Copy certificates for hosts into the certificate path and reload
prosody. prosody.
.RS .RS
@ -129,13 +129,13 @@ prosody.
prosodyctl can also show some information about the environment, prosodyctl can also show some information about the environment,
dependencies and such to aid in debugging. dependencies and such to aid in debugging.
.TP .TP
.B about .B \f[C]about\f[]
Shows environment, various paths used by Prosody and installed Shows environment, various paths used by Prosody and installed
dependencies. dependencies.
.RS .RS
.RE .RE
.TP .TP
.B check [what] .B \f[C]check\ [what]\f[]
Performs various sanity checks on the configuration, DNS setup and Performs various sanity checks on the configuration, DNS setup and
configured TLS certificates. configured TLS certificates.
\f[C]what\f[] can be one of \f[C]config\f[], \f[C]dns\f[] and \f[C]what\f[] can be one of \f[C]config\f[], \f[C]dns\f[] and

14
man/prosodyctl.markdown
View file

@ -88,23 +88,23 @@ private keys for use with Prosody. Commands are of the form
`prosodyctl cert subcommand`. Commands take a list of hosts to be `prosodyctl cert subcommand`. Commands take a list of hosts to be
included in the certificate. included in the certificate.
request hosts `request hosts`
: Create a certificate request (CSR) file for submission to a : Create a certificate request (CSR) file for submission to a
certificate authority. Multiple hosts can be given, sub-domains are certificate authority. Multiple hosts can be given, sub-domains are
automatically included. automatically included.
generate hosts `generate hosts`
: Generate a self-signed certificate. : Generate a self-signed certificate.
key host \[size\] `key host [size]`
: Generate a private key of 'size' bits (defaults to 2048). Invoked : Generate a private key of 'size' bits (defaults to 2048). Invoked
automatically by 'request' and 'generate' if needed. automatically by 'request' and 'generate' if needed.
config hosts `config hosts`
: Produce a config file for the list of hosts. Invoked automatically : Produce a config file for the list of hosts. Invoked automatically
by 'request' and 'generate' if needed. by 'request' and 'generate' if needed.
import hosts paths `import hosts paths`
: Copy certificates for hosts into the certificate path and reload : Copy certificates for hosts into the certificate path and reload
prosody. prosody.
@ -114,11 +114,11 @@ Debugging
prosodyctl can also show some information about the environment, prosodyctl can also show some information about the environment,
dependencies and such to aid in debugging. dependencies and such to aid in debugging.
about `about`
: Shows environment, various paths used by Prosody and installed : Shows environment, various paths used by Prosody and installed
dependencies. dependencies.
check \[what\] `check [what]`
: Performs various sanity checks on the configuration, DNS setup and : Performs various sanity checks on the configuration, DNS setup and
configured TLS certificates. `what` can be one of `config`, `dns` configured TLS certificates. `what` can be one of `config`, `dns`
and `certs` to run only that check. and `certs` to run only that check.