Add note to todo-3.0
[fvwm.git] / docs / COMMANDS
blob03b72799472b826d478bb961684de02af382bb89
1 The recognized commands for fvwm 2.5.28 (from cvs) as of 17-Mar-2009:
3   #                     - Comment line (ignored)
4   *                     - Module configuration line (no space after asterisk)
5   +                     - Continue the last AddToFunc, AddToMenu or AddToDecor
6   AddButtonStyle        - Add to a button style (see ButtonStyle)
7   AddTitleStyle         - Add to a title style (see TitleStyle)
8   AddToDecor            - Add a decor definition (will be obsolete)
9   AddToFunc             - Add a function definition
10   AddToMenu             - Add a menu definition
11   All                   - Operate on all windows matching the given condition
12   AnimatedMove          - Like Move, but uses animation to move windows
13   Any                   - Operate if there is any window matching the condition
14   Beep                  - Produce a bell
15   BorderStyle           - Define a window border look (will be reworked)
16   Break                 - Stop executing the current (but not parent) function
17   BugOpts               - Set some application bug workarounds
18   BusyCursor            - Show/don't show the wait cursor in certain operations
19   ButtonState           - Disable some titlebar button states (not recommended)
20   ButtonStyle           - Define a window button look (will be reworked)
21   ChangeDecor           - Attach decor to a window (will be obsolete)
22   ChangeMenuStyle       - Attach menu style to a menu (see MenuStyle)
23   CleanupColorsets      - Reset all used colorsets with the default gray colors
24   ClickTime             - Set a time in milliseconds for click and double click
25   Close                 - Try to Delete a window, if this fails, Destroy it
26   ColorLimit            - Set limit on colors used (obsolete)
27   ColormapFocus         - Change the colormap behaviour for low-depth X servers
28   Colorset              - Manage colors used like fg, bg, image bg, gradient bg
29   CopyMenuStyle         - Copy the existing menu style to new or existing one
30   Current               - Operate on the currently focused window
31   CursorMove            - Move the cursor pointer non interactively
32   CursorStyle           - Define different cursor pointer shapes and colors
33   DefaultColors         - Set colors for the feedback window (will be obsolete)
34   DefaultColorset       - Set colors for the Move/Resize feedback window
35   DefaultFont           - The default font to use (mainly for feedback window)
36   DefaultIcon           - The default icon to use for iconified windows
37   DefaultLayers         - Set StaysOnBottom, StaysPut, StaysOnTop layer numbers
38   Delete                - Try to delete a window using the X delete protocol
39   Deschedule            - Remove commands sheduled earlier using Schedule
40   Desk                  - (obsolete, use GotoDesk instead)
41   DesktopName           - Define the desktop names used in WindowList, modules
42   DesktopSize           - Set virtual desktop size in units of physical pages
43   Destroy               - Kill a window without any warning to an application
44   DestroyDecor          - Delete decor defined by AddToDecor (will be obsolete)
45   DestroyFunc           - Delete function defined using AddToFunc
46   DestroyMenu           - Delete menu defined using AddToMenu
47   DestroyMenuStyle      - Delete menu style defined using MenuStyle
48   DestroyModuleConfig   - Delete matching module config lines defined using "*"
49   DestroyStyle          - Delete style defined using Style
50   DestroyWindowStyle    - Delete style defined using WindowStyle
51   Direction             - Operate on the next window in the specified direction
52   Echo                  - Print message to stderr, mainly for debugging
53   EchoFuncDefinition    - Print the definion of a function
54   EdgeCommand           - Bind one or another screen edge to an fvwm action
55   EdgeLeaveCommand      - Bind one or another screen edge to an fvwm action
56   EdgeResistance        - Control viewport scrolling and window move over edge
57   EdgeScroll            - Control how much of the viewport is scrolled if any
58   EdgeThickness         - Control how closely to edge to run command/scrolling
59   Emulate               - Only used to position the position/size window
60   EscapeFunc            - Abort a wait or ModuleSynchonous command
61   EwmhBaseStruts        - Define restricted areas of the screen
62   EwmhNumberOfDesktops  - For ewmh pager, define number of desktops
63   Exec                  - Execute an external command
64   ExecUseShell          - The shell to use to execute an external command
65   FakeClick             - Generate a mouse click
66   FakeKeypress          - Send a keyboard event to a window
67   FlipFocus             - Focus a window without rotating windowlist order
68   Focus                 - Give focus to a window
69   FocusStyle            - Configure focus and raise policy for windows
70   Function              - Execute a user defined function, see AddToFunc
71   GlobalOpts            - (obsolete, use corresponding Style * instead)
72   GnomeButton           - Pass mouse button presses on root to GNOME program
73   GnomeShowDesks        - Limit GNOME pager to the number of desks
74   GotoDesk              - Switch viewport to another desk same page
75   GotoDeskAndPage       - Switch viewport to another desk and page
76   GotoPage              - Switch viewport to another page same desk
77   HideGeometryWindow    - Hide/show the position/size window
78   HilightColor          - (obsolete, use Style * HighlightFore/Back)
79   HilightColorset       - (obsolete, use Style * HighlightColorset)
80   IconFont              - (obsolete, use Style * IconFont)
81   Iconify               - Change iconification status of a window (minimize)
82   IconPath              - (obsolete, use ImagePath instead)
83   IgnoreModifiers       - Modifiers to ignore on mouse and key bindings
84   ImagePath             - Directories to search for images
85   KeepRc                - Do not modify the previous command return code
86   Key                   - Bind or unbind a key to an fvwm action
87   KillModule            - Stops an fvwm module
88   Layer                 - Change the layer of a window
89   LocalePath            - Directories/domains to search for locale data
90   Lower                 - Lower a window within a layer
91   Maximize              - Toggle maximal-size status of a window
92   Menu                  - Display (post) a menu
93   MenuStyle             - Control appearance and behavior of a menu
94   Module                - Invoke an fvwm module
95   ModuleListenOnly      - Invoke an fvwm module
96   ModulePath            - Modify the directories to search for an fvwm module
97   ModuleSynchronous     - Invoke an fvwm module synchronously
98   ModuleTimeout         - Set timeout value for response from module
99   Mouse                 - Bind or unbind a mouse button press to an fvwm action
100   Move                  - Move a window
101   MoveThreshold         - Set number of pixels in a click and a hold vs. a drag
102   MoveToDesk            - Move a window to another desk same page
103   MoveToPage            - Move a window to another page same desk
104   MoveToScreen          - Move a window to another Xinerama screen
105   Next                  - Operate on the next window matching conditions
106   None                  - Perform command if no window matches conditions
107   Nop                   - Do nothing (used internally)
108   NoWindow              - Prefix that runs a command without a window context
109   OpaqueMoveSize        - Set maximum size window fvwm should move opaquely
110   Pick                  - Prefix to force a window context, prompted if needed
111   PipeRead              - Exec system command interpret output as fvwm commands
112   PixmapPath            - (obsolete, use ImagePath instead)
113   PlaceAgain            - Replace a window using initial window placement logic
114   PointerKey            - Bind an action to a key based on pointer not focus
115   PointerWindow         - Operate on window under pointer if it meets conditions
116   Popup                 - Display (pop-up) a menu, see also Menu
117   Prev                  - Operate on the precious window matching conditions
118   PrintInfo             - Print information about the state of fvwm
119   PropertyChange        - Internal, used for inter-module communication
120   Quit                  - Exit fvwm
121   QuitScreen            - Stop managing the specified screen
122   QuitSession           - Ask session manager to shut down itself and fvwm
123   Raise                 - Raise a window in a layer
124   RaiseLower            - Alternately raise or lower a window in a layer
125   Read                  - Read fvwm commands from a file
126   ReadWriteColors       - Used for colorset speed hacks (will be removed?)
127   Recapture             - Reapply styles to all windows (will be obsolete)
128   RecaptureWindow       - Reapply styles to one window (will be obsolete)
129   Refresh               - Cause all windows to redraw themselves
130   RefreshWindow         - Cause one window to redraw itself
131   Repeat                - Repeat (very unreliably) the last command, don't use
132   Resize                - Cause a window to be resized
133   ResizeMaximize        - Resize a window and mark window as maximized
134   ResizeMove            - Resize and move in one operation
135   ResizeMoveMaximize    - Resize and move in one operation and mark maximized
136   RestackTransients     - Regroup the window transients in the stack
137   Restart               - Restart itself or replace with another window manager
138   SaveQuitSession       - Cause session manager to save and shutdown fvwm
139   SaveSession           - Cause session manager to save the session
140   ScanForWindow         - Operate on the matching window in the given direction
141   Schedule              - Run an fvwm command after a delay
142   Scroll                - Scroll the desktop viewport
143   Send_ConfigInfo       - Internal, used for module communication
144   Send_Reply            - Internal, used for module communication
145   Send_WindowList       - Internal, used for module communication
146   SendToModule          - Send a string (action) to a module
147   set_mask              - Internal, used for module communication
148   set_nograb_mask       - Internal, used for module communication
149   set_sync_mask         - Internal, used for module communication
150   SetAnimation          - Control animated moves and menus
151   SetEnv                - Set an environment variable
152   Silent                - Suppress errors on command, avoid window selection
153   SnapAttraction        - Control attraction of windows during move
154   SnapGrid              - Control grid used with SnapAttraction
155   State                 - Control user defined window states
156   Stick                 - Change window stickyness
157   StickAcrossDesks      - Change window stickyness on a desk basis
158   StickAcrossPages      - Change window stickyness on a page basis
159   Stroke                - Bind a stroke to an fvwm action
160   StrokeFunc            - Record stroke and execute corresponding stroke action
161   Style                 - Set attributes of windows that match a pattern
162   TearMenuOff           - Convert a menu to a window, for use in menu items
163   Test                  - Execute command if conditions are met
164   TestRc                - Conditional switch (may be changed)
165   ThisWindow            - Operate on the context window if it meets conditions
166   Title                 - Insert title into a menu
167   TitleStyle            - Control window title
168   UnsetEnv              - Remove an environment variable
169   UpdateDecor           - Update window decor (obsolete and not needed anymore)
170   UpdateStyles          - Cause styles to update while still in a function
171   Wait                  - Pause until a matching window appears
172   WarpToWindow          - Warp the pointer to a window
173   WindowFont            - (obsolete, use Style * Font)
174   WindowId              - Execute command for window matching the windowid
175   WindowList            - Display the window list as a menu to select a window
176   WindowShade           - Shade/unshade a window
177   WindowShadeAnimate    - (obsolete, use Style * WindowShadeSteps)
178   WindowStyle           - Set styles on the selected window
179   Xinerama              - Control Xinerama support
180   XineramaPrimaryScreen - Identify Xinerama primary screen
181   XineramaSls           - Control single logical screen support
182   XineramaSlsScreens    - Configure layout for single logical screen
183   XineramaSlsSize       - Configure layout for single logical screen sizes
184   XorPixmap             - Use a pixmap for move/resize rubber-band
185   XorValue              - Change bits used for move/resize rubber-band
186   XSync                 - For debugging, send all pending requests to X server
187   XSynchronize          - For debugging, cause all X requests to be synchronous