Changeset 7869e48 for doc


Ignore:
Timestamp:
Jan 12, 2013, 1:43:13 PM (11 years ago)
Author:
Jason Gross <jgross@mit.edu>
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)
Message:
Remove trailing whitespace

This commit was made with the command sequence

    for i in $(git ls-files | tr '\n' ' ');
    do
      echo $i; sed -i s'/\s\+$//g' "$(readlink -f $i)";
    done
Location:
doc
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • doc/advanced.txt

    rc82b055 r7869e48  
    4444     type          message type ('zephyr', 'aim', 'admin')
    4545     direction     either 'in' 'out' or 'none'\n"
    46      login         either 'login' 'logout' or 'none'\n" 
     46     login         either 'login' 'logout' or 'none'\n"
    4747
    4848You can also use the operators 'and' 'or' and 'not' as well as the
     
    6464*** WARNING: This interface is still evolving and may change over time ***
    6565
    66 The ~/.owlconf file is interpreted by the perl interpreter. 
     66The ~/.owlconf file is interpreted by the perl interpreter.
    6767You may specify an alternate file by running owl with "owl -c <configfile>".
    6868
     
    7676    owl::format_msg()  run to format messages when using the perl style.
    7777                       The return value is used to display the message on the
    78                        screen. 
     78                       screen.
    7979    owl::receive_msg() run when a message is received, and after
    8080                       it has been added to the message list
     
    8787     owl::command('set zsigproc "/mit/kretch/bin/getzsig foo"');
    8888
    89 will set the owl variable zsigproc to 
     89will set the owl variable zsigproc to
    9090the value "/mit/kretch/bin/getzsig foo".
    9191Note that you will need to watch out for perl quoting issues.
     
    9393
    9494Both owl::format_msg and owl::receive_msg are passed perl owl::Message
    95 objects which have methods for accessing the attributes of the message. 
     95objects which have methods for accessing the attributes of the message.
    9696
    9797(Caveat: Note that these owl::Message objects are currently only
     
    154154    }
    155155
    156 In the above, $m is the owl::Message object and 
     156In the above, $m is the owl::Message object and
    157157its methods are called with $m->METHODNAME.
    158158
    159 An example receiver function that tags all zephyr pings for 
     159An example receiver function that tags all zephyr pings for
    160160deletion would be:
    161161
     
    187187If you use pperl instead of perl, the return value
    188188of the perl command will be displayed in a pop-up window.
    189 This is particularly useful within key bindings 
     189This is particularly useful within key bindings
    190190and aliases.  For example:
    191191
     
    193193
    194194Will cause the "finger" command to be used to finger at the host
    195 where the current message came from.  You can then bind this 
     195where the current message came from.  You can then bind this
    196196to the "f" key with:
    197197
  • doc/barnowl.1

    r8135737 r7869e48  
    3636\fB\-c\fP, \fB\-\-config\-file\fP=\fIFILE\fP
    3737Specify 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 
     38an arbitrary Perl script evaluated in the \fImain\fP package, and if it
     39overrides the \fIBarnOwl::startup\fP method that is run when \fBBarnOwl\fP
     40starts.  (Compare \fI~/.owl/startup\fP, which contains \fBBarnOwl\fP commands
    4141that are run at startup after the config file is loaded.)
    4242
    43 By default, \fBBarnOwl\fP uses the first of \fI~/.owl/init.pl\fP, 
     43By default, \fBBarnOwl\fP uses the first of \fI~/.owl/init.pl\fP,
    4444\fI~/.barnowlconf\fP, or \fI~/.owlconf\fP that exists.
    4545
  • doc/code.txt

    rd40ad8b r7869e48  
    1616             is owl_function_command("foo");
    1717             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.
    1919
    20 context:     A context specifies the current state of owl, in terms 
     20context:     A context specifies the current state of owl, in terms
    2121             of which modal window is active and which point
    2222             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
    2424             some hierarchy.  Commands may restrict themselves
    2525             to only running in a limited number of contexts
     
    3434             Sometimes also referred to as typewin.
    3535
    36 filter:      Patterns which match messages.  These may 
    37              contain multiple filterelements which may be 
     36filter:      Patterns which match messages.  These may
     37             contain multiple filterelements which may be
    3838             combined together (eg, by "and" and "or").
    39              
    40 filterelement: An element of a filter which matches on some 
     39
     40filterelement: An element of a filter which matches on some
    4141               attribute of a message.
    4242
     
    4444             These are particularly useful for building up
    4545             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
    4747             routines for cropping as needed.
    4848
     
    5555             owl.h defines "g" as a singleton instance of owl_global.
    5656             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
    5858             functions.c).  Consider whether you really need to before
    5959             adding in uses of global.
     
    103103             Also contains the main loop, which is roughly:
    104104             - handle scheduled resizes, and anything that might result
    105              - while zephyrs are pending, grab incoming zephyrs 
     105             - while zephyrs are pending, grab incoming zephyrs
    106106               and handle them (which includes formatting them
    107107               with either perl extension or default formatter
     
    109109             - updates mainwin display if there are new zephyrs
    110110             - 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,
    112112               or typewin/editwin
    113113
     
    118118                   Created by codelist.pl.
    119119
    120 popwin:      Modal pop-up window container. 
     120popwin:      Modal pop-up window container.
    121121             Usually contains a viewwin for read-only scrolling text.
    122122
     
    126126
    127127util:        Misc utility functions that don't fit anywhere yet:
    128              - sepbar rendering 
     128             - sepbar rendering
    129129             - tokenizing and parsing utilities
    130130             - downstr
     
    186186        something, and this should be the exception to the rule.
    187187
    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.
    190190        People shouldn't have to spend days tweaking
    191191        with config files before being happy switching to it.
  • doc/intro.txt

    rd7cc50b r7869e48  
    188188variable.  For example:
    189189
    190      set personalbell on 
     190     set personalbell on
    191191
    192192will set the value of the variable 'personalbell' to 'on'.  The
     
    347347    owl::format_msg()  run to format messages when using the perl style.
    348348                       The return value is used to display the message on the
    349                        screen. 
     349                       screen.
    350350    owl::receive_msg() run when a message is received, and after
    351351                       it has been added to the message list
     
    424424For example:
    425425
    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
     428will bind Control-k to the delete command, but only in the
    429429recv window context.
    430430
    431 Some keymaps inherit their bindings from more 
     431Some keymaps inherit their bindings from more
    432432general keymaps.  The valid keymaps are:
    433433
     
    438438    |  |-editresponse - single-line responses to questions
    439439    |-popless         - scrolling pop-up windows
    440     |-recv            - the main message list window 
     440    |-recv            - the main message list window
    441441                        where received messages are displayed
    442442
     
    445445Note that not all commands may be used in all contexts.
    446446
    447 Key sequences may be surrounded by quotes and include 
     447Key sequences may be surrounded by quotes and include
    448448a sequence of keys that must be pressed in order
    449449to execute the command.  For example:
Note: See TracChangeset for help on using the changeset viewer.