189 lines
4.1 KiB
Groff
189 lines
4.1 KiB
Groff
.TH hackerbase 1 "hackerbase, May 26 2023"
|
|
|
|
.SH "NAME"
|
|
hackerbase - HackerSpace Members Database tool
|
|
|
|
.SH "SYNOPSIS"
|
|
|
|
.SY hackerbase
|
|
.R [
|
|
.B \-h
|
|
.R |
|
|
.B \-license
|
|
.R ]
|
|
.YS
|
|
|
|
.SY hackerbase
|
|
.B \-info
|
|
.OP \-mi id
|
|
.OP \-mn nick
|
|
.OP "OPTIONS ..."
|
|
.YS
|
|
|
|
.SY hackerbase
|
|
.R [
|
|
.B \-print
|
|
.R |
|
|
.B \-blame
|
|
.R |
|
|
.B \-edit
|
|
.R ]
|
|
.R [
|
|
.B \-mi
|
|
.R id |
|
|
.B \-mn
|
|
.R nick ]
|
|
.OP "OPTIONS ..."
|
|
.YS
|
|
|
|
.SY hackerbase
|
|
.R [
|
|
.B \-fees
|
|
.R |
|
|
.B \-problems
|
|
.R |
|
|
.B \-status
|
|
.R |
|
|
.B \-unpaired
|
|
.R |
|
|
.B \-idstats
|
|
.R |
|
|
.B \-genid
|
|
.R |
|
|
.B \-mlcheck
|
|
.R |
|
|
.B \-mlsync
|
|
.R |
|
|
.B \-notify
|
|
.R |
|
|
.B \-notify3
|
|
.R |
|
|
.B \-summary
|
|
.R ]
|
|
.OP "OPTIONS ..."
|
|
.YS
|
|
|
|
.SH "ACTIONS"
|
|
|
|
|
|
|
|
.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.
|
|
|
|
.TP
|
|
.B \-from \fRemail
|
|
Specify sender email address. The value read from configuration file
|
|
can be overriden by this option.
|
|
|
|
.TP
|
|
.B \-sendmail
|
|
Actually send emails for all email-sending actions. Without this
|
|
option, the email headers and body is only printed to standard output.
|
|
|
|
.TP
|
|
.B \-mailto \fRemail
|
|
Override all outgoing emails destination. Can be used for testing what
|
|
the recipients actually receive by sending notifications to different
|
|
email address and check whether the contents of the email are really
|
|
as required.
|
|
|
|
.TP
|
|
.B \-logfile \fRfilename
|
|
Enable logging to file. Mainly useful for running from cron. Adds
|
|
timestamps to log messages.
|
|
|
|
.TP
|
|
.B \-quiet
|
|
Suppress all progress output.
|
|
|
|
.TP
|
|
.B \-mi \fRid
|
|
Specify member by ID.
|
|
|
|
.TP
|
|
.B \-mn \fRnick
|
|
Specify member by nickname.
|
|
|
|
.TP
|
|
.B \-destroyed
|
|
Show destroyed members in \fB-fees\fR action as well.
|
|
|
|
.TP
|
|
.B \-ml-all
|
|
Load all mailman list memberships to show them in members info.
|
|
|
|
.SH "FILES"
|
|
.SH "CONFIGURATION"
|
|
.SH "COPYRIGHT"
|
|
|
|
Copyright (c) 2023 Brmlab, z.s.
|
|
|
|
.MT dominik.pantucek@trustica.cz
|
|
Dominik Pantůček
|
|
.ME
|
|
|
|
.B ISC License
|
|
|
|
Permission to use, copy, modify, and/or distribute this software
|
|
for any purpose with or without fee is hereby granted, provided
|
|
that the above copyright notice and this permission notice appear
|
|
in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
|
|
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
|
|
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
|
|
AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
|
|
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
|
|
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
|
|
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
|
|
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
.SH "AUTHOR"
|
|
Dominik Pantůček <dominik.pantucek@trustica.cz>
|