Skip to main content
Version: Next

RabbitMQ man Pages

Source Files​

These pages contain source files that reside in the server repository.

After cloning that repository in addition to this one, you can regenerate the HTML manpages using the update-manpages.sh script:

./website/docs/man/update-manpages.sh /path/to/rabbitmq-server

The script takes care of calling make(1) to generate the files.

Contributions​

Since these files 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.

Adding a New Man Page​

When a new man page is added, its contents as generated by mandoc have to be copied into this directory. A new wrapper DocBook page must be added to the parent (site) directory, see site/rabbitmq-diagnostics.8.xml for example.