diff options
| author | Jim Apperly <jim@rabbitmq.com> | 2012-02-21 12:34:40 +0000 |
|---|---|---|
| committer | Jim Apperly <jim@rabbitmq.com> | 2012-02-21 12:34:40 +0000 |
| commit | dc644d0c3b3f382b1d86140e0f9f857218a06e54 (patch) | |
| tree | f439a9a41e525d2ac445f8cd5bf29ba0c8323710 | |
| parent | 8d21e4deb7e221054a6a2640150557f42a1d738d (diff) | |
| download | rabbitmq-server-dc644d0c3b3f382b1d86140e0f9f857218a06e54.tar.gz | |
Create man page for rabbitmq-echopid.bat
| -rw-r--r-- | Makefile | 2 | ||||
| -rw-r--r-- | docs/rabbitmq-echopid.xml | 62 |
2 files changed, 63 insertions, 1 deletions
@@ -17,7 +17,7 @@ BEAM_TARGETS=$(patsubst $(SOURCE_DIR)/%.erl, $(EBIN_DIR)/%.beam, $(SOURCES)) TARGETS=$(EBIN_DIR)/rabbit.app $(INCLUDE_DIR)/rabbit_framing.hrl $(BEAM_TARGETS) plugins WEB_URL=http://www.rabbitmq.com/ MANPAGES=$(patsubst %.xml, %.gz, $(wildcard $(DOCS_DIR)/*.[0-9].xml)) -WEB_MANPAGES=$(patsubst %.xml, %.man.xml, $(wildcard $(DOCS_DIR)/*.[0-9].xml) $(DOCS_DIR)/rabbitmq-service.xml) +WEB_MANPAGES=$(patsubst %.xml, %.man.xml, $(wildcard $(DOCS_DIR)/*.[0-9].xml) $(DOCS_DIR)/rabbitmq-service.xml $(DOCS_DIR)/rabbitmq-echopid.xml) USAGES_XML=$(DOCS_DIR)/rabbitmqctl.1.xml $(DOCS_DIR)/rabbitmq-plugins.1.xml USAGES_ERL=$(foreach XML, $(USAGES_XML), $(call usage_xml_to_erl, $(XML))) QC_MODULES := rabbit_backing_queue_qc diff --git a/docs/rabbitmq-echopid.xml b/docs/rabbitmq-echopid.xml new file mode 100644 index 00000000..b5f41478 --- /dev/null +++ b/docs/rabbitmq-echopid.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd"> +<refentry lang="en"> + <refentryinfo> + <productname>RabbitMQ Server</productname> + <authorgroup> + <corpauthor>The RabbitMQ Team <<ulink url="mailto:info@rabbitmq.com"><email>info@rabbitmq.com</email></ulink>></corpauthor> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>rabbitmq-echopid.bat</refentrytitle> + <refmiscinfo class="manual">RabbitMQ Server</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>rabbitmq-echopid.bat</refname> + <refpurpose>return the process id of the Erlang runtime hosting RabbitMQ</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>rabbitmq-echopid.bat</command> + <arg choice="req">sname</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <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. + </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. + </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. + </para> + </refsect1> + + <refsect1> + <title>Options</title> + <variablelist> + <varlistentry> + <term><cmdsynopsis><arg choice="req">sname</arg></cmdsynopsis></term> + <listitem> + <para role="usage"> +The short-name form of the RabbitMQ node name. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> |