components/web/ejabberd/files/ejabberdctl.1m

   1 .TH ejabberdctl 1M "18 March 2008" "Version 2.0.5" "ejabberdctl"
   2
   3 .SH NAME
   4 ejabberdctl \(em ejabberd Jabber/XMPP server control interface
   5
   6 .SH SYNOPSIS
   7 .PP
   8 \fBejabberdctl\fR \fI[--node node] [vhost server] command [options]\fP
   9
  10 .SH DESCRIPTION
  11 .PP
  12 \fBejabberd\fR is packaged as a SMF service on OpenSolaris, and should
  13 be started and stopped using SMF. Its service name is:
  14
  15     svc:/network/xmpp:ejabberd
  16
  17 \fBejabberdctl\fR can be used to debug \fBejabberd\fR server, and
  18 perform many other administrative tasks.
  19
  20 User should have Ejabberd Management profile to manage \fBejabberd\fR
  21 service and to run \fBejabberdctl\fR command, otherwise there would be
  22 cookie file access permission issue.
  23
  24 .SH OPTIONS
  25 .TP
  26 .BI \-\-node " node"
  27 Specifies the erlang node on which command will be performed. Default
  28 value is ejabberd@localhost. Node name has the following syntax:
  29
  30     name\fI@\fPhost
  31
  32 host can either be a short hostname (usually it coincides with
  33 \fI\(gahostname\(ga\fP) or a FQDN (see \fBerl\fR(1) manual page
  34 and look for options \fI-name\fP and \fI-sname\fP for details).
  35
  36 If the node name does not contain symbol \fI@\fP, then a short hostname
  37 (that is, \fI\(gahostname\(ga\fP) is appended by \fBerlang\fR
  38 runtime system automatically.
  39
  40 .TP
  41 .BI vhost " server"
  42 Specifies the virtual host \fIserver\fP for which command will be
  43 executed. There are only few commands that needs \fIvhost\fP argument.
  44
  45 .SH COMMANDS
  46 .TP
  47 .BI start
  48 Start an ejabberd node in background mode. This is the default method.
  49
  50 .TP
  51 .BI live
  52 Start an ejabberd node in live(interactive) mode. An erlang shell is
  53 attached to the started server, showing log messages and allowing to
  54 execute interactive commands.
  55
  56 .TP
  57 .BI debug
  58 Attach an interactive Erlang shell to a running ejabberd node. This allows
  59 to execute commands interactively on a running ejabberd server. To detach
  60 it, press Ctrl+G, q, <Return>.
  61
  62 .TP
  63 .BI stop
  64 Stop ejabberd server and shut down the node.
  65
  66 .TP
  67 .BI restart
  68 Restart ejabberd server.
  69
  70 .TP
  71 .BI status
  72 Get ejabberd server status.
  73
  74 .TP
  75 .BI reopen-log
  76 Request ejabberd server to reopen its log file.
  77
  78 .TP
  79 .BI register " user server password"
  80 Register a \fIuser\fP with \fIpassword\fP for a virtual \fIserver\fP.
  81
  82 .TP
  83 .BI unregister " user server"
  84 Unregister \fIuser\fP from virtual \fIserver\fP.
  85
  86 .TP
  87 .BI backup " file"
  88 Backup ejabberd user database to a \fIfile\fP.
  89
  90 .TP
  91 .BI restore " file"
  92 Restore ejabberd user database from backup \fIfile\fP.
  93
  94 .TP
  95 .BI install-fallback " file"
  96 Install a database fallback from \fIfile\fP.
  97
  98 .TP
  99 .BI dump " file"
 100 Dump ejabberd user database to a text \fIfile\fP.
 101
 102 .TP
 103 .BI load " file"
 104 Restore ejabberd user database from a text \fIfile\fP.
 105
 106 .TP
 107 .BI import-file " file"
 108 Import user data from jabberd 1.4 spool \fIfile\fP. For example, if
 109 \fIfile\fP is \fI.../example.org/user.xml\fP then imported username
 110 will be \fIuser\fP and it will be imported to virtual server
 111 \fIexample.org\fP.
 112
 113 .TP
 114 .BI import-dir " dir"
 115 Import user data from jabberd 1.4 spool \fIdir\fP. Directory
 116 name should be the name of virtual server to import users.
 117
 118 .TP
 119 .BI delete-expired-messages
 120 Delete expired offline messages from database.
 121
 122 .TP
 123 .BI delete-old-messages n
 124 Delete offline messages older than \fIn\fP days from database.
 125
 126 .TP
 127 .BI mnesia [info]
 128 Show informatoin of Mnesia system.
 129
 130 .TP
 131 .BI incoming-s2s-number
 132 Print number of incoming s2s connections on the node
 133
 134 .TP
 135 .BI outgoing-s2s-number
 136 Print number of outgoing s2s connections on the node
 137
 138 .TP
 139 .BI user-resources " user server"
 140 List all connected resources of user \fIuser@server\fP.
 141
 142 .TP
 143 .BI connected-users-number
 144 Report number of established users' sessions.
 145
 146 .TP
 147 .BI connected-users
 148 List all established users' sessions.
 149
 150 .PP
 151 The following commands are vhost specific:
 152
 153 .TP
 154 .BI registered-users
 155 List all registered users for specified virtual \fIserver\fP.
 156
 157 .SH OPTION FILES
 158 .PP
 159
 160 .TP
 161 .BI --config file
 162 Config file for ejabberd. Default is /etc/ejabberd/ejabberd.cfg.
 163
 164 .TP
 165 .BI --ctl-config file
 166 Config file for ejabberdctl. Default is /etc/ejabberd/ejabberdctl.cfg.
 167
 168 .TP
 169 .BI --logs dir
 170 Directory for log files. Default is /var/ejabberd/log.
 171
 172 .TP
 173 .BI --spool dir
 174 Database spool dir. Default is /var/ejabberd/db/ejabberd.
 175
 176 .SH SEE ALSO
 177 .PP
 178 \fBerl\fR(1), \fBmnesia\fR(3).
 179
 180 .PP
 181 Ejabberd documentation is available at
 182 \fIhttp://www.process-one.net/en/projects/ejabberd/\fP.
 183
 184 .SH AUTHORS
 185 .PP
 186 This manual page was adapted by Sergei Golovan <sgolovan@nes.ru> for
 187 the \fBDebian\fP system (but may be used by others) from the
 188 \fBejabberd\fP documentation written by Alexey Shchepin <alexey@sevcom.net>.
 189
 190 Permission is granted to copy, distribute and/or modify this document
 191 under the terms of the GNU General Public License, Version 2 any
 192 later version published by the Free Software Foundation.
 193
 194 The complete text of the GNU General Public License can be found
 195 at http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
 196
 197 The manual page was modified for ejabberd-2.0.5 on OpenSolaris.
 198