contrib/index.html

   1 <!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   5 <title>Notion scripts collection</title>
   6 <link href="default.css" title="Default" rel="stylesheet" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class=title><h1>Notion scripts collection</h1></div>
  11
  12 Here are some scripts for Notion. All of them are in the public domain unless
  13 otherwise mentioned in the source file.
  14 <p>
  15
  16 <ul class="contents">
  17 <li><a href="#scripts">Scripts</a>
  18 <li><a href="#keybindings">Key bindings</a>
  19 <li><a href="#styles">Styles</a>
  20 <li><a href="#statusbar">Statusbar monitors</a>
  21 <li><a href="#instructions">Instructions</a>
  22     <ul>
  23         <li><a href="#using">Using</a>
  24         <li><a href="#download">Downloading</a>
  25         <li><a href="#contrib">Contributing</a>
  26     </ul>
  27     <li><a href="#legacy">Legacy</a>
  28     <ul>
  29         <li><a href="#LEGACYscripts">Scripts</a>
  30         <li><a href="#LEGACYstatusbar">Statusbar monitors</a>
  31     </ul>
  32 </ul>
  33
  34 <h2>Scripts</h2>
  35 <a name="scripts"></a>
  36
  37 <dl>
  38     <!-- New scripts in alphabetical order, please -->
  39
  40     <dt> <a href="scripts/app.lua">app.lua</a>
  41     <dd> Start an application if it's not running, but go to it if it's
  42         already started. There's also a function to replace query_editfile
  43         which will use a running emacs instance (starting it if necessary,
  44         of course).
  45
  46     <dt> <a href="scripts/autoprop.lua">autoprop.lua</a>
  47     <dd> Automatically create a winprop for the given client targeted to
  48     the given frame. Allows them to be saved and reloaded automatically.
  49
  50     <dt> <a href="scripts/bookmarks.lua">bookmarks.lua</a>
  51     <dd> Bookmarks support
  52
  53     <dt> <a href="scripts/cfg_dock2.lua">cfg_dock2.lua</a>
  54     <dd> A dock configuration with lots of added control.
  55
  56     <dt> <a href="scripts/collapse.lua">collapse.lua</a>
  57     <dd> Collapse frames on a WTiling into a single frame
  58
  59     <dt> <a href="scripts/exec_show.lua">exec_show.lua</a>
  60     <dd> Execute some shell-command (tail, head, grep etc) and display the result.
  61
  62     <dt> <a href="scripts/float-sb.lua">float-sb.lua</a>
  63     <dd> Example of a floating toggleable statusbar.
  64
  65     <dt> <a href="scripts/goto_by_tag.lua">goto_by_tag.lua</a>
  66     <dd> Sets focus to the first client with a given tag. This tag is defined
  67     using a winprop. For example you might give the tag "B" to your browser and
  68     then use the binding META+U B to directly jump to your browser.
  69
  70     <dt> <a href="scripts/lock_frame.lua">lock_frame.lua</a>
  71     <dd> 'Lock' selected frames so they don't close via the keyboard.
  72
  73     <dt> <a href="scripts/min_tabs.lua">min_tabs.lua</a>
  74     <dd> Show tabs precisely when two or more windows in an notion frame
  75
  76     <dt> <a href="scripts/move_current.lua">move_current.lua</a>
  77     <dd> Move current window in a frame to another frame in specified
  78          direction
  79
  80     <dt> <a href="scripts/mp.lua">mp.lua</a>
  81     <dd> Mark next mapped window to be attached to a specified object
  82
  83     <dt> <a href="scripts/mpd.lua">mpd.lua</a>
  84     <dd> Control a MusicPD server
  85
  86     <dt> <a href="scripts/named_scratchpad.lua">named_scratchpad.lua</a>
  87     <dd> Toggle (and create) scratchpads by name.
  88
  89     <dt> <a href="scripts/net_client_list.lua">net_client_list.lua</a>
  90     <dd> Maintain the _NET_CLIENT_LIST property (and the
  91          _NET_CLIENT_LIST_STACKING property incorrectly) on the root window.
  92
  93     <dt> <a href="scripts/nowarp_scratchpad.lua">nowarp_scratchpad.lua</a>
  94     <dd> Keeps notion from warping the pointer when activating a scratchpad
  95          region.
  96
  97     <dt> <a href="scripts/panel.lua">panel.lua</a>
  98     <dd> Facilitates placing arbitrary windows with the <tt>is_panel</tt>
  99          winprop set to true, as the stdisp.
 100
 101     <dt> <a href="scripts/query_url.lua">query_url.lua</a>
 102     <dd> Open a URL, completing on Opera bookmark file. Should be easy to
 103          support other browsers.
 104
 105     <dt> <a href="scripts/rss_feed.lua">rss_feed.lua</a>
 106     <dd> A simple rss-reader script
 107
 108     <dt> <a href="scripts/rss_feed_hh.lua">rss_feed_hh.lua</a>
 109     <dd> Some small improvements to match rss_feed my personal taste.
 110
 111     <dt> <a href="scripts/schedule.lua">schedule.lua</a>
 112     <dd> Schedule some messages to show up at specified times in the statusbar.
 113
 114     <dt> <a href="scripts/send_to_ws.lua">send_to_ws.lua</a>
 115     <dd> Quickly send to another workspace.
 116
 117     <dt> <a href="scripts/show_submap.lua">show_submap.lua</a></dt>
 118     <dd> Displays an infowin with the currently active submap.</dd>
 119
 120     <dt> <a href="scripts/simple_bindings.lua">simple_bindings.lua</a></dt>
 121     <dd> Add a first pass at the simple bindings script.</dd>
 122
 123     <dt> <a href="scripts/stock.lua">stock.lua</a></dt>
 124     <dd> An applet for retrieving and displaying stock market information
 125       from <a href="http://finance.yahoo.com">http://finance.yahoo.com.</a>
 126       You can set up a portfolio and monitor its intraday performance.</dd>
 127
 128     <dt> <a href="scripts/switch_bindings.lua">switch_bindings.lua</a>
 129     <dd> Switch between key-bindings. You can temporarily disable keybindings and
 130     restore them later when necessary.
 131
 132     <dt> <a href="scripts/tabmenu.lua">tabmenu.lua</a>
 133     <dd> A grabmenu-based alternative to tabs.
 134
 135     <dt> <a href="scripts/weather.lua">weather.lua</a></dt>
 136     <dd> This script allows you to retreive weather information from one or more
 137     weather observation stations and display it in the statusbar.</dd>
 138
 139     <dt> <a href="scripts/wrap_workspace_or_screen.lua">wrap_workspace_or_screen.lua</a></dt>
 140     <dd> When switching focus over the border of a workspace, wrap to the next
 141     workspace or screen.</dd>
 142
 143     <dt> <a href="scripts/xkbion.lua">xkbion.lua</a></dt>
 144     <dd> This script allows you to use independent keyboard layouts for different windows in Notion.
 145     It uses a window property to store the XKB groups, so you can restart Notion without losing
 146     settings for each window.</dd>
 147
 148     <dt> <a href="scripts/zoom.lua">zoom.lua</a>
 149     <dd> Simulates larswm-like window zooming.
 150
 151 </dl>
 152
 153 <h2>Key bindings</h2>
 154 <a name="keybindings"></a>
 155 <dl>
 156     <!-- New scripts in alphabetical order, please -->
 157
 158     <dt> <a href="keybindings/cfg_mouse.lua">cfg_mouse.lua</a>
 159     <dd> Make the mouse pull its weight. </dd>
 160
 161     <dt> <a href="keybindings/dans_bindings.lua">dans_bindings.lua</a>
 162     <dd> Keybindings for more intuitive WIonWS navigation.</dd>
 163
 164     <dt> <a href="keybindings/emacs_bindings.lua">emacs_bindings.lua</a>
 165     <dd> Emacs-like keybindings </dd>
 166
 167     <dt> <a href="keybindings/vim_bindings.lua">vim_bindings.lua</a>
 168     <dd> Vim-like keybindings for Notion queries.</dd>
 169 </dl>
 170
 171 <h2>Styles</h2>
 172 <a name="styles"></a>
 173
 174 <dl>
 175     <!-- New scripts in alphabetical order, please -->
 176
 177     <dt> <a href="styles/look_alex.lua">look_alex.lua</a>
 178     <dd> Black tabs, green text and borders.
 179
 180     <dt> <a href="styles/look_asm.lua">look_asm.lua</a></dt>
 181     <dd> A clean grey-blue theme with not too big tabs.</dd>
 182
 183     <dt> <a href="styles/look_atme.lua">look_atme.lua</a>
 184     <dd> A style which just looks nice.
 185
 186     <dt> <a href="styles/look_awesome.lua">look_awesome.lua</a>
 187     <dd> Inspired by look_clean, comes fully-equipped with big, friendly
 188          tabs, tasty single-pixel borders, and a sprinkling of transparency.
 189          Makes use of the
 190          <a href="http://www.is-vn.bg/hamster/jimmy-en.html">Terminus</a>
 191          font.
 192
 193     <dt> <a href="styles/look_awesome_sm.lua">look_awesome_sm.lua</a>
 194     <dd> A style based on look_awesome above, but with smaller
 195          fonts and paddings and no transparency by default.
 196          This style makes use of the 'nexus' font for tabs.
 197
 198     <dt> <a href="styles/look_awesome_yaarg.lua">look_awesome_yaarg.lua</a>
 199     <dd> A style based on look-awesome-sm above, but with darker colours
 200     to give a more somber feel.
 201
 202     <dt> <a href="styles/look_bas.lua">look_bas.lua</a>
 203     <dd> A style which colors fit the mozilla-bb background. It makes
 204          use of the techy artwiz font.
 205
 206     <dt> <a href="styles/look_blue.lua">look_blue.lua</a>
 207     <dd> A blue/gray theme based on look_violet.lua, with a nice clean look.
 208
 209     <dt> <a href="styles/look_bluecurve.lua">look_bluecurve.lua</a>
 210     <dd> A theme that fits the colors of the bluecurve-theme by
 211      <a href="http://www.redhat.com">Redhat</a>
 212
 213     <dt> <a href="styles/look_cleanpastel.lua">look_cleanpastel.lua</a>
 214     <dd> Similar to stock look-clean* styles, but greenish.
 215
 216     <dt> <a href="styles/look_cleansteel.lua">look_cleansteel.lua</a>
 217     <dd> The stock look-brownsteel style with borders removed on tiled
 218          workspaces for cleaner look.
 219
 220     <dt> <a href="styles/look_cleansteel_trans.lua">look_cleansteel_trans.lua</a>
 221     <dd> Based on look_cleansteel, but with transparent backgrounds,
 222          smaller font sizes, and a coloured notification.
 223
 224     <dt> <a href="styles/look_cleanwhite.lua">look_cleanwhite.lua</a>
 225     <dd> A bright theme that fits white terminals and white Emacs
 226          windows.
 227
 228     <dt> <a href="styles/look_cool.lua">look_cool.lua</a>
 229     <dd> A style based on look-awesome, made to fit the KDE color scheme
 230          "plastic-grey". Made by Steffen Liebergeld (26.08.2004).
 231
 232     <dt> <a href="styles/look_gtk2.lua">look_gtk2.lua</a>
 233     <dd> A theme that fits the default GTK+2 colors. It makes use of the
 234          terminus and artwiz fonts.
 235
 236     <dt> <a href="styles/look_minimalist.lua">look_minimalist.lua</a>
 237     <dd> A simple gold/red style with relatively large frame borders
 238          designed to increase usability with the minimal tabs modification.
 239
 240     <dt> <a href="styles/look_moy.lua">look_moy.lua</a>
 241     <dd> Grey and violet simple theme.
 242
 243     <dt> <a href="styles/look_ootput.lua">look_ootput.lua</a>
 244     <dd> A non-obtrusive style with clear distinctions between active borders
 245     and less active borders. This style makes use of the
 246     <a href="http://www.tobias-jung.de/seekingprofont/index.html">Profont</a> font.
 247
 248     <dt> <a href="styles/look_ootput_dark.lua">look_ootput_dark.lua</a>
 249     <dd> A darker version of look_ootput that is easier on the eyes.
 250
 251     <dt> <a href="styles/look_outback.lua">look_outback.lua</a>
 252     <dd> A warm style with sandy hints and distinctive contrast.
 253         <a href="http://www.csh.rit.edu/~apox/images/screenshots/20080408.png">Screenshot</a>.
 254
 255     <dt> <a href="styles/look_qt.lua">look_qt.lua</a>
 256     <dd> A drawing engine configuration file that reads settings
 257      from <a href="http://trolltech.com/products/qt/">Qt</a>
 258      configuration file ~/.qt/qtrc.
 259
 260     <dt> <a href="styles/look_tibi.lua">look_tibi.lua</a>
 261     <dd> A style which clearly emphasizes active elements and thus
 262       lets you quickly recognize them.  The `accent' color is
 263       configurable.
 264
 265     <dt> <a href="styles/look_tiny.lua">look_tiny.lua</a>
 266     <dd> A major modification of look_minimalist, aiming to keep
 267          everything small while not making anything unattractive.
 268
 269     <dt> <a href="styles/look_tiny_min_tabs.lua">look_tiny_min_tabs.lua</a>
 270     <dd> A major modification of look_minimalist, aiming to keep
 271          everything small while not making anything unattractive.
 272          For use with min_tabs.
 273
 274     <dt> <a href="styles/look_whitecode.lua">look_whitecode.lua</a>
 275     <dd> Clean white/light grey theme. Comes handy for glare displays as
 276          reflection is not as evil as with a dark theming.
 277          I recommend background color #808080 for a cool look in floating
 278          workspaces.
 279          <small>(Tested only on my LCD, so no idea what it looks like on a CRT)</small>
 280
 281  </dl>
 282
 283 <h2>Statusbar</h2>
 284 <a name="statusbar"></a>
 285
 286 All statusbar monitors are loaded automatically based on the statusbar
 287 template. <strong>Do not attempt to load them manually</strong> (especially
 288 not the statusd scripts). Please see <a href="#instructions">instructions</a>
 289 below for more information.
 290
 291 <h3>Internal monitors</h3>
 292 <a name="statusbar-internal"></a>
 293
 294 <dl>
 295     <!-- New scripts in alphabetical order, please -->
 296     <dt> <a href="statusbar/statusbar_act.lua">statusbar_act.lua</a>
 297     <dd> Activity (urgency flag, new unacted-upon transients, etc.)
 298          display for the statusbar.
 299
 300     <dt> <a href="statusbar/statusbar_external.lua">statusbar_external.lua</a>
 301     <dd> Show output of external programs or scripts in statusbar. If you are using ion-3ds-20060107 or later, using <a href="statusd/statusd_exec.lua">statusd_exec.lua</a> instead of this old version is suggested.
 302
 303     <dt> <a href="statusbar/statusbar_fname.lua">statusbar_fname.lua</a>
 304     <dd> Show the focused frame name in the statusbar.
 305
 306     <dt> <a href="statusbar/statusbar_wsname.lua">statusbar_wsname.lua</a>
 307     <dd> Shows the current workspace name in the statusbar, can also show a list of workspaces and indicate the current one. The current workspace indicator is customizable. This script also allows for per-head workspace information.
 308
 309 </dl>
 310
 311
 312 <h3>Notion-statusd monitors</h3>
 313 <a name="statusd"></a>
 314
 315 These monitors are run within the separate <tt>notion-statusd</tt> program.
 316 Note that many of them depend on the Linux <tt>/proc</tt> filesystem and
 317 thus will not work on other systems.
 318
 319 <dl>
 320     <!-- New scripts in alphabetical order, please -->
 321     <dt> <a href="statusd/statusd_amarok.lua">statusd_amarok.lua</a>
 322     <dd> Notion-statusd monitor reporting the current song from <a href="http://amarok.kde.org/">Amarok</a>.
 323
 324     <dt> <a href="statusd/statusd_binclock.lua">statusd_binclock.lua</a>
 325     <dd> Notion-statusd binary clock in two possible modes: Plain binary (numbers) and character mode (dots, lines, etc).
 326
 327     <dt> <a href="statusd/statusd_bitcoin.lua">statusd_bitcoin.lua</a>
 328     <dd> Notion-statusd monitor reporting bitcoin speed in khash/s and balance
 329
 330     <dt> <a href="statusd/statusd_bsdbatt.lua">statusd_bsdbatt.lua</a>
 331     <dd> Notion-statusd monitor for FreeBSD ACPI CMBATT status. Uses the sysctl interface.</dd>
 332
 333     <dt> <a href="statusd/statusd_cpufreq.lua">statusd_cpufreq.lua</a>
 334     <dd> Notion-statusd monitor reporting current CPU speed in KHz, MHz, or GHz.  Uses the <code>/proc</code> filesystem and <code>cpufreq</code>.
 335
 336     <dt> <a href="statusd/statusd_cpuspeed.lua">statusd_cpuspeed.lua</a>
 337     <dd> Notion-statusd monitor reporting current CPU speed; works with apm.
 338
 339     <dt> <a href="statusd/statusd_cpustat.lua">statusd_cpustat.lua</a>
 340     <dd> Notion-statusd monitor reporting current CPU stats using the Linux <code>/proc/stat</code> interface.
 341
 342     <dt> <a href="statusd/statusd_df.lua">statusd_df.lua</a>
 343     <dd> Notion-statusd monitor reporting free disk space.  Depends on <code>df</code>.
 344
 345     <dt> <a href="statusd/statusd_dgs.lua">statusd_dgs.lua</a>
 346     <dd> Notion-statusd monitor reporting on any games waiting for a move
 347         on <a href="www.dragongoserver.net">www.dragongoserver.net</a>.
 348
 349     <dt> <a href="statusd/statusd_drives.lua">statusd_drives.lua</a>
 350     <dd> Notion-statusd monitor reporting on connected drives
 351
 352     <dt> <a href="statusd/statusd_exec.lua">statusd_exec.lua</a>
 353     <dd> Show output of external programs or scripts in statusbar. Uses non-blocking reads and can be used with both continously outputting and periodically run programs. Allows highlighting with regexp matching.
 354
 355     <dt> <a href="statusd/statusd_flashing.lua">statusd_flashing.lua</a>
 356     <dd> Notion-statusd multi-purpose monitor. Show blinking alarms when some defined files or directories have changed. It can be used to monitor email inboxes, security logs, etc.
 357
 358     <dt> <a href="statusd/statusd_fortune.lua">statusd_fortune.lua</a>
 359     <dd> Notion-statusd monitor displaying fortunes.
 360
 361     <dt> <a href="statusd/statusd_inetaddr.lua">statusd_inetaddr.lua</a>
 362     <dd> Notion-statusd monitor reporting current IP address from ifconfig.
 363
 364     <dt> <a href="statusd/statusd_iwinfo.lua">statusd_iwinfo.lua</a>
 365     <dd> Notion-statusd monitor reporting minimal wireless info.
 366
 367     <dt><a href="statusd/statusd_laptopstatus.lua">statusd_laptopstatus.lua</a>
 368     <dd> Notion-statusd monitor reporting CPU speed &amp; temperature and battery status; works with acpi.
 369
 370     <dt><a href="statusd/statusd_maildir.lua">statusd_maildir.lua</a>
 371     <dd> Notion-statusd monitor showing mailcount of a Maildir.
 372
 373     <dt><a href="statusd/statusd_mem.lua">statusd_mem.lua</a>
 374     <dd> Notion-statusd monitor reporting current memory usage with selective alarms and non blocking I/O. Depends on Linux <code>free</code> command.
 375
 376     <dt><a href="statusd/statusd_meminfo.lua">statusd_meminfo.lua</a>
 377     <dd> Notion-statusd monitor reporting current memory and swap usage.  Depends on the Linux <code>/proc/meminfo</code> interface.
 378
 379     <dt><a href="statusd/statusd_moc.lua">statusd_moc.lua</a>
 380     <dd> Notion-statusd monitor reporting <a href="http://moc.daper.net">moc</a> information and status.
 381
 382     <dt> <a href="statusd/statusd_mocmon.lua">statusd_mocmon.lua</a>
 383     <dd> Notion-statusd monitor reporting <a href="http://moc.daper.net">moc</a> information. This is actually
 384          just a modification of <a href="statusd/statusd_xmmsip.lua">statusd_xmmsip.lua</a> using the idea of
 385          non-blocking I/O as shown in <a href="statusd/statusd_mocp.lua">statusd_mocp.lua</a>.
 386
 387     <dt><a href="statusd/statusd_mocp.lua">statusd_mocp.lua</a>
 388     <dd> Notion-statusd monitor reporting <a href="http://moc.daper.net">moc</a>
 389          status.  This is a stripped down, non-blocking I/O version of the
 390          above.  It is useful with
 391          <a href="scripts/rotate_statusbar.lua">rotate_statusbar.lua</a>.
 392
 393     <dt><a href="statusd/statusd_mpd-socket.lua">statusd_mpd-socket.lua</a>
 394     <dd> Notion-statusd monitor reporting <a href="http://www.musicpd.org">mpd</a> information and status. Uses a socket interface to avoid some performance issues with the original.
 395
 396     <dt><a href="statusd/statusd_mpd.lua">statusd_mpd.lua</a>
 397     <dd> Notion-statusd monitor reporting <a href="http://www.musicpd.org">mpd</a> information and status.
 398
 399     <dt><a href="statusd/statusd_netmon.lua">statusd_netmon.lua</a>
 400     <dd> Notion-statusd network monitor reporting network activity.
 401
 402     <dt><a href="statusd/statusd_nginfo.lua">statusd_nginfo.lua</a>
 403     <dd> Notion-statusd monitor reporting Nagios server(s) status.
 404
 405     <dt><a href="statusd/statusd_nmaild.lua">statusd_nmaild.lua</a>
 406     <dd> Notion-statusd Maildir monitor with selective alarms, counters for different filters and optional command launcher when a new email is detected.
 407
 408     <dt><a href="statusd/statusd_orpheus.lua">statusd_orpheus.lua</a>
 409     <dd> Notion-statusd monitor reporting song currently being played by orpheus.
 410
 411     <dt><a href="statusd/statusd_pytone.lua">statusd_pytone.lua</a>
 412     <dd> Notion-statusd monitor reporting song currently being played by pytone.
 413
 414     <dt><a href="statusd/statusd_ticker.lua">statusd_ticker.lua</a>
 415     <dd> Notion-statusd monitor which scrolls the output of specified programs.
 416
 417     <dt><a href="statusd/statusd_uname.lua">statusd_uname.lua</a>
 418     <dd> Notion-statusd monitor for reporting uname.  It is primarily a simple
 419          example of how to use statusd.popen_bgread() with coroutines for
 420          non-blocking I/O.
 421
 422     <dt><a href="statusd/statusd_uptime.lua">statusd_uptime.lua</a>
 423     <dd> Notion-statusd monitor reporting the system uptime.
 424
 425     <dt><a href="statusd/statusd_volume.lua">statusd_volume.lua</a>
 426     <dd> Notion-statusd monitor reporting sound volume values (currently, master and pcm). Depends on aumix.
 427
 428     <dt><a href="statusd/statusd_weather.lua">statusd_weather.lua</a>
 429     <dd> Notion-statusd monitor reporting weather.
 430
 431     <dt><a href="statusd/statusd_xmms.lua">statusd_xmms.lua</a>
 432     <dd> Notion-statusd monitor reporting song currently selected in xmms' playlist.
 433
 434     <dt> <a href="statusd/statusd_xmms2.lua">statusd_xmms2.lua</a>
 435     <dd> Song as "Artist - Title"
 436
 437     <dt> <a href="statusd/statusd_xmmsip.lua">statusd_xmmsip.lua</a>
 438     <dd> Notion-statusd monitor(s) reporting information from a xmms-infopipe-plugin's pipe.
 439          Can be customized in various ways.
 440 </dl>
 441
 442 <!--See the Wiki for
 443 <a href="http://wiki.ael.be/ion/index.php/LuaScripts">more</a> scripts,
 444 and add your own.-->
 445
 446 <h2>Instructions</h2>
 447 <a name="instructions"></a>
 448
 449 <h3>Using</h3>
 450 <a name="using"></a>
 451
 452 To use any of the scripts, follow these directions.
 453
 454 <ol>
 455 <li>Create the directory <tt>~/.notion/</tt>, if it does not exist yet.
 456 <li>Copy the script in this directory.
 457 <li>Depending on the type of script, do the following.
 458     <dl>
 459
 460     <!-- Extra space in tag to not confuse verify_index.pl hack -->
 461     <dt >Proper scripts
 462     <dd>Copy <tt>cfg_notion.lua</tt> in <tt>~/.notion/</tt>, if it does not
 463         contain one already. This file can usually be found in either
 464         <tt>/usr/local/etc/notion/</tt> or <tt>/etc/X11/notion/</tt>.
 465         Then add the suitably modified line
 466 <pre>
 467 dopath("name of script without extension")
 468 </pre>
 469         at the end of the file (in <tt>~/.notion/</tt>).
 470
 471     <dt >Statusbar
 472     <dd>Make sure you have <tt>cfg_statusbar.lua</tt> in <tt>~/.notion/</tt>,
 473         and add one of the monitors provided by the script in the template
 474         <em>without</em> the <tt>statusd_</tt> or such prefix.
 475
 476     <dt >Styles
 477     <dd>That's it. You can choose <tt>styles/refresh-list</tt> from
 478         the <b>F12</b> main menu to have a running instance of Ion
 479         find it, and then choose the style from the same menu.
 480
 481     </dl>
 482 </ol>
 483
 484 Some scripts may need further setup. For more information, see
 485 the scripts themselves, and the
 486 <a href="http://notion.sourceforge.net/notionconf"
 487 >documentation</a>.
 488
 489
 490 <h3>Downloading a copy</h3>
 491 <a name="download"></a>
 492
 493 A copy of this collection is shipped with each release of Notion.
 494
 495 If you really need the latest version get it from git:
 496 <pre>
 497 git clone git://notion.git.sourceforge.net/gitroot/notion/contrib
 498 </pre>
 499 This will get you a fully functional copy of the repository in the
 500 directory <tt>contrib</tt>.
 501 <p>
 502 To update a previously downloaded repository, use <tt>git pull</tt>.
 503 The command <tt>git log </tt> can be used to view the list of
 504 changes, and there is also an
 505 <a href="http://notion.git.sourceforge.net/git/gitweb.cgi?p=notion/contrib;a=atom">RSS feed</a>
 506 of the most
 507 <a href="http://notion.git.sourceforge.net/git/gitweb.cgi?p=notion/contrib;a=summary">recent changes</a>.
 508
 509 <h3>Contributing</h3>
 510 <a name="contrib"></a>
 511
 512 This section needs to be improved. For now, create a patch and submit it to the <a href="http://sourceforge.net/tracker/?group_id=314802&atid=1324530">sf.net patches tracker</a>, publish it on the <a href="http://sourceforge.net/mail/?group_id=314802">mailinglists</a>, or both.
 513
 514 <h2>Legacy</h2>
 515 <a name="legacy"></a>
 516 The scripts below are known to be broken and are only included for curiosity's sake. They range from being completely outdated and irrelevant to only requiring a minor fix. If you discover a legacy script whose functionality you would find useful, please file a bug report asking for the script to be fixed, or, even better, fix the script yourself. :-)
 517 <h3>Scripts</h3>
 518 <a name="LEGACYscripts"></a>
 519 <dl>
 520     <dt> <a href="scripts/legacy/adapt_menus.lua">adapt_menus.lua</a>
 521     <dd> Functions for creating a hierarchy of menus for various clients
 522              available. Key features are an attempt to organise by type hints (from
 523              the window titles) and collapse submenus when they contain only a few items.
 524
 525     <dt> <a href="scripts/legacy/alt_resize.lua">alt_resize.lua</a>
 526     <dd> Possibly more intuitive resizing bindings.
 527
 528     <dt> <a href="scripts/legacy/bindsearch.lua">bindsearch.lua</a>
 529     <dd> Search the current bindings table by key or by command.
 530
 531     <dt> <a href="scripts/legacy/closeorkill.lua">closeorkill.lua</a>
 532     <dd> Kill client on second close try if it did not respond to close
 533
 534     <dt> <a href="scripts/legacy/ctrl_statusbar.lua">ctrl_statusbar.lua</a>
 535     <dd> Menu-driven controller for the statusbar. Modules can be enabled/
 536     disabled from the menu, without requiring to edit the configuration file.
 537
 538     <dt> <a href="scripts/legacy/cwin_sp.lua">cwin_sp.lua</a>
 539     <dd> Create per-clientwin scratchpads
 540
 541     <dt> <a href="scripts/legacy/document_menus.lua">document_menus.lua</a>
 542     <dd> Navigate the filesystem using notion menus.
 543
 544     <dt> <a href="scripts/legacy/enumerate.lua">enumerate.lua</a>
 545     <dd> Adds "X." in front of the client windows, which may make switching
 546     between client-windows with MOD+n a little easier .
 547
 548     <dt> <a href="scripts/legacy/environment_placement_hook.lua">environment_placement_hook.lua</a>
 549     <dd> Linux-only placement hook which detects the presence of an ION_USE_WS
 550     environment variable in the processes of new windows, and uses that to
 551     determine where to place them.
 552
 553     <dt> <a href="scripts/legacy/frame_client_menu.lua">frame_client_menu.lua</a>
 554     <dd> Adds a 'Client windows' submenu to a frame's context menu, the menu contains all the clients in the current frame.
 555
 556     <dt> <a href="scripts/legacy/go_frame_or_desk.lua">go_frame_or_desk.lua</a>
 557     <dd> Replaced by wrap_workspace_or_screen. (selects frame in the specified direction. If there is
 558          no frame at that location, instead the next workspace
 559          in the direction becomes active)
 560
 561     <dt> <a href="scripts/legacy/goto_multihead.lua">goto_multihead.lua</a>
 562     <dd> A version of <tt>goto_dir</tt> that may be useful on
 563          multihead setups.
 564
 565     <dt> <a href="scripts/legacy/heuristics.lua">heuristics.lua</a>
 566     <dd> Window placement heuristics for tiled workspaces
 567
 568     <dt> <a href="scripts/legacy/histcompl.lua">histcompl.lua</a>
 569     <dd> History completion support for the line editor
 570
 571     <dt> <a href="scripts/legacy/named_floating_groupws.lua">named_floating_groupws.lua</a>
 572     <dd> Toggle (and create) floating WGroupWS:s by name.
 573
 574     <dt> <a href="scripts/legacy/nest_ws.lua">nest_ws.lua</a>
 575     <dd> Attach workspaces to windows, to e.g. have a WIonWS inside a
 576     WFloatWS, or vice versa
 577
 578     <dt> <a href="scripts/legacy/nextact.lua">nextact.lua</a>
 579     <dd> Go to first found region with activity flag set.
 580
 581     <dt> <a href="scripts/legacy/notifybox.lua">notifybox.lua</a>
 582     <dd> Show notification boxes, similar to the activity notification.
 583
 584     <dt> <a href="scripts/legacy/rotate_statusbar.lua">rotate_statusbar.lua</a>
 585     <dd> Rotate the statusbar between different templates.  This will
 586          automatically load all of the modules for notion-statusd.
 587
 588     <dt> <a href="scripts/legacy/xinerama_switcher.lua">xinerama_switcher.lua</a></dt>
 589     <dd> Replaced by wrap_workspace_or_screen. (This is similar to (and based on) <a
 590       href="scripts/legacy/go_frame_or_desk.lua">go_frame_or_desk.lua</a> but adds
 591     the ability to move between screens too. Left/right switch between
 592     screens, up/down between workspaces.)</dd>
 593 </dl>
 594
 595 <h3>Statusbar monitors</h3>
 596 <a name="LEGACYstatusbar"></a>
 597
 598 <h4>Internal monitors</h4>
 599 <a name="LEGACYstatusbar-internal"></a>
 600 <dl>
 601     <dt> <a href="statusbar/legacy/statusbar_workspace.lua">statusbar_workspace.lua</a>
 602     <dd> Show current workspace name in statusbar, or a list of workspace numbers with the active one indicated.
 603 </dl>
 604
 605 <h4>Notion-statusd monitors</h4>
 606 <a name="statusd"></a>
 607 <dl>
 608     <dt> <a href="statusd/legacy/statusd_apm.lua">statusd_apm.lua</a>
 609     <dd> Notion-statusd monitor reporting APM status; works on OpenBSD 4.0 by executing
 610     external program every minute. Now with hints for battery state and
 611     external A/C connection.
 612
 613     <dt> <a href="statusd/legacy/statusd_apm2.lua">statusd_apm2.lua</a>
 614     <dd> Notion-statusd monitor reporting APM status; works on FreeBSD by executing apm as an external program every minute. Added hints for a bit more color. Even though this is apm2, save it as statusd_apm.lua.
 615
 616
 617     <dt> <a href="statusd/legacy/statusd_batt.lua">statusd_batt.lua</a>
 618     <dd> Notion-statusd monitor reporting battery status; works with apm.
 619
 620     <dt> <a href="statusd/legacy/statusd_iface.lua">statusd_iface.lua</a>
 621     <dd> Notion-statusd monitor reporting currently used network
 622     interface.
 623
 624     <dt> <a href="statusd/legacy/statusd_info.lua">statusd_info.lua</a>
 625     <dd> Notion-statusd monitor reporting current CPU, RAM, and swap usage. Depends on <code>top</code> and <code>free</code>.
 626
 627     <dt><a href="statusd/legacy/statusd_linuxbatt.lua">statusd_linuxbatt.lua</a>
 628     <dd> Notion-statusd monitor reporting battery percentage and status using the Linux <code>/proc/acpi</code> interface.
 629
 630     <dt><a href="statusd/legacy/statusd_mcpu.lua">statusd_mcpu.lua</a>
 631     <dd> Notion-statusd monitor reporting multiple CPUs usage (average and per-CPU); works with <code>/proc/stat</code>.
 632
 633     <dt><a href="statusd/legacy/statusd_sysmon.lua">statusd_sysmon.lua</a>
 634     <dd> Notion-statusd monitor for reporting various system resources.
 635
 636     <dt><a href="statusd/legacy/statusd_volume2.lua">statusd_volume2.lua</a>
 637     <dd> Notion-statusd monitor reporting master sound volume and state (on or muted). Depends on <code>amixer</code>. Despite being named "statusd_volume2.lua", the script needs to be relabeled "statusd_volume.lua" to work.
 638 </dl>
 639
 640
 641 </body>
 642 </html>