source: doc/advanced.txt @ 675ce49

barnowl_perlaimdebianowlrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since 675ce49 was 675ce49, checked in by James M. Kretchmar <kretch@mit.edu>, 18 years ago
*** empty log message ***
  • Property mode set to 100644
File size: 3.3 KB
Line 
1                     ========================
2                     Owl Advanced Users Guide
3                     ========================
4
5
6=========================
7Section X: CUSTOM FILTERS
8=========================
9
10
11==========================
12Section X: THE CONFIG FILE
13==========================
14
15=======================
16Section X: KEY BINDINGS
17=======================
18
19
20=========================
21Section X: COMMAND ALISES
22=========================
23
24
25=================
26Section X: STYLES
27=================
28
29
30- - - - - - - - - - - - - - - - - - - - - - - - - - -
31
32
33For example, the following
34command will create a filter called 'mail' that maches any messages
35sent to the zephyr class 'mail':
36
37     filter mail class ^mail$
38
39The first argument after the filter command specifies the name of the
40filter to be created.  The text after that indicates that matching
41messages must have the zephyr class "mail".  For help understanding
42the '^' and '$' characters, consult a reference on regular
43expressions.  Note that all pattern matching in Owl is
44case-insensitive.
45
46The message fields that can be used in a filter command include:
47
48     sender        message sender
49     recipient     message recipient
50     class         zephyr class name
51     instance      zephyr instance name
52     opcode        zephyr opcode
53     realm         zephyr realm
54     body          message body
55     type          message type ('zephyr', 'aim', 'admin')
56     direction     either 'in' 'out' or 'none'\n"
57     login         either 'login' 'logout' or 'none'\n"
58
59You can also use the operators 'and' 'or' and 'not' as well as the
60values 'true' and 'false'.  Parentheses can be used to group
61expressions, though there must be spaces present before and after all
62parenthesis.  For example:
63
64   filter myfilt ( class ^foo$ ) or ( class ^quux$ and instance ^bar$ )
65
66If you define a filter using a filter name that already exists, it
67will overwrite the existing filter.  This can be a useful way to
68override the built-in filters.
69
70
71==========================
72Section 6: THE CONFIG FILE
73==========================
74
75*** WARNING: This interface may change substantially in the near future ***
76
77This file is interpreted by the perl interpreter.
78If you wish to execute an owl command use the
79function owl::command().  i.e.
80
81     owl::command("set zsigproc \"/mit/kretch/bin/getzsig foo\"");
82
83will set the owl variable zsigproc.  Note that commands will currently
84be executed in order after the called configuration subroutine exits.
85
86Subroutines created with the names below will be executed at the
87specified times:
88
89    subroutine name    properties
90    ---------------    ----------
91    owl::startup()     run when owl first starts
92    owl::shutdown()    run when owl exits
93    owl::format_msg()  run when a new message arrives, the return
94                          value is used to display the message on the
95                          screen
96    owl::receive_msg() run when a message is received, and after
97                       it has been added to the message list
98
99
100The following variables will be set each time a message is recevied:
101
102    $owl::class, $owl::instance, $owl::recipient,
103    $owl::sender, $owl::opcode, $owl::zsig,
104    $owl::msg, $owl::time, $owl::host, @owl::fields, $owl::id
105
106The "appendtosepbar" variable may be set in owl::format_msg()
107to set text to be appended to sepbar that separates the received
108message list from the edit window.
Note: See TracBrowser for help on using the repository browser.