subtle » subtle-contrib

h1. Subtle-contrib

{{>toc}}

Contrib is just a collection of scripts for [[subtle:subtle]], currently there is no package available and you need to clone the repository to a place you are comfortable with:

bq. hg clone http://hg.subforge.org/subtle-contrib

_These scripts may work, if you encounter any problems please ask in the usual places._

h2. Graviton

Graviton is a helper to create custom [[subtle:gravity|gravities]] visually.

{{lightbox(contrib/graviton, Graviton)}}

h3. Usage

Start [wiki#Graviton|Graviton]] on the commandline via @ruby graviton.rb@. Then just draw rectangles on the grid like e.g. via the rectangular masking tool from "GIMP":http://www.gimp.org/. Every new rectangle will have a different color to make it easier to distingish between each. To resize a rectangle press the left mouse button on one of the corners and move the mouse.

The *print* button will display the created new [subtle:gravity|gravities]] with their color name in a format that can be used in the config of [[subtle:subtle]].

h3. Colors

Following colors are used in [[wiki#Graviton|Graviton]] in given order:

{{color(#00FFFF, cyan)}}

{{color(#008000, green)}}

{{color(#808000, olive)}}

{{color(#008080, teal)}}

{{color(#0000FF, blue)}}

{{color(#C0C0C0, silver)}}

{{color(#00FF00, lime)}}

{{color(#000080, navy)}}

{{color(#800080, purple)}}

{{color(#FF00FF, magenta)}}

{{color(#800000, maroon)}}

{{color(#FF0000, red)}}

{{color(#FFFF00, yellow)}}

{{color(#808080, gray)}}

h2. Launcher

Launcher that combines modes/tagging of [[subtle:subtle]] with a browser search bar.

{{lightbox(contrib/launcher, Launcher)}}

Make sure that levenshtein.rb is also in the PATH otherwise launcher will not work

h3. Features

* Search for stuff via "Google":http://www.google.com (Chrome/Opera/Firefox)

* Point your browser directly to an uri

* Launch programs in path

* Create tags on the fly with *#tag*

* Create views on the fly with *@view*

* Set modes on the fly with *+* = full, *^* = float and *** = stick

* Tab completion for programs, views and tags

h3. Usage

Either call it like @ruby launcher.rb@ from commandline or add following loader and [[subtle:grabs|grab]] to your [[subtle:subtle]] config.

<pre>{{hide}}<code class="ruby">

begin

  require "#{ENV["HOME"]}/path/to/launcher.rb"

rescue LoadError => error

  puts error

end

grab "W-x" do

  Subtle::Contrib::Launcher.run

end

</code></pre>

h3. Configuration

Per default, the [[launcher]] uses *fixed* as font and loads entries from */usr/bin*. This can be changed after requiring the @launcher.rb@ and +before+ running it for the first time.

h4. Fonts

<pre>{{hide}}<code class="ruby">

begin

  require "#{ENV["HOME"]}/path/to/launcher.rb"

  # Set fonts

  Subtle::Contrib::Launcher.fonts = [

    "xft:DejaVu Sans Mono:pixelsize=80:antialias=true",

    "xft:DejaVu Sans Mono:pixelsize=12:antialias=true"

  ]

rescue LoadError => error

  puts error

end

</code></pre>

h4. Paths

<pre>{{hide}}<code class="ruby">

begin

  require "#{ENV["HOME"]}/path/to/launcher.rb"

  # Set paths

  Subtle::Contrib::Launcher.paths = [ "/usr/bin", "~/bin" ]

rescue LoadError => error

  puts error

end

</code></pre>

h3. Examples

|_. Insert             |_. Description                                                                    |

| g subtle wm          | Change to browser view and search for _subtle wm_ via "Google":http://google.com |

| urxvt @editor        | Open urxvt on view @editor with dummy tag                                        |

| urxvt @editor #work  | Open urxvt on view @editor with tag _work_                                       |

| urxvt #work          | Open urxvt and tag with tag _work_                                               |

| urxvt -urgentOnBell  | Open urxvt with the urgentOnBell option                                          |

| +urxvt               | Open urxvt and set full mode                                                     |

| ^urxvt               | Open urxvt and set floating mode                                                 |

| *urxvt               | Open urxvt and set sticky mode                                                   |

| urx<hit tab>         | Open urxvt (tab completion)                                                      |

h2. Selector

Merge tags of current and selected views temporarily.

{{lightbox(contrib/merger, Merger)}}

h3. Colors

|_. Color triplet |_. Meaning                |

| Focus           | Currently selected view  |

| Title           | Current view             |

| View            | Unselected views         |

| Urgent          | Selected views for merge |

h3. Keys

|_. Keys      |_. Action                                       |

| Left, Up    | Move to left                                   |

| Right, Down | Move to right                                  |

| Escape      | Hide/exit merger                               |

| Space       | Select view for merge                          |

| Return      | Merge selected views and exit hide/exit merger |

h3. Usage

Either call it like @ruby merger.rb@ from commandline or add following loader and [[subtle:grabs|grab]] to your [[subtle:subtle]] config.

<pre>{{hide}}<code class="ruby">

begin

  require "#{ENV["HOME"]}/path/to/merger.rb"

rescue LoadError => error

  puts error

end

grab "W-m" do

  Subtle::Contrib::Merger.run

end

</code></pre>

h3. Configuration

Per default, the [[Wiki#Merger|merger]] uses *fixed* as font, this can be changed after requiring the @merger.rb@ and +before+ running it for the first time.

h4. Fonts

<pre>{{hide}}<code class="ruby">

begin

  require "#{ENV["HOME"]}/path/to/merger.rb"

  # Set font

  Subtle::Contrib::Merger.font = "xft:DejaVu Sans Mono:pixelsize=80:antialias=true"

rescue LoadError => error

  puts error

end

</code></pre>

h2. Selector

Client selector that works like the subscription selector in "Google Reader":http://www.google.com/reader

{{lightbox(contrib/selector, Selector)}}

h3. Colors

|_. Color triplet |_. Meaning                       |

| Focus           | Currently selected client       |

| Occupied        | Visible clients on current view |

| View            | Currently not visible clients   |

h3. Keys

|_. Keys            |_. Action                                         |

| Left, Up          | Move to left                                     |

| Right, Down       | Move to right                                    |

| Tab               | Cycle through windows/matches                    |

| Escape            | Leave input mode/exit selector                   |

| Return            | Focus currently selected and hide/exit selector  |

| Any capital/digit | Select client prefixed with capital letter/digit |

| Any text          | Select client with matching instance name        |

h3. Usage

Either call it like @ruby selector.rb@ from commandline or add following loader and [[subtle:grabs|grab]] to your [[subtle:subtle]] config.

<pre>{{hide}}<code class="ruby">

begin

  require "#{ENV["HOME"]}/path/to/selector.rb"

rescue LoadError => error

  puts error

end

grab "W-x" do

  Subtle::Contrib::Selector.run

end

</code></pre>

h3. Configuration

Per default, the [[Wiki#Selector|selector]] uses *fixed* as font and loads entries from */usr/bin*. This can be changed after requiring the @selector.rb@ and +before+ running it for the first time.

h4. Fonts

<pre>{{hide}}<code class="ruby">

begin

  require "#{ENV["HOME"]}/path/to/selector.rb"

  # Set font

  Subtle::Contrib::Selector.font = "xft:DejaVu Sans Mono:pixelsize=80:antialias=true"

rescue LoadError => error

  puts error

end

</code></pre>

h2. Styler

Helper to create or change [[subtle:subtle]] color [[subtle:themes]].

{{lightbox(contrib/styler, Styler)}}

h3. Usage

Start "Styler":http://subforge.org/projects/subtle-contrib/wiki/Wiki/edit#Styler on the commandline via @ruby styler.rb@. It will display a preview of the current colors of "subtle":http://subtle.subforge.org and various color buttons to change them via a color chooser.

The *print* button will show the new colors on the commandline.

h2. Vitag

Vitag is a helper to edit window/view tagging with any editor (*$EDITOR*)

h3. Usage

Helper that provides a way to change the tags of all views and windows at once. It basically just opens your favorite editor via editor set in *$EDITOR* and prints every view and running client followed by it's tags. When the tags are changed and the file saved it will send the changes to [[subtle:subtle]] in one single event per view/client and non-existing tags will be created accordingly.

h3. Examples

<pre><code># Views

@terms #default #terms

@www #browser

@gimp #gimp_image #gimp_toolbox #gimp_dock

@dev #editor

# Clients

xterm #terms

</code></pre>