diff options
| author | Diana Corbacho <diana@rabbitmq.com> | 2016-08-15 12:12:56 +0100 |
|---|---|---|
| committer | Diana Corbacho <diana@rabbitmq.com> | 2016-08-15 12:12:56 +0100 |
| commit | ca2d2054ddcdcee66ec36d52a2604a3c343c4cc9 (patch) | |
| tree | dbfbfbea9569a20556ef7a7d8cbeb59d6eb6f52a /docs | |
| parent | 703ea5abe6b7fd1cb2008d4e1c990de4593de90d (diff) | |
| parent | c2bd22cdc3c1f0ba75bbeebd3a6d59b3d976cb68 (diff) | |
| download | rabbitmq-server-git-ca2d2054ddcdcee66ec36d52a2604a3c343c4cc9.tar.gz | |
Merge branch 'stable'
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rabbitmqctl.1.xml | 42 | ||||
| -rw-r--r-- | docs/usage.xsl | 10 |
2 files changed, 47 insertions, 5 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index 363748e046..9206e69924 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -744,9 +744,7 @@ <varlistentry> <term> - <cmdsynopsis> - <command>authenticate_user</command> <arg choice="req"><replaceable>username</replaceable></arg> <arg choice="req"><replaceable>password</replaceable></arg> - </cmdsynopsis> + <cmdsynopsis><command>authenticate_user</command> <arg choice="req"><replaceable>username</replaceable></arg> <arg choice="req"><replaceable>password</replaceable></arg></cmdsynopsis> </term> <listitem> <variablelist> @@ -1232,7 +1230,9 @@ <variablelist> <varlistentry role="usage-has-option-list"> - <term><cmdsynopsis><command>list_queues</command> <arg choice="opt">-p <replaceable>vhost</replaceable></arg> <arg choice="opt" role="usage-option-list"><replaceable>queueinfoitem</replaceable> ...</arg></cmdsynopsis></term> + <term> + <cmdsynopsis><command>list_queues</command> <arg choice="opt">-p <replaceable>vhost</replaceable></arg> <group choice="opt"><arg>--offline</arg><arg>--online</arg><arg>--local</arg></group> <arg choice="opt" role="usage-option-list"><replaceable>queueinfoitem</replaceable> ...</arg></cmdsynopsis> + </term> <listitem> <para> Returns queue details. Queue details of the <command>/</command> virtual host @@ -1240,6 +1240,40 @@ override this default. </para> <para> + Displayed queues can be filtered by their status or + location using one of the following mutually exclusive + options: + <variablelist> + <varlistentry> + <term><cmdsynopsis><arg choice="opt">--offline</arg></cmdsynopsis></term> + <listitem> + <para> + List only those durable queues that are not + currently running - i.e. they are located on + inaccessible nodes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><cmdsynopsis><arg choice="opt">--online</arg></cmdsynopsis></term> + <listitem> + <para> + List queues that are currently live. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><cmdsynopsis><arg choice="opt">--local</arg></cmdsynopsis></term> + <listitem> + <para> + List only those queues whose master process is + located on the current node. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> The <command>queueinfoitem</command> parameter is used to indicate which queue information items to include in the results. The column order in the results will match the order of the parameters. diff --git a/docs/usage.xsl b/docs/usage.xsl index 586f830327..0d3cb6f235 100644 --- a/docs/usage.xsl +++ b/docs/usage.xsl @@ -8,7 +8,7 @@ encoding="UTF-8" indent="no"/> <xsl:strip-space elements="*"/> -<xsl:preserve-space elements="cmdsynopsis arg" /> +<xsl:preserve-space elements="cmdsynopsis arg group" /> <xsl:template match="/"> <!-- Pull out cmdsynopsis to show the command usage line. -->%% Generated, do not edit! @@ -68,6 +68,14 @@ usage() -> %QUOTE%Usage: <!-- Don't show anything else in command usage --> <xsl:template match="text()" mode="command-usage"/> +<xsl:template match="group[@choice='opt']"> + <xsl:text>[</xsl:text> + <xsl:for-each select="arg"> + <xsl:apply-templates/> + <xsl:if test="not(position() = last())"><xsl:text>|</xsl:text></xsl:if> + </xsl:for-each> + <xsl:text>]</xsl:text> +</xsl:template> <xsl:template match="arg[@choice='opt']">[<xsl:apply-templates/>]</xsl:template> <xsl:template match="replaceable"><<xsl:value-of select="."/>></xsl:template> |
