Skip to content

Commit 68f487c

Browse files
michaelklishinmichaelklishin
committed
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 (cherry picked from commit f083259)
1 parent a41e1bc commit 68f487c

File tree

6 files changed

+167
-141
lines changed

6 files changed

+167
-141
lines changed

‎docs/rabbitmq-echopid.8‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
.Os "RabbitMQ Server"
2020
.Sh NAME
2121
.Nm rabbitmq-echopid.bat
22-
.Nd return the Windows process id of the Erlang runtime hosting RabbitMQ
22+
.Nd returns the Windows process id of the Erlang runtime running RabbitMQ
2323
.\" ------------------------------------------------------------------
2424
.Sh SYNOPSIS
2525
.\" ------------------------------------------------------------------
@@ -28,10 +28,7 @@
2828
.\" ------------------------------------------------------------------
2929
.Sh DESCRIPTION
3030
.\" ------------------------------------------------------------------
31-
RabbitMQ is an implementation of AMQP, the emerging standard for high
32-
performance enterprise messaging.
33-
The RabbitMQ server is a robust and scalable implementation of an AMQP
34-
broker.
31+
RabbitMQ is an open source multi-protocol messaging broker.
3532
.Pp
3633
Running
3734
.Nm

‎docs/rabbitmq-env.conf.5‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@
1414
.\" The Initial Developer of the Original Code is Pivotal Software, Inc.
1515
.\" Copyright (c) 2007-2017 Pivotal Software, Inc. All rights reserved.
1616
.\"
17-
.Dd April 25, 2017
17+
.Dd January 25, 2019
1818
.Dt RABBITMQ-ENV.CONF 5
1919
.Os "RabbitMQ Server"
2020
.Sh NAME
2121
.Nm rabbitmq-env.conf
22-
.Nd default settings for RabbitMQ AMQP server
22+
.Nd environment variables used by RabbitMQ server
2323
.\" ------------------------------------------------------------------
2424
.Sh DESCRIPTION
2525
.\" ------------------------------------------------------------------
2626
.Nm
27-
contains variable settings that override the defaults built in to the
28-
RabbitMQ startup scripts.
27+
contains environment variables that override the defaults built in to the
28+
RabbitMQ scripts and CLI tools.
2929
.Pp
3030
The file is interpreted by the system shell, and so should consist of a
3131
sequence of shell environment variable definitions.
@@ -58,20 +58,28 @@ prefix removed:
5858
from the environment becomes
5959
.Ev NODE_PORT
6060
in
61-
.Nm ,
62-
etc.
61+
.Nm .
6362
.\" ------------------------------------------------------------------
6463
.Sh EXAMPLES
6564
.\" ------------------------------------------------------------------
66-
Here is an example of a complete
65+
Below is an example of a minimalistic
6766
.Nm
68-
file that overrides the default Erlang node name from "rabbit" to
67+
file that overrides the default node name prefix from "rabbit" to
6968
"hare".
7069
.sp
7170
.Dl # I am a complete rabbitmq-env.conf file.
7271
.Dl # Comment lines start with a hash character.
7372
.Dl # This is a /bin/sh script file - use ordinary envt var syntax
7473
.Dl NODENAME=hare
74+
75+
In the below
76+
.Nm
77+
file RabbitMQ configuration file location is changed to "/data/services/rabbitmq/rabbitmq.conf".
78+
.sp
79+
.Dl # I am a complete rabbitmq-env.conf file.
80+
.Dl # Comment lines start with a hash character.
81+
.Dl # This is a /bin/sh script file - use ordinary envt var syntax
82+
.Dl CONFIG_FILE=/data/services/rabbitmq/rabbitmq.conf
7583
.\" ------------------------------------------------------------------
7684
.Sh SEE ALSO
7785
.\" ------------------------------------------------------------------

‎docs/rabbitmq-plugins.8‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
.Os "RabbitMQ Server"
2020
.Sh NAME
2121
.Nm rabbitmq-plugins
22-
.Nd command line for managing RabbitMQ broker plugins
22+
.Nd command line for managing RabbitMQ plugins
2323
.\" ------------------------------------------------------------------
2424
.Sh SYNOPSIS
2525
.\" ------------------------------------------------------------------
@@ -31,7 +31,7 @@
3131
.Sh DESCRIPTION
3232
.\" ------------------------------------------------------------------
3333
.Nm
34-
is a command line tool for managing RabbitMQ broker plugins.
34+
is a command line tool for managing RabbitMQ plugins.
3535
It allows one to enable, disable and browse plugins.
3636
It must be run by a user with write permissions to the RabbitMQ
3737
configuration directory.

