Project

General

Profile

Dock » History » Version 15

Per Amundsen, 04/10/2022 06:53 PM

1 1 Per Amundsen
_Added in 4.3_
2
3 11 Per Amundsen
*/dock [-u] <@window>*
4
*/dock [-abloNpNrt] [w h] <@window>*
5 14 Per Amundsen
*/dock [-cbloNpNrt] [w h] <container> <@window>*
6
*/dock [-bloNpNnrt] [w h] <container> <panel> <@window>*
7
*/dock [-biloNpNrt] [w h] <container panel tab> <@window>*
8 1 Per Amundsen
9 4 Per Amundsen
Docks/undocks a window as a [[Monitor_Panels|Monitor Panel]].
10 1 Per Amundsen
11 8 Per Amundsen
_See also [[$dockpanels]]._
12
13 1 Per Amundsen
*Switches*
14
15 10 Per Amundsen
-a - Adds the window to any other dock panel on the specified dock side as a new tab or creates a new container and panel.
16 7 Per Amundsen
-b - Dock to the bottom.
17 15 Per Amundsen
-c - Create a new container and inserts the window at the specified side/container.
18 8 Per Amundsen
-i - Inserts the window into the specified side/container/panel/tab
19 1 Per Amundsen
-l - Dock to the left.
20 15 Per Amundsen
-n - Create a new panel and inserts the window at the specified side/container/panel.
21 6 Per Amundsen
-oN - Locks the panel. (0 = unlocked, 1 = locked, Ignored by F2 to toggle panels visibility)
22
-pN - Pins the panel. (0 = unpinned, 1 = pinned, Autohide)
23 1 Per Amundsen
-r - Dock to the right.
24
-t - Dock to the top.
25
-u - Undocks/restores the @window to a regular window.
26
27
*Parameters*
28
29
[w h] - The preferred width and height of the panel.
30
<container> - Used with -c to insert the panel into a new container at the specified position. 
31 13 Per Amundsen
<container panel> - Used with -n to insert the panel into a specific container at the specified panel position.
32
<container panel tab> - Used with -i to specify where to insert the new panel.
33 1 Per Amundsen
<@window> - The window to dock.
34
35
*Example*
36
37
<pre>
38
alias testdock {
39
  ; Create a custom window.
40
  window @test
41
42 5 Per Amundsen
  ; Dock the custom window as a monitor panel to the left side, appending if there are any other panels.
43 1 Per Amundsen
  dock -al @test
44
45
  ; Restores the custom window as a normal window.
46
  dock -u @test
47
48
  ; Docks the custom window as a monitor panel to the top, ignoring any current panels.
49
  dock -t @test
50
}
51
</pre>
52
53
-