diff options
| author | Simon MacMullen <simon@rabbitmq.com> | 2010-09-07 13:37:16 +0100 |
|---|---|---|
| committer | Simon MacMullen <simon@rabbitmq.com> | 2010-09-07 13:37:16 +0100 |
| commit | 0c3f40222c5050da06a07de627b70ed6dd601b23 (patch) | |
| tree | 80b361e4634dc0d0408254b3c41841f4b27b591e /docs | |
| parent | c268faede75e4e69981e2fb022258add04069556 (diff) | |
| download | rabbitmq-server-git-0c3f40222c5050da06a07de627b70ed6dd601b23.tar.gz | |
Finish adding is_admin boolean to user.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rabbitmqctl.1.xml | 28 |
1 files changed, 12 insertions, 16 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index 0f7cfcff1f..5179eb253c 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -401,7 +401,7 @@ <variablelist> <varlistentry> - <term><cmdsynopsis><command>add_user</command> <arg choice="req"><replaceable>username</replaceable></arg> <arg choice="req"><replaceable>password</replaceable></arg> <arg choice="req"><replaceable>is_admin</replaceable></arg></cmdsynopsis></term> + <term><cmdsynopsis><command>add_user</command> <arg choice="req"><replaceable>username</replaceable></arg> <arg choice="req"><replaceable>password</replaceable></arg></cmdsynopsis></term> <listitem> <variablelist> <varlistentry> @@ -412,22 +412,12 @@ <term>password</term> <listitem><para>The password the created user will use to log in to the broker.</para></listitem> </varlistentry> - - <varlistentry> - <term>is_admin</term> - <listitem><para>Whether the user is an administrative - user. This has no effect when the user logs in via - AMQP, but can be used to permit access to additional - features when the user logs in via some other means - (for example with the management - plugin).</para></listitem> - </varlistentry> </variablelist> <para role="example-prefix">For example:</para> - <screen role="example">rabbitmqctl add_user tonyg changeit true</screen> + <screen role="example">rabbitmqctl add_user tonyg changeit</screen> <para role="example"> - This command instructs the RabbitMQ broker to create an - administrative user named <command>tonyg</command> with + This command instructs the RabbitMQ broker to create a + (non-administrative) user named <command>tonyg</command> with (initial) password <command>changeit</command>. </para> @@ -489,7 +479,11 @@ <screen role="example">rabbitmqctl set_admin tonyg</screen> <para role="example"> This command instructs the RabbitMQ broker to ensure the user - named <command>tonyg</command> is an administrator. + named <command>tonyg</command> is an administrator. This has no + effect when the user logs in via AMQP, but can be used to permit + the user to manage users, virtual hosts and permissions when the + user logs in via some other means (for example with the + management plugin). </para> </listitem> </varlistentry> @@ -520,7 +514,9 @@ <para role="example-prefix">For example:</para> <screen role="example">rabbitmqctl list_users</screen> <para role="example"> - This command instructs the RabbitMQ broker to list all users. + This command instructs the RabbitMQ broker to list all + users. Each result row will contain the user name and + the administrator status of the user, in that order. </para> </listitem> </varlistentry> |
