diff options
author | Hubert Plociniczak <hubert@lshift.net> | 2008-08-07 13:16:21 +0100 |
---|---|---|
committer | Hubert Plociniczak <hubert@lshift.net> | 2008-08-07 13:16:21 +0100 |
commit | 1c1055632923824ba1652ed32768bac50640005b (patch) | |
tree | c4a99c264619c0dd4f62c824ad47e7c3c0692775 /docs | |
parent | 1e7afa80295dd14190ae104df1266e8a04ffeed0 (diff) | |
download | rabbitmq-server-1c1055632923824ba1652ed32768bac50640005b.tar.gz |
Added 4 basic man pages.
Rabbitmqctl_real does not contain info
about realms and permissions since those
are to be removed either way.
Included pages in debian and rpm packages.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/rabbitmq-multi.1.pod | 52 | ||||
-rw-r--r-- | docs/rabbitmq-server.1.pod | 80 | ||||
-rw-r--r-- | docs/rabbitmqctl.1.pod | 37 | ||||
-rw-r--r-- | docs/rabbitmqctl_real.1.pod | 141 |
4 files changed, 310 insertions, 0 deletions
diff --git a/docs/rabbitmq-multi.1.pod b/docs/rabbitmq-multi.1.pod new file mode 100644 index 00000000..0f7aec52 --- /dev/null +++ b/docs/rabbitmq-multi.1.pod @@ -0,0 +1,52 @@ +=head1 NAME + +rabbitmq-multi - start/stop local cluster RabbitMQ nodes + +=head1 SYNOPSIS + +rabbitmq-multi I<command> [command option] + +=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. + +rabbitmq-multi scripts allows for easy set-up of a cluster on a single +machine. + +See also rabbitmq-server(1) for configuration information. + +=head1 COMMANDS + +start_all I<count> + start count nodes with unique names, listening on all IP addresses + and on sequential ports starting from 5672. + +stop_all + stop all local RabbitMQ nodes + +=head1 EXAMPLES + +Start 3 local RabbitMQ nodes with unique, sequential port numbers: + + rabbitmq-multi start_all 3 + +=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/docs/rabbitmq-server.1.pod b/docs/rabbitmq-server.1.pod new file mode 100644 index 00000000..bf411bc2 --- /dev/null +++ b/docs/rabbitmq-server.1.pod @@ -0,0 +1,80 @@ +=head1 NAME + +rabbitmq-server - start RabbitMQ AMQP server + +=head1 SYNOPSIS + +rabbitmq-server [-detached] + +=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. + +Running rabbitmq-server in the foreground displays a banner message, +and reports on progress in the startup sequence, concluding with the +message "broker running", indicating that the RabbitMQ broker has been +started successfully. To shut down the server, just terminate the +process or use rabbitmqctl(1). + +=head1 ENVIRONMENT + +B<MNESIA_BASE> + Defaults to /var/lib/rabbitmq/mnesia. Set this to the directory + where Mnesia database files should be placed. + +B<LOG_BASE> + Defaults to /var/log/rabbitmq. Log files generated by the server + will be placed in this directory. + +B<NODENAME> + Defaults to rabbit. This can be useful if you want to run more + than one node per machine - B<NODENAME> should be unique per + erlang-node-and-machine combination. See clustering on a single + machine guide + at http://www.rabbitmq.com/clustering.html#single-machine for + details. + +B<NODE_IP_ADDRESS> + Defaults to 0.0.0.0. This can be changed if you only want to bind + to one network interface. + +B<NODE_PORT> + Defaults to 5672. + +B<CLUSTER_CONFIG_FILE> + Defaults to /etc/default/rabbitmq_cluster.config. If this file is + present it is used by the server to auto-configure a RabbitMQ + cluster. + See the clustering guide at http://www.rabbitmq.com/clustering.html + for details. + +=head1 OPTIONS + +B<-detached> start the server process in the background + +=head1 EXAMPLES + +Run RabbitMQ AMQP server in the background: + + rabbitmq-server -detached + +=head1 SEE ALSO + +rabbitmq-multi(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/docs/rabbitmqctl.1.pod b/docs/rabbitmqctl.1.pod new file mode 100644 index 00000000..602cf751 --- /dev/null +++ b/docs/rabbitmqctl.1.pod @@ -0,0 +1,37 @@ +=head1 NAME + +rabbitmqctl - wrapper for the command line tool for managing a RabbitMQ broker + +=head1 SYNOPSIS + +rabbitmqctl 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 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. + +=head1 SEE ALSO + +rabbitmq-server(1), rabbitmqctl_real(1), rabbitmq-multi(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/docs/rabbitmqctl_real.1.pod b/docs/rabbitmqctl_real.1.pod new file mode 100644 index 00000000..f52eb394 --- /dev/null +++ b/docs/rabbitmqctl_real.1.pod @@ -0,0 +1,141 @@ +=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 |