summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorFlorent Le Coz <louiz@louiz.org>2014-06-24 20:47:07 +0200
committerFlorent Le Coz <louiz@louiz.org>2014-06-24 13:56:44 +0200
commit39175e1ad6fe6507bbe2874c6ce413cbe9c3366e (patch)
treebfe9fda3354ccc0ba437cfa959349d3ce7ab1c76 /INSTALL
parenta2d55e4bead65d211b1c84e3b2a2a55b70f852d8 (diff)
downloadbiboumi-39175e1ad6fe6507bbe2874c6ce413cbe9c3366e.tar.gz
biboumi-39175e1ad6fe6507bbe2874c6ce413cbe9c3366e.tar.bz2
biboumi-39175e1ad6fe6507bbe2874c6ce413cbe9c3366e.tar.xz
biboumi-39175e1ad6fe6507bbe2874c6ce413cbe9c3366e.zip
Little documentation update
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL27
1 files changed, 18 insertions, 9 deletions
diff --git a/INSTALL b/INSTALL
index 645b9be..fbe6623 100644
--- a/INSTALL
+++ b/INSTALL
@@ -4,6 +4,11 @@
Build and runtime dependencies:
+Tools:
+
+- A C++14 compiler (clang >= 3.4 or gcc >= 4.9 for example)
+- CMake
+- ronn (optional) to build the man page
Libraries:
@@ -34,11 +39,6 @@ Libraries:
Provides the support for a systemd service of Type=notify. This is useful only
if you are packaging biboumi in a distribution with Systemd.
-Tools:
-- A C++14 compiler (clang >= 3.4 or gcc >= 4.9 for example)
-- CMake
-- ronn (optional) to build the man page
-
==============
Configure
@@ -67,10 +67,10 @@ or
and respond to the questions when you are prompted to.
-You can select the poller used by biboumi, at compile-time, using the POLLER
-cmake option. Available values are:
- POLL: use the standard poll(2). This is the default value because it works on all supported plateforms
- EPOLL: use the Linux-specific epoll(7)
+You can, for example, select the poller used by biboumi, at compile-time,
+using the POLLER cmake option. Available values are:
+ EPOLL: use the Linux-specific epoll(7). This is the default on Linux.
+ POLL: use the standard poll(2). This is the default value on all non-Linux platforms.
Example, configure the poller with cmake:
% cmake . -DPOLLER=EPOLL
@@ -92,3 +92,12 @@ Example, configure the poller with cmake:
- Install the software system-wide
# make install
+
+
+=============
+ Run
+=============
+
+Run the software using the `biboumi` binary. Read the documentation (the
+man page biboumi(1) or the “biboumi.1.md” file) for more information on how
+to use biboumi.