Lortug Documentation
Prev		Next

Chapter 4. Creating Scripts

Table of Contents
The OPTIONS section
The VARS section
TOOLBAR sections
Command lists
Built-in Commands

Lortug uses script files to describe the layout of the toolbars it is to create and the commands attached to the toolbar components. Examples of these script files are located in the samples directory in the distribution and are copied to (prefix)/share/Lortug/samples during installation. The sample scripts contain comments explaining what they do.

Script files can be broken down into the following section types:

OPTIONS: Sets options for lortug that affect all toolbars.
VARS: Defines variables where toolbar components can store their state. Commands can also use variables as arguments and manipulate the value of variables.
TOOLBAR: This section defines the layout of a toolbar and attaches commands to its components.
NEW ROW: This command (which cannot be placed within any of the other section types) starts either a new row or column of toolbars (depending on the toolbar orietation set in the OPTIONS section).

With the exception of NEW ROW all the sections being with BEGIN [section type] and end with END [section type] (ie BEGIN OPTIONS). The script file parser is CASE SENSITIVE, so make sure that the BEGIN/END and section type names are capitals. Each command in a script file must be on its own line. Commands can be split onto multiple lines by using the \ continuation character at the end of the line. There can be only one each of the OPTIONS and VARS sections but as many NEW ROW commands and TOOLBAR sections as one wants in a script file. Comments can be placed in a scriptt file using the # character, when this character is encountered the parser will ignore the rest of the line.

The OPTIONS section

The OPTIONS section sets lortug options that affect all toolbars. The possible options are:

ORIENTATION = [VERT or HORZ]
Controls orientation of toolbars. Horizontal(HORZ) is default.
ICON_PATH = [path list]
Sets extra locations that are searched when looking for button icons. Lortug automatically looks for icons in the current directory, ~/.Lortug and (prefix)/share/Lortug. The paths in this list are searched also. The list should contain aboslute paths separated by :'s.
START_UP = [cmd list]
Sets commands that should be executed when lortug starts up (see Command Lists for more info).
SHUTDOWN = [cmd list]
Sets commands that should be executed when lortug shuts down (see Command Lists for more info).
SAVE_STATE = [list of toolbar components]
Sets the toolbar conmponents whose state should be saved and restored between shut down and start up of lortug. The list is a list of toolbar component names (see TOOLBARS for more info on toolbar component names) separated by |'s. Alternatively the keyword ALL can be used in place of the component list, when this is done all toolbar components will have their state saved and restored.
SAVE_VARS = [list of vars]
Sets the variables whose values should be saved and restored between shut down and start up of lortug. The list is a list of variable names separated by |'s (see VARS for more info on variable names).
TITLE = [window title]
Sets the title for the window that the toolbars are placed in.
POSITION = [x]+[y]
Sets the position for the window. [x] is the horizontal position and [y] is the vertical position.

The following example sets the toolbar orientation to vertical, adds /usr/local/share/pixmaps and /usr/share/pixmaps to the icon search path, tells lortug to save and restore the value of variables foo1 and foo2, sets the window title to "Lortug Example" and sets the window position to (200, 100).

BEGIN OPTIONS ORIENTATION = VERT ICON_PATH =
/usr/local/share/pixmaps:/usr/share/pixmaps SAVE_VARS = foo1 | foo2
TITLE = Lortug Example POSITION = 200+100 END OPTIONS

Note that the indenting in the example above is only done for aesthetic reasons, lortug itself doesn't care about it.