Help:Actions

From Openbox

Revision as of 19:37, 4 June 2007 by DanaJansens (Talk | contribs)

Jump to: navigation, search

Contents

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 will be expanded to your home directory, but no other shell expansions or scripting syntax may be used in the command.
<startupnotify><enabled> no A boolean (yes/no) which says if the startup notification protocol should be used to notify other programs that an application is launching.

Example:

<keybind key="W-space">
  <action name="Execute">
    <startupnotify>
      <enabled>yes</enabled>
      <name>Terminal</name>
    </startupnotify>
    <execute>gnome-terminal</execute>
  </action>
</keybind>

<keybind key="W-t">
  <action name="Execute"><execute>xterm</execute></action>
</keybind>

NextWindow

Cycles focus to the next window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with icons for all the windows which can be focused.
<allDesktops> no A boolean (yes/no) which when enabled lets you cycle focus between windows on all desktops, instead of only on the current desktop.
<panels> no A boolean (yes/no) which when enabled lets you cycle focus to/between panel windows such as your taskbar. This can be combined with <desktop>.
<desktop> no A boolean (yes/no) which when enabled lets you cycle focus to the desktop window, if one exists (such as in GNOME or KDE). This can be combined with <panels>.
<linear> no A boolean (yes/no) which when enabled causes focus to cycle in a fixed ordering, rather than in the order which windows have been last focused.

Example:

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

PreviousWindow

Cycles focus to the previous window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with icons for all the windows which can be focused.
<allDesktops> no A boolean (yes/no) which when enabled lets you cycle focus between windows on all desktops, instead of only on the current desktop.
<panels> no A boolean (yes/no) which when enabled lets you cycle focus to/between panel windows such as your taskbar. This can be combined with <desktop>.
<desktop> no A boolean (yes/no) which when enabled lets you cycle focus to the desktop window, if one exists (such as in GNOME or KDE). This can be combined with <panels>.
<linear> no A boolean (yes/no) which when enabled causes focus to cycle in a fixed ordering, rather than in the order which windows have been last focused.

Example:

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

DirectionalFocusNorth

Cycles focus to the window north of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example:

<keybind key="W-Up">
  <action name="DirectionalFocusNorth"><dialog>yes</dialog></action>
</keybind>

DirectionalFocusSouth

Cycles focus to the window south of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example:

<keybind key="W-Down">
  <action name="DirectionalFocusSouth"/>
</keybind>

DirectionalFocusEast

Cycles focus to the window east of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example:

<keybind key="W-Right">
  <action name="DirectionalFocusEast"><dialog>yes</dialog></action>
</keybind>

DirectionalFocusWest

Cycles focus to the window west of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example:

<keybind key="W-Left">
  <action name="DirectionalFocusWest"/>
</keybind>

DirectionalFocusNorthWest

Cycles focus to the window north-west of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example:

<keybind key="W-Up">
  <action name="DirectionalFocusNorthWest"><dialog>yes</dialog></action>
</keybind>

DirectionalFocusNorthEast

Cycles focus to the window north-east of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example:

<keybind key="W-Up">
  <action name="DirectionalFocusNorthEast"/>
</keybind>

DirectionalFocusSouthWest

Cycles focus to the window south-west of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example:

<keybind key="W-Up">
  <action name="DirectionalFocusSouthWest"><dialog>yes</dialog></action>
</keybind>

DirectionalFocusSouthEast

Cycles focus to the window South-east of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example:

<keybind key="W-Up">
  <action name="DirectionalFocusSouthEast"/>
</keybind>


Desktop

Changes the visible desktop.

Option Default Value Description
<desktop> 1 The number of the desktop to switch to, starting from 1.

Example:

<keybind key="W-F1">
  <action name="Desktop"><desktop>1</desktop></action>
</keybind>
<keybind key="W-F2">
  <action name="Desktop"><desktop>2</desktop></action>
</keybind>

DesktopNext

Make the next desktop visible.

Option Default Value Description
<dialog> yes A boolean (yes/no) which makes a dialog be shown on screen which shows a simple pager and the desktop names for switching. This option can't be used for mouse bindings.
<wrap> yes A boolean (yes/no) which when enabled lets you wrap around from the last desktop to the first, and vice versa.

Example:

<mousebind button="A-Down" action="Click">
  <action name="DesktopNext"/>
</mousebind>

<keybind key="C-A-Right">
  <action name="DesktopNext"><wrap>no</wrap></action>
