diff options
| author | Jean-Sébastien Pédron <jean-sebastien@rabbitmq.com> | 2017-04-25 10:50:00 +0200 |
|---|---|---|
| committer | Jean-Sébastien Pédron <jean-sebastien@rabbitmq.com> | 2017-04-26 18:24:27 +0200 |
| commit | c0af14ba3b98d4e028274fa326144223cb508b5c (patch) | |
| tree | 528e2231c4ccd80a10be3da79485e8e385b216e7 /docs/rabbitmq-env.conf.5 | |
| parent | 775a41579c6ed5dd046aaed0eb5eacf8a48460f7 (diff) | |
| download | rabbitmq-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-env.conf.5')
| -rw-r--r-- | docs/rabbitmq-env.conf.5 | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/docs/rabbitmq-env.conf.5 b/docs/rabbitmq-env.conf.5 new file mode 100644 index 0000000000..4d86d672e4 --- /dev/null +++ b/docs/rabbitmq-env.conf.5 @@ -0,0 +1,86 @@ +.\" 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-ENV.CONF 5 +.Os "RabbitMQ Server" +.Sh NAME +.Nm rabbitmq-env.conf +.Nd default settings for RabbitMQ AMQP server +.\" ------------------------------------------------------------------ +.Sh DESCRIPTION +.\" ------------------------------------------------------------------ +.Nm +contains variable settings that override the defaults built in to the +RabbitMQ startup scripts. +.Pp +The file is interpreted by the system shell, and so should consist of a +sequence of shell environment variable definitions. +Normal shell syntax is permitted (since the file is sourced using the +shell "." operator), including line comments starting with "#". +.Pp +In order of preference, the startup scripts get their values from the +environment, from +.Nm +and finally from the built-in default values. +For example, for the +.Ev RABBITMQ_NODENAME +setting, +.Ev RABBITMQ_NODENAME +from the environment is checked first. +If it is absent or equal to the empty string, then +.Ev NODENAME +from +.Nm +is checked. +If it is also absent or set equal to the empty string then the default +value from the startup script is used. +.Pp +The variable names in +.Nm +are always equal to the environment variable names, with the +.Qq RABBITMQ_ +prefix removed: +.Ev RABBITMQ_NODE_PORT +from the environment becomes +.Ev NODE_PORT +in +.Nm , +etc. +.\" ------------------------------------------------------------------ +.Sh EXAMPLES +.\" ------------------------------------------------------------------ +Here is an example of a complete +.Nm +file that overrides the default Erlang node name from "rabbit" to +"hare". +.sp +.Dl # I am a complete rabbitmq-env.conf file. +.Dl # Comment lines start with a hash character. +.Dl # This is a /bin/sh script file - use ordinary envt var syntax +.Dl NODENAME=hare +.\" ------------------------------------------------------------------ +.Sh SEE ALSO +.\" ------------------------------------------------------------------ +.Xr rabbitmq-echopid 8 , +.Xr rabbitmq-plugins 8 , +.Xr rabbitmq-server 8 , +.Xr rabbitmq-service 8 , +.Xr rabbitmqctl 8 +.\" ------------------------------------------------------------------ +.Sh AUTHOR +.\" ------------------------------------------------------------------ +.An The RabbitMQ Team Aq Mt info@rabbitmq.com |
