Software `/` code `/` prosody

Annotate

man/prosodyctl.man @ 7567:495de404a8ae

ejabberdsql2prosody: rename variable 'host' to prevent shadowing upvalue [luacheck] Functions roster(), roster_pending(), roster_group(), private_storage() and offline_msg() have argument named "host", which used to shadow upvalue of this variable before this change. Instead of renaming this argument, let's rename the variable to match what the script says in usage: Usage: ejabberdsql2prosody.lua filename.txt hostname

author	Anton Shestakov <av6@dwimlabs.net>
date	Fri, 12 Aug 2016 13:44:47 +0800
parent	7034:27f4d63f136a
child	8005:b472bccf8023

rev	line source
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	1 .\" Automatically generated by Pandoc 1.15.2
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	2 .\"
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	3 .hy
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	4 .TH "PROSODYCTL" "1" "2015\-12\-23" "" ""
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
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	7 prosodyctl \- Manage a Prosody XMPP server
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]
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	12 prosodyctl\ command\ [\-\-help]
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	13 \f[]
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.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	23 If a user named "prosody" is found then prosodyctl will change to that
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	24 user before executing its commands.
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
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	29 the usual form: user\@domain.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	30 .TP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	31 .B adduser jid
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.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	33 You will be prompted to enter the user\[aq]s password.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	34 .RS
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	35 .RE
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	36 .TP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	37 .B passwd jid
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	38 Changes the password of an existing user with Jabber ID, jid.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	39 You will be prompted to enter the user\[aq]s new password.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	40 .RS
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	41 .RE
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	42 .TP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	43 .B deluser jid
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	44 Deletes an existing user with Jabber ID, jid, from the server.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	45 .RS
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	46 .RE
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	47 .SS Daemon Management
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	48 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	49 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	50 recommended that you utilize your distributions daemon management
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	51 features if you attained Prosody through a package.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	52 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	53 To perform daemon control commands prosodyctl needs a pidfile value
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	54 specified in \f[C]/etc/prosody/prosody.cfg.lua\f[].
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	55 Failure to do so will cause prosodyctl to complain.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	56 .TP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	57 .B start
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	58 Starts the prosody server daemon.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	59 If run as root prosodyctl will attempt to change to a user named
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	60 "prosody" before executing.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	61 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	62 to execute.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	63 .RS
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	64 .RE
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	65 .TP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	66 .B stop
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	67 Stops the prosody server daemon.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	68 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	69 to stop executing.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	70 .RS
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	71 .RE
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	72 .TP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	73 .B restart
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	74 Restarts the prosody server daemon.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	75 Equivalent to running prosodyctl stop followed by prosodyctl start.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	76 .RS
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	77 .RE
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	78 .TP
7033 719f02848c99 man prosodyctl: Add missing 'reload' command Kim Alvefur <zash@zash.se> parents: 7032 diff changeset	79 .B reload
719f02848c99 man prosodyctl: Add missing 'reload' command Kim Alvefur <zash@zash.se> parents: 7032 diff changeset	80 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	81 files.
719f02848c99 man prosodyctl: Add missing 'reload' command Kim Alvefur <zash@zash.se> parents: 7032 diff changeset	82 .RS
719f02848c99 man prosodyctl: Add missing 'reload' command Kim Alvefur <zash@zash.se> parents: 7032 diff changeset	83 .RE
719f02848c99 man prosodyctl: Add missing 'reload' command Kim Alvefur <zash@zash.se> parents: 7032 diff changeset	84 .TP
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	85 .B status
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	86 Prints the current execution status of the prosody server daemon.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	87 .RS
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	88 .RE
7034 27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	89 .SS Debugging
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	90 .PP
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	91 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	92 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	93 .TP
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	94 .B about
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	95 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	96 dependencies.
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	97 .RS
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	98 .RE
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	99 .TP
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	100 .B check [what]
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	101 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	102 configured TLS certificates.
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	103 \f[C]what\f[] can be one of \f[C]config\f[], \f[C]dns\f[] and
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	104 \f[C]certs\f[] to run only that check.
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	105 .RS
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	106 .RE
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	107 .SS Ejabberd Compatibility
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	108 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	109 ejabberd is another XMPP server which provides a comparable control
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	110 tool, ejabberdctl, to control its server\[aq]s operations.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	111 prosodyctl implements some commands which are compatible with
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	112 ejabberdctl.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	113 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	114 .IP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	115 .nf
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	116 \f[C]
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	117 register\ user\ server\ password
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	118
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	119 unregister\ user\ server
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	120 \f[]
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	121 .fi
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	122 .SH OPTIONS
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	123 .TP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	124 .B \f[C]\-\-help\f[]
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	125 Display help text for the specified command.
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	126 .RS
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	127 .RE
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	128 .SH FILES
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	129 .TP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	130 .B \f[C]/etc/prosody/prosody.cfg.lua\f[]
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	131 The main prosody configuration file.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	132 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	133 server daemon and to determine if a host has been configured.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	134 .RS
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	135 .RE
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	136 .SH ONLINE
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	137 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	138 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	139 .SH AUTHORS
7033 719f02848c99 man prosodyctl: Add missing 'reload' command Kim Alvefur <zash@zash.se> parents: 7032 diff changeset	140 Dwayne Bent <dbb.1@liqd.org>; Kim Alvefur.

prosody

495de404a8ae

man/prosodyctl.man

Software / code / prosody

Annotate

man/prosodyctl.man @ 7567:495de404a8ae

Software `/` code `/` prosody