diff options
| author | Emile Joubert <emile@rabbitmq.com> | 2011-05-10 16:33:46 +0100 |
|---|---|---|
| committer | Emile Joubert <emile@rabbitmq.com> | 2011-05-10 16:33:46 +0100 |
| commit | c5e3a7814b57592d540e3180f9b915fcbe70afd7 (patch) | |
| tree | cfbffa96b1007cc139759563d31de7af0452a445 /docs/rabbitmqctl.1.xml | |
| parent | 6f5aa1a601225b5d2d0b19bf4d82ebcb3a5e3a89 (diff) | |
| parent | fb266015210dc54b686cf1af39f8b88b075c8d7a (diff) | |
| download | rabbitmq-server-git-c5e3a7814b57592d540e3180f9b915fcbe70afd7.tar.gz | |
Merge bug20589 into default
Diffstat (limited to 'docs/rabbitmqctl.1.xml')
| -rw-r--r-- | docs/rabbitmqctl.1.xml | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index 3550e5eaef..628691589b 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -1264,6 +1264,67 @@ </varlistentry> </variablelist> </refsect2> + + <refsect2> + <title>Configuration variables</title> + <para> + Some configuration values can be changed at run time. Note + that this does not apply to all variables; many are only read + at startup - changing them will have no effect. + </para> + <variablelist> + <varlistentry> + <term><cmdsynopsis><command>set_env</command> <arg choice="req"><replaceable>variable</replaceable></arg> <arg choice="req"><replaceable>value</replaceable></arg></cmdsynopsis></term> + <listitem> + <variablelist> + <varlistentry> + <term>variable</term> + <listitem><para>The name of the variable to set, as the string form of an Erlang term.</para></listitem> + </varlistentry> + <varlistentry> + <term>value</term> + <listitem><para>The value to set it to, as the string form of an Erlang term.</para></listitem> + </varlistentry> + </variablelist> + <para> + Set the value of a configuration variable. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><cmdsynopsis><command>get_env</command> <arg choice="req"><replaceable>variable</replaceable></arg></cmdsynopsis></term> + <listitem> + <variablelist> + <varlistentry> + <term>variable</term> + <listitem><para>The name of the variable to get, as the string form of an Erlang term.</para></listitem> + </varlistentry> + </variablelist> + <para> + Get the value of a configuration variable, printing either + {ok,<command>Value</command>} or undefined. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><cmdsynopsis><command>unset_env</command> <arg choice="req"><replaceable>variable</replaceable></arg></cmdsynopsis></term> + <listitem> + <variablelist> + <varlistentry> + <term>variable</term> + <listitem><para>The name of the variable to clear, as the string form of an Erlang term.</para></listitem> + </varlistentry> + </variablelist> + <para> + Clear the value of a configuration variable. + </para> + </listitem> + </varlistentry> + + </variablelist> + </refsect2> </refsect1> </refentry> |