Help:Actions

From Openbox

Revision as of 23:45, 3 June 2007 by DanaJansens (Talk | contribs)

Jump to: navigation, search

Actions are used to specify the behavior of Openbox. Actions are used in both keyboard and mouse bindings.

Contents

Actions

As discussed in the keyboard and mouse bindings guide, actions are used inside these bindings. You can put more than one action in a row in any binding to have it perform more than one action.

Here are a couple examples of actions, with and without parameters:

<keybind key="A-Tab">
  <action name="NextWindow"/>
</keybind>
<keybind key="A-S-Tab">
  <action name="PreviousWindow"/>
</keybind>
<keybind key="C-A-Tab">
  <action name="NextWindow">
    <panels>yes</panels><desktop>yes</desktop>
  </action>
</keybind>

Syntax

The full syntax for an action is:

<action name="NAME">OPTIONS</action>

If you are not setting any parameters, you can use this (but don't forget the trailing "/" !):

<action name="NAME" />

Name

The NAME is the name of the action, which specifies which action to run. See the list of actions to see what names are possible.

Options

The OPTIONS are 0 or more options for the given action, that change how the action will behave. Each action has its own options, and some don't have any. See the list of actions to see the options available to each action.

Options are specified such as this:

<action name="NAME">
  <option1>value</option1>
  <option2>value</option2>
  ...
</action>

List of actions

Global actions

These actions are not used to manipulate windows. As such, they work whether a window is currently focused or not.

Execute

Runs a program

Option Default Value Description
<execute> "" A string which is the command to be executed, along with any arguments to be passed to it. The "~" tilde character which is expanded to your home directory, but no other shell expansions or scripting syntax may be used in the command.
Personal tools