Merge branch 'master' into rabbitmq-server-1838-active-field-for-consumers

Conflicts:
	src/rabbit_fifo.erl

Author: acogoluegnes

docs/rabbitmq-echopid.8

@@ -14,12 +14,12 @@
 .\" The Initial Developer of the Original Code is Pivotal Software, Inc.
 .\" Copyright (c) 2007-2019 Pivotal Software, Inc.  All rights reserved.
 .\"
-.Dd April 25, 2017
+.Dd January 25, 2019
 .Dt RABBITMQ-ECHOPID.BAT 8
 .Os "RabbitMQ Server"
 .Sh NAME
 .Nm rabbitmq-echopid.bat
-.Nd return the Windows process id of the Erlang runtime hosting RabbitMQ
+.Nd returns the Windows process id of the Erlang runtime running RabbitMQ
 .\" ------------------------------------------------------------------
 .Sh SYNOPSIS
 .\" ------------------------------------------------------------------
@@ -28,10 +28,7 @@
 .\" ------------------------------------------------------------------
 .Sh DESCRIPTION
 .\" ------------------------------------------------------------------
-RabbitMQ is an implementation of AMQP, the emerging standard for high
-performance enterprise messaging.
-The RabbitMQ server is a robust and scalable implementation of an AMQP
-broker.
+RabbitMQ is an open source multi-protocol messaging broker.
 .Pp
 Running
 .Nm

docs/rabbitmq-env.conf.5

@@ -14,18 +14,18 @@
 .\" The Initial Developer of the Original Code is Pivotal Software, Inc.
 .\" Copyright (c) 2007-2019 Pivotal Software, Inc.  All rights reserved.
 .\"
-.Dd April 25, 2017
+.Dd January 25, 2019
 .Dt RABBITMQ-ENV.CONF 5
 .Os "RabbitMQ Server"
 .Sh NAME
 .Nm rabbitmq-env.conf
-.Nd default settings for RabbitMQ AMQP server
+.Nd environment variables used by RabbitMQ server
 .\" ------------------------------------------------------------------
 .Sh DESCRIPTION
 .\" ------------------------------------------------------------------
 .Nm
-contains variable settings that override the defaults built in to the
-RabbitMQ startup scripts.
+contains environment variables that override the defaults built in to the
+RabbitMQ scripts and CLI tools.
 .Pp
 The file is interpreted by the system shell, and so should consist of a
 sequence of shell environment variable definitions.
@@ -58,20 +58,28 @@ prefix removed:
 from the environment becomes
 .Ev NODE_PORT
 in
-.Nm ,
-etc.
+.Nm .
 .\" ------------------------------------------------------------------
 .Sh EXAMPLES
 .\" ------------------------------------------------------------------
-Here is an example of a complete
+Below is an example of a minimalistic 
 .Nm
-file that overrides the default Erlang node name from "rabbit" to
+file that overrides the default node name prefix from "rabbit" to
 "hare".
 .sp
 .Dl # I am a complete rabbitmq-env.conf file.
 .Dl # Comment lines start with a hash character.
 .Dl # This is a /bin/sh script file - use ordinary envt var syntax
 .Dl NODENAME=hare
+
+In the below
+.Nm
+file RabbitMQ configuration file location is changed to "/data/services/rabbitmq/rabbitmq.conf".
+.sp
+.Dl # I am a complete rabbitmq-env.conf file.
+.Dl # Comment lines start with a hash character.
+.Dl # This is a /bin/sh script file - use ordinary envt var syntax
+.Dl CONFIG_FILE=/data/services/rabbitmq/rabbitmq.conf
 .\" ------------------------------------------------------------------
 .Sh SEE ALSO
 .\" ------------------------------------------------------------------

docs/rabbitmq-plugins.8

@@ -14,31 +14,41 @@
 .\" The Initial Developer of the Original Code is Pivotal Software, Inc.
 .\" Copyright (c) 2007-2019 Pivotal Software, Inc.  All rights reserved.
 .\"
-.Dd April 25, 2017
+.Dd January 25, 2019
 .Dt RABBITMQ-PLUGINS 8
 .Os "RabbitMQ Server"
 .Sh NAME
 .Nm rabbitmq-plugins
-.Nd command line for managing RabbitMQ broker plugins
+.Nd command line for managing RabbitMQ plugins
 .\" ------------------------------------------------------------------
 .Sh SYNOPSIS
 .\" ------------------------------------------------------------------
 .Nm
