mirror of
https://github.com/bjc/prosody.git
synced 2025-04-03 05:07:42 +03:00
man/prosodyctl: Normalize formatting syntax
Filtered trough pandoc
This commit is contained in:
Kim Alvefur
parent
da53d0fc75
commit
7f2e4b6313
2 changed files with 60 additions and 112 deletions
|
|
@ -1,16 +1,16 @@
|
|||
.\" Automatically generated by Pandoc 1.19.2.1
|
||||
.\" Automatically generated by Pandoc 2.17.0.1
|
||||
.\"
|
||||
.TH "PROSODYCTL" "1" "2017\-09\-02" "" ""
|
||||
.TH "PROSODYCTL" "1" "2017-09-02" "" ""
|
||||
.hy
|
||||
.SH NAME
|
||||
.PP
|
||||
prosodyctl \- Manage a Prosody XMPP server
|
||||
prosodyctl - Manage a Prosody XMPP server
|
||||
.SH SYNOPSIS
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
prosodyctl\ command\ [\-\-help]
|
||||
\f[]
|
||||
prosodyctl command [--help]
|
||||
\f[R]
|
||||
.fi
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
|
|
@ -20,30 +20,24 @@ 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.
|
||||
If a user named \[lq]prosody\[rq] is found then prosodyctl will change
|
||||
to that user before executing its commands.
|
||||
.SH COMMANDS
|
||||
.SS User Management
|
||||
.PP
|
||||
In the following commands users are identified by a Jabber ID, jid, of
|
||||
the usual form: user\@domain.
|
||||
the usual form: user\[at]domain.
|
||||
.TP
|
||||
.B adduser jid
|
||||
adduser jid
|
||||
Adds a user with Jabber ID, jid, to the server.
|
||||
You will be prompted to enter the user\[aq]s password.
|
||||
.RS
|
||||
.RE
|
||||
You will be prompted to enter the user\[cq]s password.
|
||||
.TP
|
||||
.B passwd jid
|
||||
passwd jid
|
||||
Changes the password of an existing user with Jabber ID, jid.
|
||||
You will be prompted to enter the user\[aq]s new password.
|
||||
.RS
|
||||
.RE
|
||||
You will be prompted to enter the user\[cq]s new password.
|
||||
.TP
|
||||
.B deluser jid
|
||||
deluser jid
|
||||
Deletes an existing user with Jabber ID, jid, from the server.
|
||||
.RS
|
||||
.RE
|
||||
.SS Daemon Management
|
||||
.PP
|
||||
Although prosodyctl has commands to manage the prosody daemon it is
|
||||
|
|
@ -51,136 +45,102 @@ recommended that you utilize your distributions daemon management
|
|||
features if you attained Prosody through a package.
|
||||
.PP
|
||||
To perform daemon control commands prosodyctl needs a pidfile value
|
||||
specified in \f[C]/etc/prosody/prosody.cfg.lua\f[].
|
||||
specified in \f[C]/etc/prosody/prosody.cfg.lua\f[R].
|
||||
Failure to do so will cause prosodyctl to complain.
|
||||
.TP
|
||||
.B start
|
||||
start
|
||||
Starts the prosody server daemon.
|
||||
If run as root prosodyctl will attempt to change to a user named
|
||||
"prosody" before executing.
|
||||
\[lq]prosody\[rq] before executing.
|
||||
This operation will block for up to five seconds to wait for the server
|
||||
to execute.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B stop
|
||||
stop
|
||||
Stops the prosody server daemon.
|
||||
This operation will block for up to five seconds to wait for the server
|
||||
to stop executing.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B restart
|
||||
restart
|
||||
Restarts the prosody server daemon.
|
||||
Equivalent to running prosodyctl stop followed by prosodyctl start.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B reload
|
||||
reload
|
||||
Signals the prosody server daemon to reload configuration and reopen log
|
||||
files.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B status
|
||||
status
|
||||
Prints the current execution status of the prosody server daemon.
|
||||
.RS
|
||||
.RE
|
||||
.SS Certificates
|
||||
.PP
|
||||
prosodyctl can create self\-signed certificates, certificate requests
|
||||
and private keys for use with Prosody.
|
||||
Commands are of the form \f[C]prosodyctl\ cert\ subcommand\f[].
|
||||
prosodyctl can create self-signed certificates, certificate requests and
|
||||
private keys for use with Prosody.
|
||||
Commands are of the form \f[C]prosodyctl cert subcommand\f[R].
|
||||
Commands take a list of hosts to be included in the certificate.
|
||||
.TP
|
||||
.B \f[C]request\ hosts\f[]
|
||||
\f[B]\f[CB]request hosts\f[B]\f[R]
|
||||
Create a certificate request (CSR) file for submission to a certificate
|
||||
authority.
|
||||
Multiple hosts can be given, sub\-domains are automatically included.
|
||||
.RS
|
||||
.RE
|
||||
Multiple hosts can be given, sub-domains are automatically included.
|
||||
.TP
|
||||
.B \f[C]generate\ hosts\f[]
|
||||
Generate a self\-signed certificate.
|
||||
.RS
|
||||
.RE
|
||||
\f[B]\f[CB]generate hosts\f[B]\f[R]
|
||||
Generate a self-signed certificate.
|
||||
.TP
|
||||
.B \f[C]key\ host\ [size]\f[]
|
||||
Generate a private key of \[aq]size\[aq] bits (defaults to 2048).
|
||||
Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if
|
||||
needed.
|
||||
.RS
|
||||
.RE
|
||||
\f[B]\f[CB]key host [size]\f[B]\f[R]
|
||||
Generate a private key of `size' bits (defaults to 2048).
|
||||
Invoked automatically by `request' and `generate' if needed.
|
||||
.TP
|
||||
.B \f[C]config\ hosts\f[]
|
||||
\f[B]\f[CB]config hosts\f[B]\f[R]
|
||||
Produce a config file for the list of hosts.
|
||||
Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if
|
||||
needed.
|
||||
.RS
|
||||
.RE
|
||||
Invoked automatically by `request' and `generate' if needed.
|
||||
.TP
|
||||
.B \f[C]import\ hosts\ paths\f[]
|
||||
\f[B]\f[CB]import hosts paths\f[B]\f[R]
|
||||
Copy certificates for hosts into the certificate path and reload
|
||||
prosody.
|
||||
.RS
|
||||
.RE
|
||||
.SS Debugging
|
||||
.PP
|
||||
prosodyctl can also show some information about the environment,
|
||||
dependencies and such to aid in debugging.
|
||||
.TP
|
||||
.B \f[C]about\f[]
|
||||
\f[B]\f[CB]about\f[B]\f[R]
|
||||
Shows environment, various paths used by Prosody and installed
|
||||
dependencies.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[C]check\ [what]\f[]
|
||||
\f[B]\f[CB]check [what]\f[B]\f[R]
|
||||
Performs various sanity checks on the configuration, DNS setup and
|
||||
configured TLS certificates.
|
||||
\f[C]what\f[] can be one of \f[C]config\f[], \f[C]dns\f[] and
|
||||
\f[C]certs\f[] to run only that check.
|
||||
.RS
|
||||
.RE
|
||||
\f[C]what\f[R] can be one of \f[C]config\f[R], \f[C]dns\f[R] and
|
||||
\f[C]certs\f[R] to run only that check.
|
||||
.SS Ejabberd Compatibility
|
||||
.PP
|
||||
ejabberd is another XMPP server which provides a comparable control
|
||||
tool, ejabberdctl, to control its server\[aq]s operations.
|
||||
tool, ejabberdctl, to control its server\[cq]s operations.
|
||||
prosodyctl implements some commands which are compatible with
|
||||
ejabberdctl.
|
||||
For details of how these commands work you should see ejabberdctl(8).
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
register\ user\ server\ password
|
||||
register user server password
|
||||
|
||||
unregister\ user\ server
|
||||
\f[]
|
||||
unregister user server
|
||||
\f[R]
|
||||
.fi
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B \f[C]\-\-config\ filename\f[]
|
||||
\f[B]\f[CB]--config filename\f[B]\f[R]
|
||||
Use the specified config file instead of the default.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[C]\-\-root\f[]
|
||||
Don\[aq]t drop root privileges.
|
||||
.RS
|
||||
.RE
|
||||
\f[B]\f[CB]--root\f[B]\f[R]
|
||||
Don\[cq]t drop root privileges.
|
||||
.TP
|
||||
.B \f[C]\-\-help\f[]
|
||||
\f[B]\f[CB]--help\f[B]\f[R]
|
||||
Display help text for the specified command.
|
||||
.RS
|
||||
.RE
|
||||
.SH FILES
|
||||
.TP
|
||||
.B \f[C]/etc/prosody/prosody.cfg.lua\f[]
|
||||
\f[B]\f[CB]/etc/prosody/prosody.cfg.lua\f[B]\f[R]
|
||||
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.
|
||||
.RS
|
||||
.RE
|
||||
.SH ONLINE
|
||||
.PP
|
||||
More information may be found online at: <https://prosody.im/>
|
||||
|
|
|
|||
|
|
@ -1,24 +1,21 @@
|
|||
---
|
||||
author:
|
||||
- 'Dwayne Bent <dbb.1@liqd.org>'
|
||||
- Dwayne Bent <dbb.1@liqd.org>
|
||||
- Kim Alvefur
|
||||
date: '2017-09-02'
|
||||
date: 2017-09-02
|
||||
section: 1
|
||||
title: PROSODYCTL
|
||||
---
|
||||
|
||||
NAME
|
||||
====
|
||||
# NAME
|
||||
|
||||
prosodyctl - Manage a Prosody XMPP server
|
||||
|
||||
SYNOPSIS
|
||||
========
|
||||
# SYNOPSIS
|
||||
|
||||
prosodyctl command [--help]
|
||||
|
||||
DESCRIPTION
|
||||
===========
|
||||
# DESCRIPTION
|
||||
|
||||
prosodyctl is the control tool for the Prosody XMPP server. It may be
|
||||
used to control the server daemon and manage users.
|
||||
|
|
@ -28,11 +25,9 @@ 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
|
||||
========
|
||||
# COMMANDS
|
||||
|
||||
User Management
|
||||
---------------
|
||||
## User Management
|
||||
|
||||
In the following commands users are identified by a Jabber ID, jid, of
|
||||
the usual form: user@domain.
|
||||
|
|
@ -48,8 +43,7 @@ passwd jid
|
|||
deluser jid
|
||||
: Deletes an existing user with Jabber ID, jid, from the server.
|
||||
|
||||
Daemon Management
|
||||
-----------------
|
||||
## Daemon Management
|
||||
|
||||
Although prosodyctl has commands to manage the prosody daemon it is
|
||||
recommended that you utilize your distributions daemon management
|
||||
|
|
@ -80,8 +74,7 @@ reload
|
|||
status
|
||||
: Prints the current execution status of the prosody server daemon.
|
||||
|
||||
Certificates
|
||||
------------
|
||||
## Certificates
|
||||
|
||||
prosodyctl can create self-signed certificates, certificate requests and
|
||||
private keys for use with Prosody. Commands are of the form
|
||||
|
|
@ -108,8 +101,7 @@ included in the certificate.
|
|||
: Copy certificates for hosts into the certificate path and reload
|
||||
prosody.
|
||||
|
||||
Debugging
|
||||
---------
|
||||
## Debugging
|
||||
|
||||
prosodyctl can also show some information about the environment,
|
||||
dependencies and such to aid in debugging.
|
||||
|
|
@ -123,8 +115,7 @@ dependencies and such to aid in debugging.
|
|||
configured TLS certificates. `what` can be one of `config`, `dns`
|
||||
and `certs` to run only that check.
|
||||
|
||||
Ejabberd Compatibility
|
||||
----------------------
|
||||
## Ejabberd Compatibility
|
||||
|
||||
ejabberd is another XMPP server which provides a comparable control
|
||||
tool, ejabberdctl, to control its server's operations. prosodyctl
|
||||
|
|
@ -135,8 +126,7 @@ details of how these commands work you should see ejabberdctl(8).
|
|||
|
||||
unregister user server
|
||||
|
||||
OPTIONS
|
||||
=======
|
||||
# OPTIONS
|
||||
|
||||
`--config filename`
|
||||
: Use the specified config file instead of the default.
|
||||
|
|
@ -147,15 +137,13 @@ OPTIONS
|
|||
`--help`
|
||||
: Display help text for the specified command.
|
||||
|
||||
FILES
|
||||
=====
|
||||
# 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
|
||||
======
|
||||
# ONLINE
|
||||
|
||||
More information may be found online at: <https://prosody.im/>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue