prosody
a187600ec7d6
man/prosodyctl.man

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

Software / code / prosody

Annotate

man/prosodyctl.man @ 12976:a187600ec7d6

util: Add compat for prosody module name change to C sources
author Kim Alvefur <zash@zash.se>
date Fri, 17 Mar 2023 18:03:07 +0100
parent 12246:51930f685c16
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
1 .\" Automatically generated by Pandoc 2.17.0.1
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
2 .\"
12243
73ecfe811526 util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents: 12242
diff changeset
3 .TH "PROSODYCTL" "1" "2022-02-02" "" ""
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
4 .hy
1464
047ed6e52a41 Added man page for prosodyctl
Dwayne Bent <dbb.0@liqd.org>
parents:
diff changeset
5 .SH NAME
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
6 .PP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
7 prosodyctl - Manage a Prosody XMPP server
1464
047ed6e52a41 Added man page for prosodyctl
Dwayne Bent <dbb.0@liqd.org>
parents:
diff changeset
8 .SH SYNOPSIS
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
9 .IP
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
10 .nf
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
11 \f[C]
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
12 prosodyctl command [--help]
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
13 \f[R]
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
14 .fi
1464
047ed6e52a41 Added man page for prosodyctl
Dwayne Bent <dbb.0@liqd.org>
parents:
diff changeset
15 .SH DESCRIPTION
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
16 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
17 prosodyctl is the control tool for the Prosody XMPP server.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
18 It may be used to control the server daemon and manage users.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
19 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
20 prosodyctl needs to be executed with sufficient privileges to perform
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
21 its commands.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
22 This typically means executing prosodyctl as the root user.
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
23 If a user named \[lq]prosody\[rq] is found then prosodyctl will change
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
24 to that user before executing its commands.
1464
047ed6e52a41 Added man page for prosodyctl
Dwayne Bent <dbb.0@liqd.org>
parents:
diff changeset
25 .SH COMMANDS
047ed6e52a41 Added man page for prosodyctl
Dwayne Bent <dbb.0@liqd.org>
parents:
diff changeset
26 .SS User Management
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
27 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
28 In the following commands users are identified by a Jabber ID, jid, of
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
29 the usual form: user\[at]domain.
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
30 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
31 adduser jid
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
32 Adds a user with Jabber ID, jid, to the server.
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
33 You will be prompted to enter the user\[cq]s password.
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
34 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
35 passwd jid
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
36 Changes the password of an existing user with Jabber ID, jid.
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
37 You will be prompted to enter the user\[cq]s new password.
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
38 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
39 deluser jid
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
40 Deletes an existing user with Jabber ID, jid, from the server.
1464
047ed6e52a41 Added man page for prosodyctl
Dwayne Bent <dbb.0@liqd.org>
parents:
diff changeset
41 .SS Daemon Management
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
42 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
43 Although prosodyctl has commands to manage the prosody daemon it is
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
44 recommended that you utilize your distributions daemon management
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
45 features if you attained Prosody through a package.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
46 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
47 To perform daemon control commands prosodyctl needs a pidfile value
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
48 specified in \f[C]/etc/prosody/prosody.cfg.lua\f[R].
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
49 Failure to do so will cause prosodyctl to complain.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
50 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
51 start
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
52 Starts the prosody server daemon.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
53 If run as root prosodyctl will attempt to change to a user named
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
54 \[lq]prosody\[rq] before executing.
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
55 This operation will block for up to five seconds to wait for the server
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
56 to execute.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
57 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
58 stop
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
59 Stops the prosody server daemon.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
60 This operation will block for up to five seconds to wait for the server
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
61 to stop executing.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
62 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
63 restart
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
64 Restarts the prosody server daemon.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
65 Equivalent to running prosodyctl stop followed by prosodyctl start.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
66 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
67 reload
7033
719f02848c99 man prosodyctl: Add missing 'reload' command
Kim Alvefur <zash@zash.se>
parents: 7032
diff changeset
68 Signals the prosody server daemon to reload configuration and reopen log
719f02848c99 man prosodyctl: Add missing 'reload' command
Kim Alvefur <zash@zash.se>
parents: 7032
diff changeset
69 files.
719f02848c99 man prosodyctl: Add missing 'reload' command
Kim Alvefur <zash@zash.se>
parents: 7032
diff changeset
70 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
71 status
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
72 Prints the current execution status of the prosody server daemon.
8005
b472bccf8023 man prosodyctl: Rebuild from Markdown source
Kim Alvefur <zash@zash.se>
parents: 7034
diff changeset
73 .SS Certificates
b472bccf8023 man prosodyctl: Rebuild from Markdown source
Kim Alvefur <zash@zash.se>
parents: 7034
diff changeset
74 .PP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
75 prosodyctl can create self-signed certificates, certificate requests and
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
76 private keys for use with Prosody.
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
77 Commands are of the form \f[C]prosodyctl cert subcommand\f[R].
8005
b472bccf8023 man prosodyctl: Rebuild from Markdown source
Kim Alvefur <zash@zash.se>
parents: 7034
diff changeset
78 Commands take a list of hosts to be included in the certificate.
b472bccf8023 man prosodyctl: Rebuild from Markdown source
Kim Alvefur <zash@zash.se>
parents: 7034
diff changeset
79 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
80 \f[B]\f[CB]request hosts\f[B]\f[R]
8005
b472bccf8023 man prosodyctl: Rebuild from Markdown source
Kim Alvefur <zash@zash.se>
parents: 7034
diff changeset
81 Create a certificate request (CSR) file for submission to a certificate
b472bccf8023 man prosodyctl: Rebuild from Markdown source
Kim Alvefur <zash@zash.se>
parents: 7034
diff changeset
82 authority.
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
83 Multiple hosts can be given, sub-domains are automatically included.
8005
b472bccf8023 man prosodyctl: Rebuild from Markdown source
Kim Alvefur <zash@zash.se>
parents: 7034
diff changeset
84 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
85 \f[B]\f[CB]generate hosts\f[B]\f[R]
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
86 Generate a self-signed certificate.
8005
b472bccf8023 man prosodyctl: Rebuild from Markdown source
Kim Alvefur <zash@zash.se>
parents: 7034
diff changeset
87 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
88 \f[B]\f[CB]key host [size]\f[B]\f[R]
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
89 Generate a private key of `size' bits (defaults to 2048).
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
90 Invoked automatically by `request' and `generate' if needed.
8005
b472bccf8023 man prosodyctl: Rebuild from Markdown source
Kim Alvefur <zash@zash.se>
parents: 7034
diff changeset
91 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
92 \f[B]\f[CB]config hosts\f[B]\f[R]
8005
b472bccf8023 man prosodyctl: Rebuild from Markdown source
Kim Alvefur <zash@zash.se>
parents: 7034
diff changeset
93 Produce a config file for the list of hosts.
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
94 Invoked automatically by `request' and `generate' if needed.
8204
7343ffbc65ea man prosodyctl: Add text about the `cert import` command
Kim Alvefur <zash@zash.se>
parents: 8171
diff changeset
95 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
96 \f[B]\f[CB]import hosts paths\f[B]\f[R]
8204
7343ffbc65ea man prosodyctl: Add text about the `cert import` command
Kim Alvefur <zash@zash.se>
parents: 8171
diff changeset
97 Copy certificates for hosts into the certificate path and reload
7343ffbc65ea man prosodyctl: Add text about the `cert import` command
Kim Alvefur <zash@zash.se>
parents: 8171
diff changeset
98 prosody.
7034
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents: 7033
diff changeset
99 .SS Debugging
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents: 7033
diff changeset
100 .PP
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents: 7033
diff changeset
101 prosodyctl can also show some information about the environment,
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents: 7033
diff changeset
102 dependencies and such to aid in debugging.
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents: 7033
diff changeset
103 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
104 \f[B]\f[CB]about\f[B]\f[R]
7034
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents: 7033
diff changeset
105 Shows environment, various paths used by Prosody and installed
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents: 7033
diff changeset
106 dependencies.
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents: 7033
diff changeset
107 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
108 \f[B]\f[CB]check [what]\f[B]\f[R]
7034
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents: 7033
diff changeset
109 Performs various sanity checks on the configuration, DNS setup and
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands
Kim Alvefur <zash@zash.se>
parents: 7033
diff changeset
110 configured TLS certificates.
12246
51930f685c16 man/prosodyctl: Complete list of 'check' variants
Kim Alvefur <zash@zash.se>
parents: 12245
diff changeset
111 \f[C]what\f[R] can be one of \f[C]config\f[R], \f[C]dns\f[R]
51930f685c16 man/prosodyctl: Complete list of 'check' variants
Kim Alvefur <zash@zash.se>
parents: 12245
diff changeset
112 \f[C]certs\f[R], \f[C]disabled\f[R] and \f[C]connectivity\f[R] to run
51930f685c16 man/prosodyctl: Complete list of 'check' variants
Kim Alvefur <zash@zash.se>
parents: 12245
diff changeset
113 only that check.
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
114 .SS Ejabberd Compatibility
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
115 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
116 ejabberd is another XMPP server which provides a comparable control
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
117 tool, ejabberdctl, to control its server\[cq]s operations.
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
118 prosodyctl implements some commands which are compatible with
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
119 ejabberdctl.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
120 For details of how these commands work you should see ejabberdctl(8).
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
121 .IP
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
122 .nf
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
123 \f[C]
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
124 register user server password
1464
047ed6e52a41 Added man page for prosodyctl
Dwayne Bent <dbb.0@liqd.org>
parents:
diff changeset
125
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
126 unregister user server
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
127 \f[R]
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
128 .fi
1464
047ed6e52a41 Added man page for prosodyctl
Dwayne Bent <dbb.0@liqd.org>
parents:
diff changeset
129 .SH OPTIONS
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
130 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
131 \f[B]\f[CB]--config filename\f[B]\f[R]
8005
b472bccf8023 man prosodyctl: Rebuild from Markdown source
Kim Alvefur <zash@zash.se>
parents: 7034
diff changeset
132 Use the specified config file instead of the default.
b472bccf8023 man prosodyctl: Rebuild from Markdown source
Kim Alvefur <zash@zash.se>
parents: 7034
diff changeset
133 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
134 \f[B]\f[CB]--root\f[B]\f[R]
12245
dfa3cac981bc man/prosodyctl: Clarify description of --root
Kim Alvefur <zash@zash.se>
parents: 12244
diff changeset
135 Don\[cq]t drop root privileges (e.g.\ when invoked with sudo).
8171
746d73347937 man prosodyctl: Mention the --root flag
Kim Alvefur <zash@zash.se>
parents: 8005
diff changeset
136 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
137 \f[B]\f[CB]--help\f[B]\f[R]
1464
047ed6e52a41 Added man page for prosodyctl
Dwayne Bent <dbb.0@liqd.org>
parents:
diff changeset
138 Display help text for the specified command.
12243
73ecfe811526 util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents: 12242
diff changeset
139 .TP
73ecfe811526 util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents: 12242
diff changeset
140 \f[B]\f[CB]--verbose\f[B]\f[R]
73ecfe811526 util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents: 12242
diff changeset
141 Increase log level to show debug messages.
73ecfe811526 util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents: 12242
diff changeset
142 .TP
73ecfe811526 util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents: 12242
diff changeset
143 \f[B]\f[CB]--quiet\f[B]\f[R]
73ecfe811526 util.startup: Teach prosodyctl to be --quiet as complement to --verbose
Kim Alvefur <zash@zash.se>
parents: 12242
diff changeset
144 Reduce log level to only show errors.
12244
858d40d675ee util.startup: Teach prosodyctl to be completely --silent
Kim Alvefur <zash@zash.se>
parents: 12243
diff changeset
145 .TP
858d40d675ee util.startup: Teach prosodyctl to be completely --silent
Kim Alvefur <zash@zash.se>
parents: 12243
diff changeset
146 \f[B]\f[CB]--silent\f[B]\f[R]
858d40d675ee util.startup: Teach prosodyctl to be completely --silent
Kim Alvefur <zash@zash.se>
parents: 12243
diff changeset
147 Disable logging completely, leaving only command output.
1464
047ed6e52a41 Added man page for prosodyctl
Dwayne Bent <dbb.0@liqd.org>
parents:
diff changeset
148 .SH FILES
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
149 .TP
12242
202319a990e7 man/prosodyctl: Normalize formatting syntax
Kim Alvefur <zash@zash.se>
parents: 8365
diff changeset
150 \f[B]\f[CB]/etc/prosody/prosody.cfg.lua\f[B]\f[R]
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
151 The main prosody configuration file.
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
152 prosodyctl reads this to determine the process ID file of the prosody
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
153 server daemon and to determine if a host has been configured.
1464
047ed6e52a41 Added man page for prosodyctl
Dwayne Bent <dbb.0@liqd.org>
parents:
diff changeset
154 .SH ONLINE
7032
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
155 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown
Kim Alvefur <zash@zash.se>
parents: 2699
diff changeset
156 More information may be found online at: <https://prosody.im/>
1464
047ed6e52a41 Added man page for prosodyctl
Dwayne Bent <dbb.0@liqd.org>
parents:
diff changeset
157 .SH AUTHORS
7033
719f02848c99 man prosodyctl: Add missing 'reload' command
Kim Alvefur <zash@zash.se>
parents: 7032
diff changeset
158 Dwayne Bent <dbb.1@liqd.org>; Kim Alvefur.