- Timestamp:
- Jan 12, 2013, 1:43:13 PM (12 years ago)
- Children:
- e3a0d71, 4485285
- Parents:
- 4626016
- git-author:
- Jason Gross <jgross@mit.edu> (01/12/13 13:13:18)
- git-committer:
- Jason Gross <jgross@mit.edu> (01/12/13 13:43:13)
- Location:
- doc
- Files:
-
- 4 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/advanced.txt
rc82b055 r7869e48 44 44 type message type ('zephyr', 'aim', 'admin') 45 45 direction either 'in' 'out' or 'none'\n" 46 login either 'login' 'logout' or 'none'\n" 46 login either 'login' 'logout' or 'none'\n" 47 47 48 48 You can also use the operators 'and' 'or' and 'not' as well as the … … 64 64 *** WARNING: This interface is still evolving and may change over time *** 65 65 66 The ~/.owlconf file is interpreted by the perl interpreter. 66 The ~/.owlconf file is interpreted by the perl interpreter. 67 67 You may specify an alternate file by running owl with "owl -c <configfile>". 68 68 … … 76 76 owl::format_msg() run to format messages when using the perl style. 77 77 The return value is used to display the message on the 78 screen. 78 screen. 79 79 owl::receive_msg() run when a message is received, and after 80 80 it has been added to the message list … … 87 87 owl::command('set zsigproc "/mit/kretch/bin/getzsig foo"'); 88 88 89 will set the owl variable zsigproc to 89 will set the owl variable zsigproc to 90 90 the value "/mit/kretch/bin/getzsig foo". 91 91 Note that you will need to watch out for perl quoting issues. … … 93 93 94 94 Both owl::format_msg and owl::receive_msg are passed perl owl::Message 95 objects which have methods for accessing the attributes of the message. 95 objects which have methods for accessing the attributes of the message. 96 96 97 97 (Caveat: Note that these owl::Message objects are currently only … … 154 154 } 155 155 156 In the above, $m is the owl::Message object and 156 In the above, $m is the owl::Message object and 157 157 its methods are called with $m->METHODNAME. 158 158 159 An example receiver function that tags all zephyr pings for 159 An example receiver function that tags all zephyr pings for 160 160 deletion would be: 161 161 … … 187 187 If you use pperl instead of perl, the return value 188 188 of the perl command will be displayed in a pop-up window. 189 This is particularly useful within key bindings 189 This is particularly useful within key bindings 190 190 and aliases. For example: 191 191 … … 193 193 194 194 Will cause the "finger" command to be used to finger at the host 195 where the current message came from. You can then bind this 195 where the current message came from. You can then bind this 196 196 to the "f" key with: 197 197 -
doc/barnowl.1
r8135737 r7869e48 36 36 \fB\-c\fP, \fB\-\-config\-file\fP=\fIFILE\fP 37 37 Specify an alternate config file for \fBBarnOwl\fP to use. The config file is 38 an arbitrary Perl script evaluated in the \fImain\fP package, and if it 39 overrides the \fIBarnOwl::startup\fP method that is run when \fBBarnOwl\fP 40 starts. (Compare \fI~/.owl/startup\fP, which contains \fBBarnOwl\fP commands 38 an arbitrary Perl script evaluated in the \fImain\fP package, and if it 39 overrides the \fIBarnOwl::startup\fP method that is run when \fBBarnOwl\fP 40 starts. (Compare \fI~/.owl/startup\fP, which contains \fBBarnOwl\fP commands 41 41 that are run at startup after the config file is loaded.) 42 42 43 By default, \fBBarnOwl\fP uses the first of \fI~/.owl/init.pl\fP, 43 By default, \fBBarnOwl\fP uses the first of \fI~/.owl/init.pl\fP, 44 44 \fI~/.barnowlconf\fP, or \fI~/.owlconf\fP that exists. 45 45 -
doc/code.txt
rd40ad8b r7869e48 16 16 is owl_function_command("foo"); 17 17 Commands are only active within specific contexts, 18 and attempts to call them from invalid contexts will fail. 18 and attempts to call them from invalid contexts will fail. 19 19 20 context: A context specifies the current state of owl, in terms 20 context: A context specifies the current state of owl, in terms 21 21 of which modal window is active and which point 22 22 in its life owl is in (eg, in startup, or running). 23 This is implemented as a bitmask and there is 23 This is implemented as a bitmask and there is 24 24 some hierarchy. Commands may restrict themselves 25 25 to only running in a limited number of contexts … … 34 34 Sometimes also referred to as typewin. 35 35 36 filter: Patterns which match messages. These may 37 contain multiple filterelements which may be 36 filter: Patterns which match messages. These may 37 contain multiple filterelements which may be 38 38 combined together (eg, by "and" and "or"). 39 40 filterelement: An element of a filter which matches on some 39 40 filterelement: An element of a filter which matches on some 41 41 attribute of a message. 42 42 … … 44 44 These are particularly useful for building up 45 45 text regions that are to be rendered on-screen, 46 as they resize memory as needed, and they have 46 as they resize memory as needed, and they have 47 47 routines for cropping as needed. 48 48 … … 55 55 owl.h defines "g" as a singleton instance of owl_global. 56 56 Where possible/appropriate, most accesses to global data should 57 be from a limited number of files (eg, from owl.c and 57 be from a limited number of files (eg, from owl.c and 58 58 functions.c). Consider whether you really need to before 59 59 adding in uses of global. … … 103 103 Also contains the main loop, which is roughly: 104 104 - handle scheduled resizes, and anything that might result 105 - while zephyrs are pending, grab incoming zephyrs 105 - while zephyrs are pending, grab incoming zephyrs 106 106 and handle them (which includes formatting them 107 107 with either perl extension or default formatter … … 109 109 - updates mainwin display if there are new zephyrs 110 110 - displays and updates popwins and the terminal as necessary 111 - sends characters to the popwin, recwin/mainwin, 111 - sends characters to the popwin, recwin/mainwin, 112 112 or typewin/editwin 113 113 … … 118 118 Created by codelist.pl. 119 119 120 popwin: Modal pop-up window container. 120 popwin: Modal pop-up window container. 121 121 Usually contains a viewwin for read-only scrolling text. 122 122 … … 126 126 127 127 util: Misc utility functions that don't fit anywhere yet: 128 - sepbar rendering 128 - sepbar rendering 129 129 - tokenizing and parsing utilities 130 130 - downstr … … 186 186 something, and this should be the exception to the rule. 187 187 188 Owl should be generally useful out-of-the-box without 189 extensive configuration, for most people's needs. 188 Owl should be generally useful out-of-the-box without 189 extensive configuration, for most people's needs. 190 190 People shouldn't have to spend days tweaking 191 191 with config files before being happy switching to it. -
doc/intro.txt
rd7cc50b r7869e48 188 188 variable. For example: 189 189 190 set personalbell on 190 set personalbell on 191 191 192 192 will set the value of the variable 'personalbell' to 'on'. The … … 347 347 owl::format_msg() run to format messages when using the perl style. 348 348 The return value is used to display the message on the 349 screen. 349 screen. 350 350 owl::receive_msg() run when a message is received, and after 351 351 it has been added to the message list … … 424 424 For example: 425 425 426 bindkey recv C-k command delete 427 428 will bind Control-k to the delete command, but only in the 426 bindkey recv C-k command delete 427 428 will bind Control-k to the delete command, but only in the 429 429 recv window context. 430 430 431 Some keymaps inherit their bindings from more 431 Some keymaps inherit their bindings from more 432 432 general keymaps. The valid keymaps are: 433 433 … … 438 438 | |-editresponse - single-line responses to questions 439 439 |-popless - scrolling pop-up windows 440 |-recv - the main message list window 440 |-recv - the main message list window 441 441 where received messages are displayed 442 442 … … 445 445 Note that not all commands may be used in all contexts. 446 446 447 Key sequences may be surrounded by quotes and include 447 Key sequences may be surrounded by quotes and include 448 448 a sequence of keys that must be pressed in order 449 449 to execute the command. For example:
Note: See TracChangeset
for help on using the changeset viewer.