diff options
author | Hubert Plociniczak <hubert@lshift.net> | 2008-08-12 17:04:47 +0100 |
---|---|---|
committer | Hubert Plociniczak <hubert@lshift.net> | 2008-08-12 17:04:47 +0100 |
commit | 53e01ba00a7706da871e3f1a2852208930b4db83 (patch) | |
tree | 793b01ed32782bee553436feb7baae9e01ba9d24 | |
parent | 17770414ef76eb4c94dd5ea4d35bb8b3f3757494 (diff) | |
parent | e3b70ba2dcea8cc272a83e698343783ac9a5c101 (diff) | |
download | rabbitmq-server-53e01ba00a7706da871e3f1a2852208930b4db83.tar.gz |
Merge bug17940 into bug19166
-rw-r--r-- | docs/rabbitmq-multi.pod | 2 | ||||
-rw-r--r-- | docs/rabbitmq-server.pod | 2 | ||||
-rw-r--r-- | docs/rabbitmqctl.pod | 116 | ||||
-rw-r--r-- | docs/rabbitmqctl_real.pod | 141 | ||||
-rw-r--r-- | packaging/RPMS/Fedora/rabbitmq-server.spec | 2 | ||||
-rw-r--r-- | packaging/debs/Debian/debian/rules | 1 | ||||
-rw-r--r-- | packaging/windows/Makefile | 1 |
7 files changed, 115 insertions, 150 deletions
diff --git a/docs/rabbitmq-multi.pod b/docs/rabbitmq-multi.pod index 0f7aec52..2e3f28c8 100644 --- a/docs/rabbitmq-multi.pod +++ b/docs/rabbitmq-multi.pod @@ -34,7 +34,7 @@ Start 3 local RabbitMQ nodes with unique, sequential port numbers: =head1 SEE ALSO -rabbitmq-server(1), rabbitmqctl(1), rabbitmqctl_real(1) +rabbitmq-server(1), rabbitmqctl(1) =head1 AUTHOR diff --git a/docs/rabbitmq-server.pod b/docs/rabbitmq-server.pod index bf411bc2..1eaf2dfd 100644 --- a/docs/rabbitmq-server.pod +++ b/docs/rabbitmq-server.pod @@ -62,7 +62,7 @@ Run RabbitMQ AMQP server in the background: =head1 SEE ALSO -rabbitmq-multi(1), rabbitmqctl(1), rabbitmqctl_real(1) +rabbitmq-multi(1), rabbitmqctl(1) =head1 AUTHOR diff --git a/docs/rabbitmqctl.pod b/docs/rabbitmqctl.pod index 602cf751..db31b621 100644 --- a/docs/rabbitmqctl.pod +++ b/docs/rabbitmqctl.pod @@ -1,10 +1,10 @@ =head1 NAME -rabbitmqctl - wrapper for the command line tool for managing a RabbitMQ broker +rabbitmqctl - command line tool for managing a RabbitMQ broker =head1 SYNOPSIS -rabbitmqctl I<command> [command options] +rabbitmqctl [-n I<node>] I<<command>> [command options] =head1 DESCRIPTION @@ -12,14 +12,116 @@ RabbitMQ is an implementation of AMQP, the emerging standard for high performance enterprise messaging. The RabbitMQ server is a robust and scalable implementation of an AMQP broker. -rabbitmqctl is a wrapper around rabbitmqctl_real(1) tool and performs -all commands properly with I<rabbitmq> user permissions. - -See rabbitmqctl_real(1) for the list of available commands. +rabbitmqctl is a command line tool for managing a RabbitMQ broker. +It performs all actions by connecting to one of the broker's nodes. + + +=head1 OPTIONS + +B<-n> I<node> + default node is C<rabbit@server>, where server is the local host. + On a host named C<server.example.com>, the node name of the RabbitMQ + Erlang node will usually be rabbit@server (unless NODENAME has been + set to some non-default value at broker startup time). + The output of hostname -s is usually the correct suffix to use + after the "@" sign. See rabbitmq-server(1) for details of configur- + ing the RabbitMQ broker. + + +=head1 COMMANDS + +=head2 APPLICATION AND CLUSTER MANAGEMENT + +stop + stop the Erlang node on which RabbitMQ broker is running. + +stop_app + stop the RabbitMQ application, leaving the Erlang node running. + This command is typically run prior to performing other management + actions that require the RabbitMQ application to be stopped, + e.g. I<reset>. + +start_app + start the RabbitMQ application. + This command is typically run prior to performing other management + actions that require the RabbitMQ application to be stopped, + e.g. I<reset>. + +status + display various information about the RabbitMQ broker, such as + whether the RabbitMQ application on the current node, its version + number, what nodes are part of the broker, which of these are + running. + +force + return a RabbitMQ node to its virgin state. + Removes the node from any cluster it belongs to, removes all data + from the management database, such as configured users, vhosts and + deletes all persistent messages. + +force_reset + the same as I<force> command, but resets the node unconditionally, + regardless of the current management database state and cluster + configuration. + It should only be used as a last resort if the database or cluster + configuration has been corrupted. + +cluster I<clusternode> ... + instruct the node to become member of a cluster with the specified + nodes determined by I<clusternode> option(s). + See http://www.rabbitmq.com/clustering.html for more information + about clustering. + +=head2 USER MANAGEMENT + +add_user I<username> I<password> + create a user named I<username> with (initial) password I<password>. + +change_password I<username> I<newpassword> + change the password for the user named I<username> to I<newpassword>. + +list_users + list all users. + +=head2 ACCESS CONTROL + +add_vhost I<vhostpath> + create a new virtual host called I<vhostpath>. + +delete_vhost I<vhostpath> + delete a virtual host I<vhostpath>. + That command deletes also all its exchanges, queues and user mappings. + +list_vhosts + list all virtual hosts. + +map_user_vhost I<username> I<vhostpath> + grant the user named I<username> access to the virtual host called + I<vhostpath>. + +unmap_user_vhost I<username> I<vhostpath> + deny the user named I<username> access to the virtual host called + I<vhostpath>. + +list_user_vhost I<username> + list all the virtual hosts to which the user named I<username> has + been granted access. + +=head1 EXAMPLES + +Create a user named foo with (initial) password bar at the Erlang node +rabbit@test: + + rabbitmqctl -n rabbit@test add_user foo bar + +Grant user named foo access to the virtual host called test at the +default Erlang node: + + rabbitmqctl map_user_vhost foo test =head1 SEE ALSO -rabbitmq-server(1), rabbitmqctl_real(1), rabbitmq-multi(1) +rabbitmq-multi(1), rabbitmq-server(1) =head1 AUTHOR diff --git a/docs/rabbitmqctl_real.pod b/docs/rabbitmqctl_real.pod deleted file mode 100644 index f52eb394..00000000 --- a/docs/rabbitmqctl_real.pod +++ /dev/null @@ -1,141 +0,0 @@ -=head1 NAME - -rabbitmqctl_real - command line tool for managing a RabbitMQ broker - -=head1 SYNOPSIS - -rabbitmqctl_real [-n I<node>] I<<command>> [command options] - -=head1 DESCRIPTION - -RabbitMQ is an implementation of AMQP, the emerging standard for high -performance enterprise messaging. The RabbitMQ server is a robust and -scalable implementation of an AMQP broker. - -rabbitmqctl_real is a command line tool for managing a RabbitMQ broker. -It performs all actions by connecting to one of the broker's node. -rabbitmqctl_real is called by the rabbitmqctl(1) wrapper to be -correctly executed with I<rabbitmq> user permissions. - - -=head1 OPTIONS - -B<-n> I<node> - default node is C<rabbit@server>, where server is the local host. - On a host named C<server.example.com>, the node name of the RabbitMQ - Erlang node will usually be rabbit@server (unless NODENAME has been - set to some non-default value at broker startup time). - The output of hostname -s is usually the correct suffix to use - after the "@" sign. See rabbitmq-server(1) for details of configur- - ing the RabbitMQ broker. - - -=head1 COMMANDS - -=head2 APPLICATION AND CLUSTER MANAGEMENT - -stop - stop the Erlang node on which RabbitMQ broker is running. - -stop_app - stop the RabbitMQ application, leaving the Erlang node running. - This command is typically run prior to performing other management - actions that require the RabbitMQ application to be stopped, - e.g. I<reset>. - -start_app - start the RabbitMQ application. - This command is typically run prior to performing other management - actions that require the RabbitMQ application to be stopped, - e.g. I<reset>. - -status - display various information about the RabbitMQ broker, such as - whether the RabbitMQ application on the current node, its version - number, what nodes are part of the broker, which of these are - running. - -force - return a RabbitMQ node to its virgin state. - Removes the node from any cluster it belongs to, removes all data - from the management database, such as configured users, vhosts and - realms, and deletes all persistent messages. - -force_reset - the same as I<force> command, but resets the node unconditionally, - regardless of the current management database state and cluster - configuration. - It should only be used as a last resort if the database or cluster - configuration has been corrupted. - -cluster I<clusternode> ... - instruct the node to become member of a cluster with the specified - nodes determined by I<clusternode> option(s). - See http://www.rabbitmq.com/clustering.html for more information - about clustering. - -=head2 USER MANAGEMENT - -add_user I<username> I<password> - create a user named I<username> with (initial) password I<password>. - -change_password I<username> I<newpassword> - change the password for the user named I<username> to I<newpassword>. - -list_users - list all users. - -=head2 ACCESS CONTROL - -add_vhost I<vhostpath> - create a new virtual host called I<vhostpath>. - -delete_vhost I<vhostpath> - delete a virtual host I<vhostpath>. - That command deletes also all its exchanges, queues and user mappings. - -list_vhosts - list all virtual hosts. - -map_user_vhost I<username> I<vhostpath> - grant the user named I<username> access to the virtual host called - I<vhostpath>. - -unmap_user_vhost I<username> I<vhostpath> - deny the user named I<username> access to the virtual host called - I<vhostpath>. - -list_user_vhost I<username> - list all the virtual hosts to which the user named I<username> has - been granted access. - -=head1 EXAMPLES - -Create a user named foo with (initial) password bar at the Erlang node -rabbit@test: - - rabbitmqctl -n rabbit@test add_user foo bar - -Grant user named foo access to the virtual host called test at the -default Erlang node: - - rabbitmqctl map_user_vhost foo test - -=head1 SEE ALSO - -rabbitmq-server(1), rabbitmqctl(1), rabbitmqctl_real(1) - -=head1 AUTHOR - -Originally written by The RabbitMQ Team <info@lshift.net> - -=head1 COPYRIGHT - -This package, the RabbitMQ server is licensed under the MPL. - -If you have any questions regarding licensing, please contact us at -info@rabbitmq.com. - -=head1 REFERENCES - -RabbitMQ Web Site: http://www.rabbitmq.com diff --git a/packaging/RPMS/Fedora/rabbitmq-server.spec b/packaging/RPMS/Fedora/rabbitmq-server.spec index 87530f6e..d1a70e88 100644 --- a/packaging/RPMS/Fedora/rabbitmq-server.spec +++ b/packaging/RPMS/Fedora/rabbitmq-server.spec @@ -58,6 +58,8 @@ mv %{buildroot}/usr/sbin/rabbitmqctl %{buildroot}/usr/sbin/rabbitmqctl_real cp ../rabbitmqctl_wrapper %{buildroot}/usr/sbin/rabbitmqctl chmod 0755 %{buildroot}/usr/sbin/rabbitmqctl +cp %{buildroot}%{_mandir}/man1/rabbitmqctl.1.gz %{buildroot}%{_mandir}/man1/rabbitmqctl_real.1.gz + %post # create rabbitmq group if ! getent group rabbitmq >/dev/null; then diff --git a/packaging/debs/Debian/debian/rules b/packaging/debs/Debian/debian/rules index 3e05863a..e230aec5 100644 --- a/packaging/debs/Debian/debian/rules +++ b/packaging/debs/Debian/debian/rules @@ -14,5 +14,6 @@ install/rabbitmq-server:: rm $(RABBIT_LIB)/LICENSE* mv $(DEB_DESTDIR)usr/sbin/rabbitmqctl $(DEB_DESTDIR)usr/sbin/rabbitmqctl_real cp debian/rabbitmqctl_wrapper $(DEB_DESTDIR)usr/sbin/rabbitmqctl + cp $(DEB_DESTDIR)usr/share/man/man1/rabbitmqctl.1.gz $(DEB_DESTDIR)usr/share/man/man1/rabbitmqctl_real.1.gz chmod a+x $(DEB_DESTDIR)usr/sbin/rabbitmqctl echo "Tag: usr-lib-in-arch-all" > $(DEB_DESTDIR)usr/share/linda/overrides/rabbitmq-server diff --git a/packaging/windows/Makefile b/packaging/windows/Makefile index 077461c5..f9437da7 100644 --- a/packaging/windows/Makefile +++ b/packaging/windows/Makefile @@ -15,6 +15,7 @@ dist: rm -rf $(SOURCE_DIR)/scripts rm -rf $(SOURCE_DIR)/codegen* $(SOURCE_DIR)/Makefile rm -f $(SOURCE_DIR)/BUILD + rm -rf $(SOURCE_DIR)/docs mv $(SOURCE_DIR) $(TARGET_DIR) zip -r $(TARGET_ZIP).zip $(TARGET_DIR) |