+.Op Fl q
+.Op Fl s
+.Op Fl l
 .Op Fl n Ar node
+.Op Fl t Ar timeout
 .Ar command
 .Op Ar command_options
 .\" ------------------------------------------------------------------
 .Sh DESCRIPTION
 .\" ------------------------------------------------------------------
 .Nm
-is a command line tool for managing RabbitMQ broker plugins.
-It allows one to enable, disable and browse plugins.
+is a command line tool for managing RabbitMQ plugins.
+See the
+.Lk https://www.rabbitmq.com/plugins.html "RabbitMQ Plugins guide"
+for an overview of RabbitMQ plugins and how they are used.
+
+.Nm
+allows the operator to enable, disable and inspect plugins.
 It must be run by a user with write permissions to the RabbitMQ
 configuration directory.
 .Pp
-Some plugins depend on others to work correctly.
+Plugins can depend on other plugins.
 .Nm
-traverses these dependencies and enables all required plugins.
+resolves the dependencies and enables or disables all dependencies
+so that the user doesn't have to manage them explicitly.
 Plugins listed on the
 .Nm
 command line are marked as explicitly enabled; dependent plugins are
@@ -54,12 +64,66 @@ and
 commands will update the plugins file and then attempt to connect to the
 broker and ensure it is running all enabled plugins.
 By default if it is not possible to connect to the running broker (for
-example if it is stopped) then a warning is displayed.
-Specify
-.Fl -online
-or
+example if it is stopped) the operation will fail.
+If
+.Nm
+is used on the same host as the target node,
 .Fl -offline
-to change this behaviour.
+can be specified to make
+.Nm
+resolve and update plugin state directly (without contacting the node).
+Such changes will only have an effect on next node start.
+To learn more, see the
+.Lk https://www.rabbitmq.com/plugins.html "RabbitMQ Plugins guide"
+.
+.\" ------------------------------------------------------------------
+.Sh OPTIONS
+.\" ------------------------------------------------------------------
+.Bl -tag -width Ds
+.It Fl n Ar node
+Default node is
+.Qq Pf rabbit@ Ar target-hostname ,
+where
+.Ar target-hostname
+is the local host.
+On a host named
+.Qq myserver.example.com ,
+the node name will usually be
+.Qq rabbit@myserver
+(unless
+.Ev RABBITMQ_NODENAME
+has been overridden).
+The output of
+.Qq hostname -s
+is usually the correct suffix to use after the
+.Qq @
+sign.
+See
+.Xr rabbitmq-server 8
+for details of configuring a RabbitMQ node.
+.It Fl q , -quiet
+Quiet output mode is selected.
+Informational messages are reduced when quiet mode is in effect.
+.It Fl s , -silent
+Silent output mode is selected.
+Informational messages are reduced and table headers are suppressed when silent mode is in effect.
+.It Fl t Ar timeout , Fl -timeout Ar timeout
+Operation timeout in seconds.
+Not all commands support timeouts.
+Default is
+.Cm infinity .
+.It Fl l , Fl -longnames
+Must be specified when the cluster is configured to use long (FQDN) node names.
+To learn more, see the
+.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide"
+.It Fl -erlang-cookie Ar cookie
+Shared secret to use to authenticate to the target node.
+Prefer using a local file or the
+.Ev RABBITMQ_ERLANG_COOKIE
+environment variable instead of specifying this option on the command line.
+To learn more, see the
+.Lk https://www.rabbitmq.com/cli.html "RabbitMQ CLI Tools guide"
+.El
 .\" ------------------------------------------------------------------
 .Sh COMMANDS
 .\" ------------------------------------------------------------------
@@ -124,9 +188,9 @@ This command lists all implicitly or explicitly enabled RabbitMQ plugins.
 .It Cm enable Oo Fl -offline Oc Oo Fl -online Oc Ar plugin ...
 .Bl -tag -width Ds
 .It Fl -offline
-Just modify the enabled plugins file.
+Modify node's enabled plugin state directly without contacting the node.
 .It Fl -online
-Treat failure to connect to the running broker as fatal.
+Treat a failure to connect to the running broker as fatal.
 .It Ar plugin
 One or more plugins to enable.
 .El
@@ -144,29 +208,29 @@ plugins and all their dependencies:
 .It Cm disable Oo Fl -offline Oc Oo Fl -online Oc Ar plugin ...
 .Bl -tag -width Ds
 .It Fl -offline
-Just modify the enabled plugins file.
+Modify node's enabled plugin state directly without contacting the node.
 .It Fl -online
