root
/
rabbitmq-server
mirror of https://github.com/rabbitmq/rabbitmq-server.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
rabbitmq-server/deps/rabbit/docs/rabbitmq-server.8

99 lines
3.5 KiB
Groff
Raw Normal View History

docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.\" vim:ft=nroff:
Introduce a new CLI tool (scope), rabbitmq-tanzu For Tanzu (commercial) plugins to attach their commands to instead of polluting rabbitmqctl. Pair: @pjk25 (cherry picked from commit 6e0f2436faf86c0233af8b75125f9754a33fec77)
2021-11-30 22:43:42 +08:00
.\" This Source Code Form is subject to the terms of the Mozilla Public
Switch to Mozilla Public License 2.0 (MPL 2.0)
2020-07-10 21:31:17 +08:00
.\" License, v. 2.0. If a copy of the MPL was not distributed with this
.\" file, You can obtain one at https://mozilla.org/MPL/2.0/.
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.\"
Bump (c) year
2022-03-21 05:21:56 +08:00
.\" Copyright (c) 2007-2022 VMware, Inc. or its affiliates. All rights reserved.
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.\"
man pages: bump revision dates
2019-09-28 16:05:25 +08:00
.Dd September 28, 2019
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.Dt RABBITMQ-SERVER 8
.Os "RabbitMQ Server"
.Sh NAME
.Nm rabbitmq-server
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
.Nd starts a RabbitMQ node
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.\" ------------------------------------------------------------------
.Sh SYNOPSIS
.\" ------------------------------------------------------------------
.Nm
.Op Fl detached
.\" ------------------------------------------------------------------
.Sh DESCRIPTION
.\" ------------------------------------------------------------------
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
RabbitMQ is an open source multi-protocol messaging broker.
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.Pp
Running
.Nm
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
starts a RabbitMQ node in the foreground. The node will display a startup
banner and report when startup is complete.
To shut down the server, use service management tools or
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.Xr rabbitmqctl 8 .
.\" ------------------------------------------------------------------
.Sh ENVIRONMENT
.\" ------------------------------------------------------------------
.Bl -tag -width Ds
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
.It Ev RABBITMQ_CONFIG_FILE
rabbitmq-diagnostics(8) WIP
2019-02-01 21:19:28 +08:00
Defaults to
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
.Pa /etc/rabbitmq/rabbitmq.conf .
Node configuration file path.
To learn more, see the
.Lk https://www.rabbitmq.com/configure.html "RabbitMQ Configuration guide"
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.It Ev RABBITMQ_MNESIA_BASE
Defaults to
.Pa /var/lib/rabbitmq/mnesia .
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
Node data directory will be located (or created) in this directory.
To learn more, see the
.Lk https://www.rabbitmq.com/relocate.html "RabbitMQ File and Directory guide"
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.It Ev RABBITMQ_LOG_BASE
Defaults to
.Pa /var/log/rabbitmq .
Log files generated by the server will be placed in this directory.
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
To learn more, see the
.Lk https://www.rabbitmq.com/logging.html "RabbitMQ Logging guide"
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.It Ev RABBITMQ_NODENAME
Defaults to
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
.Qq rabbit@ .
followed by the computed hostname.
Can be used to run multiple nodes on the same host.
Every node in a cluster must have a unique
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.Ev RABBITMQ_NODENAME
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
To learn more, see the
.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide"
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.It Ev RABBITMQ_NODE_IP_ADDRESS
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
By default RabbitMQ will bind to all IPv6 and IPv4 interfaces available.
This variable limits the node to one network interface or address
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
family.
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
To learn more, see the
.Lk https://www.rabbitmq.com/networking.html "RabbitMQ Networking guide"
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.It Ev RABBITMQ_NODE_PORT
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
AMQP 0-9-1 and AMQP 1.0 port. Defaults to 5672.
To learn more, see the
.Lk https://www.rabbitmq.com/networking.html "RabbitMQ Networking guide"
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.El
.\" ------------------------------------------------------------------
.Sh OPTIONS
.\" ------------------------------------------------------------------
.Bl -tag -width Ds
Document new cli switches Fixes rabbitmq/rabbitmq-website#633 Also includes minor fix for -detached argument
2018-12-07 06:59:00 +08:00
.It Fl detached
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
Start the server process in the background.
Note that this will cause the pid not to be written to the pid file.
.Pp
For example, runs RabbitMQ AMQP server in the background:
.sp
.Dl rabbitmq-server -detached
.El
.\" ------------------------------------------------------------------
.Sh SEE ALSO
.\" ------------------------------------------------------------------
rabbitmq-diagnostics(8) WIP
2019-02-01 21:19:28 +08:00
.Xr rabbitmqctl 8 ,
.Xr rabbitmq-diagnostics 8 ,
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.Xr rabbitmq-plugins 8 ,
Cross-linking for newly added man pages
2019-09-26 13:53:48 +08:00
.Xr rabbitmq-queues 8 ,
.Xr rabbitmq-upgrade 8 ,
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.Xr rabbitmq-service 8 ,
rabbitmq-diagnostics(8) WIP
2019-02-01 21:19:28 +08:00
.Xr rabbitmq-env.conf 5 ,
.Xr rabbitmq-echopid 8
docs: Convert manpages from DocBook to mdoc(7) Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
2017-04-25 16:50:00 +08:00
.\" ------------------------------------------------------------------
.Sh AUTHOR
.\" ------------------------------------------------------------------
.An The RabbitMQ Team Aq Mt info@rabbitmq.com