diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 17 | ||||
| -rw-r--r-- | docs/rabbitmq-server.8 | 2 | ||||
| -rw-r--r-- | docs/rabbitmq.conf.example | 9 | ||||
| -rw-r--r-- | docs/rabbitmqctl.8 | 5 |
4 files changed, 32 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md index 74bce06870..7efad23cf1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,3 +8,20 @@ This directory contains [CLI tool](https://rabbitmq.com/cli.html) man page sourc * A [systemd unit file example](./rabbitmq-server.service.example) Please [see rabbitmq.com](https://rabbitmq.com/documentation.html) for documentation guides. + +## man Pages + +### Source Files + +This directory contains man pages that are are converted to HTML using `mandoc`: + + gmake web-manpages + +The result is then copied to the [website repository](https://github.com/rabbitmq/rabbitmq-website/tree/live/site/man) + +### Contributions + +Since deployed man pages are generated, it is important to keep them in sync with the source. +Accepting community contributions — which will always come as website pull requests — +is fine but the person who merges them is responsible for backporting all changes +to the source pages in this repo. diff --git a/docs/rabbitmq-server.8 b/docs/rabbitmq-server.8 index 84772aa042..4c469d25d0 100644 --- a/docs/rabbitmq-server.8 +++ b/docs/rabbitmq-server.8 @@ -74,7 +74,7 @@ Defaults to 5672. .Sh OPTIONS .\" ------------------------------------------------------------------ .Bl -tag -width Ds -.It Fl -detached +.It Fl detached Start the server process in the background. Note that this will cause the pid not to be written to the pid file. .Pp diff --git a/docs/rabbitmq.conf.example b/docs/rabbitmq.conf.example index 2a373b2eb3..a62ed38291 100644 --- a/docs/rabbitmq.conf.example +++ b/docs/rabbitmq.conf.example @@ -503,8 +503,17 @@ # Kernel section # ====================================== +## Timeout used to detect peer unavailability, including CLI tools. +## Related doc guide: https://www.rabbitmq.com/nettick.html. +## # net_ticktime = 60 +## Inter-node communication port range. +## Related doc guide: https://www.rabbitmq.com/networking.html#epmd-inet-dist-port-range. +## +# inet_dist_listen_min = 25672 +# inet_dist_listen_max = 25692 + ## ---------------------------------------------------------------------------- ## RabbitMQ Management Plugin ## diff --git a/docs/rabbitmqctl.8 b/docs/rabbitmqctl.8 index c99170d175..524da897d1 100644 --- a/docs/rabbitmqctl.8 +++ b/docs/rabbitmqctl.8 @@ -73,6 +73,11 @@ for details of configuring the RabbitMQ broker. .It Fl q , -quiet Quiet output mode is selected. Informational messages are suppressed when quiet mode is in effect. +.It Fl s , -silent +Silent output mode is selected. +Informational messages and table headers are suppressed when silent mode is in effect. +.It Fl -no-table-headers +Do not output headers for tabular data. .It Fl -dry-run Do not run the command. Only print information message. |