|
1464
|
1 .TH PROSODYCTL 1 "2009-07-02"
|
|
|
2
|
|
|
3 .SH NAME
|
|
|
4 prosodyctl \- Manage a Prosody XMPP server
|
|
|
5
|
|
|
6 .SH SYNOPSIS
|
|
|
7 \fBprosodyctl\fP \fIcommand\fP [\fI--help\fP]
|
|
|
8
|
|
|
9 .SH DESCRIPTION
|
|
|
10 \fBprosodyctl\fP is the control tool for the Prosody XMPP server. It may be
|
|
|
11 used to control the server daemon and manage users.
|
|
|
12
|
|
|
13 \fBprosodyctl\fP needs to be executed with sufficient privileges to perform
|
|
|
14 its commands. This typically means executing \fBprosodyctl\fP as the root user.
|
|
|
15 If a user named "prosody" is found then \fBprosodyctl\fP will change to that
|
|
|
16 user before executing its commands.
|
|
|
17
|
|
|
18 .SH COMMANDS
|
|
|
19 .SS User Management
|
|
|
20 In the following commands users are identified by a Jabber ID, \fIjid\fP, of the
|
|
|
21 usual form: user@domain.
|
|
|
22
|
|
|
23 .IP "\fBadduser\fP \fIjid\fP"
|
|
|
24 Adds a user with Jabber ID, \fIjid\fP, to the server. You will be
|
|
|
25 prompted to enter the user's password.
|
|
|
26
|
|
|
27 .IP "\fBpasswd\fP \fIjid\fP"
|
|
|
28 Changes the password of an existing user with Jabber ID, \fIjid\fP. You will be
|
|
|
29 prompted to enter the user's new password.
|
|
|
30
|
|
|
31 .IP "\fBdeluser\fP \fIjid\fP"
|
|
|
32 Deletes an existing user with Jabber ID, \fIjid\fP, from the server.
|
|
|
33
|
|
|
34 .SS Daemon Management
|
|
|
35 Although \fBprosodyctl\fP has commands to manage the \fBprosody\fP daemon it is
|
|
|
36 recommended that you utilize your distributions daemon management features if
|
|
|
37 you attained Prosody through a package.
|
|
|
38
|
|
|
39 To perform daemon control commands \fBprosodyctl\fP needs a \fIpidfile\fP value
|
|
|
40 specified in \fI/etc/prosody/prosody.cfg.lua\fP. Failure to do so will cause
|
|
|
41 \fBprosodyctl\fP to complain.
|
|
|
42
|
|
|
43 .IP \fBstart\fP
|
|
|
44 Starts the \fBprosody\fP server daemon. If run as root \fBprosodyctl\fP will
|
|
|
45 attempt to change to a user named "prosody" before executing. This operation
|
|
|
46 will block for up to five seconds to wait for the server to execute.
|
|
|
47
|
|
|
48 .IP \fBstop\fP
|
|
|
49 Stops the \fBprosody\fP server daemon. This operation will block for up to five
|
|
|
50 seconds to wait for the server to stop executing.
|
|
|
51
|
|
|
52 .IP \fBstatus\fP
|
|
|
53 Prints the current execution status of the \fBprosody\fP server daemon.
|
|
|
54
|
|
|
55 .SS Ejabberd Compatibility
|
|
|
56 \fBejabberd\fP is another XMPP server which provides a comparable control tool,
|
|
|
57 \fBejabberdctl\fP, to control its server's operations. \fBprosodyctl\fP
|
|
|
58 implements some commands which are compatible with \fBejabberdctl\fP. For
|
|
|
59 details of how these commands work you should see
|
|
|
60 .BR ejabberdctl (8).
|
|
|
61
|
|
|
62 .IP "\fBregister\fP \fIuser server password\fP"
|
|
|
63 .IP "\fBunregister\fP \fIuser server\fP"
|
|
|
64
|
|
|
65 .SH OPTIONS
|
|
|
66 .IP \fI--help\fP
|
|
|
67 Display help text for the specified command.
|
|
|
68
|
|
|
69 .SH FILES
|
|
|
70 .IP \fI/etc/prosody/prosody.cfg.lua\fP
|
|
|
71 The main \fBprosody\fP configuration file. \fBprosodyctl\fP reads this to
|
|
|
72 determine the process ID file of the \fBprosody\fP server daemon and to
|
|
|
73 determine if a host has been configured.
|
|
|
74
|
|
|
75 .SH ONLINE
|
|
|
76 More information may be found online at: \fIhttp://prosody.im/\fP
|
|
|
77
|
|
|
78 .SH AUTHORS
|
|
|
79 Dwayne Bent <dbb.0@liqd.org>
|
