docs: Fixed some typos, 80 column lines (where possible)

This commit is contained in:
Tomi Ollila 2024-04-23 21:39:38 +03:00 committed by Johan Malm
parent 32929e8ab5
commit 2e2cf54c00
3 changed files with 52 additions and 49 deletions

View file

@ -178,8 +178,8 @@ Actions are used in menus and keyboard/mouse bindings.
If *output* is specified, the window will be sent directly to the If *output* is specified, the window will be sent directly to the
specified output and *direction* is ignored. If *output* is omitted, specified output and *direction* is ignored. If *output* is omitted,
*direction* may be one of "left", "right", "up" or "down" to indicate *direction* may be one of "left", "right", "up" or "down" to indicate
that the window should be moved to the next output in that direction that the window should be moved to the next output in that direction
(if one exists). (if one exists).
*wrap* [yes|no] When using the direction attribute, wrap around from *wrap* [yes|no] When using the direction attribute, wrap around from
@ -238,7 +238,7 @@ Actions are used in menus and keyboard/mouse bindings.
smaller than "eDP-1" output to cut off bottom panel from screen sharing. smaller than "eDP-1" output to cut off bottom panel from screen sharing.
Virtual output is also useful for extending the desktop to (maybe Virtual output is also useful for extending the desktop to (maybe
mobile) remote systems like tablets. E.g. simply adding a virtual mobile) remote systems like tablets. E.g. simply adding a virtual
output, attaching wayvnc to it and running a VNC client on the remote output, attaching wayvnc to it and running a VNC client on the remote
system. system.

View file

@ -103,7 +103,7 @@ However, there are some caveats:
1. In menu.xml, the attributes *id*, *label* and *execute* must be 1. In menu.xml, the attributes *id*, *label* and *execute* must be
expressed as attributes rather than as separate child elements. expressed as attributes rather than as separate child elements.
2. Ordering of attributes can sometimes be singificant. For example, 2. Ordering of attributes can sometimes be significant. For example,
when setting fonts via attributes rather than children, when setting fonts via attributes rather than children,
*<font place="ActiveWindow" name="..." size="..." />* *<font place="ActiveWindow" name="..." size="..." />*
@ -257,14 +257,15 @@ this is for compatibility with Openbox.
- 'o' - output name (show if more than 1 monitor active) - 'o' - output name (show if more than 1 monitor active)
- 'T' - title of window - 'T' - title of window
- 't' - title of window (if different than wm-class/app-id) - 't' - title of window (if different than wm-class/app-id)
Recommend using with a mono space font, to keep alignment. Recommend using with a monospace font, to keep alignment.
- *custom - subset of printf options allowed -- man 3 printf* - *custom - subset of printf options allowed -- man 3 printf*
- random text may be inserted - random text may be inserted
- field length, example "%10" use 10 spaces, even if text uses less - field length, example "%10" use 10 spaces, even if text uses less
- left jusify text, example "%-" - left justify text, example "%-"
- right justify text, example "%" instead of "%-" - right justify text, example "%" instead of "%-"
- example, %-10 would left justify and make room for 10 charaters - example, %-10 would left justify and make room for 10 characters
- Only one custom format allowed now. Future enhancements may allow more than one. - Only one custom format allowed now. Future enhancements may
allow more than one.
*width* defines the width of the field expressed as a percentage of *width* defines the width of the field expressed as a percentage of
the overall window switcher width. The "%" character is required. the overall window switcher width. The "%" character is required.
@ -658,7 +659,7 @@ extending outward from the snapped edge.
*<tablet><map button="" to="" />* *<tablet><map button="" to="" />*
Tablet buttons emulate regular mouse buttons. If not specified Tablet buttons emulate regular mouse buttons. If not specified
otherwise, the tip (Tip) is mapped to left mouse click, the first pen otherwise, the tip (Tip) is mapped to left mouse click, the first pen
button (Stylus) is mapped to right mouse button click and the second pen button (Stylus) is mapped to right mouse button click and the second pen
button (Stylus2) emulates a middle mouse button click. button (Stylus2) emulates a middle mouse button click.
Supported map *buttons* are: Supported map *buttons* are:

