Advertisement
Guest User

Untitled

a guest
Oct 22nd, 2012
103
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 22.17 KB | None | 0 0
  1. AddWorkspace (Name :: string)
  2. Adds a new workspace to Wingo with a name Name. Note that a workspace name
  3. must be unique with respect to other workspaces and must have non-zero length.
  4.  
  5. And (Op1 :: int) (Op2 :: int)
  6. Returns the logical AND of Op1 and Op2.
  7.  
  8. If Op1 or Op2 is not in {0, 1}, then a warning is logged and nil is returned.
  9.  
  10. AutoCycle (Workspace :: int | string)
  11. Cycles to the next automatic tiling layout in the workspace specified by
  12. Workspace.
  13.  
  14. Note that this command has no effect if the workspace is not visible.
  15.  
  16. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  17.  
  18. AutoMakeMaster (Workspace :: int | string)
  19. Switches the current window with the first master in the layout for the
  20. workspace specified by Workspace.
  21.  
  22. Note that this command has no effect if the workspace is not visible.
  23.  
  24. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  25.  
  26. AutoMaster (Workspace :: int | string)
  27. Focuses the (first) master window in the layout for the workspace specified
  28. by Workspace.
  29.  
  30. Note that this command has no effect if the workspace is not visible.
  31.  
  32. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  33.  
  34. AutoMastersFewer (Workspace :: int | string)
  35. Allows one fewer master window to fit into the master split.
  36.  
  37. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  38.  
  39. AutoMastersMore (Workspace :: int | string)
  40. Allows one more master window to fit into the master split.
  41.  
  42. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  43.  
  44. AutoNext (Workspace :: int | string)
  45. Moves focus to the next client in the layout.
  46.  
  47. Note that this command has no effect if the workspace is not visible.
  48.  
  49. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  50.  
  51. AutoPrev (Workspace :: int | string)
  52. Moves focus to the next client in the layout.
  53.  
  54. Note that this command has no effect if the workspace is not visible.
  55.  
  56. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  57.  
  58. AutoResizeMaster (Workspace :: int | string) (Amount :: float)
  59. Increases or decreases the size of the master split by Amount in the layout on
  60. the workspace specified by Workspace.
  61.  
  62. Amount should be a ratio between 0.0 and 1.0.
  63.  
  64. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  65.  
  66. AutoResizeWindow (Workspace :: int | string) (Amount :: float)
  67. Increases or decreases the size of the current window by Amount in the layout
  68. on the workspace specified by Workspace.
  69.  
  70. Amount should be a ratio between 0.0 and 1.0.
  71.  
  72. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  73.  
  74. AutoSwitchNext (Workspace :: int | string)
  75. Switches the current window with the next window in the layout.
  76.  
  77. Note that this command has no effect if the workspace is not visible.
  78.  
  79. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  80.  
  81. AutoSwitchPrev (Workspace :: int | string)
  82. Switches the current window with the previous window in the layout.
  83.  
  84. Note that this command has no effect if the workspace is not visible.
  85.  
  86. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  87.  
  88. AutoTile (Workspace :: int | string)
  89. Initiates automatic tiling on the workspace specified by Workspace. If tiling
  90. is already active, the layout will be re-placed.
  91.  
  92. Note that this command has no effect if the workspace is not visible.
  93.  
  94. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  95.  
  96. AutoUntile (Workspace :: int | string)
  97. Stops automatic tiling on the workspace specified by Workspace, and restores
  98. windows to their position and geometry before being tiled. If tiling is not
  99. active on the specified workspace, this command has no effect.
  100.  
  101. Note that this command has no effect if the workspace is not visible.
  102.  
  103. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  104.  
  105. Close (Client :: int | string)
  106. Closes the window specified by Client.
  107.  
  108. Client may be the window id or a substring that matches a window name.
  109.  
  110. CycleClientChoose
  111. Activates the current choice in a cycle prompt.
  112.  
  113. CycleClientHide
  114. Hides (i.e., cancels) the current cycle prompt.
  115.  
  116. CycleClientNext (OnlyActiveWorkspace :: string) (OnlyVisible :: string) (ShowIconified :: string)
  117. Shows the cycle prompt for clients and advances the selection to the next
  118. client. If the cycle prompt is already visible, then the selection is advanced
  119. to the next client.
  120.  
  121. OnlyActiveWorkspace specifies that only clients on the current workspace should
  122. be listed. Valid values are "yes" or "no".
  123.  
  124. OnlyVisible specifies that only clients on visible workspaces should be listed.
  125. Valid values are "yes" or "no".
  126.  
  127. ShowIconified specifies that iconified clients will be shown. Valid values are
  128. "yes" or "no".
  129.  
  130. CycleClientPrev (OnlyActiveWorkspace :: string) (OnlyVisible :: string) (ShowIconified :: string)
  131. Shows the cycle prompt for clients and advances the selection to the previous
  132. client. If the cycle prompt is already visible, then the selection is advanced
  133. to the previous client.
  134.  
  135. OnlyActiveWorkspace specifies that only clients on the current workspace should
  136. be listed. Valid values are "yes" or "no".
  137.  
  138. OnlyVisible specifies that only clients on visible workspaces should be listed.
  139. Valid values are "yes" or "no".
  140.  
  141. ShowIconified specifies that iconified clients will be shown. Valid values are
  142. "yes" or "no".
  143.  
  144. Dale
  145. Make sure "audio_play_cmd" is set to a program that can play wav files.
  146.  
  147. False
  148. Always returns 1.
  149.  
  150. Float (Client :: int | string)
  151. Floats the window specified by Client. If the window is already floating,
  152. this command has no effect.
  153.  
  154. Client may be the window id or a substring that matches a window name.
  155.  
  156. Focus (Client :: int | string)
  157. Focuses the window specified by Client.
  158.  
  159. Client may be the window id or a substring that matches a window name.
  160.  
  161. FocusRaise (Client :: int | string)
  162. Focuses and raises the window specified by Client.
  163.  
  164. Client may be the window id or a substring that matches a window name.
  165.  
  166. FrameBorders (Client :: int | string)
  167. Set the decorations of the window specified by Client to the "Borders" frame.
  168.  
  169. Client may be the window id or a substring that matches a window name.
  170.  
  171. FrameFull (Client :: int | string)
  172. Set the decorations of the window specified by Client to the "Full" frame.
  173.  
  174. Client may be the window id or a substring that matches a window name.
  175.  
  176. FrameNada (Client :: int | string)
  177. Set the decorations of the window specified by Client to the "Nada" frame.
  178.  
  179. Client may be the window id or a substring that matches a window name.
  180.  
  181. FrameSlim (Client :: int | string)
  182. Set the decorations of the window specified by Client to the "Slim" frame.
  183.  
  184. Client may be the window id or a substring that matches a window name.
  185.  
  186. GetActive
  187. Returns the id of the currently active window. If there is no active window,
  188. 0 is returned.
  189.  
  190. GetClientList (Workspace :: int | string)
  191. Returns a list of client ids separated by new lines on the workspace specified
  192. by Workspace. Clients are listed in their focus orderering, from most recently
  193. focused to least recently focused.
  194.  
  195. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  196.  
  197. GetClientName (Client :: int | string)
  198. Returns the name of the window specified by Client active window.
  199.  
  200. Client may be the window id or a substring that matches a window name.
  201.  
  202. GetClientType (Client :: int | string)
  203. Returns the type of the window specified by Client active window. A window
  204. type will either be "desktop", "dock" or "normal".
  205.  
  206. Client may be the window id or a substring that matches a window name.
  207.  
  208. GetClientWorkspace (Client :: int | string)
  209. Returns the workspace of the window specified by Client active window.
  210.  
  211. Client may be the window id or a substring that matches a window name.
  212.  
  213. GetLayout (Workspace :: int | string)
  214. Returns the name of the currently active (or "default") layout on the workspace
  215. specified by Workspace. Note that when a workspace is set to a tiling layout,
  216. it is still possible for clients to be floating.
  217.  
  218. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  219.  
  220. GetWorkspace
  221. Returns the name of the current workspace.
  222.  
  223. GetWorkspaceList
  224. Returns a list of all workspaces, in the order that they were added.
  225.  
  226. The special "Sticky" workspace is not included.
  227.  
  228. GetWorkspaceNext
  229. Returns the name of the "next" workspace. The ordering of workspaces is
  230. the order in which they were added. This might cause confusing behavior in
  231. multi-head setups, since multiple workspaces can be viewable at one time.
  232.  
  233. GetWorkspacePrefix (Prefix :: string)
  234. Returns the first non-visible workspace starting with Prefix. If the current
  235. workspace starts with Prefix, then the first workspace *after* the current
  236. workspace starting with Prefix will be returned.
  237.  
  238. GetWorkspacePrev
  239. Returns the name of the "previous" workspace. The ordering of workspaces is
  240. the order in which they were added. This might cause confusing behavior in
  241. multi-head setups, since multiple workspaces can be viewable at one time.
  242.  
  243. HeadFocus (Head :: int)
  244. Focuses the head indexed at Head. Indexing starts at 0. Heads are ordered
  245. by their physical position: left to right and then top to bottom.
  246.  
  247. HeadFocusWithClient (Head :: int) (Client :: int | string)
  248. Focuses the head indexed at Head, and move the Client specified by client to
  249. that head. Indexing of heads starts at 0. Heads are ordered by their physical
  250. position: left to right and then top to bottom.
  251.  
  252. Client may be the window id or a substring that matches a window name.
  253.  
  254. Input (Label :: string)
  255. Shows a centered prompt window that allows the user to type in text. If the
  256. user presses the Confirm Key (i.e., enter), then the text typed into the
  257. input box will be returned.
  258.  
  259. Label will be shown next to the input box.
  260.  
  261. This command may be used as a sub-command to pass user provided arguments to
  262. another command.
  263.  
  264. MatchClientClass (Client :: int | string) (Class :: string)
  265. Returns 1 if the "class" part of the WM_CLASS property on the window
  266. specified by Client contains the substring specified by Class, and otherwise
  267. returns 0. The search is done case insensitively.
  268.  
  269. Client may be the window id or a substring that matches a window name.
  270.  
  271. MatchClientInstance (Client :: int | string) (Instance :: string)
  272. Returns 1 if the "instance" part of the WM_CLASS property on the window
  273. specified by Client contains the substring specified by Instance, and otherwise
  274. returns 0. The search is done case insensitively.
  275.  
  276. Client may be the window id or a substring that matches a window name.
  277.  
  278. MatchClientIsTransient (Client :: int | string)
  279. Returns 1 if the window specified by Client is a transient window, and
  280. otherwise returns 0. A transient window usually corresponds to some kind of
  281. dialog window.
  282.  
  283. Client may be the window id or a substring that matches a window name.
  284.  
  285. MatchClientName (Client :: int | string) (Name :: string)
  286. Returns 1 if the name of the window specified by Client contains the substring
  287. specified by Name, and otherwise returns 0. The search is done case
  288. insensitively.
  289.  
  290. Client may be the window id or a substring that matches a window name.
  291.  
  292. MatchClientType (Client :: int | string) (Type :: string)
  293. Returns 1 if the type of the window specified by Client matches the type
  294. named by Type, and otherwise returns 0.
  295.  
  296. Valid window types are "Normal", "Dock" or "Desktop".
  297.  
  298. Client may be the window id or a substring that matches a window name.
  299.  
  300. Maximize (Client :: int | string)
  301. Maximizes the window specified by Client. If the window is already maximized,
  302. this command has no effect.
  303.  
  304. Client may be the window id or a substring that matches a window name.
  305.  
  306. MouseMove
  307. Initiates a drag that allows a window to be moved with the mouse.
  308.  
  309. This is a special command that can only be assigned in Wingo's mouse
  310. configuration file. Invoking this command in any other way has no effect.
  311.  
  312. MouseResize (Direction :: string)
  313. Initiates a drag that allows a window to be resized with the mouse.
  314.  
  315. Direction specifies how the window should be resized, and what the pointer
  316. should look like. For example, if Direction is set to "BottomRight", then only
  317. the width and height of the window can change---but not the x or y position.
  318.  
  319. Valid values for Direction are: Infer, Top, Bottom, Left, Right, TopLeft,
  320. TopRight, BottomLeft and BottomRight. When "Infer" is used, the direction
  321. is determined based on where the pointer is on the window when the drag is
  322. initiated.
  323.  
  324. This is a special command that can only be assigned in Wingo's mouse
  325. configuration file. Invoking this command in any other way has no effect.
  326.  
  327. Move (Client :: int | string) (X :: float | int) (Y :: float | int)
  328. Moves the window specified by Client to the x and y position specified by
  329. X and Y. Note that the origin is located in the top left corner.
  330.  
  331. X and Y may either be pixels (integers) or ratios in the range 0.0 to
  332. 1.0 (specifically, (0.0, 1.0]). Ratios are measured with respect to the
  333. window's workspace's geometry.
  334.  
  335. Client may be the window id or a substring that matches a window name.
  336.  
  337. MovePointer (X :: int) (Y :: int)
  338. Moves the pointer to the x and y position specified by X and Y. Note the the
  339. origin is located in the top left corner.
  340.  
  341. MovePointerRelative (X :: int) (Y :: int)
  342. Moves the pointer to the x and y position specified by X and Y relative to the
  343. current workspace. Note the the origin is located in the top left corner of
  344. the current workspace.
  345.  
  346. MoveRelative (Client :: int | string) (X :: float | int) (Y :: float | int)
  347. Moves the window specified by Client to the x and y position specified by
  348. X and Y, relative to its workspace. Note that the origin is located in the top
  349. left corner of the client's workspace.
  350.  
  351. X and Y may either be pixels (integers) or ratios in the range 0.0 to
  352. 1.0 (specifically, (0.0, 1.0]). Ratios are measured with respect to the
  353. window's workspace's geometry.
  354.  
  355. Client may be the window id or a substring that matches a window name.
  356.  
  357. Not (Op :: int)
  358. Returns the negation of Op. When Op is 0, Not returns 1. When Op is 1, Not
  359. returns 0.
  360.  
  361. If Op is not in {0, 1}, then a warning is logged and nil is returned.
  362.  
  363. Or (Op1 :: int) (Op2 :: int)
  364. Returns the logical OR of Op1 and Op2.
  365.  
  366. If Op1 or Op2 is not in {0, 1}, then a warning is logged and nil is returned.
  367.  
  368. Quit
  369. Stops Wingo.
  370.  
  371. Raise (Client :: int | string)
  372. Raises the window specified by Client to the top of its layer.
  373.  
  374. Client may be the window id or a substring that matches a window name.
  375.  
  376. RemoveWorkspace (Workspace :: int | string)
  377. Removes the workspace specified by Workspace. Note that a workspace can *only*
  378. be removed if it is empty (i.e., does not contain any windows).
  379.  
  380. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  381.  
  382. Resize (Client :: int | string) (Width :: float | int) (Height :: float | int)
  383. Resizes the window specified by Client to some width and height specified by
  384. Width and Height.
  385.  
  386. Width and Height may either be pixels (integers) or ratios in the range 0.0 to
  387. 1.0 (specifically, (0.0, 1.0]). Ratios are measured with respect to the
  388. window's workspace's geometry.
  389.  
  390. Client may be the window id or a substring that matches a window name.
  391.  
  392. Restart
  393. Restarts Wingo in place using exec. This should be used to reload Wingo
  394. after you've made changes to its configuration.
  395.  
  396. SelectClient (TabCompletion :: string) (OnlyActiveWorkspace :: string) (OnlyVisible :: string) (ShowIconified :: string)
  397. Shows a centered prompt window with a list of clients satisfying the arguments
  398. provided.
  399.  
  400. OnlyActiveWorkspace specifies that only clients on the current workspace should
  401. be listed. Valid values are "yes" or "no".
  402.  
  403. OnlyVisible specifies that only clients on visible workspaces should be listed.
  404. Valid values are "yes" or "no".
  405.  
  406. ShowIconified specifies that iconified clients will be shown. Valid values are
  407. "yes" or "no".
  408.  
  409. TabCompletetion can be set to either "Prefix" or "Any". When it's set to
  410. "Prefix", the clients can be searched by a prefix matching string. When it's set
  411. to "Any", the clients can be searched by a substring matching string.
  412.  
  413. This command may be used as a sub-command to pass a particular client to
  414. another command.
  415.  
  416. SelectWorkspace (TabCompletion :: string)
  417. Shows a centered prompt window with a list of all workspaces.
  418.  
  419. TabCompletetion can be set to either "Prefix" or "Any". When it's set to
  420. "Prefix", the workspaces can be searched by a prefix matching string. When it's
  421. set to "Any", the workspaces can be searched by a substring matching string.
  422.  
  423. This command may be used as a sub-command to pass a particular workspace to
  424. another command.
  425.  
  426. SetLayout (Workspace :: int | string) (Name :: string)
  427. Sets the current layout of the workspace specified by Workspace to the layout
  428. named by Name. If a layout with name Name does not exist, this command has
  429. no effect.
  430.  
  431. Note that this command has no effect if the workspace is not visible.
  432.  
  433. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  434.  
  435. SetOpacity (Client :: int | string) (Opacity :: float)
  436. Sets the opacity of the window specified by Client to the opacity level
  437. specified by Opacity.
  438.  
  439. This command won't have any effect unless you're running a compositing manager
  440. like xcompmgr or cairo-compmgr.
  441.  
  442. Client may be the window id or a substring that matches a window name.
  443.  
  444. Opacity should be a float in the range 0.0 to 1.0, inclusive, where 0.0 is
  445. completely transparent and 1.0 is completely opaque.
  446.  
  447. Shell (Command :: string)
  448. Attempts to execute the shell command specified by Command. If an error occurs,
  449. it will be logged to Wingo's stderr.
  450.  
  451. Note that the parser for translating shell commands to something acceptable
  452. for Go's os/exec package is fairly primitive. Therefore, this should not be
  453. considered as a suitable replacement for similar utilities (like gmrun or
  454. xbindkeys).
  455.  
  456. ToggleFloating (Client :: int | string)
  457. Toggles whether the window specified by Client should be forced into the
  458. floating layout. A window forced into the floating layout CANNOT be tiled.
  459.  
  460. Client may be the window id or a substring that matches a window name.
  461.  
  462. ToggleIconify (Client :: int | string)
  463. Iconifies (minimizes) or deiconifies (unminimizes) the window specified by
  464. Client.
  465.  
  466. Client may be the window id or a substring that matches a window name.
  467.  
  468. ToggleMaximize (Client :: int | string)
  469. Maximizes or restores the window specified by Client.
  470.  
  471. Client may be the window id or a substring that matches a window name.
  472.  
  473. ToggleStackAbove (Client :: int | string)
  474. Toggles the layer of the window specified by Client from normal to above. When
  475. a window is in the "above" layer, it will always be above other (normal)
  476. clients.
  477.  
  478. Client may be the window id or a substring that matches a window name.
  479.  
  480. ToggleStackBelow (Client :: int | string)
  481. Toggles the layer of the window specified by Client from normal to below. When
  482. a window is in the "below" layer, it will always be below other (normal)
  483. clients.
  484.  
  485. Client may be the window id or a substring that matches a window name.
  486.  
  487. ToggleSticky (Client :: int | string)
  488. Toggles the sticky status of the window specified by Client. When a window is
  489. sticky, it will always be visible unless iconified. (i.e., it does not belong
  490. to any particular workspace.)
  491.  
  492. Client may be the window id or a substring that matches a window name.
  493.  
  494. True
  495. Always returns 1.
  496.  
  497. Unfloat (Client :: int | string)
  498. Unfloats the window specified by Client. If the window is not floating,
  499. this command has no effect.
  500.  
  501. Client may be the window id or a substring that matches a window name.
  502.  
  503. Unmaximize (Client :: int | string)
  504. Unmaximizes the window specified by Client. If the window is not maximized,
  505. this command has no effect.
  506.  
  507. Client may be the window id or a substring that matches a window name.
  508.  
  509. WingoExec (Commands :: string)
  510. Executes a series of Wingo commands specified by Commands. If an error occurs
  511. while executing the command, it will be shown in a popup message.
  512.  
  513. WingoHelp (CommandName :: string)
  514. Shows the usage information for a particular command specified by CommandName.
  515.  
  516. Workspace (Workspace :: int | string)
  517. Sets the current workspace to the one specified by Workspace.
  518.  
  519. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  520.  
  521. WorkspaceGreedy (Workspace :: int | string)
  522. Sets the current workspace to the one specified by Workspace in a greedy
  523. fashion.
  524.  
  525. A greedy switch *always* brings the specified workspace to the
  526. currently focused head. (N.B. Greedy is only different when switching between
  527. two visible workspaces.)
  528.  
  529. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  530.  
  531. WorkspaceGreedyWithClient (Workspace :: int | string) (Client :: int | string)
  532. Sets the current workspace to the workspace specified by Workspace in a greedy
  533. fashion, and moves the window specified by Client to that workspace.
  534.  
  535. A greedy switch *always* brings the specified workspace to the
  536. currently focused head. (N.B. Greedy is only different when switching between
  537. two visible workspaces.)
  538.  
  539. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  540.  
  541. Client may be the window id or a substring that matches a window name.
  542.  
  543. WorkspaceSendClient (Workspace :: int | string) (Client :: int | string)
  544. Sends the window specified by Client to the workspace specified by Workspace.
  545.  
  546. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  547.  
  548. Client may be the window id or a substring that matches a window name.
  549.  
  550. WorkspaceWithClient (Workspace :: int | string) (Client :: int | string)
  551. Sets the current workspace to the workspace specified by Workspace, and moves
  552. the window specified by Client to that workspace.
  553.  
  554. Workspace may be a workspace index (integer) starting at 0, or a workspace name.
  555.  
  556. Client may be the window id or a substring that matches a window name.
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement