The XFce Desktop Environment
Prev |  | Next

# XFwm commands

This large section describes all xfwm commands that may be used in menus and function definitions. For menus generally only the "Exec", "PopUp" and "Nop" commands are used.

Table 13-1. XFwm commands

Command | Description | Example
--- | --- | ---
ArrangeIcons [<desk1> <desk2>] | Arange icons on the current desk or on <desk1> to <desk2> | ArrangeIcons 0 9
Beep | Produces a beep | Beep
Close | Close a window | Close
Current [conditions] <command> | The Current, Next and Prev commands take a condition between square brackets as first argument and a command as second argument. The condition limits the action to certain window states. Possible conditions are described in the paragraph after this table. | Current [!Iconic] Focus
Delete | Sends a message to a window asking that it removes itself | Delete
Desk <step> Desk 0 <desk> | Change to another desk/workspace. You can either specify a step (1 means to next workspace, -1 means to previous workspace) or when the first argument is 0, you can specify the number of the worlspace to go to (starting from 0). | Desk -1 Desk 0 3
Destroy | Send destroy signal to a window | Destroy
Echo <s> | Prints string to stderr | Echo "Done"
Exec <c> | Executes a command | Exec xedit
FlipFocus | Toggle focus between last two active windows | FlipFocus
Focus | Gives focus to a window | Focus
Function <fn> | Executes a function. Mostly used in mouse and key bindings. | Mouse 1 T A Function Move-or-Raise
Iconify | (De)Iconifies a window | Iconify
IconifyAll | Iconifies all windows in a workspace | IconifyAll
KillModule <m> | Kills a module | KillModule xfpager
Lower | Lowers a window | Lower
Maximize [<p1> <p2>] | Maximizes a window. You may specify a horizontal percentage p1 and a vertical percentage p2. | Maximize 0 100
Menu <m> <dbl-click-action> | Displays menu or triggers action if user performed a double click | Menu "Utilities" Close
Module <m> | Executes a module | Module xfce
Move [<x> <y>] | Moves a window | Move
Next [conditions] <command> | The Current, Next and Prev commands take a condition between square brackets as first argument and a command as second argument. The condition limits the action to certain window states. Possible conditions are described in the paragraph after this table. | Next [!Iconic] Focus
None | Does nothing | None
Nop | No operation. Creates a separator in a menu | AddToMenu "user_menu" "" Nop
PopUp | Pops up a menu | AddToMenu "user_menu" "My Menu" PopUp "my_menu"
Prev [conditions] <command> | The Current, Next and Prev commands take a condition between square brackets as first argument and a command as second argument. The condition limits the action to certain window states. Possible conditions are described in the paragraph after this table. | Prev [!Iconic] Focus
Quit | Quits xfwm and consequently exits the X session, closing all running applications | Quit
Raise | Raises a window | Raise
RaiseLower | Raises or Lowers a window dependng on current state | RaiseLower
Read <f> | Reads a configuration file | Read ~/.xfce/myssettings
Recapture | Recapture all windows | Recapture
Refresh | Refresh the screen | Refresh
RefreshWindow | Refresh current window | RefreshWindow
Resize [<x <y>] | Resizes a window | Resize
Restart | Restart xfwm | Restart
Shade | (Un)Shades a window | Shade
ShowMeMouse | Shows the mouse by animating a circle around the pointer | ShowMeMouse
Stick | Make a window sticky | Stick
Switch | Switch focus to next window | Switch
Wait <name> | Waits until window <name> appears | Wait xterm
WarpToWindow <p1> <p2> | Warps mouse pointer to window. <p1> and <p2> are horizontal and vertical percentage of the screen. | WarpToWindow 50 50
WindowId <n> <cmd> | Perform an action on window with ID <n> as shown in the windowlist. Used in WindowListFunc, which is executed when an entry in the windowlist is pressed. | WindowId $0 Focus
WindowList | Gives a list of all windows on the screen | WindowList
WindowsDesk <step> WindowsDesk 0 <desk> | Send current window to another desk/workspace. You can either specify a step (1 means to next workspace, -1 means to previous workspace) or when the first argument is 0, you can specify the number of the worlspace to go to (starting from 0). | WindowsDesk -1 WindowsDesk 0 3

The window circulation functions Next, Prev and Current take an argument between square brackets to customize the behaviour. Conditions may be combined separated by spaces.

     Next [ !Iconic CurrentDesk] Iconify

Recognized conditions are :

- ! : Negates the following option

- Iconic

- Visible

- Sticky

- Maximized

- Transient

- Raised

- CurrentDesk

- CurrentPage

- CurrentPageAnyDesk

- CurrentScreen

- CirculateHit

- CirculateHitIcon

Prev | Home | Next
Menus and functions | Up | Keyboard shortcuts and mouse bindings