otak home page

(Documentation)

SYNOPSIS

The directory $HOME/.otak is created when user is starting otak for the first time. It contains config and baseconfig files.

config is otak configuration file. It contains keys definitions and other options which are described in CONFIG part.

baseconfig is base configuration file. It defines what information about people will be collected. By default it contains: First and Surname, e-mail, cell phone, home page and comment. How the file should looks like is described in BASECONFIG part.

comments Comments in config and baseconfig files are lines beginning with #, or a line beginning with ## (whitespace before this will be ignored), and end with the next such line.

CONFIG

base.config.file = (filename) Variable defines where is the otak database config file. Default is "$HOME/.otak/baseconfig"

base.dir = (dirname) Variable defines where is the database dir. File "main" in directory, is the main database (default loaded). (Since version 1.2.0 otak supports more then one database file. See the help window for info about shortcuts). Default is "$HOME/.otak/base"

size.file = (filename) Variable defines where is the otak window-size file. (Window sizes are writing to this file when you quit otak). Default is "$HOME/.otak/wins"

cmd.on.enter = (stanza_name) where (stanza_name) is a name of section of baseconfig. BASECONFIG describes how to create these beasts. stanza`s name that is called after enter has been pressed. If someone want to use otak as a cell phone book he should write here "sms". If someone want to use otak as a email adress book he should write here "email". ("email" is a default value).

menu.title = (stanza_name) Field to be displayed in main list (on people screen). Default value is name.

show.query = (stanza_name) Field to be displayed after successful query. (when the --query option were given) Default value is "email".(for mutt query ;^) .nf

hide.wininfo = (bool) where (bool) is true/false, 1/0 etc. Defines whether show the info window. It could be helpfull, because it limits screen`s operation to minimum. Default is false.

show.intro = (bool) Defines whether show start intro. Maybe someone like ASCII art :). Default is false.

toolbar.up = (bool) Defines whether show toolbar on the top of the screen. Default is true.

read.size.file = (bool) Defines if read window sieze file. Default is true.

big.windows = (bool) Defines whether show biger windows. (varible read.size.file must be true). Default is false.

sort.base = (bool) Defines if sort data base before write. Default is true.

show.labels = (bool) Defines (for info window) if show label`s name and item caption or just item caption.
e.g:
"-) name: FooBar" or "-) FooBar".
Default is false.

arrow.string = (string) Above this varible is to "-) ". Default is "-) ".

silent = (bool) Quiet; Do not write anything to standard output (Do not display error messages too). Default is false.

no.messages = (bool) Like a silent, but suppress error messages about noexistent or unreadable files (or tsys errors). Default is true;

Entries below define keys for particular commands. Value is any letter.
remove.key
add.key
edit.key
back.key
quit.key
move.key
load.key

BASECONFIG

introduction: By default the baseconfig file is in directory $HOME/.otak. It can be given as argument after -B option, or set in otak config file.

[stanza_name] stanza`s name in square brackets [] Every new stanza definiton has to start from the name put into [] (square brackets). After this you can set values.
for instance: [sms], [music].

Setting values (stanza definition) :

label = element`s name Value of label that is shown on the edition (data) screen. For instance:
label=Play some music

key = (any letter) This variables define, shortcut for this field.

multiple = (bool) This variables define, whether this field could have many values in database.
for instance: One name is enough, but we want to collect a few e-mails.

command = (command-name) Name of command which is called by the program. All stanza-name are exported, and then passed to the shell.
e.g:
command = mutt "$name ($email)"
command = sms $sms "Hi $name, $text /mee"
Sometimes (when text=true), you can use special $text varible.

text = (bool) when this variable is true, otak asks you before using command to write some text down. After this shell varible $text is set to the entered text.
To see some example look at /etc/otak/baseconfig.