diff --git a/doc/hackerbase.1 b/doc/hackerbase.1 index d6efdab..b8df018 100644 --- a/doc/hackerbase.1 +++ b/doc/hackerbase.1 @@ -3,6 +3,8 @@ .SH "NAME" hackerbase - HackerSpace Members Database tool +See \fBEXAMPLES\fR for a quick start guide. + .SH "SYNOPSIS" .SY hackerbase @@ -446,6 +448,105 @@ summary-mailto rada@brmlab.cz .SH "EXAMPLES" +These examples provide a quick start guide for using this tool in +common situations. + +.SS "Allocating an ID for a New Member" + +To allocate a new but unused valid member id, use: + +.RS +.EX +hackerbase -genid +.EE +.RE + +.SS "Creating a New Member" + +Currently this has to be performed manually. + +Firstly allocate a new ID (see above). + +Go to members base directory - the git repository specified by the +\fBmembers-directory\fR configuration option or \fB\-members\fR +command-line option. Create a file with the name containing only the +new 4-digit id. Add mandatory fields: + +.RS +.EX +cat <1234 +nick NickName +name GivenName SurName +mail user.name@domain.tld +phone +420123456789 +joined 2023-05 +EOF +.EE +.RE + +The "1234" must be replaced with the newly allocated member ID and +"2023-05" with the first month this member is an actual member. Then a +compatibility symbolic link has to be created: + +.RS +.EX +ln -s NickName 1234 +.EE +.RE + +After checking the correctnes of the new member file, everything +should be commited to the git repository: + +.RS +.EX +git add 1234 NickName +git commit -am "council-member: added new member NickName" +.EE +.RE + +The "council-member" part should be replaced with the nickname of the +council member performing the addition. + +.SS "Checking for Problems" + +To see any members and/or member files with problems, use: + +.RS +.EX +hackerbase -problems +.EE +.RE + +See \fB\-problems\fR action above for more details. + +.SS "Overview" + +To get the overview, use the generic information action: + +.RS +.ES +hackerbase -info +.EE +.RE + +This prints the current members of all organizational bodies, active +members, suspended members, soon-to-expire suspended members and +debtors with debt greater than membership fee for three months. + +.SS "Export Data for BrmDoor" + +BrmDoor project expects separate files for generic RFID cards and +desfire cards. To generate the files, used: + +.RS +.EX +hackerbase -gencards cards.txt cards_desfiter.txt +.EE +.RE + +Any filenames can be used but the names used in examples are what the +BrmDoor expects. + .SH "COPYRIGHT" Copyright (c) 2023 Brmlab, z.s.