Changeset c82b055 for doc/intro.txt
- Timestamp:
- Jul 26, 2003, 1:36:36 PM (22 years ago)
- Branches:
- master, barnowl_perlaim, debian, owl, release-1.10, release-1.4, release-1.5, release-1.6, release-1.7, release-1.8, release-1.9
- Children:
- 87c6ef1
- Parents:
- a7a42b9
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/intro.txt
r675ce49 rc82b055 336 336 owl::command("set zsigproc \"/mit/kretch/bin/getzsig foo\""); 337 337 338 will set the owl variable zsigproc. Note that commands will currently 339 be executed in order after the called configuration subroutine exits. 338 will set the owl variable zsigproc. 340 339 341 340 Subroutines created with the names below will be executed at the … … 346 345 owl::startup() run when owl first starts 347 346 owl::shutdown() run when owl exits 348 owl::format_msg() run when a new message arrives, the return349 350 screen347 owl::format_msg() run to format messages when using the perl style. 348 The return value is used to display the message on the 349 screen. 351 350 owl::receive_msg() run when a message is received, and after 352 351 it has been added to the message list 353 352 354 355 The following variables will be set each time a message is recevied: 356 357 $owl::class, $owl::instance, $owl::recipient, 358 $owl::sender, $owl::opcode, $owl::zsig, 359 $owl::msg, $owl::time, $owl::host, @owl::fields, $owl::id 353 Both owl::format_msg and owl::receive_msg are passed 354 perl owl::Message objects which contain attributes of the message. 355 Please see the advanced.txt file for further documentation 356 of the Perl extension API. 360 357 361 358 The "appendtosepbar" variable may be set in owl::format_msg() … … 368 365 ========================================== 369 366 367 Aliases 368 ------- 369 370 Command aliases allow users to create shortcuts 371 for commonly used commands. Aliases can be created wit 372 the alias command: 373 374 alias NAME VALUE 375 376 For example: 377 378 alias zw zwrite 379 380 Will make "zw" an alias for the zwrite command. As such, "zw aphacker" 381 will be expanded to "zwrite aphacker". If the value of an 382 alias is multiple words, use of the alias will result in the alias 383 command name being replaced by the sequence of words. 384 Any arguments following the alias name will be appended 385 after the expanded alias value. For example: 386 387 alias vs view -s 388 389 will result in "vs standard" being expanded to "view -s standard". 390 There is not yet any way to allow an alias to take arguments 391 that will be inserted in the middle of the expansion. 392 393 394 Separating Commands 395 ------------------- 396 397 Multiple commands can be grouped together with parentheses 398 and then separated by semicolons. For example: 399 400 ( smartnarrow ; delete view ; expunge ; view all ) 401 402 Will result in the four commands being executed 403 in sequence. This is particularly useful with key bindings 404 and coommands. For example: 405 406 alias sn-delete ( smartnarrow ; delete view ) 407 408 will create an "sn-delete" alias that will smartnarrow 409 to a view and them mark the view for deletion. 410 411 Using "show commands" will list all existing aliases. 412 413 414 Key Bindings 415 ------------ 416 417 New key bindings may be created with the "bindkey" command. Each key 418 binding is associated with a particular keymap which is applicable in 419 a particular context/situation. When the key associated with a 420 binding is pressed in the right context, it will result in an owl 421 command being run. The syntax is: 422 423 bindkey <keymap> <keyseq> command <command> 424 425 For example: 426 427 bindkey recv C-k command delete 428 429 will bind Control-k to the delete command, but only in the 430 recv window context. 431 432 Some keymaps inherit their bindings from more 433 general keymaps. The valid keymaps are: 434 435 - global - owl-wide defaults (apply everywhere) 436 |-edit - all text editing and command windows 437 | |-editmulti - multi-line text editing windows 438 | |-editline - single-line editing and command windows 439 | |-editresponse - single-line responses to questions 440 |-popless - scrolling pop-up windows 441 |-recv - the main message list window 442 where received messages are displayed 443 444 The existing key bindings can be shown with "show keymaps". 445 The use of "show commands" will list all available commands. 446 Note that not all commands may be used in all contexts. 447 448 Key sequences may be surrounded by quotes and include 449 a sequence of keys that must be pressed in order 450 to execute the command. For example: 451 452 bindkey recv "C-s v" command view -s vt 453 454 will result in "Control-s" followed by "v" in the recv window 455 causing the command "view -s vt" to be run. 456 457 370 458 371 459 ==============================
Note: See TracChangeset
for help on using the changeset viewer.