aboutsummaryrefslogtreecommitdiff
path: root/rabbitmq-c/README
diff options
context:
space:
mode:
authorEugen Wissner <belka@caraus.de>2026-09-22 23:32:38 +0200
committerEugen Wissner <belka@caraus.de>2026-09-22 23:32:38 +0200
commit93c11444174013050aac719fd9c48d79e6b7fa66 (patch)
treec8b5465c82d4fb528ecfeba1fdf10699d34217d8 /rabbitmq-c/README
parentb9f03cb474149ad5388f1d9c150f4e03b971a0ef (diff)
downloadslackbuilds-93c11444174013050aac719fd9c48d79e6b7fa66.tar.gz
librabbitmq-c: Renamed to rabbitmq-c
Diffstat (limited to 'rabbitmq-c/README')
-rw-r--r--rabbitmq-c/README55
1 files changed, 55 insertions, 0 deletions
diff --git a/rabbitmq-c/README b/rabbitmq-c/README
new file mode 100644
index 0000000..5eda5e7
--- /dev/null
+++ b/rabbitmq-c/README
@@ -0,0 +1,55 @@
+This is a C-language AMQP client library for use with v2.0+ of the
+RabbitMQ broker.
+
+* `BUILD_EXAMPLES=ON/OFF` toggles building the examples.
+ OFF by default.
+
+* `BUILD_SHARED_LIBS=ON/OFF` toggles building rabbitmq-c as a shared
+ library.
+ ON by default.
+
+* `BUILD_STATIC_LIBS=ON/OFF` toggles building rabbitmq-c as a static
+ library.
+ OFF by default.
+
+* `BUILD_TESTS=ON/OFF` toggles building test code.
+ OFF by default.
+
+* `BUILD_TOOLS=ON/OFF` toggles building the command line tools.
+ ON by default.
+
+* `BUILD_TOOLS_DOCS=ON/OFF` toggles building the man pages for the
+ command line tools.
+ ON by default if BUILD_TOOLS is ON and xmlto is installed.
+
+* `ENABLE_SSL_SUPPORT=ON/OFF` toggles building rabbitmq-c with SSL
+ support.
+ ON by default if the OpenSSL headers and library can be found.
+
+* `BUILD_API_DOCS=ON/OFF` toggles building the Doxygen API documentation
+ OFF by default.
+
+* `RUN_SYSTEM_TESTS=ON/OFF` toggles building the system tests. Tests
+ require an accessible RabbitMQ server instance on localhost.
+ OFF by default.
+
+If BUILD_EXAMPLES=ON or BUILD_TESTS=ON then executable programs will
+be compiled from sources in /usr/doc/rabbitmq-c-$VERSION/examples/src/
+-and-or- /usr/doc/rabbitmq-c-$VERSION/examples/src/ The Extra Programs
+will be installed in /usr/doc/rabbitmq-c-$VERSION/{examples,tests}/bin/
+
+For Example, to build examples and tests:
+
+BUILD_EXAMPLES=ON BUILD_TESTS=ON ./rabbitmq-c.SlackBuild
+
+To build a nice html Doxygen API documentation tree in the directory
+/usr/doc/rabbitmq-c-$VERSION/html/ you need to pass BUILD_API_DOCS=ON
+to the script, for example
+
+ BUILD_API_DOCS=ON ./rabbitmq-c.SlackBuild
+
+To build examples, tests and the html documentation:
+
+BUILD_EXAMPLES=ON \
+BUILD_TESTS=ON \
+BUILD_API_DOCS=ON ./rabbitmq-c.SlackBuild