Skip to content

Commit 81da40d

Browse files
author
Simon MacMullen
committed
Update the man page.
1 parent 29088e0 commit 81da40d

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/rabbitmqctl.1.xml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -163,20 +163,28 @@
163163
</varlistentry>
164164

165165
<varlistentry>
166-
<term><cmdsynopsis><command>wait</command></cmdsynopsis></term>
166+
<term><cmdsynopsis><command>wait</command> <arg choice="req"><replaceable>pid_file</replaceable></arg></cmdsynopsis></term>
167167
<listitem>
168168
<para>
169169
Wait for the RabbitMQ application to start.
170170
</para>
171171
<para>
172172
This command will wait for the RabbitMQ application to
173-
start at the node. As long as the Erlang node is up but
174-
the RabbitMQ application is down it will wait
175-
indefinitely. If the node itself goes down, or takes
176-
more than five seconds to come up, it will fail.
173+
start at the node. It will wait for the pid file to
174+
be created, then for a process with a pid specified in the
175+
pid file to start, and then for the RabbitMQ application
176+
to start in that process. It will fail if the process
177+
terminates without starting the RabbitMQ application.
178+
</para>
179+
<para>
180+
A suitable pid file is created by
181+
the <command>rabbitmq-server</command> script. By
182+
default this is located in the Mnesia directory. Modify
183+
the <command>RABBITMQ_PID_FILE</command> environment
184+
variable to change the location.
177185
</para>
178186
<para role="example-prefix">For example:</para>
179-
<screen role="example">rabbitmqctl wait</screen>
187+
<screen role="example">rabbitmqctl wait /var/run/rabbitmq/pid</screen>
180188
<para role="example">
181189
This command will return when the RabbitMQ node has
182190
started up.

0 commit comments

Comments
 (0)