mirrors/prosody
1
0
Fork 0
mirror of https://github.com/bjc/prosody.git synced 2025-04-03 21:27:38 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

man/prosodyctl: Normalize formatting syntax

Browse source 
Filtered trough pandoc
This commit is contained in:
Kim Alvefur 2022-02-02 18:30:54 +01:00
parent da53d0fc75
commit 7f2e4b6313
2 changed files with 60 additions and 112 deletions
Download patch file Download diff file Expand all files Collapse all files

132
man/prosodyctl.man
View file

@ -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 .hy
.SH NAME .SH NAME
.PP .PP
prosodyctl \- Manage a Prosody XMPP server prosodyctl - Manage a Prosody XMPP server
.SH SYNOPSIS .SH SYNOPSIS
.IP .IP
.nf .nf
\f[C] \f[C]
prosodyctl\ command\ [\-\-help] prosodyctl command [--help]
\f[] \f[R]
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.PP .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 prosodyctl needs to be executed with sufficient privileges to perform
its commands. its commands.
This typically means executing prosodyctl as the root user. This typically means executing prosodyctl as the root user.
If a user named "prosody" is found then prosodyctl will change to that If a user named \[lq]prosody\[rq] is found then prosodyctl will change
user before executing its commands. to that user before executing its commands.
.SH COMMANDS .SH COMMANDS
.SS User Management .SS User Management
.PP .PP
In the following commands users are identified by a Jabber ID, jid, of 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 .TP
.B adduser jid adduser jid
Adds a user with Jabber ID, jid, to the server. Adds a user with Jabber ID, jid, to the server.
You will be prompted to enter the user\[aq]s password. You will be prompted to enter the user\[cq]s password.
.RS
.RE
.TP .TP
.B passwd jid passwd jid
Changes the password of an existing user with Jabber ID, jid. Changes the password of an existing user with Jabber ID, jid.
You will be prompted to enter the user\[aq]s new password. You will be prompted to enter the user\[cq]s new password.
.RS
.RE
.TP .TP
.B deluser jid deluser jid
Deletes an existing user with Jabber ID, jid, from the server. Deletes an existing user with Jabber ID, jid, from the server.
.RS
.RE
.SS Daemon Management .SS Daemon Management
.PP .PP
Although prosodyctl has commands to manage the prosody daemon it is 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. features if you attained Prosody through a package.
.PP .PP
To perform daemon control commands prosodyctl needs a pidfile value 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. Failure to do so will cause prosodyctl to complain.
.TP .TP
.B start start
Starts the prosody server daemon. Starts the prosody server daemon.
If run as root prosodyctl will attempt to change to a user named 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 This operation will block for up to five seconds to wait for the server
to execute. to execute.
.RS
.RE
.TP .TP
.B stop stop
Stops the prosody server daemon. Stops the prosody server daemon.
This operation will block for up to five seconds to wait for the server This operation will block for up to five seconds to wait for the server
to stop executing. to stop executing.
.RS
.RE
.TP .TP
.B restart restart
Restarts the prosody server daemon. Restarts the prosody server daemon.
Equivalent to running prosodyctl stop followed by prosodyctl start. Equivalent to running prosodyctl stop followed by prosodyctl start.
.RS
.RE
.TP .TP
.B reload reload
Signals the prosody server daemon to reload configuration and reopen log Signals the prosody server daemon to reload configuration and reopen log
files. files.
.RS
.RE
.TP .TP
.B status status
Prints the current execution status of the prosody server daemon. Prints the current execution status of the prosody server daemon.
.RS
.RE
.SS Certificates .SS Certificates
.PP .PP
prosodyctl can create self\-signed certificates, certificate requests prosodyctl can create self-signed certificates, certificate requests and
and private keys for use with Prosody. private keys for use with Prosody.
Commands are of the form \f[C]prosodyctl\ cert\ subcommand\f[]. Commands are of the form \f[C]prosodyctl cert subcommand\f[R].
Commands take a list of hosts to be included in the certificate. Commands take a list of hosts to be included in the certificate.
.TP .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 Create a certificate request (CSR) file for submission to a certificate
authority. authority.
Multiple hosts can be given, sub\-domains are automatically included. Multiple hosts can be given, sub-domains are automatically included.
.RS
.RE
.TP .TP
.B \f[C]generate\ hosts\f[] \f[B]\f[CB]generate hosts\f[B]\f[R]
Generate a self\-signed certificate. Generate a self-signed certificate.
.RS
.RE
.TP .TP
.B \f[C]key\ host\ [size]\f[] \f[B]\f[CB]key host [size]\f[B]\f[R]
Generate a private key of \[aq]size\[aq] bits (defaults to 2048). Generate a private key of `size' bits (defaults to 2048).
Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if Invoked automatically by `request' and `generate' if needed.
needed.
.RS
.RE
.TP .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. Produce a config file for the list of hosts.
Invoked automatically by \[aq]request\[aq] and \[aq]generate\[aq] if Invoked automatically by `request' and `generate' if needed.
needed.
.RS
.RE
.TP .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 Copy certificates for hosts into the certificate path and reload
prosody. prosody.
.RS
.RE
.SS Debugging .SS Debugging
.PP .PP
prosodyctl can also show some information about the environment, prosodyctl can also show some information about the environment,
dependencies and such to aid in debugging. dependencies and such to aid in debugging.
.TP .TP
.B \f[C]about\f[] \f[B]\f[CB]about\f[B]\f[R]
Shows environment, various paths used by Prosody and installed Shows environment, various paths used by Prosody and installed
dependencies. dependencies.
.RS
.RE
.TP .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 Performs various sanity checks on the configuration, DNS setup and
configured TLS certificates. configured TLS certificates.
\f[C]what\f[] can be one of \f[C]config\f[], \f[C]dns\f[] and \f[C]what\f[R] can be one of \f[C]config\f[R], \f[C]dns\f[R] and
\f[C]certs\f[] to run only that check. \f[C]certs\f[R] to run only that check.
.RS
.RE
.SS Ejabberd Compatibility .SS Ejabberd Compatibility
.PP .PP
ejabberd is another XMPP server which provides a comparable control 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 prosodyctl implements some commands which are compatible with
ejabberdctl. ejabberdctl.
For details of how these commands work you should see ejabberdctl(8). For details of how these commands work you should see ejabberdctl(8).
.IP .IP
.nf .nf
\f[C] \f[C]
register\ user\ server\ password register user server password
unregister\ user\ server unregister user server
\f[] \f[R]
.fi .fi
.SH OPTIONS .SH OPTIONS
.TP .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. Use the specified config file instead of the default.
.RS
.RE
.TP .TP
.B \f[C]\-\-root\f[] \f[B]\f[CB]--root\f[B]\f[R]
Don\[aq]t drop root privileges. Don\[cq]t drop root privileges.
.RS
.RE
.TP .TP
.B \f[C]\-\-help\f[] \f[B]\f[CB]--help\f[B]\f[R]
Display help text for the specified command. Display help text for the specified command.
.RS
.RE
.SH FILES .SH FILES
.TP .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. The main prosody configuration file.
prosodyctl reads this to determine the process ID file of the prosody prosodyctl reads this to determine the process ID file of the prosody
server daemon and to determine if a host has been configured. server daemon and to determine if a host has been configured.
.RS
.RE
.SH ONLINE .SH ONLINE
.PP .PP
More information may be found online at: <https://prosody.im/> More information may be found online at: <https://prosody.im/>

