diff options
-rw-r--r-- | docs/rabbitmq-echopid.xml | 31 |
1 files changed, 20 insertions, 11 deletions
diff --git a/docs/rabbitmq-echopid.xml b/docs/rabbitmq-echopid.xml index b5f41478..d3dcea52 100644 --- a/docs/rabbitmq-echopid.xml +++ b/docs/rabbitmq-echopid.xml @@ -28,21 +28,30 @@ <refsect1> <title>Description</title> <para> - 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 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. </para> <para> -Running <command>rabbitmq-echopid</command> will attempt to discover and echo -the process id (PID) of the Erlang runtime process (erl.exe) that is hosting -RabbitMQ. To allow erl.exe time to start up and load RabbitMQ, the script -will wait for ten seconds before timing out if a suitable PID cannot be -found. + Running <command>rabbitmq-echopid</command> will attempt to + discover and echo the process id (PID) of the Erlang runtime + process (erl.exe) that is hosting RabbitMQ. To allow erl.exe + time to start up and load RabbitMQ, the script will wait for + ten seconds before timing out if a suitable PID cannot be + found. </para> <para> -If a PID is discovered, the script will echo it to stdout before exiting with -a ERRORLEVEL of 0. If no PID is discovered before the timeout, nothing is -written to stdout and the script exits setting ERRORLEVEL to 1. + If a PID is discovered, the script will echo it to stdout + before exiting with a ERRORLEVEL of 0. If no PID is + discovered before the timeout, nothing is written to stdout + and the script exits setting ERRORLEVEL to 1. + </para> + <para> + Note that this script only exists on Windows due to the need + to wait for erl.exe and possibly time-out. To obtain the PID + on Unix set RABBITMQ_PID_FILE before starting + rabbitmq-server and do not use "-detached". </para> </refsect1> |