Skip to content

Commit df67e4d

Browse files
author
Matthew Sackman
committed
merging in from default
2 parents 01c0100 + ae00b84 commit df67e4d

File tree

6 files changed

+392
-242
lines changed

6 files changed

+392
-242
lines changed

docs/rabbitmq-activate-plugins.1.pod

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
=head1 NAME
22

3-
rabbitmq-activate-plugins - command line tool for activating plugins in a RabbitMQ broker
3+
rabbitmq-activate-plugins - command line tool for activating plugins
4+
in a RabbitMQ broker
45

56
=head1 SYNOPSIS
67

@@ -12,8 +13,8 @@ RabbitMQ is an implementation of AMQP, the emerging standard for high
1213
performance enterprise messaging. The RabbitMQ server is a robust and
1314
scalable implementation of an AMQP broker.
1415

15-
rabbitmq-activate-plugins is a command line tool for activating plugins installed
16-
into the broker's plugins directory.
16+
rabbitmq-activate-plugins is a command line tool for activating
17+
plugins installed into the broker's plugins directory.
1718

1819
=head1 EXAMPLES
1920

@@ -24,12 +25,13 @@ execute:
2425

2526
=head1 SEE ALSO
2627

27-
rabbitmq.conf(5), rabbitmq-multi(1), rabbitmq-server(1), rabbitmqctl(1)
28+
L<rabbitmq.conf(5)>, L<rabbitmq-multi(1)>, L<rabbitmq-server(1)>,
29+
L<rabbitmqctl(1)>
2830

2931
=head1 AUTHOR
3032

3133
The RabbitMQ Team <[email protected]>
3234

3335
=head1 REFERENCES
3436

35-
RabbitMQ Web Site: http://www.rabbitmq.com
37+
RabbitMQ Web Site: L<http://www.rabbitmq.com>

docs/rabbitmq-multi.1.pod

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,30 @@ scalable implementation of an AMQP broker.
1515
rabbitmq-multi scripts allows for easy set-up of a cluster on a single
1616
machine.
1717

18-
See also rabbitmq-server(1) for configuration information.
18+
See also L<rabbitmq-server(1)> for configuration information.
1919

2020
=head1 COMMANDS
2121

22-
start_all I<count>
23-
start count nodes with unique names, listening on all IP addresses
24-
and on sequential ports starting from 5672.
22+
=over
2523

26-
status
27-
print the status of all running RabbitMQ nodes
24+
=item start_all I<count>
2825

29-
stop_all
30-
stop all local RabbitMQ nodes
26+
Start count nodes with unique names, listening on all IP addresses and
27+
on sequential ports starting from 5672.
3128

32-
rotate_logs
33-
rotate log files for all local and running RabbitMQ nodes
29+
=item status
30+
31+
Print the status of all running RabbitMQ nodes.
32+
33+
=item stop_all
34+
35+
Stop all local RabbitMQ nodes,
36+
37+
=item rotate_logs
38+
39+
Rotate log files for all local and running RabbitMQ nodes.
40+
41+
=back
3442

3543
=head1 EXAMPLES
3644

@@ -40,12 +48,12 @@ Start 3 local RabbitMQ nodes with unique, sequential port numbers:
4048

4149
=head1 SEE ALSO
4250

43-
rabbitmq.conf(5), rabbitmq-server(1), rabbitmqctl(1)
51+
L<rabbitmq.conf(5)>, L<rabbitmq-server(1)>, L<rabbitmqctl(1)>
4452

4553
=head1 AUTHOR
4654

4755
The RabbitMQ Team <[email protected]>
4856

4957
=head1 REFERENCES
5058

51-
RabbitMQ Web Site: http://www.rabbitmq.com
59+
RabbitMQ Web Site: L<http://www.rabbitmq.com>

docs/rabbitmq-server.1.pod

Lines changed: 39 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,41 +16,57 @@ Running rabbitmq-server in the foreground displays a banner message,
1616
and reports on progress in the startup sequence, concluding with the
1717
message "broker running", indicating that the RabbitMQ broker has been
1818
started successfully. To shut down the server, just terminate the
19-
process or use rabbitmqctl(1).
19+
process or use L<rabbitmqctl(1)>.
2020

2121
=head1 ENVIRONMENT
2222

23-
B<RABBITMQ_MNESIA_BASE>
24-
Defaults to /var/lib/rabbitmq/mnesia. Set this to the directory
25-
where Mnesia database files should be placed.
23+
=over
2624

27-
B<RABBITMQ_LOG_BASE>
28-
Defaults to /var/log/rabbitmq. Log files generated by the server
29-
will be placed in this directory.
25+
=item B<RABBITMQ_MNESIA_BASE>
3026

31-
B<RABBITMQ_NODENAME>
32-
Defaults to rabbit. This can be useful if you want to run more
33-
than one node per machine - B<RABBITMQ_NODENAME> should be unique per
27+
Defaults to F</var/lib/rabbitmq/mnesia>. Set this to the directory where
28+
Mnesia database files should be placed.
29+
30+
=item B<RABBITMQ_LOG_BASE>
31+
32+
Defaults to F</var/log/rabbitmq>. Log files generated by the server will
33+
be placed in this directory.
34+
35+
=item B<RABBITMQ_NODENAME>
36+
37+
Defaults to rabbit. This can be useful if you want to run more than
38+
one node per machine - B<RABBITMQ_NODENAME> should be unique per
3439
erlang-node-and-machine combination. See clustering on a single
3540
machine guide at
36-
http://www.rabbitmq.com/clustering.html#single-machine for details.
41+
L<http://www.rabbitmq.com/clustering.html#single-machine> for details.
42+
43+
=item B<RABBITMQ_NODE_IP_ADDRESS>
44+
45+
Defaults to 0.0.0.0. This can be changed if you only want to bind to
46+
one network interface.
3747

