Project

General

Profile

Dock » History » Version 8

Per Amundsen, 04/10/2022 01:07 PM

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