mirrors/prosody
1
0
Fork 0
mirror of https://github.com/bjc/prosody.git synced 2025-04-03 05:07:42 +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 78b88eff88
commit 97b8c70117
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 take a list of hosts to be included in the certificate.
.TP
.B request hosts
.B \f[C]request\ hosts\f[]
Create a certificate request (CSR) file for submission to a certificate
authority.
Multiple hosts can be given, sub\-domains are automatically included.
.RS
.RE
.TP
.B generate hosts
.B \f[C]generate\ hosts\f[]
Generate a self\-signed certificate.
.RS
.RE
.TP
.B key host [size]
.B \f[C]key\ host\ [size]\f[]
Generate a private key of \[aq]size\[aq] bits (defaults to 2048).
Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if
needed.
.RS
.RE
.TP
.B config hosts
.B \f[C]config\ hosts\f[]
Produce a config file for the list of hosts.
Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if
needed.
.RS
.RE
.TP
.B import hosts paths
.B \f[C]import\ hosts\ paths\f[]
Copy certificates for hosts into the certificate path and reload
prosody.
.RS
@ -129,13 +129,13 @@ prosody.
prosodyctl can also show some information about the environment,
dependencies and such to aid in debugging.
.TP
.B about
.B \f[C]about\f[]
Shows environment, various paths used by Prosody and installed
dependencies.
.RS
.RE
.TP
.B check [what]
.B \f[C]check\ [what]\f[]
Performs various sanity checks on the configuration, DNS setup and
configured TLS certificates.
\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
included in the certificate.
request hosts
`request hosts`
: Create a certificate request (CSR) file for submission to a
certificate authority. Multiple hosts can be given, sub-domains are
automatically included.
generate hosts
`generate hosts`
: Generate a self-signed certificate.
key host \[size\]
`key host [size]`
: Generate a private key of 'size' bits (defaults to 2048). Invoked
automatically by 'request' and 'generate' if needed.
config hosts
`config hosts`
: Produce a config file for the list of hosts. Invoked automatically
by 'request' and 'generate' if needed.
import hosts paths
`import hosts paths`
: Copy certificates for hosts into the certificate path and reload
prosody.
@ -114,11 +114,11 @@ Debugging
prosodyctl can also show some information about the environment,
dependencies and such to aid in debugging.
about
`about`
: Shows environment, various paths used by Prosody and installed
dependencies.
check \[what\]
`check [what]`
: Performs various sanity checks on the configuration, DNS setup and
configured TLS certificates. `what` can be one of `config`, `dns`
and `certs` to run only that check.