From c6c893e5acd674f2513ec9e7ee7c785c4395da4d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Fri, 26 May 2023 15:27:04 +0200 Subject: [PATCH] Add basic options descriptions. --- doc/hackerbase.1 | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/doc/hackerbase.1 b/doc/hackerbase.1 index f423e94..f86791c 100644 --- a/doc/hackerbase.1 +++ b/doc/hackerbase.1 @@ -65,7 +65,53 @@ hackerbase - HackerSpace Members Database tool .SH "OPTIONS" +.TP +.B \-config \fRfname +Initial configuration file name - should be a full path. See +\fBCONFIGURATION\fR for more information. +.TP +.B \-members \fRdir +Members base directory with all members files. See \fBFILES\fR for +more information. The value read from configuration file can be +overriden by this option. + +.TP +.B \-month \fRYYYY-MM +Specify current month to see the situation at particular point in time +- usually in the past. It also sets the current day to the 1st day of +the specified month. + +.TP +.B \-today \fRYYYY-MM-DD +Specify current day as with previous option. This does not affect the +computation of membership fees and payments. It does however affect +the organizational bodies membership or other members properties +recorded with day precision. + +.TP +.B \-tstyle \fR[ debug | ascii | unicode ] +Use given style for table borders and separators. Defaults to "unicode". + +.TP +.B \-apikey \fRfname +File with Fio API keys. See \fBFILES\fR for more information. The +value read from configuration file can be overriden by this option. + +.TP +.B \-bankdir \fRdir +Directory for storing bank account statement CSV files. The value read +from configuration file can be overriden by this option. A working +"parts/" subdirectory is created by bank account statements downloader +(hb_fetch_fio) in this directory for the purpose of handling +incremental account statement downloads from the bank. + +.TP +.B \-checked \fRfile +File containing the ID of the latest known incoming bank transaction +across all bank account statements. The value read from configuration +file can be overriden by this option. This file is used for the +\fB\-unpaired\fR action. .SH "FILES" .SH "CONFIGURATION"