-Treat failure to connect to the running broker as fatal.
+Treat a failure to connect to the running broker as fatal.
 .It Ar plugin
 One or more plugins to disable.
 .El
 .Pp
 Disables the specified plugins and all their dependencies.
 .Pp
 For example, this command disables
-.Qq amqp_client
+.Qq rabbitmq_management
 and all plugins that depend on it:
 .sp
-.Dl rabbitmq-plugins disable amqp_client
+.Dl rabbitmq-plugins disable rabbitmq_management
 .\" ------------------------------------
 .It Cm set Oo Fl -offline Oc Oo Fl -online Oc Op Ar plugin ...
 .Bl -tag -width Ds
 .It Fl -offline
-Just modify the enabled plugins file.
+Modify node's enabled plugin state directly without contacting the node.
 .It Fl -online
-Treat failure to connect to the running broker as fatal.
+Treat a failure to connect to the running broker as fatal.
 .It Ar plugin
-Zero or more plugins to enable.
+Zero or more plugins to disable.
 .El
 .Pp
 Enables the specified plugins and all their dependencies.

docs/rabbitmq-server.8

@@ -14,12 +14,12 @@
 .\" The Initial Developer of the Original Code is Pivotal Software, Inc.
 .\" Copyright (c) 2007-2019 Pivotal Software, Inc.  All rights reserved.
 .\"
-.Dd April 25, 2017
+.Dd January 25, 2019
 .Dt RABBITMQ-SERVER 8
 .Os "RabbitMQ Server"
 .Sh NAME
 .Nm rabbitmq-server
-.Nd start RabbitMQ AMQP server
+.Nd starts a RabbitMQ node
 .\" ------------------------------------------------------------------
 .Sh SYNOPSIS
 .\" ------------------------------------------------------------------
@@ -28,47 +28,55 @@
 .\" ------------------------------------------------------------------
 .Sh DESCRIPTION
 .\" ------------------------------------------------------------------
-RabbitMQ is an implementation of AMQP, the emerging standard for high
-performance enterprise messaging.
-The RabbitMQ server is a robust and scalable implementation of an AMQP
-broker.
+RabbitMQ is an open source multi-protocol messaging broker.
 .Pp
 Running
 .Nm
-in the foreground displays a banner message, and reports on progress in
-the startup sequence, concluding with the message
-.Qq broker running ,
-indicating that the RabbitMQ broker has been started successfully.
-To shut down the server, just terminate the process or use
+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
 .Xr rabbitmqctl 8 .
 .\" ------------------------------------------------------------------
 .Sh ENVIRONMENT
 .\" ------------------------------------------------------------------
 .Bl -tag -width Ds
+.It Ev RABBITMQ_CONFIG_FILE
+Defaults to 
+.Pa /etc/rabbitmq/rabbitmq.conf .
+Node configuration file path.
+To learn more, see the
+.Lk https://www.rabbitmq.com/configure.html "RabbitMQ Configuration guide"
 .It Ev RABBITMQ_MNESIA_BASE
 Defaults to
 .Pa /var/lib/rabbitmq/mnesia .
-Set this to the directory where Mnesia database files should be placed.
+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"
 .It Ev RABBITMQ_LOG_BASE
 Defaults to
 .Pa /var/log/rabbitmq .
 Log files generated by the server will be placed in this directory.
+To learn more, see the
+.Lk https://www.rabbitmq.com/logging.html "RabbitMQ Logging guide"
 .It Ev RABBITMQ_NODENAME
 Defaults to
-.Qq rabbit .
-This can be useful if you want to run more than one node per machine -
+.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
 .Ev RABBITMQ_NODENAME
-should be unique per erlang-node-and-machine combination.
-See the
-.Lk http://www.rabbitmq.com/clustering.html#single-machine "clustering on a single machine guide"
-for details.
+To learn more, see the
+.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide"
 .It Ev RABBITMQ_NODE_IP_ADDRESS
-By default RabbitMQ will bind to all interfaces, on IPv4 and IPv6 if
-available.
-Set this if you only want to bind to one network interface or address
+By default RabbitMQ will bind to all IPv6 and IPv4 interfaces available.
+This variable limits the node to one network interface or address
 family.
+To learn more, see the
+.Lk https://www.rabbitmq.com/networking.html "RabbitMQ Networking guide"
 .It Ev RABBITMQ_NODE_PORT
-Defaults to 5672.
+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"
 .El
 .\" ------------------------------------------------------------------
 .Sh OPTIONS