Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- AddWorkspace (Name :: string)
- Adds a new workspace to Wingo with a name Name. Note that a workspace name
- must be unique with respect to other workspaces and must have non-zero length.
- And (Op1 :: int) (Op2 :: int)
- Returns the logical AND of Op1 and Op2.
- If Op1 or Op2 is not in {0, 1}, then a warning is logged and nil is returned.
- AutoCycle (Workspace :: int | string)
- Cycles to the next automatic tiling layout in the workspace specified by
- Workspace.
- Note that this command has no effect if the workspace is not visible.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- AutoMakeMaster (Workspace :: int | string)
- Switches the current window with the first master in the layout for the
- workspace specified by Workspace.
- Note that this command has no effect if the workspace is not visible.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- AutoMaster (Workspace :: int | string)
- Focuses the (first) master window in the layout for the workspace specified
- by Workspace.
- Note that this command has no effect if the workspace is not visible.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- AutoMastersFewer (Workspace :: int | string)
- Allows one fewer master window to fit into the master split.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- AutoMastersMore (Workspace :: int | string)
- Allows one more master window to fit into the master split.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- AutoNext (Workspace :: int | string)
- Moves focus to the next client in the layout.
- Note that this command has no effect if the workspace is not visible.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- AutoPrev (Workspace :: int | string)
- Moves focus to the next client in the layout.
- Note that this command has no effect if the workspace is not visible.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- AutoResizeMaster (Workspace :: int | string) (Amount :: float)
- Increases or decreases the size of the master split by Amount in the layout on
- the workspace specified by Workspace.
- Amount should be a ratio between 0.0 and 1.0.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- AutoResizeWindow (Workspace :: int | string) (Amount :: float)
- Increases or decreases the size of the current window by Amount in the layout
- on the workspace specified by Workspace.
- Amount should be a ratio between 0.0 and 1.0.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- AutoSwitchNext (Workspace :: int | string)
- Switches the current window with the next window in the layout.
- Note that this command has no effect if the workspace is not visible.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- AutoSwitchPrev (Workspace :: int | string)
- Switches the current window with the previous window in the layout.
- Note that this command has no effect if the workspace is not visible.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- AutoTile (Workspace :: int | string)
- Initiates automatic tiling on the workspace specified by Workspace. If tiling
- is already active, the layout will be re-placed.
- Note that this command has no effect if the workspace is not visible.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- AutoUntile (Workspace :: int | string)
- Stops automatic tiling on the workspace specified by Workspace, and restores
- windows to their position and geometry before being tiled. If tiling is not
- active on the specified workspace, this command has no effect.
- Note that this command has no effect if the workspace is not visible.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- Close (Client :: int | string)
- Closes the window specified by Client.
- Client may be the window id or a substring that matches a window name.
- CycleClientChoose
- Activates the current choice in a cycle prompt.
- CycleClientHide
- Hides (i.e., cancels) the current cycle prompt.
- CycleClientNext (OnlyActiveWorkspace :: string) (OnlyVisible :: string) (ShowIconified :: string)
- Shows the cycle prompt for clients and advances the selection to the next
- client. If the cycle prompt is already visible, then the selection is advanced
- to the next client.
- OnlyActiveWorkspace specifies that only clients on the current workspace should
- be listed. Valid values are "yes" or "no".
- OnlyVisible specifies that only clients on visible workspaces should be listed.
- Valid values are "yes" or "no".
- ShowIconified specifies that iconified clients will be shown. Valid values are
- "yes" or "no".
- CycleClientPrev (OnlyActiveWorkspace :: string) (OnlyVisible :: string) (ShowIconified :: string)
- Shows the cycle prompt for clients and advances the selection to the previous
- client. If the cycle prompt is already visible, then the selection is advanced
- to the previous client.
- OnlyActiveWorkspace specifies that only clients on the current workspace should
- be listed. Valid values are "yes" or "no".
- OnlyVisible specifies that only clients on visible workspaces should be listed.
- Valid values are "yes" or "no".
- ShowIconified specifies that iconified clients will be shown. Valid values are
- "yes" or "no".
- Dale
- Make sure "audio_play_cmd" is set to a program that can play wav files.
- False
- Always returns 1.
- Float (Client :: int | string)
- Floats the window specified by Client. If the window is already floating,
- this command has no effect.
- Client may be the window id or a substring that matches a window name.
- Focus (Client :: int | string)
- Focuses the window specified by Client.
- Client may be the window id or a substring that matches a window name.
- FocusRaise (Client :: int | string)
- Focuses and raises the window specified by Client.
- Client may be the window id or a substring that matches a window name.
- FrameBorders (Client :: int | string)
- Set the decorations of the window specified by Client to the "Borders" frame.
- Client may be the window id or a substring that matches a window name.
- FrameFull (Client :: int | string)
- Set the decorations of the window specified by Client to the "Full" frame.
- Client may be the window id or a substring that matches a window name.
- FrameNada (Client :: int | string)
- Set the decorations of the window specified by Client to the "Nada" frame.
- Client may be the window id or a substring that matches a window name.
- FrameSlim (Client :: int | string)
- Set the decorations of the window specified by Client to the "Slim" frame.
- Client may be the window id or a substring that matches a window name.
- GetActive
- Returns the id of the currently active window. If there is no active window,
- 0 is returned.
- GetClientList (Workspace :: int | string)
- Returns a list of client ids separated by new lines on the workspace specified
- by Workspace. Clients are listed in their focus orderering, from most recently
- focused to least recently focused.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- GetClientName (Client :: int | string)
- Returns the name of the window specified by Client active window.
- Client may be the window id or a substring that matches a window name.
- GetClientType (Client :: int | string)
- Returns the type of the window specified by Client active window. A window
- type will either be "desktop", "dock" or "normal".
- Client may be the window id or a substring that matches a window name.
- GetClientWorkspace (Client :: int | string)
- Returns the workspace of the window specified by Client active window.
- Client may be the window id or a substring that matches a window name.
- GetLayout (Workspace :: int | string)
- Returns the name of the currently active (or "default") layout on the workspace
- specified by Workspace. Note that when a workspace is set to a tiling layout,
- it is still possible for clients to be floating.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- GetWorkspace
- Returns the name of the current workspace.
- GetWorkspaceList
- Returns a list of all workspaces, in the order that they were added.
- The special "Sticky" workspace is not included.
- GetWorkspaceNext
- Returns the name of the "next" workspace. The ordering of workspaces is
- the order in which they were added. This might cause confusing behavior in
- multi-head setups, since multiple workspaces can be viewable at one time.
- GetWorkspacePrefix (Prefix :: string)
- Returns the first non-visible workspace starting with Prefix. If the current
- workspace starts with Prefix, then the first workspace *after* the current
- workspace starting with Prefix will be returned.
- GetWorkspacePrev
- Returns the name of the "previous" workspace. The ordering of workspaces is
- the order in which they were added. This might cause confusing behavior in
- multi-head setups, since multiple workspaces can be viewable at one time.
- HeadFocus (Head :: int)
- Focuses the head indexed at Head. Indexing starts at 0. Heads are ordered
- by their physical position: left to right and then top to bottom.
- HeadFocusWithClient (Head :: int) (Client :: int | string)
- Focuses the head indexed at Head, and move the Client specified by client to
- that head. Indexing of heads starts at 0. Heads are ordered by their physical
- position: left to right and then top to bottom.
- Client may be the window id or a substring that matches a window name.
- Input (Label :: string)
- Shows a centered prompt window that allows the user to type in text. If the
- user presses the Confirm Key (i.e., enter), then the text typed into the
- input box will be returned.
- Label will be shown next to the input box.
- This command may be used as a sub-command to pass user provided arguments to
- another command.
- MatchClientClass (Client :: int | string) (Class :: string)
- Returns 1 if the "class" part of the WM_CLASS property on the window
- specified by Client contains the substring specified by Class, and otherwise
- returns 0. The search is done case insensitively.
- Client may be the window id or a substring that matches a window name.
- MatchClientInstance (Client :: int | string) (Instance :: string)
- Returns 1 if the "instance" part of the WM_CLASS property on the window
- specified by Client contains the substring specified by Instance, and otherwise
- returns 0. The search is done case insensitively.
- Client may be the window id or a substring that matches a window name.
- MatchClientIsTransient (Client :: int | string)
- Returns 1 if the window specified by Client is a transient window, and
- otherwise returns 0. A transient window usually corresponds to some kind of
- dialog window.
- Client may be the window id or a substring that matches a window name.
- MatchClientName (Client :: int | string) (Name :: string)
- Returns 1 if the name of the window specified by Client contains the substring
- specified by Name, and otherwise returns 0. The search is done case
- insensitively.
- Client may be the window id or a substring that matches a window name.
- MatchClientType (Client :: int | string) (Type :: string)
- Returns 1 if the type of the window specified by Client matches the type
- named by Type, and otherwise returns 0.
- Valid window types are "Normal", "Dock" or "Desktop".
- Client may be the window id or a substring that matches a window name.
- Maximize (Client :: int | string)
- Maximizes the window specified by Client. If the window is already maximized,
- this command has no effect.
- Client may be the window id or a substring that matches a window name.
- MouseMove
- Initiates a drag that allows a window to be moved with the mouse.
- This is a special command that can only be assigned in Wingo's mouse
- configuration file. Invoking this command in any other way has no effect.
- MouseResize (Direction :: string)
- Initiates a drag that allows a window to be resized with the mouse.
- Direction specifies how the window should be resized, and what the pointer
- should look like. For example, if Direction is set to "BottomRight", then only
- the width and height of the window can change---but not the x or y position.
- Valid values for Direction are: Infer, Top, Bottom, Left, Right, TopLeft,
- TopRight, BottomLeft and BottomRight. When "Infer" is used, the direction
- is determined based on where the pointer is on the window when the drag is
- initiated.
- This is a special command that can only be assigned in Wingo's mouse
- configuration file. Invoking this command in any other way has no effect.
- Move (Client :: int | string) (X :: float | int) (Y :: float | int)
- Moves the window specified by Client to the x and y position specified by
- X and Y. Note that the origin is located in the top left corner.
- X and Y may either be pixels (integers) or ratios in the range 0.0 to
- 1.0 (specifically, (0.0, 1.0]). Ratios are measured with respect to the
- window's workspace's geometry.
- Client may be the window id or a substring that matches a window name.
- MovePointer (X :: int) (Y :: int)
- Moves the pointer to the x and y position specified by X and Y. Note the the
- origin is located in the top left corner.
- MovePointerRelative (X :: int) (Y :: int)
- Moves the pointer to the x and y position specified by X and Y relative to the
- current workspace. Note the the origin is located in the top left corner of
- the current workspace.
- MoveRelative (Client :: int | string) (X :: float | int) (Y :: float | int)
- Moves the window specified by Client to the x and y position specified by
- X and Y, relative to its workspace. Note that the origin is located in the top
- left corner of the client's workspace.
- X and Y may either be pixels (integers) or ratios in the range 0.0 to
- 1.0 (specifically, (0.0, 1.0]). Ratios are measured with respect to the
- window's workspace's geometry.
- Client may be the window id or a substring that matches a window name.
- Not (Op :: int)
- Returns the negation of Op. When Op is 0, Not returns 1. When Op is 1, Not
- returns 0.
- If Op is not in {0, 1}, then a warning is logged and nil is returned.
- Or (Op1 :: int) (Op2 :: int)
- Returns the logical OR of Op1 and Op2.
- If Op1 or Op2 is not in {0, 1}, then a warning is logged and nil is returned.
- Quit
- Stops Wingo.
- Raise (Client :: int | string)
- Raises the window specified by Client to the top of its layer.
- Client may be the window id or a substring that matches a window name.
- RemoveWorkspace (Workspace :: int | string)
- Removes the workspace specified by Workspace. Note that a workspace can *only*
- be removed if it is empty (i.e., does not contain any windows).
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- Resize (Client :: int | string) (Width :: float | int) (Height :: float | int)
- Resizes the window specified by Client to some width and height specified by
- Width and Height.
- Width and Height may either be pixels (integers) or ratios in the range 0.0 to
- 1.0 (specifically, (0.0, 1.0]). Ratios are measured with respect to the
- window's workspace's geometry.
- Client may be the window id or a substring that matches a window name.
- Restart
- Restarts Wingo in place using exec. This should be used to reload Wingo
- after you've made changes to its configuration.
- SelectClient (TabCompletion :: string) (OnlyActiveWorkspace :: string) (OnlyVisible :: string) (ShowIconified :: string)
- Shows a centered prompt window with a list of clients satisfying the arguments
- provided.
- OnlyActiveWorkspace specifies that only clients on the current workspace should
- be listed. Valid values are "yes" or "no".
- OnlyVisible specifies that only clients on visible workspaces should be listed.
- Valid values are "yes" or "no".
- ShowIconified specifies that iconified clients will be shown. Valid values are
- "yes" or "no".
- TabCompletetion can be set to either "Prefix" or "Any". When it's set to
- "Prefix", the clients can be searched by a prefix matching string. When it's set
- to "Any", the clients can be searched by a substring matching string.
- This command may be used as a sub-command to pass a particular client to
- another command.
- SelectWorkspace (TabCompletion :: string)
- Shows a centered prompt window with a list of all workspaces.
- TabCompletetion can be set to either "Prefix" or "Any". When it's set to
- "Prefix", the workspaces can be searched by a prefix matching string. When it's
- set to "Any", the workspaces can be searched by a substring matching string.
- This command may be used as a sub-command to pass a particular workspace to
- another command.
- SetLayout (Workspace :: int | string) (Name :: string)
- Sets the current layout of the workspace specified by Workspace to the layout
- named by Name. If a layout with name Name does not exist, this command has
- no effect.
- Note that this command has no effect if the workspace is not visible.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- SetOpacity (Client :: int | string) (Opacity :: float)
- Sets the opacity of the window specified by Client to the opacity level
- specified by Opacity.
- This command won't have any effect unless you're running a compositing manager
- like xcompmgr or cairo-compmgr.
- Client may be the window id or a substring that matches a window name.
- Opacity should be a float in the range 0.0 to 1.0, inclusive, where 0.0 is
- completely transparent and 1.0 is completely opaque.
- Shell (Command :: string)
- Attempts to execute the shell command specified by Command. If an error occurs,
- it will be logged to Wingo's stderr.
- Note that the parser for translating shell commands to something acceptable
- for Go's os/exec package is fairly primitive. Therefore, this should not be
- considered as a suitable replacement for similar utilities (like gmrun or
- xbindkeys).
- ToggleFloating (Client :: int | string)
- Toggles whether the window specified by Client should be forced into the
- floating layout. A window forced into the floating layout CANNOT be tiled.
- Client may be the window id or a substring that matches a window name.
- ToggleIconify (Client :: int | string)
- Iconifies (minimizes) or deiconifies (unminimizes) the window specified by
- Client.
- Client may be the window id or a substring that matches a window name.
- ToggleMaximize (Client :: int | string)
- Maximizes or restores the window specified by Client.
- Client may be the window id or a substring that matches a window name.
- ToggleStackAbove (Client :: int | string)
- Toggles the layer of the window specified by Client from normal to above. When
- a window is in the "above" layer, it will always be above other (normal)
- clients.
- Client may be the window id or a substring that matches a window name.
- ToggleStackBelow (Client :: int | string)
- Toggles the layer of the window specified by Client from normal to below. When
- a window is in the "below" layer, it will always be below other (normal)
- clients.
- Client may be the window id or a substring that matches a window name.
- ToggleSticky (Client :: int | string)
- Toggles the sticky status of the window specified by Client. When a window is
- sticky, it will always be visible unless iconified. (i.e., it does not belong
- to any particular workspace.)
- Client may be the window id or a substring that matches a window name.
- True
- Always returns 1.
- Unfloat (Client :: int | string)
- Unfloats the window specified by Client. If the window is not floating,
- this command has no effect.
- Client may be the window id or a substring that matches a window name.
- Unmaximize (Client :: int | string)
- Unmaximizes the window specified by Client. If the window is not maximized,
- this command has no effect.
- Client may be the window id or a substring that matches a window name.
- WingoExec (Commands :: string)
- Executes a series of Wingo commands specified by Commands. If an error occurs
- while executing the command, it will be shown in a popup message.
- WingoHelp (CommandName :: string)
- Shows the usage information for a particular command specified by CommandName.
- Workspace (Workspace :: int | string)
- Sets the current workspace to the one specified by Workspace.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- WorkspaceGreedy (Workspace :: int | string)
- Sets the current workspace to the one specified by Workspace in a greedy
- fashion.
- A greedy switch *always* brings the specified workspace to the
- currently focused head. (N.B. Greedy is only different when switching between
- two visible workspaces.)
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- WorkspaceGreedyWithClient (Workspace :: int | string) (Client :: int | string)
- Sets the current workspace to the workspace specified by Workspace in a greedy
- fashion, and moves the window specified by Client to that workspace.
- A greedy switch *always* brings the specified workspace to the
- currently focused head. (N.B. Greedy is only different when switching between
- two visible workspaces.)
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- Client may be the window id or a substring that matches a window name.
- WorkspaceSendClient (Workspace :: int | string) (Client :: int | string)
- Sends the window specified by Client to the workspace specified by Workspace.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- Client may be the window id or a substring that matches a window name.
- WorkspaceWithClient (Workspace :: int | string) (Client :: int | string)
- Sets the current workspace to the workspace specified by Workspace, and moves
- the window specified by Client to that workspace.
- Workspace may be a workspace index (integer) starting at 0, or a workspace name.
- Client may be the window id or a substring that matches a window name.
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement