EekBoek quick start guide
Using EekBoek for the first time can be confusing, not only because it was originally conceived in Dutch, but also because the configurations and options may be hard to find. The following assumes that you have a working operating system with the latest version of EekBoek installed and a terminal window logged in as a user with the ability to run sudo commands (root privileges).
Setting up an administration
Type the following to enter the EekBoek environment in english:
LANG=en_US.UTF-8 ebshell
The ebshell is the environment in which all EekBoek commands can be entered. If this is the first time you log into the EekBoek environment, you will now be presented with an interactive menu consisting of 6 questions. These questions help to set up an administration for you. After completion, there is a directory under $HOME/.eekboek/admdir with the name of the administration that contains the set of configuration files. So, if the administration is called eekboek_test_2015, then the configuration files will be stored under $HOME/.eekboek/admdir/eekboek_test_2015.
Type help to get a list of commands. Type the following command to find help on that command:
help
For instance help memoriaal.
Syntax
The following syntax is used in the booking examples below:
- ? = optional
- * = zero or more
- + = one or more
- | = alternatives
Booking formats
Inkoopfactuur: | inkoop(:nr)? date description crediteur (--totaal=amount)? regel+ |
Verkoopfactuur: | verkoop(:nr)? date description debiteur (--totaal=amount)? regel+ |
Bankafschrift: | bank(:nr)? date description (crd_regel | deb_regel | std_regel)+ |
Kas: | kas(:nr)? date description (crd_regel | deb_regel | std_regel)+ |
Memoriaal: | memoriaal(:nr)? date description (crd_regel | deb_regel | std_regel)+ |
crd_regel: | crd date? crediteur amount |
deb_regel: | deb date? debiteur amount |
std_regel: | std date? regel |
regel: | description amount account |
Entering bookings
EekBoek bookings can be entered in the following format:
[kas|bank|inkoop|verkoop]:[booking number] [date] [description] [relation] memoriaal [date] [description] [relation]
Example:
verkoop:12 20xx-10-20 "Consulting hours" ACME
For backdated bookings, use the following format:
[kas|bank|inkoop|verkoop]:[year]:[accountnumber] [date] [description] [relation]
Example:
verkoop:2006:12 20xx-10-20 "Consulting hours" ACME
Removing bookings
To remove bookings, use the following command:
verwijder
for the last entered booking, or:
verwijder verkoop:12
to remove the booking with the specified booking number.
Leaving EekBoek
Type quit to leave the EekBoek environment.