</keybind>

DesktopPrevious

Make the previous desktop visible.

Option Default Value Description
<dialog> yes A boolean (yes/no) which makes a dialog be shown on screen which shows a simple pager and the desktop names for switching. This option can't be used for mouse bindings.
<wrap> yes A boolean (yes/no) which when enabled lets you wrap around from the last desktop to the first, and vice versa.

Example:

<mousebind button="A-Up" action="Click">
  <action name="DesktopPrevious"/>
</mousebind>

<keybind key="C-A-Right">
  <action name="DesktopPrevious"><wrap>no</wrap></action>
</keybind>

DesktopLeft

Make the desktop to the left of the current desktop visible.

Option Default Value Description
<dialog> yes A boolean (yes/no) which makes a dialog be shown on screen which shows a simple pager and the desktop names for switching. This option can't be used for mouse bindings.
<wrap> yes A boolean (yes/no) which when enabled lets you wrap around from the last desktop to the first, and vice versa.

Example:

<keybind key="C-A-Left">
  <action name="DesktopLeft"><wrap>no</wrap></action>
</keybind>

DesktopRight

Make the desktop to the right of the current desktop visible.

Option Default Value Description
<dialog> yes A boolean (yes/no) which makes a dialog be shown on screen which shows a simple pager and the desktop names for switching. This option can't be used for mouse bindings.
<wrap> yes A boolean (yes/no) which when enabled lets you wrap around from the last desktop to the first, and vice versa.

Example:

<keybind key="C-A-Right">
  <action name="DesktopRight"><wrap>no</wrap></action>
</keybind>

DesktopUp

Make the desktop above the current desktop visible.

Option Default Value Description
<dialog> yes A boolean (yes/no) which makes a dialog be shown on screen which shows a simple pager and the desktop names for switching. This option can't be used for mouse bindings.
<wrap> yes A boolean (yes/no) which when enabled lets you wrap around from the last desktop to the first, and vice versa.

Example:

<keybind key="C-A-Up">
  <action name="DesktopUp"><wrap>no</wrap></action>
</keybind>

DesktopDown

Make the desktop below the current desktop visible.

Option Default Value Description
<dialog> yes A boolean (yes/no) which makes a dialog be shown on screen which shows a simple pager and the desktop names for switching. This option can't be used for mouse bindings.
<wrap> yes A boolean (yes/no) which when enabled lets you wrap around from the last desktop to the first, and vice versa.

Example:

<keybind key="C-A-Down">
  <action name="DesktopDown"><wrap>no</wrap></action>
</keybind>

DesktopLast

Make the most recently visible desktop visible again. Only one desktop is remembered, so using this twice will simply flip between two desktops.

Example:

<keybind key="W-space">
  <action name="DesktopLast"/>
</keybind>

ToggleShowDesktop

Hides all windows so that the desktop is visible, and gives focus to the desktop window if one exists (such as in GNOME and KDE). You can also use the action again to show the windows again, if no windows have become visible yet.

Example: <keybind key="W-d">

 <action name="ToggleShowDesktop"/>

</keybind>

ShowDesktop

Hides all windows so that the desktop is visible, and gives focus to the desktop window if one exists (such as in GNOME and KDE). Normally, what you want is ToggleShowDesktop.

Example: <keybind key="C-A-d">

 <action name="ShowDesktop"/>

</keybind>

UnshowDesktop

When ShowDesktop or ToggleShowDesktop was used, and no windows have become visible yet, this will show the hidden windows. Normally, what you want is ToggleShowDesktop.

Example:

<keybind key="C-A-d">
  <action name="UnshowDesktop"/>
</keybind>

ToggleDockAutohide

Toggles the autohide setting on the dock temporarily. This effectively means you can show/hide the dock with a keybinding.

Example:

<keybind key="C-A-d">
  <action name="ToggleDockAutohide"/>
</keybind>

Reconfigure

Prompts Openbox to reload its config file, menu and theme.

Example:

<keybind key="W-F11">
  <action name="Reconfigure"/>
</keybind>

Restart

Restarts Openbox. This starts a new copy of Openbox, and can be used to upgrade to a newly installed version without logging out of your X session.

<keybind key="W-F12">
  <action name="Restart"/>
</keybind>

Exit

Exits Openbox.

<keybind key="C-A-S-F12">
  <action name="Exit"/>
</keybind>
Personal tools