From 2cb84d18470cb59040c858f4ee0b495f8d5dc374 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Tue, 11 Apr 2023 23:06:59 +0200 Subject: [PATCH] Document the configuration file. --- doc/formats.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/doc/formats.md b/doc/formats.md index 8d50431..0414489 100644 --- a/doc/formats.md +++ b/doc/formats.md @@ -1,8 +1,8 @@ -Members Base +File Formats ============ -This file documents the internal structure of the members information -storage. +This file documents the internal structure of various file formats +used. Members Directory ----------------- @@ -15,10 +15,11 @@ Symlinks to the member files serve as human-readable aliases. The implementation handles situation when the human-readable name is the member file and the symlink is the four-digit member id. -Member File Parsing - Passes 0 and 1 ------------------------------------- +Key File Parsing - Passes 0 and 1 +--------------------------------- -Member files are read line-by-line. +All files are read line-by-line. This applies to both member file and +configuration file. ### Pass 0 @@ -112,8 +113,13 @@ If any of Mandatory keys is missing, it is filled with * phone -Member File Schema ------------------- +Configuration File Parsing - Pass 2 +----------------------------------- -nick - single word - alphabetical characters, underscore, dash, numbers +Basic passes 0 and 1 are performed and then only the following keys +are used to set initial values for runtime parameters: +* members-directory +* apikeys-file +* jendasap-checked +* bank-dir