mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-06-08 14:18:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs to note that macOS is supported by the panel kitten as well

Browse Source
This commit is contained in:
Kovid Goyal
2025-04-23 20:52:11 +05:30
parent c3e1f2317b
commit 983e570bbe
2 changed files with 26 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
kittens/panel/main.py
View File

@@ -50,28 +50,28 @@ If it has the suffix :code:`px` then it sets the width of the panel in pixels in
type=int
default=0
Set the top margin for the panel, in pixels. Has no effect for bottom edge panels.
Only works on a Wayland compositor that supports the wlr layer shell protocol.
Only works on macOS and Wayland compositors that supports the wlr layer shell protocol.
--margin-left
type=int
default=0
Set the left margin for the panel, in pixels. Has no effect for right edge panels.
Only works on a Wayland compositor that supports the wlr layer shell protocol.
Only works on macOS and Wayland compositors that supports the wlr layer shell protocol.
--margin-bottom
type=int
default=0
Set the bottom margin for the panel, in pixels. Has no effect for top edge panels.
Only works on a Wayland compositor that supports the wlr layer shell protocol.
Only works on macOS and Wayland compositors that supports the wlr layer shell protocol.
--margin-right
type=int
default=0
Set the right margin for the panel, in pixels. Has no effect for left edge panels.
Only works on a Wayland compositor that supports the wlr layer shell protocol.
Only works on macOS and Wayland compositors that supports the wlr layer shell protocol.
--edge
@@ -85,10 +85,11 @@ a background in your sway config it will cover the background drawn using this
kitten.
Additionally, there are two more values: :code:`center` and :code:`none`.
The value :code:`center` anchors the panel to all sides and covers the entire
display (on macOS the part of the display not covered by titlebar and dock) by default.
The panel can be shrunk using the margin parameters.
display (on macOS the part of the display not covered by titlebar and dock).
The panel can be shrunk and placed using the margin parameters.
The value :code:`none` anchors the panel to the top left corner and should be
placed and sized using the margin parameters.
placed and using the margin parameters. It's size is set bye :option:`--lines`
and :option:`--columns`.
--layer
@@ -96,7 +97,8 @@ choices=background,bottom,top,overlay
default=bottom
On a Wayland compositor that supports the wlr layer shell protocol, specifies the layer
on which the panel should be drawn. This parameter is ignored and set to
:code:`background` if :option:`--edge` is set to :code:`background`.
:code:`background` if :option:`--edge` is set to :code:`background`. On macOS, maps
these to appropriate NSWindow *levels*.
--config -c
@@ -133,6 +135,7 @@ choices=not-allowed,exclusive,on-demand
default=not-allowed
On a Wayland compositor that supports the wlr layer shell protocol, specify the focus policy for keyboard
interactivity with the panel. Please refer to the wlr layer shell protocol documentation for more details.
Ignored on X11 and macOS.
--exclusive-zone
@@ -143,12 +146,14 @@ Please refer to the wlr layer shell documentation for more details on the meanin
If :option:`--edge` is set to anything other than :code:`center` or :code:`none`, this flag will not have any
effect unless the flag :option:`--override-exclusive-zone` is also set.
If :option:`--edge` is set to :code:`background`, this option has no effect.
Ignored on X11 and macOS.
--override-exclusive-zone
type=bool-set
On a Wayland compositor that supports the wlr layer shell protocol, override the default exclusive zone.
This has effect only if :option:`--edge` is set to :code:`top`, :code:`left`, :code:`bottom` or :code:`right`.
Ignored on X11 and macOS.
--single-instance -1
@@ -185,7 +190,7 @@ For internal debugging use.
args = PanelCLIOptions()
help_text = 'Use a command line program to draw a GPU accelerated panel on your X11 desktop'
help_text = 'Use a command line program to draw a GPU accelerated panel on your desktop'
usage = '[cmdline-to-run ...]'