View file

@ -131,18 +131,20 @@ openbox and is used by many popular themes. For the sake of brevity, these
elements are not listed here, but are supported. elements are not listed here, but are supported.
*window.active.shadow.size* *window.active.shadow.size*
Size of the drop-shadow for the focused window, in pixels. Default is 60. Size of the drop-shadow for the focused window, in pixels.
Default is 60.
*window.inactive.shadow.size* *window.inactive.shadow.size*
Size of drop-shadows for non-focused windows, in pixels. Default is 40. Size of drop-shadows for non-focused windows, in pixels.
Default is 40.
*window.active.shadow.color* *window.active.shadow.color*
Color of the drop-shadow for the focused window, including opacity. Default Color of the drop-shadow for the focused window, including opacity.
is #00000060 (black with 38% opacity). Default is #00000060 (black with 38% opacity).
*window.inactive.shadow.color* *window.inactive.shadow.color*
Color of drop-shadows for non-focused windows, including opacity. Default is Color of drop-shadows for non-focused windows, including opacity.
#00000040 (black with 25% opacity). Default is #00000040 (black with 25% opacity).
*menu.items.bg.color* *menu.items.bg.color*
Background color of inactive menu items. Background color of inactive menu items.
@ -173,15 +175,15 @@ elements are not listed here, but are supported.
*window.active.title.bg.color* if not set. *window.active.title.bg.color* if not set.
*osd.border.color* *osd.border.color*
Border color of on-screen-display. Inherits *osd.label.text.color* if not Border color of on-screen-display. Inherits *osd.label.text.color* if
set. not set.
*osd.border.width* *osd.border.width*
Border width of on-screen-display. Inherits *border.width* if not set. Border width of on-screen-display. Inherits *border.width* if not set.
*osd.label.text.color* *osd.label.text.color*
Text color of on-screen-display. Inherits *window.active.label.text.color* if Text color of on-screen-display. Inherits
not set. *window.active.label.text.color* if not set.
*osd.window-switcher.width* *osd.window-switcher.width*
Width of window switcher in pixels. Default is 600. Width of window switcher in pixels. Default is 600.
@ -205,15 +207,15 @@ elements are not listed here, but are supported.
Default is 2. Default is 2.
*osd.window-switcher.preview.border.width* *osd.window-switcher.preview.border.width*
Border width of the outlines shown as the preview of the window selected by Border width of the outlines shown as the preview of the window selected
window switcher. Inherits *osd.border.width* if not set. by window switcher. Inherits *osd.border.width* if not set.
*osd.window-switcher.preview.border.color* *osd.window-switcher.preview.border.color*
Color(s) of the outlines shown as the preview of the window selected by Color(s) of the outlines shown as the preview of the window selected by
window switcher. Possible value is a color or up to 3 colors separated window switcher. Possible value is a color or up to 3 colors separated
by commas (e.g. "#ffffff,#000000,#ffffff"). When multiple colors are by commas (e.g. "#ffffff,#000000,#ffffff"). When multiple colors are
specified, a multi-line rectangle with each line having the specified color specified, a multi-line rectangle with each line having the specified
is drawn. If not set, this inherits the on-screen-display theme color is drawn. If not set, this inherits the on-screen-display theme
("[*osd.bg.color*],[*osd.label.text.color*],[*osd.bg.color*]"). ("[*osd.bg.color*],[*osd.label.text.color*],[*osd.bg.color*]").
*osd.workspace-switcher.boxes.width* *osd.workspace-switcher.boxes.width*
@ -225,55 +227,55 @@ elements are not listed here, but are supported.
boxes. Default is 20. boxes. Default is 20.
*snapping.overlay.region.bg.enabled* [yes|no] *snapping.overlay.region.bg.enabled* [yes|no]
Show a filled rectangle as an overlay when a window is snapped to a region. Show a filled rectangle as an overlay when a window is snapped to a
Default is yes for hardware-based renderers and no for software-based region. Default is yes for hardware-based renderers and no for
renderers. software-based renderers.
*snapping.overlay.edge.bg.enabled* [yes|no] *snapping.overlay.edge.bg.enabled* [yes|no]
Show a filled rectangle as an overlay when a window is snapped to an edge. Show a filled rectangle as an overlay when a window is snapped to an
Default is yes for hardware-based renderer and no for software-based edge. Default is yes for hardware-based renderer and no for
renderers. software-based renderers.
*snapping.overlay.region.border.enabled* [yes|no] *snapping.overlay.region.border.enabled* [yes|no]
Show an outlined rectangle as an overlay when a window is snapped to a Show an outlined rectangle as an overlay when a window is snapped to a
region. Default is no for hardware-based renderers and yes for software-based region. Default is no for hardware-based renderers and yes for
renderers. software-based renderers.
*snapping.overlay.edge.border.enabled* [yes|no] *snapping.overlay.edge.border.enabled* [yes|no]
Show an outlined rectangle as an overlay when a window is snapped to an edge. Show an outlined rectangle as an overlay when a window is snapped to an
Default is no for hardware-based renderer and yes for software-based edge. Default is no for hardware-based renderer and yes for
renderers. software-based renderers.
*snapping.overlay.region.bg.color* *snapping.overlay.region.bg.color*
Color of a filled rectangle shown as an overlay when a window is snapped to Color of a filled rectangle shown as an overlay when a window is snapped
a region. Default is #8080b380. to a region. Default is #8080b380.
*snapping.overlay.edge.bg.color* *snapping.overlay.edge.bg.color*
Color of a filled rectangle shown as an overlay when a window is snapped to Color of a filled rectangle shown as an overlay when a window is snapped
an edge. Default is #8080b380. to an edge. Default is #8080b380.
*snapping.overlay.region.border.width* *snapping.overlay.region.border.width*
Border width of an outlined rectangle shown as an overlay when a window is Border width of an outlined rectangle shown as an overlay when a window
snapped to a region. Inherits `osd.border.width` if not set. is snapped to a region. Inherits `osd.border.width` if not set.
*snapping.overlay.edge.border.width* *snapping.overlay.edge.border.width*
Border width of an outlined rectangle shown as the preview when a window is Border width of an outlined rectangle shown as the preview when a window
snapped to an edge. Inherits `osd.border.width` if not set. is snapped to an edge. Inherits `osd.border.width` if not set.
*snapping.overlay.region.border.color* *snapping.overlay.region.border.color*
Color(s) of an outlined rectangle shown as an overlay when a window is Color(s) of an outlined rectangle shown as an overlay when a window is
snapped to a region. Possible values and the default value are the same as snapped to a region. Possible values and the default value are the same
those of *osd.window-switcher.preview.border.color*. as those of *osd.window-switcher.preview.border.color*.
*snapping.overlay.edge.border.color* *snapping.overlay.edge.border.color*
Color(s) of an outlined rectangle shown as an overlay when a window is Color(s) of an outlined rectangle shown as an overlay when a window is
snapped to an edge. Possible values and the default value are the same as snapped to an edge. Possible values and the default value are the same
those of *osd.window-switcher.preview.border.color*. as those of *osd.window-switcher.preview.border.color*.
*border.color* *border.color*
Set both *window.active.border.color* and *window.inactive.border.color*. Set both *window.active.border.color* and
This is obsolete, but supported for backward compatibility as some themes *window.inactive.border.color*. This is obsolete, but supported for
still contain it. backward compatibility as some themes still contain it.
# BUTTONS # BUTTONS