40
man/prosodyctl.markdown
View file

@ -1,24 +1,21 @@
--- ---
author: author:
- 'Dwayne Bent <dbb.1@liqd.org>' - Dwayne Bent <dbb.1@liqd.org>
- Kim Alvefur - Kim Alvefur
date: '2017-09-02' date: 2017-09-02
section: 1 section: 1
title: PROSODYCTL title: PROSODYCTL
--- ---
NAME # NAME
====
prosodyctl - Manage a Prosody XMPP server prosodyctl - Manage a Prosody XMPP server
SYNOPSIS # SYNOPSIS
========
prosodyctl command [--help] prosodyctl command [--help]
DESCRIPTION # DESCRIPTION
===========
prosodyctl is the control tool for the Prosody XMPP server. It may be prosodyctl is the control tool for the Prosody XMPP server. It may be
used to control the server daemon and manage users. 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 user. If a user named "prosody" is found then prosodyctl will change to
that user before executing its commands. 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 In the following commands users are identified by a Jabber ID, jid, of
the usual form: user@domain. the usual form: user@domain.
@ -48,8 +43,7 @@ passwd jid
deluser jid deluser jid
: Deletes an existing user with Jabber ID, jid, from the server. : 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 Although prosodyctl has commands to manage the prosody daemon it is
recommended that you utilize your distributions daemon management recommended that you utilize your distributions daemon management
@ -80,8 +74,7 @@ reload
status status
: Prints the current execution status of the prosody server daemon. : Prints the current execution status of the prosody server daemon.
Certificates ## Certificates
------------
prosodyctl can create self-signed certificates, certificate requests and prosodyctl can create self-signed certificates, certificate requests and
private keys for use with Prosody. Commands are of the form 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 : Copy certificates for hosts into the certificate path and reload
prosody. prosody.
Debugging ## Debugging
---------
prosodyctl can also show some information about the environment, prosodyctl can also show some information about the environment,
dependencies and such to aid in debugging. 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` configured TLS certificates. `what` can be one of `config`, `dns`
and `certs` to run only that check. and `certs` to run only that check.
Ejabberd Compatibility ## Ejabberd Compatibility
----------------------
ejabberd is another XMPP server which provides a comparable control ejabberd is another XMPP server which provides a comparable control
tool, ejabberdctl, to control its server's operations. prosodyctl 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 unregister user server
OPTIONS # OPTIONS
=======
`--config filename` `--config filename`
: Use the specified config file instead of the default. : Use the specified config file instead of the default.
@ -147,15 +137,13 @@ OPTIONS
`--help` `--help`
: Display help text for the specified command. : Display help text for the specified command.
FILES # FILES
=====
`/etc/prosody/prosody.cfg.lua` `/etc/prosody/prosody.cfg.lua`
: The main prosody configuration file. prosodyctl reads this to : The main prosody configuration file. prosodyctl reads this to
determine the process ID file of the prosody server daemon and to determine the process ID file of the prosody server daemon and to
determine if a host has been configured. determine if a host has been configured.
ONLINE # ONLINE
======
More information may be found online at: <https://prosody.im/> More information may be found online at: <https://prosody.im/>