root
/
rabbitmq-server
mirror of https://github.com/rabbitmq/rabbitmq-server.git
1
0
Fork 0
Code Issues Actions 4 Packages Projects Releases Wiki Activity
rabbitmq-server/deps/rabbit/docs/rabbitmq-echopid.8

71 lines
2.3 KiB
Groff
Raw Normal View History

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]
2017-04-25 16:50:00 +08:00
.\" vim:ft=nroff:
Switch to Mozilla Public License 2.0 (MPL 2.0)
2020-07-10 21:31:17 +08:00
.\" This Source Code Form is subject to the terms of the Mozilla Public
.\" License, v. 2.0. If a copy of the MPL was not distributed with this
.\" file, You can obtain one at https://mozilla.org/MPL/2.0/.
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]
2017-04-25 16:50:00 +08:00
.\"
Update copyright (year 2020)
2020-03-10 22:36:02 +08:00
.\" Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved.
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]
2017-04-25 16:50:00 +08:00
.\"
man pages: bump revision dates
2019-09-28 16:05:25 +08:00
.Dd September 28, 2019
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]
2017-04-25 16:50:00 +08:00
.Dt RABBITMQ-ECHOPID.BAT 8
.Os "RabbitMQ Server"
.Sh NAME
.Nm rabbitmq-echopid.bat
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
.Nd returns the Windows process id of the Erlang runtime running RabbitMQ
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]
2017-04-25 16:50:00 +08:00
.\" ------------------------------------------------------------------
.Sh SYNOPSIS
.\" ------------------------------------------------------------------
.Nm
.Ar sname
.\" ------------------------------------------------------------------
.Sh DESCRIPTION
.\" ------------------------------------------------------------------
Man page edits and updates * Clarifications, less obscure or Erlang-centric language * Link to relevant doc guides * Prefer "mirror" or "follower" over "slave" * Reduce the number or archaic versions mentioned
2019-01-25 17:41:43 +08:00
RabbitMQ is an open source multi-protocol messaging broker.
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]
2017-04-25 16:50:00 +08:00
.Pp
Running
.Nm
will attempt to discover and echo the process id (PID) of the Erlang
runtime process
.Pq Pa erl.exe
that is hosting RabbitMQ.
To allow
.Pa 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.
.Pp
If a PID is discovered, the script will echo it to stdout
before exiting with a
.Ev ERRORLEVEL
of 0.
If no PID is discovered before the timeout, nothing is written to stdout
and the script exits setting
.Ev ERRORLEVEL
to 1.
.Pp
Note that this script only exists on Windows due to the need to wait for
.Pa erl.exe
and possibly time-out.
To obtain the PID on Unix set
.Ev RABBITMQ_PID_FILE
before starting
.Xr rabbitmq-server 8
and do not use
.Fl detached .
.\" ------------------------------------------------------------------
.Sh OPTIONS
.\" ------------------------------------------------------------------
.Bl -tag -width Ds
.It Ar sname
The short-name form of the RabbitMQ node name.
.El
.\" ------------------------------------------------------------------
.Sh SEE ALSO
.\" ------------------------------------------------------------------
.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