From 015312a6a9bcc33cd627dbc07104a22b12924dbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Fri, 26 May 2023 17:30:28 +0200 Subject: [PATCH] Document basic configuration file structure. --- doc/formats.md | 2 ++ doc/hackerbase.1 | 16 +++++++++++++++- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/doc/formats.md b/doc/formats.md index ab01d35..892c5c0 100644 --- a/doc/formats.md +++ b/doc/formats.md @@ -124,6 +124,8 @@ are used to set initial values for runtime parameters: * apikeys-file * jendasap-checked * bank-dir +* email-from +* summary-mailto API Keys File ------------- diff --git a/doc/hackerbase.1 b/doc/hackerbase.1 index 58790ee..dfdf6ec 100644 --- a/doc/hackerbase.1 +++ b/doc/hackerbase.1 @@ -289,7 +289,21 @@ considered. .SH "CONFIGURATION" -it is in /etc/hackerbase +The default path with the initial hackerbase configuration is stored +in "/etc/hackerbase" but this can be overriden by \fB\-config\fR +command-line option. + +Before parsing the configuration file all comments are removed. The +comments start with the \fB#\fR character and continue until the end +of the line. + +All empty lines and lines containing only whitespace charecters are +removed. + +Remaining lines are parsed as follows - leading whitespace is stripped +and first token comprised of non-whitespace characters is taken as +configuration key. The remainder of the line without leading +whitespace is then taken as given configuration option value. .SH "EXAMPLES"