38-
B<RABBITMQ_NODE_IP_ADDRESS>
39-
Defaults to 0.0.0.0. This can be changed if you only want to bind
40-
to one network interface.
48+
=item B<RABBITMQ_NODE_PORT>
4149

42-
B<RABBITMQ_NODE_PORT>
43-
Defaults to 5672.
50+
Defaults to 5672.
4451

45-
B<RABBITMQ_CLUSTER_CONFIG_FILE>
46-
Defaults to /etc/rabbitmq/rabbitmq_cluster.config. If this file is
52+
=item B<RABBITMQ_CLUSTER_CONFIG_FILE>
53+
54+
Defaults to F</etc/rabbitmq/rabbitmq_cluster.config>. If this file is
4755
present it is used by the server to auto-configure a RabbitMQ cluster.
48-
See the clustering guide at http://www.rabbitmq.com/clustering.html
56+
See the clustering guide at L<http://www.rabbitmq.com/clustering.html>
4957
for details.
5058

59+
=back
60+
5161
=head1 OPTIONS
5262

53-
B<-detached> start the server process in the background
63+
=over
64+
65+
=item B<-detached>
66+
67+
start the server process in the background
68+
69+
=back
5470

5571
=head1 EXAMPLES
5672

@@ -60,12 +76,13 @@ Run RabbitMQ AMQP server in the background:
6076

6177
=head1 SEE ALSO
6278

63-
rabbitmq.conf(5), rabbitmq-multi(1), rabbitmqctl(1)
79+
L<rabbitmq.conf(5)>, L<rabbitmq-multi(1)>, L<rabbitmqctl(1)>
6480

6581
=head1 AUTHOR
6682

6783
The RabbitMQ Team <[email protected]>
6884

6985
=head1 REFERENCES
7086

71-
RabbitMQ Web Site: http://www.rabbitmq.com
87+
RabbitMQ Web Site: L<http://www.rabbitmq.com>
88+

docs/rabbitmq.conf.5.pod

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
=head1 NAME
22

3-
/etc/rabbitmq/rabbitmq.conf - default settings for RabbitMQ AMQP server
3+
F</etc/rabbitmq/rabbitmq.conf> - default settings for RabbitMQ AMQP
4+
server
45

56
=head1 DESCRIPTION
67

7-
/etc/rabbitmq/rabbitmq.conf contains variable settings that override the
8+
F</etc/rabbitmq/rabbitmq.conf> contains variable settings that override the
89
defaults built in to the RabbitMQ startup scripts.
910

1011
The file is interpreted by the system shell, and so should consist of
@@ -13,27 +14,35 @@ syntax is permitted (since the file is sourced using the shell "."
1314
operator), including line comments starting with "#".
1415

1516
In order of preference, the startup scripts get their values from the
16-
environment, from /etc/rabbitmq/rabbitmq.conf and finally from the
17-
built-in default values. For example, for the B<RABBITMQ_NODENAME> setting,
17+
environment, from F</etc/rabbitmq/rabbitmq.conf> and finally from the
18+
built-in default values. For example, for the B<RABBITMQ_NODENAME>
19+
setting,
1820

19-
B<RABBITMQ_NODENAME>
20-
from the environment is checked first. If it is absent or equal to
21-
the empty string, then
21+
=over
2222

23-
B<NODENAME>
24-
from /etc/rabbitmq/rabbitmq.conf is checked. If it is also absent
23+
=item B<RABBITMQ_NODENAME>
24+
25+
from the environment is checked first. If it is absent or equal to the
26+
empty string, then
27+
28+
=item B<NODENAME>
29+
30+
from L</etc/rabbitmq/rabbitmq.conf> is checked. If it is also absent
2531
or set equal to the empty string then the default value from the
2632
startup script is used.
2733

2834
The variable names in /etc/rabbitmq/rabbitmq.conf are always equal to the
2935
environment variable names, with the B<RABBITMQ_> prefix removed:
3036
B<RABBITMQ_NODE_PORT> from the environment becomes B<NODE_PORT> in the
31-
/etc/rabbitmq/rabbitmq.conf file, etc.
37+
F</etc/rabbitmq/rabbitmq.conf> file, etc.
38+
39+
=back
3240

3341
=head1 EXAMPLES
3442

35-
The following is an example of a complete /etc/rabbitmq/rabbitmq.conf file
36-
that overrides the default Erlang node name from "rabbit" to "hare":
43+
The following is an example of a complete
44+
F</etc/rabbitmq/rabbitmq.conf> file that overrides the default Erlang
45+
node name from "rabbit" to "hare":
3746

3847
# I am a complete /etc/rabbitmq/rabbitmq.conf file.
3948
# Comment lines start with a hash character.
@@ -42,7 +51,7 @@ that overrides the default Erlang node name from "rabbit" to "hare":
4251

4352
=head1 SEE ALSO
4453

45-
rabbitmq-server(1), rabbitmq-multi(1), rabbitmqctl(1)
54+
L<rabbitmq-server(1)>, L<rabbitmq-multi(1)>, L<rabbitmqctl(1)>
4655

4756
=head1 AUTHOR
4857

@@ -57,4 +66,4 @@ [email protected].
5766

5867
=head1 REFERENCES
5968

60-
RabbitMQ Web Site: http://www.rabbitmq.com
69+
RabbitMQ Web Site: L<http://www.rabbitmq.com>

0 commit comments

Comments
 (0)