prosody
8e079677d724
man/prosodyctl.man

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

Comparison

man/prosodyctl.man @ 8365:8e079677d724

man prosodyctl: Highlight subcommands
author Kim Alvefur <zash@zash.se>
date Mon, 23 Oct 2017 12:46:11 +0200
parent 8204:7343ffbc65ea
child 12242:202319a990e7
comparison
equal deleted inserted replaced
8364:f91ab40a3105 8365:8e079677d724
91 prosodyctl can create self\-signed certificates, certificate requests 91 prosodyctl can create self\-signed certificates, certificate requests
92 and private keys for use with Prosody. 92 and private keys for use with Prosody.
93 Commands are of the form \f[C]prosodyctl\ cert\ subcommand\f[]. 93 Commands are of the form \f[C]prosodyctl\ cert\ subcommand\f[].
94 Commands take a list of hosts to be included in the certificate. 94 Commands take a list of hosts to be included in the certificate.
95 .TP 95 .TP
96 .B request hosts 96 .B \f[C]request\ hosts\f[]
97 Create a certificate request (CSR) file for submission to a certificate 97 Create a certificate request (CSR) file for submission to a certificate
98 authority. 98 authority.
99 Multiple hosts can be given, sub\-domains are automatically included. 99 Multiple hosts can be given, sub\-domains are automatically included.
100 .RS 100 .RS
101 .RE 101 .RE
102 .TP 102 .TP
103 .B generate hosts 103 .B \f[C]generate\ hosts\f[]
104 Generate a self\-signed certificate. 104 Generate a self\-signed certificate.
105 .RS 105 .RS
106 .RE 106 .RE
107 .TP 107 .TP
108 .B key host [size] 108 .B \f[C]key\ host\ [size]\f[]
109 Generate a private key of \[aq]size\[aq] bits (defaults to 2048). 109 Generate a private key of \[aq]size\[aq] bits (defaults to 2048).
110 Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if 110 Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if
111 needed. 111 needed.
112 .RS 112 .RS
113 .RE 113 .RE
114 .TP 114 .TP
115 .B config hosts 115 .B \f[C]config\ hosts\f[]
116 Produce a config file for the list of hosts. 116 Produce a config file for the list of hosts.
117 Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if 117 Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if
118 needed. 118 needed.
119 .RS 119 .RS
120 .RE 120 .RE
121 .TP 121 .TP
122 .B import hosts paths 122 .B \f[C]import\ hosts\ paths\f[]
123 Copy certificates for hosts into the certificate path and reload 123 Copy certificates for hosts into the certificate path and reload
124 prosody. 124 prosody.
125 .RS 125 .RS
126 .RE 126 .RE
127 .SS Debugging 127 .SS Debugging
128 .PP 128 .PP
129 prosodyctl can also show some information about the environment, 129 prosodyctl can also show some information about the environment,
130 dependencies and such to aid in debugging. 130 dependencies and such to aid in debugging.
131 .TP 131 .TP
132 .B about 132 .B \f[C]about\f[]
133 Shows environment, various paths used by Prosody and installed 133 Shows environment, various paths used by Prosody and installed
134 dependencies. 134 dependencies.
135 .RS 135 .RS
136 .RE 136 .RE
137 .TP 137 .TP
138 .B check [what] 138 .B \f[C]check\ [what]\f[]
139 Performs various sanity checks on the configuration, DNS setup and 139 Performs various sanity checks on the configuration, DNS setup and
140 configured TLS certificates. 140 configured TLS certificates.
141 \f[C]what\f[] can be one of \f[C]config\f[], \f[C]dns\f[] and 141 \f[C]what\f[] can be one of \f[C]config\f[], \f[C]dns\f[] and
142 \f[C]certs\f[] to run only that check. 142 \f[C]certs\f[] to run only that check.
143 .RS 143 .RS