| 1 |
Compiz Boxmenu |
| 2 |
|
| 3 |
=== Requirements === |
| 4 |
|
| 5 |
* A recent version of GLib 2.x and GTK+ 2.x |
| 6 |
* libwnck (2.20 is probably best, but not strictly required) |
| 7 |
* dbus (you must have a running session bus) and dbus-glib (for dbus version) |
| 8 |
|
| 9 |
It does not strictly require compiz (but it does need a recent version of the |
| 10 |
vpswitch plugin for 'Initiate on Desktop' to work) |
| 11 |
|
| 12 |
=== Install === |
| 13 |
|
| 14 |
$ make |
| 15 |
$ sudo make install |
| 16 |
|
| 17 |
Prefix support is currently broken, so it only works correctly if you install |
| 18 |
to /usr (will be fixed when it gets a proper buildsystem or perhaps sooner) |
| 19 |
|
| 20 |
=== Usage === |
| 21 |
|
| 22 |
For the lazy, you can run the provided "autoconfig-compiz.py" script (as your |
| 23 |
user, *not* as root!), but here's what it sets: |
| 24 |
+ General Options > Commands > Commands > Command line 0 to "compiz-boxmenu" |
| 25 |
+ General Options > Commands > Key bindings > Run command 0 to "<Control>space" |
| 26 |
+ Viewport Switcher > Desktop-based Viewport Switching > Plugin for initiate |
| 27 |
action to "core" |
| 28 |
+ Viewport Switcher > Desktop-based Viewport Switching > Action name for |
| 29 |
initiate to "run_command0_key" |
| 30 |
|
| 31 |
=== Menu Format === |
| 32 |
|
| 33 |
The default menu lives at /etc/xdg/compiz/boxmenu/menu.xml. You can override |
| 34 |
that menu by copying it to ~/.config/compiz/boxmenu/menu.xml (it's XDG |
| 35 |
basedir-compliant, so if you're setting those variables, adjust accordingly) |
| 36 |
|
| 37 |
Menus: <menu title="Title"> Menus can contain <item> and more <menu> tags (so |
| 38 |
they're infinitely nestable!). The title attribute is optional and is ignored |
| 39 |
for the toplevel menu. You can also set the icon for a menu by setting the |
| 40 |
icon="/path/or/name/of/icon" attribute |
| 41 |
|
| 42 |
Items: <item type="Type"> There are a few supported item types: |
| 43 |
* launcher: supports the following child elements: |
| 44 |
- <name>: the label to show in the menu |
| 45 |
- <icon>: the icon name to use in the menu. |
| 46 |
This name is looked up by gtk+, so you can toss custom icons in |
| 47 |
~/.icons/$YOUR_THEME/$ICON_SIZE/apps/ or ~/.local/share/icons. By setting |
| 48 |
the mode1="file" attribute, you can specify icons located in nonstandard |
| 49 |
locations (like ~/.face for your login icon) |
| 50 |
- <command>: the launcher command line, now can be used as |
| 51 |
a pipemenu by setting the mode2="pipe" attribute (this was done |
| 52 |
to make up for the removal of pipeitems) |
| 53 |
* separator: a simple GtkSeparatorMenuItem. You can add some more flare by |
| 54 |
setting the icon="/path/or/name/of/icon" attribute and setting the |
| 55 |
name="yourcustomname" attribute. You can also set a dynamic name for the |
| 56 |
separator by setting the mode="exec" attribute. |
| 57 |
* windowlist: libwnck-based window list menu. It also supports the following |
| 58 |
child elements: |
| 59 |
- <icon>: just like launcher's <icon> |
| 60 |
* viewportlist: libwnck-based viewport list menu. It also supports the |
| 61 |
following child elements: |
| 62 |
- <icon>: just like launcher's <icon> |
| 63 |
- <vpicon>: just like icon, except for the viewports |
| 64 |
- <wrap>: specifies whether the viewport list should have wrapped navigation |
| 65 |
* reload: reload button (it actually quits the daemon) |
| 66 |
- <icon>: just like launcher's <icon> |
| 67 |
* documents: access to recent documents list |
| 68 |
- <icon>: just like launcher's <icon> |
| 69 |
- <command>: just like launcher's <command>, except it is used to open files |
| 70 |
in the document list |
| 71 |
|
| 72 |
=== Implementation === |
| 73 |
|
| 74 |
It compiles into two binaries, compiz-boxmenu and compiz-boxmenu-daemon. |
| 75 |
compiz-boxmenu is a simple dbus client that connects |
| 76 |
to org.compiz_fusion.boxmenu and calls the show method. The actual menu is |
| 77 |
compiz-boxmenu-daemon, but you shouldn't ever need to manually launch it; the |
| 78 |
dbus service file will cause it to be automatically spawned when the name is |
| 79 |
requested. |
| 80 |
|
| 81 |
There are also four other binaries that allow you to call up the viewport list, |
| 82 |
windowlist, desktop list, and documents list on their own. These are |
| 83 |
compiz-boxmenu-vplist, compiz-boxmenu-wlist, compiz-boxmenu-dplist, |
| 84 |
and compiz-boxmenu-dlist. |
| 85 |
|
| 86 |
You can also edit the menu by running compiz-boxmenu-editor |
| 87 |
|
| 88 |
== Credits == |
| 89 |
crdlb for the original |
| 90 |
Openbox developers for the pipeitem -> pipemenu idea |
| 91 |
Windowmaker developers for the filebrowser idea |