‎docs/rabbitmq-server.8‎

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
.\" The Initial Developer of the Original Code is Pivotal Software, Inc.
1515
.\" Copyright (c) 2007-2017 Pivotal Software, Inc. All rights reserved.
1616
.\"
17-
.Dd April 25, 2017
17+
.Dd January 25, 2019
1818
.Dt RABBITMQ-SERVER 8
1919
.Os "RabbitMQ Server"
2020
.Sh NAME
2121
.Nm rabbitmq-server
22-
.Nd start RabbitMQ AMQP server
22+
.Nd starts a RabbitMQ node
2323
.\" ------------------------------------------------------------------
2424
.Sh SYNOPSIS
2525
.\" ------------------------------------------------------------------
@@ -28,47 +28,55 @@
2828
.\" ------------------------------------------------------------------
2929
.Sh DESCRIPTION
3030
.\" ------------------------------------------------------------------
31-
RabbitMQ is an implementation of AMQP, the emerging standard for high
32-
performance enterprise messaging.
33-
The RabbitMQ server is a robust and scalable implementation of an AMQP
34-
broker.
31+
RabbitMQ is an open source multi-protocol messaging broker.
3532
.Pp
3633
Running
3734
.Nm
38-
in the foreground displays a banner message, and reports on progress in
39-
the startup sequence, concluding with the message
40-
.Qq broker running ,
41-
indicating that the RabbitMQ broker has been started successfully.
42-
To shut down the server, just terminate the process or use
35+
starts a RabbitMQ node in the foreground. The node will display a startup
36+
banner and report when startup is complete.
37+
To shut down the server, use service management tools or
4338
.Xr rabbitmqctl 8 .
4439
.\" ------------------------------------------------------------------
4540
.Sh ENVIRONMENT
4641
.\" ------------------------------------------------------------------
4742
.Bl -tag -width Ds
43+
.It Ev RABBITMQ_CONFIG_FILE
44+
Defaults to
45+
.Pa /etc/rabbitmq/rabbitmq.conf .
46+
Node configuration file path.
47+
To learn more, see the
48+
.Lk https://www.rabbitmq.com/configure.html "RabbitMQ Configuration guide"
4849
.It Ev RABBITMQ_MNESIA_BASE
4950
Defaults to
5051
.Pa /var/lib/rabbitmq/mnesia .
51-
Set this to the directory where Mnesia database files should be placed.
52+
Node data directory will be located (or created) in this directory.
53+
To learn more, see the
54+
.Lk https://www.rabbitmq.com/relocate.html "RabbitMQ File and Directory guide"
5255
.It Ev RABBITMQ_LOG_BASE
5356
Defaults to
5457
.Pa /var/log/rabbitmq .
5558
Log files generated by the server will be placed in this directory.
59+
To learn more, see the
60+
.Lk https://www.rabbitmq.com/logging.html "RabbitMQ Logging guide"
5661
.It Ev RABBITMQ_NODENAME
5762
Defaults to
58-
.Qq rabbit .
59-
This can be useful if you want to run more than one node per machine -
63+
.Qq rabbit@ .
64+
followed by the computed hostname.
65+
Can be used to run multiple nodes on the same host.
66+
Every node in a cluster must have a unique
6067
.Ev RABBITMQ_NODENAME
61-
should be unique per erlang-node-and-machine combination.
62-
See the
63-
.Lk http://www.rabbitmq.com/clustering.html#single-machine "clustering on a single machine guide"
64-
for details.
68+
To learn more, see the
69+
.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide"
6570
.It Ev RABBITMQ_NODE_IP_ADDRESS
66-
By default RabbitMQ will bind to all interfaces, on IPv4 and IPv6 if
67-
available.
68-
Set this if you only want to bind to one network interface or address
71+
By default RabbitMQ will bind to all IPv6 and IPv4 interfaces available.
72+
This variable limits the node to one network interface or address
6973
family.
74+
To learn more, see the
75+
.Lk https://www.rabbitmq.com/networking.html "RabbitMQ Networking guide"
7076
.It Ev RABBITMQ_NODE_PORT
71-
Defaults to 5672.
77+
AMQP 0-9-1 and AMQP 1.0 port. Defaults to 5672.
78+
To learn more, see the
79+
.Lk https://www.rabbitmq.com/networking.html "RabbitMQ Networking guide"
7280
.El
7381
.\" ------------------------------------------------------------------
7482
.Sh OPTIONS

