summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFlorent Le Coz <louiz@louiz.org>2013-12-08 20:33:36 +0100
committerFlorent Le Coz <louiz@louiz.org>2013-12-08 20:33:36 +0100
commitbb094e5058f0ee4b22e73b10166d0ca90fab559b (patch)
treeae582039cda6159789f390d4a489af61c72461e2 /doc
parent2aa868c7cc3a11b66f3326519f8d67b67b33b986 (diff)
downloadbiboumi-bb094e5058f0ee4b22e73b10166d0ca90fab559b.tar.gz
biboumi-bb094e5058f0ee4b22e73b10166d0ca90fab559b.tar.bz2
biboumi-bb094e5058f0ee4b22e73b10166d0ca90fab559b.tar.xz
biboumi-bb094e5058f0ee4b22e73b10166d0ca90fab559b.zip
Document the log_file and log_level configuration options
Diffstat (limited to 'doc')
-rw-r--r--doc/biboumi.112
-rw-r--r--doc/biboumi.md10
2 files changed, 22 insertions, 0 deletions
diff --git a/doc/biboumi.1 b/doc/biboumi.1
index 013ab77..3e472c8 100644
--- a/doc/biboumi.1
+++ b/doc/biboumi.1
@@ -36,6 +36,18 @@ The hostname served by the XMPP gateway\. This domain must be configured in th
.P
The password used to authenticate the XMPP component to your XMPP server\. This password must be configured in the XMPP server, associated with the external component on \fIhostname\fR\.
.
+.P
+\fBlog_file\fR
+.
+.P
+A filename into which logs are written\. If none is provided, the logs are written on standard output
+.
+.P
+\fBlog_level\fR
+.
+.P
+Indicate what type of log messages to write in the logs\. Values can be from 0 to 3\. 0 is debug, 1 is info, 2 is warnig, 3 is error\.
+.
.SH "USAGE"
When started, biboumi connects, without encryption (see \fISECURITY\fR), to the local XMPP server on the port \fB5347\fR and provides the configured password to authenticate\. Biboumi then serves the configured \fBhostname\fR, this means that all XMPP stanza with a \fBto\fR JID on that domain will be sent to biboumi, and biboumi will send only send messages coming from this hostname\.
.
diff --git a/doc/biboumi.md b/doc/biboumi.md
index 355445e..811b5c0 100644
--- a/doc/biboumi.md
+++ b/doc/biboumi.md
@@ -46,6 +46,16 @@ The configuration file uses a simple format of the form
This password must be configured in the XMPP server, associated with the
external component on *hostname*.
+`log_file`
+
+ A filename into which logs are written. If none is provided, the logs are
+ written on standard output
+
+`log_level`
+
+ Indicate what type of log messages to write in the logs. Values can be from 0 to 3.
+ 0 is debug, 1 is info, 2 is warnig, 3 is error.
+
USAGE
-----