From 3b6b74c13ebd0490ccfe85e7a1c25d22bd1dd598 Mon Sep 17 00:00:00 2001
From: Emile Joubert <emile@rabbitmq.com>
Date: Tue, 9 Oct 2012 15:44:47 +0100
Subject: Simpler policy interface

---
 docs/rabbitmqctl.1.xml | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)

(limited to 'docs/rabbitmqctl.1.xml')

diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml
index eea42484..564af9fd 100644
--- a/docs/rabbitmqctl.1.xml
+++ b/docs/rabbitmqctl.1.xml
@@ -905,7 +905,7 @@
       </para>
       <variablelist>
         <varlistentry>
-          <term><cmdsynopsis><command>set_policy</command> <arg choice="opt">-p <replaceable>vhostpath</replaceable></arg> <arg choice="req"><replaceable>key</replaceable></arg> <arg choice="req"><replaceable>value</replaceable></arg></cmdsynopsis></term>
+          <term><cmdsynopsis><command>set_policy</command> <arg choice="opt">-p <replaceable>vhostpath</replaceable></arg> <arg choice="req"><replaceable>key</replaceable></arg> <arg choice="req"><replaceable>pattern</replaceable></arg>  <arg choice="req"><replaceable>definition</replaceable></arg> <arg choice="opt"><replaceable>priority</replaceable></arg> </cmdsynopsis></term>
           <listitem>
             <para>
               Sets a policy.
@@ -918,17 +918,28 @@
                 </para></listitem>
               </varlistentry>
               <varlistentry>
-                <term>value</term>
+                <term>pattern</term>
+                <listitem><para>
+                    The regular expression, which when matches on a given resources causes the policy to apply.
+                </para></listitem>
+              </varlistentry>
+              <varlistentry>
+                <term>definition</term>
                 <listitem><para>
                     The definition of the policy, as a
                     JSON string. In most shells you are very likely to
                     need to quote this.
                 </para></listitem>
               </varlistentry>
+              <varlistentry>
+                <term>priority</term>
+                <listitem><para>
+                    The priority of the policy as an integer, defaulting to 0. Higher numbers indicate greater precedence.
+                </para></listitem>
+              </varlistentry>
             </variablelist>
             <para role="example-prefix">For example:</para>
-            <screen role="example">rabbitmqctl set_policy federate-me '{"pattern":"^amq.",\
-                                     "policy":{"federation-upstream-set":"all"}}'</screen>
+            <screen role="example">rabbitmqctl set_policy federate-me "^amq." '{"federation-upstream-set":"all"}'</screen>
             <para role="example">
               This command sets the policy <command>federate-me</command> in the default virtual host so that built-in exchanges are federated.
             </para>
-- 
cgit v1.2.1