Changeset 11730 in project


Ignore:
Timestamp:
08/23/08 18:18:15 (13 years ago)
Author:
sjamaan
Message:

Remove prefixes from wmiirc wikipage and add note about version 0.2 (chicken 4 port)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/wmiirc

    r11240 r11730  
    129129when a window is (de)selected, when a tag is (de)selected, when a tag
    130130is created/destroyed etc.  The exact events are listed with the
    131 {{wmii:event-handlers}} procedure.
     131{{event-handlers}} procedure.
    132132
    133133===== Special names and limitations
     
    151151To get a connection to the server, call the following:
    152152
    153   procedure: (wmii:connect [inport outport])
     153  procedure: (connect [inport outport])
    154154
    155155If you provide an inport and outport, it will connect to a 9p server
     
    162162handlers.  After having done this, you can enter the event loop using
    163163
    164   procedure: (wmii:event-loop [kill-others])
     164  procedure: (event-loop [kill-others])
    165165
    166166This procedure will only return when another wmiirc wants to take over
     
    171171==== wmii operations
    172172
    173   procedure: (wmii:quit)
     173  procedure: (quit)
    174174
    175175Tells wmii to quit.
    176176
    177   procedure: (wmii:exec cmdline)
     177  procedure: (exec cmdline)
    178178
    179179Tells wmii to execute the given commandline, replacing the wmii
    180180process.  This can be used to change to a different window manager.
    181181
    182   procedure: (wmii:global-settings)
     182  procedure: (global-settings)
    183183
    184184Returns an alist of the current global settings.
    185185
    186   procedure: (wmii:global-settings-set! alist)
     186  procedure: (global-settings-set! alist)
    187187
    188188Change the global settings.  Example:
    189189
    190190<enscript highlight=scheme>
    191 (wmii:global-settings-set!
     191(global-settings-set!
    192192 `((font . "-*-fixed-medium-r-*-*-13-*-*-*-*-*-*-*")
    193193   (focuscolors . (#xffffff #x285577 #x4c7899))
     
    209209alist and the following procedure:
    210210
    211   procedure: (wmii:colrules-set! alist)
     211  procedure: (colrules-set! alist)
    212212
    213213The keys of the alist are strings that are interpreted by wmii as a
     
    221221
    222222<enscript highlight=scheme>
    223   (wmii:colrules-set! '(("www" . (20 80))
     223  (colrules-set! '(("www" . (20 80))
    224224                        ("email" . (10 20 70))
    225225                        ("graphics" . 100) ;; can also be (100)
     
    229229You can request the current column rules with the following procedure:
    230230
    231   procedure: (wmii:colrules)
    232 
    233 This returns an alist of the same type as accepted by wmii:colrules-set!.
     231  procedure: (colrules)
     232
     233This returns an alist of the same type as accepted by colrules-set!.
    234234
    235235==== Tag rules
     
    238238tags a client should get when it's first created.
    239239
    240   procedure: (wmii:tagrules-set! alist)
     240  procedure: (tagrules-set! alist)
    241241
    242242The alist here takes again strings as keys which are interpreted as
     
    245245
    246246<enscript highlight=scheme>
    247   (wmii:tagrules-set! `(("XMMS.*" . ("music" "~"))
     247  (tagrules-set! `(("XMMS.*" . ("music" "~"))
    248248                        ("display.*" . ("graphics" "~"))
    249249                        ("Gimp.*" . ("graphics" "~"))
     
    257257Just like colrules, tagrules can be listed:
    258258
    259   procedure: (wmii:tagrules)
    260 
    261 Returns an alist that looks just like the one from {{wmii:tagrules-set!}}.
     259  procedure: (tagrules)
     260
     261Returns an alist that looks just like the one from {{tagrules-set!}}.
    262262
    263263==== Event handlers
     
    266266those with this procedure:
    267267
    268   procedure: (wmii:event-handlers-set! alist [grab-keys])
     268  procedure: (event-handlers-set! alist [grab-keys])
    269269
    270270The alist has keys that are either simply symbols that name the event
     
    311311You can also use the following procedure to get the current event handlers:
    312312
    313   procedure: (wmii:event-handlers)
     313  procedure: (event-handlers)
    314314
    315315Note that this procedure can not return event handlers in other processes.
     
    318318=== Keys
    319319
    320   procedure: (wmii:grabbed-keys)
     320  procedure: (grabbed-keys)
    321321
    322322Get a list of currently grabbed keys.
    323323
    324   procedure: (wmii:grabbed-keys-set! keys)
     324  procedure: (grabbed-keys-set! keys)
    325325
    326326Sets the keys grabbed by wmii.  {{keys}} is a list of key descriptions.
     
    329329
    330330<enscript highlight="scheme">
    331   (wmii:grabbed-keys-set! '(("Mod1" "x")
     331  (grabbed-keys-set! '(("Mod1" "x")
    332332                            ("Mod2" "Space")
    333333                            ("Mod1" "Shift" "Space")))
     
    339339to hook shift-x, that would not be ("X"), but ("Shift" "x").
    340340
    341   procedure: (wmii:key-code->string)
    342   procedure: (wmii:string->key-code)
     341  procedure: (key-code->string)
     342  procedure: (string->key-code)
    343343
    344344Translate a chicken-wmiirc keycode to a string that can be written to wmii's
    345345{{/keys}} file.  Example:
    346346
    347   (wmii:key-code->string '("Mod1" "Shift" "x")) => "Mod1-Shift-x"
    348   (wmii:string->keycode "Mod1-Shift-x") => ("Mod1" "Shift" "x")
     347  (key-code->string '("Mod1" "Shift" "x")) => "Mod1-Shift-x"
     348  (string->keycode "Mod1-Shift-x") => ("Mod1" "Shift" "x")
    349349
    350350=== Navigating
    351351
    352   procedure: (wmii:goto-tag tag)
     352  procedure: (goto-tag tag)
    353353
    354354Switch the view to the named {{tag}}.
    355355
    356   procedure: (wmii:navigate-to direction [tag])
     356  procedure: (navigate-to direction [tag])
    357357
    358358Navigate to the given {{direction}} in the given {{tag}}.  Tag
     
    367367that tag.
    368368
    369   procedure: (wmii:send-to direction [client] [tag])
     369  procedure: (send-to direction [client] [tag])
    370370
    371371Send the given {{client}} (defaults to "sel", the currently selected
     
    376376=== Tags
    377377
    378   procedure: (wmii:tags)
     378  procedure: (tags)
    379379 
    380380This procedure returns a list of all the tags known to wmii, as strings.
    381381
    382   procedure: (wmii:tag-settings-set! alist [tag])
     382  procedure: (tag-settings-set! alist [tag])
    383383
    384384Change the settings for the named {{tag}}, which defaults to "sel",
     
    386386as keys, and setting lists as values. Example:
    387387
    388   (wmii:tag-settings-set! '(("colmode" . ("sel" "stack"))))
     388  (tag-settings-set! '(("colmode" . ("sel" "stack"))))
    389389
    390390This sets the current tag's column mode to stacked.
    391391 
    392   procedure: (wmii:tag-settings [tag])
     392  procedure: (tag-settings [tag])
    393393
    394394Returns an alist of the settings for the named {{tag}}.  {{tag}} defaults
     
    397397=== Bars
    398398
    399   procedure: (wmii:tabs bar)
     399  procedure: (tabs bar)
    400400
    401401Return a list of all tabs on the {{bar}}.  {{bar}} can be {{"lbar"}}
    402402(the left bar) or {{"rbar"}} (the right bar).
    403403
    404   procedure: (wmii:write-tab bar tab contents [colors])
     404  procedure: (write-tab bar tab contents [colors])
    405405
    406406Change the string {{contents}} of a {{tab}} on the indicated
     
    412412Example:
    413413
    414   (wmii:write-tab "lbar" "hello" "hello there")
     414  (write-tab "lbar" "hello" "hello there")
    415415
    416416Creates a tab called "hello" on the left bar, which displays the
    417417string "hello there".
    418418
    419   procedure: (wmii:destroy-tab bar tab)
     419  procedure: (destroy-tab bar tab)
    420420
    421421Destroy {{tab}} on {{bar}}.
     
    423423=== Clients
    424424
    425   procedure: (wmii:client=? client1 client2)
     425  procedure: (client=? client1 client2)
    426426
    427427Are two clients one and the same?  Currently clients are represented
     
    430430this to compare them to be forwards-compatible.  These "opaque" client
    431431objects can be obtained by event handlers from the various events that
    432 operate on a client, or by {{wmii:clients}}, for example.
    433 
    434   procedure: (wmii:clients)
     432operate on a client, or by {{clients}}, for example.
     433
     434  procedure: (clients)
    435435
    436436Returns a list of all the clients managed by wmii, in all tabs.
    437437
    438   procedure: (wmii:client-tags [client])
     438  procedure: (client-tags [client])
    439439
    440440Return a list of all tags on {{client}}.  Defaults to the
    441441currently selected client ("sel").
    442442
    443   procedure: (wmii:client-tags-set! tags [client])
     443  procedure: (client-tags-set! tags [client])
    444444
    445445Set the {{tags}} (a list of strings) on the {{client}}.
     
    450450can use the following procedures:
    451451
    452   procedure: (wmii:write file data)
     452  procedure: (write file data)
    453453
    454454Write the string contents of {{data}} to the named {{file}}.  If the
    455455file does not exist, it is created.
    456456
    457   procedure: (wmii:read file)
     457  procedure: (read file)
    458458
    459459Read the given {{file}} into a string.
    460460
    461   procedure: (wmii:read-lines file)
     461  procedure: (read-lines file)
    462462
    463463Read the given {{file}} line by line and create a list with an entry
    464464per line.
    465465
    466   procedure: (wmii:directory path)
     466  procedure: (directory path)
    467467
    468468Show the directory contents of the named {{path}}.
     
    699699
    7007000.1 Initial release
     7010.2 Port to hygienic Chicken
    701702
    702703=== License
Note: See TracChangeset for help on using the changeset viewer.