Software `/` code `/` prosody

Annotate

man/prosodyctl.man @ 10067:598befab492e

mod_admin_telnet: Check for simple commands before executing in sandbox This makes fixing yield over pcall boundry issue easier since it would have jumped to the thread error handler instead of proceeding to checking for simple commands.

author	Kim Alvefur <zash@zash.se>
date	Fri, 10 May 2019 01:28:09 +0200
parent	8365:8e079677d724
child	12242:202319a990e7

rev	line source
8005 b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	1 .\" Automatically generated by Pandoc 1.19.2.1
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	2 .\"
8204 7343ffbc65ea man prosodyctl: Add text about the `cert import` command Kim Alvefur <zash@zash.se> parents: 8171 diff changeset	3 .TH "PROSODYCTL" "1" "2017\-09\-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
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
8005 b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	89 .SS Certificates
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	90 .PP
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	91 prosodyctl can create self\-signed certificates, certificate requests
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	92 and private keys for use with Prosody.
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	93 Commands are of the form \f[C]prosodyctl\ cert\ subcommand\f[].
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	94 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	95 .TP
8365 8e079677d724 man prosodyctl: Highlight subcommands Kim Alvefur <zash@zash.se> parents: 8204 diff changeset	96 .B \f[C]request\ hosts\f[]
8005 b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	97 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	98 authority.
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	99 Multiple hosts can be given, sub\-domains are automatically included.
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	100 .RS
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	101 .RE
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	102 .TP
8365 8e079677d724 man prosodyctl: Highlight subcommands Kim Alvefur <zash@zash.se> parents: 8204 diff changeset	103 .B \f[C]generate\ hosts\f[]
8005 b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	104 Generate a self\-signed certificate.
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	105 .RS
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	106 .RE
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	107 .TP
8365 8e079677d724 man prosodyctl: Highlight subcommands Kim Alvefur <zash@zash.se> parents: 8204 diff changeset	108 .B \f[C]key\ host\ [size]\f[]
8005 b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	109 Generate a private key of \[aq]size\[aq] bits (defaults to 2048).
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	110 Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	111 needed.
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	112 .RS
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	113 .RE
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	114 .TP
8365 8e079677d724 man prosodyctl: Highlight subcommands Kim Alvefur <zash@zash.se> parents: 8204 diff changeset	115 .B \f[C]config\ hosts\f[]
8005 b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	116 Produce a config file for the list of hosts.
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	117 Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	118 needed.
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	119 .RS
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	120 .RE
8204 7343ffbc65ea man prosodyctl: Add text about the `cert import` command Kim Alvefur <zash@zash.se> parents: 8171 diff changeset	121 .TP
8365 8e079677d724 man prosodyctl: Highlight subcommands Kim Alvefur <zash@zash.se> parents: 8204 diff changeset	122 .B \f[C]import\ hosts\ paths\f[]
8204 7343ffbc65ea man prosodyctl: Add text about the `cert import` command Kim Alvefur <zash@zash.se> parents: 8171 diff changeset	123 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	124 prosody.
7343ffbc65ea man prosodyctl: Add text about the `cert import` command Kim Alvefur <zash@zash.se> parents: 8171 diff changeset	125 .RS
7343ffbc65ea man prosodyctl: Add text about the `cert import` command Kim Alvefur <zash@zash.se> parents: 8171 diff changeset	126 .RE
7034 27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	127 .SS Debugging
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	128 .PP
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	129 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	130 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	131 .TP
8365 8e079677d724 man prosodyctl: Highlight subcommands Kim Alvefur <zash@zash.se> parents: 8204 diff changeset	132 .B \f[C]about\f[]
7034 27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	133 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	134 dependencies.
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	135 .RS
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	136 .RE
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	137 .TP
8365 8e079677d724 man prosodyctl: Highlight subcommands Kim Alvefur <zash@zash.se> parents: 8204 diff changeset	138 .B \f[C]check\ [what]\f[]
7034 27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	139 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	140 configured TLS certificates.
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	141 \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	142 \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	143 .RS
27f4d63f136a man prosodyctl: Add information about the 'about' and 'check' commands Kim Alvefur <zash@zash.se> parents: 7033 diff changeset	144 .RE
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	145 .SS Ejabberd Compatibility
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	146 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	147 ejabberd is another XMPP server which provides a comparable control
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	148 tool, ejabberdctl, to control its server\[aq]s operations.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	149 prosodyctl implements some commands which are compatible with
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	150 ejabberdctl.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	151 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	152 .IP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	153 .nf
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	154 \f[C]
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	155 register\ user\ server\ password
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	156
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	157 unregister\ user\ server
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	158 \f[]
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	159 .fi
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	160 .SH OPTIONS
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	161 .TP
8005 b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	162 .B \f[C]\-\-config\ filename\f[]
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	163 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	164 .RS
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	165 .RE
b472bccf8023 man prosodyctl: Rebuild from Markdown source Kim Alvefur <zash@zash.se> parents: 7034 diff changeset	166 .TP
8171 746d73347937 man prosodyctl: Mention the --root flag Kim Alvefur <zash@zash.se> parents: 8005 diff changeset	167 .B \f[C]\-\-root\f[]
746d73347937 man prosodyctl: Mention the --root flag Kim Alvefur <zash@zash.se> parents: 8005 diff changeset	168 Don\[aq]t drop root privileges.
746d73347937 man prosodyctl: Mention the --root flag Kim Alvefur <zash@zash.se> parents: 8005 diff changeset	169 .RS
746d73347937 man prosodyctl: Mention the --root flag Kim Alvefur <zash@zash.se> parents: 8005 diff changeset	170 .RE
746d73347937 man prosodyctl: Mention the --root flag Kim Alvefur <zash@zash.se> parents: 8005 diff changeset	171 .TP
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	172 .B \f[C]\-\-help\f[]
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	173 Display help text for the specified command.
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	174 .RS
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	175 .RE
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	176 .SH FILES
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	177 .TP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	178 .B \f[C]/etc/prosody/prosody.cfg.lua\f[]
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	179 The main prosody configuration file.
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	180 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	181 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	182 .RS
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	183 .RE
1464 047ed6e52a41 Added man page for prosodyctl Dwayne Bent <dbb.0@liqd.org> parents: diff changeset	184 .SH ONLINE
7032 817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	185 .PP
817c7b197ac7 man prosodyctl: Accidentally markdown Kim Alvefur <zash@zash.se> parents: 2699 diff changeset	186 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	187 .SH AUTHORS
7033 719f02848c99 man prosodyctl: Add missing 'reload' command Kim Alvefur <zash@zash.se> parents: 7032 diff changeset	188 Dwayne Bent <dbb.1@liqd.org>; Kim Alvefur.

prosody

598befab492e

man/prosodyctl.man

Software / code / prosody

Annotate

man/prosodyctl.man @ 10067:598befab492e

Software `/` code `/` prosody