mirror of
https://github.com/bjc/prosody.git
synced 2025-04-03 05:07:42 +03:00
man prosodyctl: Accidentally markdown
This commit is contained in:
Kim Alvefur
parent
58430694cc
commit
e310e18a50
3 changed files with 212 additions and 68 deletions
4
man/Makefile
Normal file
4
man/Makefile
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
all: prosodyctl.man
|
||||||
|
|
||||||
|
%.man: %.markdown
|
||||||
|
pandoc -s -t man -o $@ $^
|
||||||
|
|
@ -1,83 +1,116 @@
|
||||||
.TH PROSODYCTL 1 "2009-07-02"
|
.\" Automatically generated by Pandoc 1.15.2
|
||||||
|
.\"
|
||||||
|
.hy
|
||||||
|
.TH "PROSODYCTL" "1" "2015\-12\-23" "" ""
|
||||||
.SH NAME
|
.SH NAME
|
||||||
|
.PP
|
||||||
prosodyctl \- Manage a Prosody XMPP server
|
prosodyctl \- Manage a Prosody XMPP server
|
||||||
|
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
\fBprosodyctl\fP \fIcommand\fP [\fI--help\fP]
|
.IP
|
||||||
|
.nf
|
||||||
|
\f[C]
|
||||||
|
prosodyctl\ command\ [\-\-help]
|
||||||
|
\f[]
|
||||||
|
.fi
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
\fBprosodyctl\fP is the control tool for the Prosody XMPP server. It may be
|
.PP
|
||||||
used to control the server daemon and manage users.
|
prosodyctl is the control tool for the Prosody XMPP server.
|
||||||
|
It may be used to control the server daemon and manage users.
|
||||||
\fBprosodyctl\fP needs to be executed with sufficient privileges to perform
|
.PP
|
||||||
its commands. This typically means executing \fBprosodyctl\fP as the root user.
|
prosodyctl needs to be executed with sufficient privileges to perform
|
||||||
If a user named "prosody" is found then \fBprosodyctl\fP will change to that
|
its commands.
|
||||||
|
This typically means executing prosodyctl as the root user.
|
||||||
|
If a user named "prosody" is found then prosodyctl will change to that
|
||||||
user before executing its commands.
|
user before executing its commands.
|
||||||
|
|
||||||
.SH COMMANDS
|
.SH COMMANDS
|
||||||
.SS User Management
|
.SS User Management
|
||||||
In the following commands users are identified by a Jabber ID, \fIjid\fP, of the
|
.PP
|
||||||
usual form: user@domain.
|
In the following commands users are identified by a Jabber ID, jid, of
|
||||||
|
the usual form: user\@domain.
|
||||||
.IP "\fBadduser\fP \fIjid\fP"
|
.TP
|
||||||
Adds a user with Jabber ID, \fIjid\fP, to the server. You will be
|
.B adduser jid
|
||||||
prompted to enter the user's password.
|
Adds a user with Jabber ID, jid, to the server.
|
||||||
|
You will be prompted to enter the user\[aq]s password.
|
||||||
.IP "\fBpasswd\fP \fIjid\fP"
|
.RS
|
||||||
Changes the password of an existing user with Jabber ID, \fIjid\fP. You will be
|
.RE
|
||||||
prompted to enter the user's new password.
|
.TP
|
||||||
|
.B passwd jid
|
||||||
.IP "\fBdeluser\fP \fIjid\fP"
|
Changes the password of an existing user with Jabber ID, jid.
|
||||||
Deletes an existing user with Jabber ID, \fIjid\fP, from the server.
|
You will be prompted to enter the user\[aq]s new password.
|
||||||
|
.RS
|
||||||
|
.RE
|
||||||
|
.TP
|
||||||
|
.B deluser jid
|
||||||
|
Deletes an existing user with Jabber ID, jid, from the server.
|
||||||
|
.RS
|
||||||
|
.RE
|
||||||
.SS Daemon Management
|
.SS Daemon Management
|
||||||
Although \fBprosodyctl\fP has commands to manage the \fBprosody\fP daemon it is
|
.PP
|
||||||
recommended that you utilize your distributions daemon management features if
|
Although prosodyctl has commands to manage the prosody daemon it is
|
||||||
you attained Prosody through a package.
|
recommended that you utilize your distributions daemon management
|
||||||
|
features if you attained Prosody through a package.
|
||||||
To perform daemon control commands \fBprosodyctl\fP needs a \fIpidfile\fP value
|
.PP
|
||||||
specified in \fI/etc/prosody/prosody.cfg.lua\fP. Failure to do so will cause
|
To perform daemon control commands prosodyctl needs a pidfile value
|
||||||
\fBprosodyctl\fP to complain.
|
specified in \f[C]/etc/prosody/prosody.cfg.lua\f[].
|
||||||
|
Failure to do so will cause prosodyctl to complain.
|
||||||
.IP \fBstart\fP
|
.TP
|
||||||
Starts the \fBprosody\fP server daemon. If run as root \fBprosodyctl\fP will
|
.B start
|
||||||
attempt to change to a user named "prosody" before executing. This operation
|
Starts the prosody server daemon.
|
||||||
will block for up to five seconds to wait for the server to execute.
|
If run as root prosodyctl will attempt to change to a user named
|
||||||
|
"prosody" before executing.
|
||||||
.IP \fBstop\fP
|
This operation will block for up to five seconds to wait for the server
|
||||||
Stops the \fBprosody\fP server daemon. This operation will block for up to five
|
to execute.
|
||||||
seconds to wait for the server to stop executing.
|
.RS
|
||||||
|
.RE
|
||||||
.IP \fBrestart\fP
|
.TP
|
||||||
Restarts the \fBprosody\fP server daemon. Equivalent to running \fBprosodyctl
|
.B stop
|
||||||
stop\fP followed by \fBprosodyctl start\fP.
|
Stops the prosody server daemon.
|
||||||
|
This operation will block for up to five seconds to wait for the server
|
||||||
.IP \fBstatus\fP
|
to stop executing.
|
||||||
Prints the current execution status of the \fBprosody\fP server daemon.
|
.RS
|
||||||
|
.RE
|
||||||
|
.TP
|
||||||
|
.B restart
|
||||||
|
Restarts the prosody server daemon.
|
||||||
|
Equivalent to running prosodyctl stop followed by prosodyctl start.
|
||||||
|
.RS
|
||||||
|
.RE
|
||||||
|
.TP
|
||||||
|
.B status
|
||||||
|
Prints the current execution status of the prosody server daemon.
|
||||||
|
.RS
|
||||||
|
.RE
|
||||||
.SS Ejabberd Compatibility
|
.SS Ejabberd Compatibility
|
||||||
\fBejabberd\fP is another XMPP server which provides a comparable control tool,
|
.PP
|
||||||
\fBejabberdctl\fP, to control its server's operations. \fBprosodyctl\fP
|
ejabberd is another XMPP server which provides a comparable control
|
||||||
implements some commands which are compatible with \fBejabberdctl\fP. For
|
tool, ejabberdctl, to control its server\[aq]s operations.
|
||||||
details of how these commands work you should see
|
prosodyctl implements some commands which are compatible with
|
||||||
.BR ejabberdctl (8).
|
ejabberdctl.
|
||||||
|
For details of how these commands work you should see ejabberdctl(8).
|
||||||
.IP "\fBregister\fP \fIuser server password\fP"
|
.IP
|
||||||
.IP "\fBunregister\fP \fIuser server\fP"
|
.nf
|
||||||
|
\f[C]
|
||||||
|
register\ user\ server\ password
|
||||||
|
|
||||||
|
unregister\ user\ server
|
||||||
|
\f[]
|
||||||
|
.fi
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.IP \fI--help\fP
|
.TP
|
||||||
|
.B \f[C]\-\-help\f[]
|
||||||
Display help text for the specified command.
|
Display help text for the specified command.
|
||||||
|
.RS
|
||||||
|
.RE
|
||||||
.SH FILES
|
.SH FILES
|
||||||
.IP \fI/etc/prosody/prosody.cfg.lua\fP
|
.TP
|
||||||
The main \fBprosody\fP configuration file. \fBprosodyctl\fP reads this to
|
.B \f[C]/etc/prosody/prosody.cfg.lua\f[]
|
||||||
determine the process ID file of the \fBprosody\fP server daemon and to
|
The main prosody configuration file.
|
||||||
determine if a host has been configured.
|
prosodyctl reads this to determine the process ID file of the prosody
|
||||||
|
server daemon and to determine if a host has been configured.
|
||||||
|
.RS
|
||||||
|
.RE
|
||||||
.SH ONLINE
|
.SH ONLINE
|
||||||
More information may be found online at: \fIhttp://prosody.im/\fP
|
.PP
|
||||||
|
More information may be found online at: <https://prosody.im/>
|
||||||
.SH AUTHORS
|
.SH AUTHORS
|
||||||
Dwayne Bent <dbb.1@liqd.org>
|
Dwayne Bent <dbb.1@liqd.org>.
|
||||||
|
|
|
||||||
107
man/prosodyctl.markdown
Normal file
107
man/prosodyctl.markdown
Normal file
|
|
@ -0,0 +1,107 @@
|
||||||
|
---
|
||||||
|
author:
|
||||||
|
- 'Dwayne Bent <dbb.1@liqd.org>'
|
||||||
|
date: '2015-12-23'
|
||||||
|
section: 1
|
||||||
|
title: PROSODYCTL
|
||||||
|
...
|
||||||
|
|
||||||
|
NAME
|
||||||
|
====
|
||||||
|
|
||||||
|
prosodyctl - Manage a Prosody XMPP server
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
========
|
||||||
|
|
||||||
|
prosodyctl command [--help]
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
===========
|
||||||
|
|
||||||
|
prosodyctl is the control tool for the Prosody XMPP server. It may be
|
||||||
|
used to control the server daemon and manage users.
|
||||||
|
|
||||||
|
prosodyctl needs to be executed with sufficient privileges to perform
|
||||||
|
its commands. This typically means executing prosodyctl as the root
|
||||||
|
user. If a user named "prosody" is found then prosodyctl will change to
|
||||||
|
that user before executing its commands.
|
||||||
|
|
||||||
|
COMMANDS
|
||||||
|
========
|
||||||
|
|
||||||
|
User Management
|
||||||
|
---------------
|
||||||
|
|
||||||
|
In the following commands users are identified by a Jabber ID, jid, of
|
||||||
|
the usual form: user@domain.
|
||||||
|
|
||||||
|
adduser jid
|
||||||
|
: Adds a user with Jabber ID, jid, to the server. You will be prompted
|
||||||
|
to enter the user's password.
|
||||||
|
|
||||||
|
passwd jid
|
||||||
|
: Changes the password of an existing user with Jabber ID, jid. You
|
||||||
|
will be prompted to enter the user's new password.
|
||||||
|
|
||||||
|
deluser jid
|
||||||
|
: Deletes an existing user with Jabber ID, jid, from the server.
|
||||||
|
|
||||||
|
Daemon Management
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Although prosodyctl has commands to manage the prosody daemon it is
|
||||||
|
recommended that you utilize your distributions daemon management
|
||||||
|
features if you attained Prosody through a package.
|
||||||
|
|
||||||
|
To perform daemon control commands prosodyctl needs a pidfile value
|
||||||
|
specified in `/etc/prosody/prosody.cfg.lua`. Failure to do so will cause
|
||||||
|
prosodyctl to complain.
|
||||||
|
|
||||||
|
start
|
||||||
|
: Starts the prosody server daemon. If run as root prosodyctl will
|
||||||
|
attempt to change to a user named "prosody" before executing. This
|
||||||
|
operation will block for up to five seconds to wait for the server
|
||||||
|
to execute.
|
||||||
|
|
||||||
|
stop
|
||||||
|
: Stops the prosody server daemon. This operation will block for up to
|
||||||
|
five seconds to wait for the server to stop executing.
|
||||||
|
|
||||||
|
restart
|
||||||
|
: Restarts the prosody server daemon. Equivalent to running prosodyctl
|
||||||
|
stop followed by prosodyctl start.
|
||||||
|
|
||||||
|
status
|
||||||
|
: Prints the current execution status of the prosody server daemon.
|
||||||
|
|
||||||
|
Ejabberd Compatibility
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
ejabberd is another XMPP server which provides a comparable control
|
||||||
|
tool, ejabberdctl, to control its server's operations. prosodyctl
|
||||||
|
implements some commands which are compatible with ejabberdctl. For
|
||||||
|
details of how these commands work you should see ejabberdctl(8).
|
||||||
|
|
||||||
|
register user server password
|
||||||
|
|
||||||
|
unregister user server
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
=======
|
||||||
|
|
||||||
|
`--help`
|
||||||
|
: Display help text for the specified command.
|
||||||
|
|
||||||
|
FILES
|
||||||
|
=====
|
||||||
|
|
||||||
|
`/etc/prosody/prosody.cfg.lua`
|
||||||
|
: The main prosody configuration file. prosodyctl reads this to
|
||||||
|
determine the process ID file of the prosody server daemon and to
|
||||||
|
determine if a host has been configured.
|
||||||
|
|
||||||
|
ONLINE
|
||||||
|
======
|
||||||
|
|
||||||
|
More information may be found online at: <https://prosody.im/>
|
||||||
Loading…
Add table
Add a link
Reference in a new issue