‎docs/rabbitmq-service.8‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
.Os "RabbitMQ Server"
2020
.Sh NAME
2121
.Nm rabbitmq-service.bat
22-
.Nd manage RabbitMQ AMQP Windows service
22+
.Nd tool for managing RabbitMQ Windows service
2323
.\" ------------------------------------------------------------------
2424
.Sh SYNOPSIS
2525
.\" ------------------------------------------------------------------
@@ -28,17 +28,14 @@
2828
.\" ------------------------------------------------------------------
2929
.Sh DESCRIPTION
3030
.\" ------------------------------------------------------------------
31-
RabbitMQ is an implementation of AMQP, the emerging standard for high
32-
performance enterprise messaging.
33-
The RabbitMQ server is a robust and scalable implementation of an AMQP
34-
broker.
31+
RabbitMQ is an open source multi-protocol messaging broker.
3532
.Pp
3633
Running
3734
.Nm
38-
allows the RabbitMQ broker to be run as a service on
39-
NT/2000/2003/XP/Vista® environments.
35+
allows the RabbitMQ broker to be run as a service in
36+
Windows® environments.
4037
The RabbitMQ broker service can be started and stopped using the
41-
Windows® services applet.
38+
Windows® services panel.
4239
.Pp
4340
By default the service will run in the authentication context of the
4441
local system account.
@@ -93,25 +90,28 @@ Note: Windows only. Defaults to the application data directory of the
9390
current user. This is the location of log and database directories.
9491
.It Ev RABBITMQ_NODENAME
9592
Defaults to
96-
.Qq rabbit .
97-
This can be useful if you want to run more than one node per machine -
93+
.Qq rabbit@ .
94+
followed by the computed hostname.
95+
Can be used to run multiple nodes on the same host.
96+
Every node in a cluster must have a unique
9897
.Ev RABBITMQ_NODENAME
99-
should be unique per erlang-node-and-machine combination.
100-
See the
101-
.Lk http://www.rabbitmq.com/clustering.html#single-machine clustering on a single machine guide
102-
for details.
98+
To learn more, see the
99+
.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide"
103100
.It Ev RABBITMQ_NODE_IP_ADDRESS
104-
By default RabbitMQ will bind to all interfaces, on IPv4 and IPv6 if
105-
available.
106-
Set this if you only want to bind to one network interface or address
101+
By default RabbitMQ will bind to all IPv6 and IPv4 interfaces available.
102+
This variable limits the node to one network interface or address
107103
family.
104+
To learn more, see the
105+
.Lk https://www.rabbitmq.com/networking.html "RabbitMQ Networking guide"
108106
.It Ev RABBITMQ_NODE_PORT
109-
Defaults to 5672.
107+
AMQP 0-9-1 and AMQP 1.0 port. Defaults to 5672.
108+
To learn more, see the
109+
.Lk https://www.rabbitmq.com/networking.html "RabbitMQ Networking guide"
110110
.It Ev ERLANG_SERVICE_MANAGER_PATH
111111
Defaults to
112-
.Pa C:\(rsProgram\ Files\(rserl5.5.5\(rserts-5.5.5\(rsbin
112+
.Pa C:\(rsProgram\ Files\(rserl{version}\(rserts-{version}\(rsbin
113113
(or
114-
.Pa C:\(rsProgram\ Files\ (x86)\(rserl5.5.5\(rserts-5.5.5\(rsbin
114+
.Pa C:\(rsProgram\ Files\ (x86)\(rserl{version}\(rserts-{version}\(rsbin
115115
for 64-bit environments).
116116
This is the installation location of the Erlang service manager.
117117
.It Ev RABBITMQ_CONSOLE_LOG

0 commit comments

Comments
 (0)