summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlvaro Videla <videlalvaro@gmail.com>2015-10-30 16:32:03 +0100
committerAlvaro Videla <videlalvaro@gmail.com>2015-10-30 16:32:03 +0100
commitad8fea9914cd739765af6a88367388c74861c966 (patch)
tree7fd2165321cfca478738b37de1c35e41fcae861a /docs
parent06c3d2b0484fe9695aaac66edc2830c91041c507 (diff)
parent3ab1f8d196dd61e12098b1fbfd32320f82137c91 (diff)
downloadrabbitmq-server-git-ad8fea9914cd739765af6a88367388c74861c966.tar.gz
merges master with erlang.mk changes
Diffstat (limited to 'docs')
-rw-r--r--docs/README-for-packages20
-rw-r--r--docs/rabbitmq.config.example9
-rw-r--r--docs/rabbitmqctl.1.xml20
3 files changed, 49 insertions, 0 deletions
diff --git a/docs/README-for-packages b/docs/README-for-packages
new file mode 100644
index 0000000000..35a1523ac3
--- /dev/null
+++ b/docs/README-for-packages
@@ -0,0 +1,20 @@
+This is rabbitmq-server, a message broker implementing AMQP, STOMP and MQTT.
+
+Most of the documentation for RabbitMQ is provided on the RabbitMQ web
+site. You can see documentation for the current version at:
+
+http://www.rabbitmq.com/documentation.html
+
+and for previous versions at:
+
+http://www.rabbitmq.com/previous.html
+
+Man pages are installed with this package. Of particular interest are
+rabbitmqctl(1), to interact with a running RabbitMQ server, and
+rabbitmq-plugins(1), to enable and disable plugins. These should be
+run as the superuser.
+
+An example configuration file is provided in the same directory as
+this README. Copy it to /etc/rabbitmq/rabbitmq.config to use it. The
+RabbitMQ server must be restarted after changing the configuration
+file.
diff --git a/docs/rabbitmq.config.example b/docs/rabbitmq.config.example
index 3047f8f70e..6be9504b8b 100644
--- a/docs/rabbitmq.config.example
+++ b/docs/rabbitmq.config.example
@@ -193,6 +193,10 @@
%%
%% {vm_memory_high_watermark, 0.4},
+ %% Alternatively, we can set a limit (in megabytes) of RAM used by the node.
+ %%
+ %% {vm_memory_high_watermark, {absolute, 1024}},
+
%% Fraction of the high watermark limit at which queues start to
%% page message out to disc in order to free up memory.
%%
@@ -200,6 +204,11 @@
%%
%% {vm_memory_high_watermark_paging_ratio, 0.5},
+ %% Interval (in milliseconds) at which we perform the check of the memory
+ %% levels against the watermarks.
+ %%
+ %% {memory_monitor_interval, 2500},
+
%% Set disk free limit (in bytes). Once free disk space reaches this
%% lower bound, a disk alarm will be set - see the documentation
%% listed above for more details.
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml
index 4a5e315ecd..43d00418e6 100644
--- a/docs/rabbitmqctl.1.xml
+++ b/docs/rabbitmqctl.1.xml
@@ -1230,6 +1230,11 @@
queue is non-exclusive.</para></listitem>
</varlistentry>
<varlistentry>
+ <term>exclusive</term>
+ <listitem><para>True if queue is exclusive (i.e. has
+ owner_pid), false otherwise</para></listitem>
+ </varlistentry>
+ <varlistentry>
<term>exclusive_consumer_pid</term>
<listitem><para>Id of the Erlang process representing the channel of the
exclusive consumer subscribed to this queue. Empty if
@@ -1925,6 +1930,21 @@
</variablelist>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><cmdsynopsis><command>set_vm_memory_high_watermark absolute</command> <arg choice="req"><replaceable>memory_limit_mb</replaceable></arg></cmdsynopsis></term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term>memory_limit_mb</term>
+ <listitem><para>
+ The new memory limit at which flow control is
+ triggered, expressed in MB as an integer number
+ greater than or equal to 0.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect2>
</refsect1>