summaryrefslogtreecommitdiff
path: root/docs/rabbitmq-server.8
diff options
context:
space:
mode:
authorJean-Sébastien Pédron <jean-sebastien@rabbitmq.com>2017-04-25 10:50:00 +0200
committerJean-Sébastien Pédron <jean-sebastien@rabbitmq.com>2017-04-26 18:24:27 +0200
commitc0af14ba3b98d4e028274fa326144223cb508b5c (patch)
tree528e2231c4ccd80a10be3da79485e8e385b216e7 /docs/rabbitmq-server.8
parent775a41579c6ed5dd046aaed0eb5eacf8a48460f7 (diff)
downloadrabbitmq-server-git-c0af14ba3b98d4e028274fa326144223cb508b5c.tar.gz
docs: Convert manpages from DocBook to mdoc(7)
Writing those manpages directly in the target markup language allows to use its full expressiveness, unlike the generated output from DocBook. To create their HTML versions, we use mandoc(1), plus a small awk script to adapt the generated HTML to our needs. I tried groff(1) and man2html(1) but the former transforms nearly everything to simple <p> and the later tries to reproduce the rendering of a manpage in a terminal. Manpages in section 1 are moved to section 8 because they are commands to manage a system service, not general purpose commands. This commits requires a change in the website to integrate the new generated HTML manpages. [#143563295]
Diffstat (limited to 'docs/rabbitmq-server.8')
-rw-r--r--docs/rabbitmq-server.896
1 files changed, 96 insertions, 0 deletions
diff --git a/docs/rabbitmq-server.8 b/docs/rabbitmq-server.8
new file mode 100644
index 0000000000..84772aa042
--- /dev/null
+++ b/docs/rabbitmq-server.8
@@ -0,0 +1,96 @@
+.\" vim:ft=nroff:
+.\" The contents of this file are subject to the Mozilla Public License
+.\" Version 1.1 (the "License"); you may not use this file except in
+.\" compliance with the License. You may obtain a copy of the License
+.\" at http://www.mozilla.org/MPL/
+.\"
+.\" Software distributed under the License is distributed on an "AS IS"
+.\" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+.\" the License for the specific language governing rights and
+.\" limitations under the License.
+.\"
+.\" The Original Code is RabbitMQ.
+.\"
+.\" The Initial Developer of the Original Code is Pivotal Software, Inc.
+.\" Copyright (c) 2007-2017 Pivotal Software, Inc. All rights reserved.
+.\"
+.Dd April 25, 2017
+.Dt RABBITMQ-SERVER 8
+.Os "RabbitMQ Server"
+.Sh NAME
+.Nm rabbitmq-server
+.Nd start RabbitMQ AMQP server
+.\" ------------------------------------------------------------------
+.Sh SYNOPSIS
+.\" ------------------------------------------------------------------
+.Nm
+.Op Fl detached
+.\" ------------------------------------------------------------------
+.Sh 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.
+.Pp
+Running
+.Nm
+in the foreground displays a banner message, and reports on progress in
+the startup sequence, concluding with the message
+.Qq broker running ,
+indicating that the RabbitMQ broker has been started successfully.
+To shut down the server, just terminate the process or use
+.Xr rabbitmqctl 8 .
+.\" ------------------------------------------------------------------
+.Sh ENVIRONMENT
+.\" ------------------------------------------------------------------
+.Bl -tag -width Ds
+.It Ev RABBITMQ_MNESIA_BASE
+Defaults to
+.Pa /var/lib/rabbitmq/mnesia .
+Set this to the directory where Mnesia database files should be placed.
+.It Ev RABBITMQ_LOG_BASE
+Defaults to
+.Pa /var/log/rabbitmq .
+Log files generated by the server will be placed in this directory.
+.It Ev RABBITMQ_NODENAME
+Defaults to
+.Qq rabbit .
+This can be useful if you want to run more than one node per machine -
+.Ev RABBITMQ_NODENAME
+should be unique per erlang-node-and-machine combination.
+See the
+.Lk http://www.rabbitmq.com/clustering.html#single-machine "clustering on a single machine guide"
+for details.
+.It Ev RABBITMQ_NODE_IP_ADDRESS
+By default RabbitMQ will bind to all interfaces, on IPv4 and IPv6 if
+available.
+Set this if you only want to bind to one network interface or address
+family.
+.It Ev RABBITMQ_NODE_PORT
+Defaults to 5672.
+.El
+.\" ------------------------------------------------------------------
+.Sh OPTIONS
+.\" ------------------------------------------------------------------
+.Bl -tag -width Ds
+.It Fl -detached
+Start the server process in the background.
+Note that this will cause the pid not to be written to the pid file.
+.Pp
+For example, runs RabbitMQ AMQP server in the background:
+.sp
+.Dl rabbitmq-server -detached
+.El
+.\" ------------------------------------------------------------------
+.Sh SEE ALSO
+.\" ------------------------------------------------------------------
+.Xr rabbitmq-env.conf 5 ,
+.Xr rabbitmq-echopid 8 ,
+.Xr rabbitmq-plugins 8 ,
+.Xr rabbitmq-service 8 ,
+.Xr rabbitmqctl 8
+.\" ------------------------------------------------------------------
+.Sh AUTHOR
+.\" ------------------------------------------------------------------
+.An The RabbitMQ Team Aq Mt info@rabbitmq.com