prosody
817c7b197ac7
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 @ 7032:817c7b197ac7

man prosodyctl: Accidentally markdown
author Kim Alvefur <zash@zash.se>
date Wed, 23 Dec 2015 14:19:01 +0100
parent 2699:1ae8a1ac93bd
child 7033:719f02848c99
comparison
equal deleted inserted replaced
7031:89221daefae9 7032:817c7b197ac7
1 .TH PROSODYCTL 1 "2009-07-02" 1 .\" Automatically generated by Pandoc 1.15.2
2 2 .\"
3 .hy
4 .TH "PROSODYCTL" "1" "2015\-12\-23" "" ""
3 .SH NAME 5 .SH NAME
6 .PP
4 prosodyctl \- Manage a Prosody XMPP server 7 prosodyctl \- Manage a Prosody XMPP server
5
6 .SH SYNOPSIS 8 .SH SYNOPSIS
7 \fBprosodyctl\fP \fIcommand\fP [\fI--help\fP] 9 .IP
8 10 .nf
11 \f[C]
12 prosodyctl\ command\ [\-\-help]
13 \f[]
14 .fi
9 .SH DESCRIPTION 15 .SH DESCRIPTION
10 \fBprosodyctl\fP is the control tool for the Prosody XMPP server. It may be 16 .PP
11 used to control the server daemon and manage users. 17 prosodyctl is the control tool for the Prosody XMPP server.
12 18 It may be used to control the server daemon and manage users.
13 \fBprosodyctl\fP needs to be executed with sufficient privileges to perform 19 .PP
14 its commands. This typically means executing \fBprosodyctl\fP as the root user. 20 prosodyctl needs to be executed with sufficient privileges to perform
15 If a user named "prosody" is found then \fBprosodyctl\fP will change to that 21 its commands.
22 This typically means executing prosodyctl as the root user.
23 If a user named "prosody" is found then prosodyctl will change to that
16 user before executing its commands. 24 user before executing its commands.
17
18 .SH COMMANDS 25 .SH COMMANDS
19 .SS User Management 26 .SS User Management
20 In the following commands users are identified by a Jabber ID, \fIjid\fP, of the 27 .PP
21 usual form: user@domain. 28 In the following commands users are identified by a Jabber ID, jid, of
29 the usual form: user\@domain.
30 .TP
31 .B adduser jid
32 Adds a user with Jabber ID, jid, to the server.
33 You will be prompted to enter the user\[aq]s password.
34 .RS
35 .RE
36 .TP
37 .B passwd jid
38 Changes the password of an existing user with Jabber ID, jid.
39 You will be prompted to enter the user\[aq]s new password.
40 .RS
41 .RE
42 .TP
43 .B deluser jid
44 Deletes an existing user with Jabber ID, jid, from the server.
45 .RS
46 .RE
47 .SS Daemon Management
48 .PP
49 Although prosodyctl has commands to manage the prosody daemon it is
50 recommended that you utilize your distributions daemon management
51 features if you attained Prosody through a package.
52 .PP
53 To perform daemon control commands prosodyctl needs a pidfile value
54 specified in \f[C]/etc/prosody/prosody.cfg.lua\f[].
55 Failure to do so will cause prosodyctl to complain.
56 .TP
57 .B start
58 Starts the prosody server daemon.
59 If run as root prosodyctl will attempt to change to a user named
60 "prosody" before executing.
61 This operation will block for up to five seconds to wait for the server
62 to execute.
63 .RS
64 .RE
65 .TP
66 .B stop
67 Stops the prosody server daemon.
68 This operation will block for up to five seconds to wait for the server
69 to stop executing.
70 .RS
71 .RE
72 .TP
73 .B restart
74 Restarts the prosody server daemon.
75 Equivalent to running prosodyctl stop followed by prosodyctl start.
76 .RS
77 .RE
78 .TP
79 .B status
80 Prints the current execution status of the prosody server daemon.
81 .RS
82 .RE
83 .SS Ejabberd Compatibility
84 .PP
85 ejabberd is another XMPP server which provides a comparable control
86 tool, ejabberdctl, to control its server\[aq]s operations.
87 prosodyctl implements some commands which are compatible with
88 ejabberdctl.
89 For details of how these commands work you should see ejabberdctl(8).
90 .IP
91 .nf
92 \f[C]
93 register\ user\ server\ password
22 94
23 .IP "\fBadduser\fP \fIjid\fP" 95 unregister\ user\ server
24 Adds a user with Jabber ID, \fIjid\fP, to the server. You will be 96 \f[]
25 prompted to enter the user's password. 97 .fi
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 \fBrestart\fP
53 Restarts the \fBprosody\fP server daemon. Equivalent to running \fBprosodyctl
54 stop\fP followed by \fBprosodyctl start\fP.
55
56 .IP \fBstatus\fP
57 Prints the current execution status of the \fBprosody\fP server daemon.
58
59 .SS Ejabberd Compatibility
60 \fBejabberd\fP is another XMPP server which provides a comparable control tool,
61 \fBejabberdctl\fP, to control its server's operations. \fBprosodyctl\fP
62 implements some commands which are compatible with \fBejabberdctl\fP. For
63 details of how these commands work you should see
64 .BR ejabberdctl (8).
65
66 .IP "\fBregister\fP \fIuser server password\fP"
67 .IP "\fBunregister\fP \fIuser server\fP"
68
69 .SH OPTIONS 98 .SH OPTIONS
70 .IP \fI--help\fP 99 .TP
100 .B \f[C]\-\-help\f[]
71 Display help text for the specified command. 101 Display help text for the specified command.
72 102 .RS
103 .RE
73 .SH FILES 104 .SH FILES
74 .IP \fI/etc/prosody/prosody.cfg.lua\fP 105 .TP
75 The main \fBprosody\fP configuration file. \fBprosodyctl\fP reads this to 106 .B \f[C]/etc/prosody/prosody.cfg.lua\f[]
76 determine the process ID file of the \fBprosody\fP server daemon and to 107 The main prosody configuration file.
77 determine if a host has been configured. 108 prosodyctl reads this to determine the process ID file of the prosody
78 109 server daemon and to determine if a host has been configured.
110 .RS
111 .RE
79 .SH ONLINE 112 .SH ONLINE
80 More information may be found online at: \fIhttp://prosody.im/\fP 113 .PP
81 114 More information may be found online at: <https://prosody.im/>
82 .SH AUTHORS 115 .SH AUTHORS
83 Dwayne Bent <dbb.1@liqd.org> 116 Dwayne Bent <dbb.1@liqd.org>.