configuration.md
ASCII text
Configuring the Panorama panel
The panel loads all its configuration from a file
~/.config/panorama-panel/config.yaml
. The format has a single top-level key
panels
which is a list of the panels to generate. Each panel has the following
keys:
position
:top
,right
,bottom
orleft
; specifies the edge of the monitor to show the panel onmonitor
: the index of the monitor to show the panel on (usually refers to the order in which the monitors are plugged in)size
: the thickness of the panel in pixelsautohide
: whether the panel automatically hides leaving only 1pxhide_time
: the duration in ms of the sliding animation (not applicable ifautohide
isfalse
)can_capture_keyboard
: whether the panel can receive keyboard focus (works best with special compositor setup; check accessibility.md for details)applets
: a dictionary with keysleft
,centre
,right
; they are actually named wrong and are start/centre/end areas, each key has a list of applets, each applet is described by a dictionary with a single key being the class name and the value being a dictionary with configuration options (the options depend on the applet)
Example:
panels: - position: top monitor: 0 size: 40 autohide: false hide_time: 300 applets: left: - WFWindowList: {} centre: [] right: - ClockApplet: formatting: '%T, %a %-d %b %Y'
The order the panels are specified in decides how they occupy the screen, thus, if you specify panel 1 on top, panel 2 on left, and panel 3 on bottom it will look like:
=========================== =111111111111111111111111111= =22 = =22 = =22 = =22 = =22 = =22 = =223333333333333333333333333= ===========================
1Configuring the Panorama panel 2------------------------------ 3 4The panel loads all its configuration from a file 5`~/.config/panorama-panel/config.yaml`. The format has a single top-level key 6`panels` which is a list of the panels to generate. Each panel has the following 7keys: 8 9* `position`: `top`, `right`, `bottom` or `left`; specifies the edge of the 10monitor to show the panel on 11* `monitor`: the index of the monitor to show the panel on (usually refers 12to the order in which the monitors are plugged in) 13* `size`: the thickness of the panel in pixels 14* `autohide`: whether the panel automatically hides leaving only 1px 15* `hide_time`: the duration in ms of the sliding animation (not applicable 16if `autohide` is `false`) 17* `can_capture_keyboard`: whether the panel can receive keyboard focus 18(works best with special compositor setup; check 19[accessibility.md](accessibility.md) for details) 20* `applets`: a dictionary with keys `left`, `centre`, `right`; they are actually 21named wrong and are start/centre/end areas, each key has a list of applets, 22each applet is described by a dictionary with a single key being the class 23name and the value being a dictionary with configuration options (the options 24depend on the applet) 25 26Example: 27 28~~~yaml 29panels: 30- position: top 31monitor: 0 32size: 40 33autohide: false 34hide_time: 300 35applets: 36left: 37- WFWindowList: {} 38centre: [] 39right: 40- ClockApplet: 41formatting: '%T, %a %-d %b %Y' 42~~~ 43 44The order the panels are specified in decides how they occupy the screen, thus, 45if you specify panel 1 on top, panel 2 on left, and panel 3 on bottom it will 46look like: 47 48~~~ 49=========================== 50=111111111111111111111111111= 51=22 = 52=22 = 53=22 = 54=22 = 55=22 = 56=22 = 57=223333333333333333333333333= 58=========================== 59~~~ 60