brmlab/hackerbase
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Document basic configuration file structure.

Browse source
This commit is contained in:
Dominik Pantůček 2023-05-26 17:30:28 +02:00
parent e83d12add5
commit 015312a6a9
2 changed files with 17 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/formats.md
View file

@ -124,6 +124,8 @@ are used to set initial values for runtime parameters:
* apikeys-file * apikeys-file
* jendasap-checked * jendasap-checked
* bank-dir * bank-dir
* email-from
* summary-mailto
API Keys File API Keys File
------------- -------------

16
doc/hackerbase.1
View file

@ -289,7 +289,21 @@ considered.
.SH "CONFIGURATION" .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" .SH "EXAMPLES"