mirror of
https://github.com/labwc/labwc.git
synced 2026-05-22 21:37:34 -04:00
Typo/style fixes in docs and code comments
Codespell(1)-pointed typos in files listed by `git ls-files`
(sans checkpatch.pl and possibly some others). Removed some
extra spaces. Added a few missing trailing periods.
`Default is ...`. Added spaces in ' />' where missing
(sans e.g. wayland protocol and t/* files).
Fit some lines in docs/*.scd to 80 colums.
Used git grep commands (to find similar cases):
$ git grep -n '\S/>'
$ git grep -nF '. '
$ git grep -n '[^\t*'\'',{#]\t'
$ git grep -ni 'default '
No functional change. No change in *.[ch] line numbers.
This commit is contained in:
parent
4af693a7fd
commit
80ff89c640
16 changed files with 88 additions and 84 deletions
|
|
@ -12,7 +12,7 @@
|
||||||
swaybg -c '#113344' >/dev/null 2>&1 &
|
swaybg -c '#113344' >/dev/null 2>&1 &
|
||||||
|
|
||||||
# Configure output directives such as mode, position, scale and transform.
|
# Configure output directives such as mode, position, scale and transform.
|
||||||
# Use wlr-randr to get your output names
|
# Use wlr-randr to get your output names.
|
||||||
# Example ~/.config/kanshi/config below:
|
# Example ~/.config/kanshi/config below:
|
||||||
# profile {
|
# profile {
|
||||||
# output HDMI-A-1 position 1366,0
|
# output HDMI-A-1 position 1366,0
|
||||||
|
|
|
||||||
|
|
@ -139,22 +139,21 @@ Actions are used in menus and keyboard/mouse bindings.
|
||||||
and OSD, useful for binding to keys without modifiers.
|
and OSD, useful for binding to keys without modifiers.
|
||||||
|
|
||||||
*workspace* [all|current]
|
*workspace* [all|current]
|
||||||
This determines whether to cycle through windows on all workspaces or the
|
This determines whether to cycle through windows on all workspaces or
|
||||||
current workspace. Default is "current".
|
the current workspace. Default is "current".
|
||||||
|
|
||||||
*output* [all|focused|cursor]
|
*output* [all|focused|cursor]
|
||||||
This determines whether to cycle through windows on all outputs, the focused
|
This determines whether to cycle through windows on all outputs, the
|
||||||
output, or the output under the cursor. Default is "all".
|
focused output, or the output under the cursor. Default is "all".
|
||||||
|
|
||||||
*identifier* [all|current]
|
*identifier* [all|current]
|
||||||
This determines whether to cycle through all windows or only windows of the
|
This determines whether to cycle through all windows or only windows of
|
||||||
same application as the currently focused window. Default is "all".
|
the same application as the currently focused window. Default is "all".
|
||||||
|
|
||||||
*<action name="Reconfigure" />*
|
*<action name="Reconfigure" />*
|
||||||
Re-load configuration and theme files.
|
Re-load configuration and theme files.
|
||||||
|
|
||||||
*<action name="ShowMenu" menu="root-menu" />*
|
*<action name="ShowMenu" menu="root-menu" />*
|
||||||
|
|
||||||
Show a menu.
|
Show a menu.
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -300,7 +299,7 @@ Actions are used in menus and keyboard/mouse bindings.
|
||||||
(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
|
||||||
right-to-left or top-to-bottom, and vice versa. Default no.
|
right-to-left or top-to-bottom, and vice versa. Default is no.
|
||||||
|
|
||||||
*<action name="FitToOutput" />*
|
*<action name="FitToOutput" />*
|
||||||
Resizes active window size to width and height of the output when the
|
Resizes active window size to width and height of the output when the
|
||||||
|
|
@ -314,10 +313,10 @@ Actions are used in menus and keyboard/mouse bindings.
|
||||||
workspace or its index (starting at 1) as configured in rc.xml.
|
workspace or its index (starting at 1) as configured in rc.xml.
|
||||||
|
|
||||||
*wrap* [yes|no] Wrap around from last desktop to first, and vice
|
*wrap* [yes|no] Wrap around from last desktop to first, and vice
|
||||||
versa. Default yes.
|
versa. Default is yes.
|
||||||
|
|
||||||
*toggle* [yes|no] Toggle to “last” if already on the workspace that
|
*toggle* [yes|no] Toggle to “last” if already on the workspace that
|
||||||
would be the actual destination. Default no.
|
would be the actual destination. Default is no.
|
||||||
|
|
||||||
*<action name="SendToDesktop" to="value" follow="yes" wrap="yes" />*
|
*<action name="SendToDesktop" to="value" follow="yes" wrap="yes" />*
|
||||||
Send active window to workspace.
|
Send active window to workspace.
|
||||||
|
|
@ -325,10 +324,11 @@ Actions are used in menus and keyboard/mouse bindings.
|
||||||
*to* The workspace to send the window to. Supported values are the same
|
*to* The workspace to send the window to. Supported values are the same
|
||||||
as for GoToDesktop.
|
as for GoToDesktop.
|
||||||
|
|
||||||
*follow* [yes|no] Also switch to the specified workspace. Default yes.
|
*follow* [yes|no] Also switch to the specified workspace.
|
||||||
|
Default is yes.
|
||||||
|
|
||||||
*wrap* [yes|no] Wrap around from last desktop to first, and vice
|
*wrap* [yes|no] Wrap around from last desktop to first, and vice
|
||||||
versa. Default yes.
|
versa. Default is yes.
|
||||||
|
|
||||||
*<action name="VirtualOutputAdd" output_name="value" />*
|
*<action name="VirtualOutputAdd" output_name="value" />*
|
||||||
Add virtual output (headless backend).
|
Add virtual output (headless backend).
|
||||||
|
|
@ -430,11 +430,11 @@ Actions are used in menus and keyboard/mouse bindings.
|
||||||
used.
|
used.
|
||||||
|
|
||||||
*<action name="ToggleShowDesktop" />*
|
*<action name="ToggleShowDesktop" />*
|
||||||
Minimize all windows in the current workspace so that the desktop becomes
|
Minimize all windows in the current workspace so that the desktop
|
||||||
visible. On calling the action again the hidden windows are unminimized,
|
becomes visible. On calling the action again the hidden windows are
|
||||||
provided that - since the initial `ShowDesktop` - (a) no windows have been
|
unminimized, provided that - since the initial `ShowDesktop` - (a) no
|
||||||
unminimized; (b) workspaces have not been switched; and (c) no new
|
windows have been unminimized; (b) workspaces have not been switched;
|
||||||
applications have been started.
|
and (c) no new applications have been started.
|
||||||
|
|
||||||
*<action name="ZoomIn">*++
|
*<action name="ZoomIn">*++
|
||||||
*<action name="ZoomOut">*
|
*<action name="ZoomOut">*
|
||||||
|
|
@ -449,8 +449,8 @@ Actions are used in menus and keyboard/mouse bindings.
|
||||||
binding.
|
binding.
|
||||||
|
|
||||||
*<action name="DebugToggleKeyStateIndicator" />*
|
*<action name="DebugToggleKeyStateIndicator" />*
|
||||||
Toggle visibility of key-state on-screen display (OSD). Note: This is for
|
Toggle visibility of key-state on-screen display (OSD). Note: This is
|
||||||
debugging purposes only.
|
for debugging purposes only.
|
||||||
|
|
||||||
# CONDITIONAL ACTIONS
|
# CONDITIONAL ACTIONS
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -526,7 +526,8 @@ extending outward from the snapped edge.
|
||||||
*<range><inner>* and *<range><outer>*, and 50 for *<cornerRange>*.
|
*<range><inner>* and *<range><outer>*, and 50 for *<cornerRange>*.
|
||||||
|
|
||||||
*<snapping><overlay><enabled>* [yes|no]
|
*<snapping><overlay><enabled>* [yes|no]
|
||||||
Show an overlay when snapping a window to an output edge. Default is yes.
|
Show an overlay when snapping a window to an output edge.
|
||||||
|
Default is yes.
|
||||||
|
|
||||||
*<snapping><overlay><delay><inner>*++
|
*<snapping><overlay><delay><inner>*++
|
||||||
*<snapping><overlay><delay><outer>*
|
*<snapping><overlay><delay><outer>*
|
||||||
|
|
@ -595,7 +596,7 @@ extending outward from the snapped edge.
|
||||||
A setting of 0 disables the OSD. Default is 1000 ms.
|
A setting of 0 disables the OSD. Default is 1000 ms.
|
||||||
|
|
||||||
*<desktops><prefix>*
|
*<desktops><prefix>*
|
||||||
Set the prefix to use when using "number" above. Default is "Workspace"
|
Set the prefix to use when using "number" above. Default is "Workspace".
|
||||||
|
|
||||||
## THEME
|
## THEME
|
||||||
|
|
||||||
|
|
@ -824,9 +825,10 @@ overrideInhibition="">*
|
||||||
Make this keybind work even if the screen is locked. Default is no.
|
Make this keybind work even if the screen is locked. Default is no.
|
||||||
|
|
||||||
*overrideInhibition* [yes|no]
|
*overrideInhibition* [yes|no]
|
||||||
Make this keybind work even if the view inhibits keybinds. Default is no.
|
Make this keybind work even if the view inhibits keybinds.
|
||||||
This can be used to prevent W-Tab and similar keybinds from being
|
This can be used to prevent W-Tab and similar keybinds from being
|
||||||
delivered to Virtual Machines, VNC clients or nested compositors.
|
delivered to Virtual Machines, VNC clients or nested compositors.
|
||||||
|
Default is no.
|
||||||
|
|
||||||
*onRelease* [yes|no]
|
*onRelease* [yes|no]
|
||||||
When yes, fires the keybind action when the key or key
|
When yes, fires the keybind action when the key or key
|
||||||
|
|
@ -900,7 +902,7 @@ input-devices by the Wayland protocol.
|
||||||
- Shade: A button that, by default, toggles window shading.
|
- Shade: A button that, by default, toggles window shading.
|
||||||
- AllDesktops: A button that, by default, toggles omnipresence of a
|
- AllDesktops: A button that, by default, toggles omnipresence of a
|
||||||
window.
|
window.
|
||||||
- Close: A button that, by default, closses a window.
|
- Close: A button that, by default, closes a window.
|
||||||
- Border: The window's border including Top...BRCorner below.
|
- Border: The window's border including Top...BRCorner below.
|
||||||
- Top: The top edge of the window's border.
|
- Top: The top edge of the window's border.
|
||||||
- Bottom: The bottom edge of the window's border.
|
- Bottom: The bottom edge of the window's border.
|
||||||
|
|
@ -1260,7 +1262,8 @@ Note: To rotate touch events with output rotation, use the libinput
|
||||||
The default method depends on the touchpad hardware.
|
The default method depends on the touchpad hardware.
|
||||||
|
|
||||||
*<libinput><device><scrollMethod>* [none|twofinger|edge|onbutton]
|
*<libinput><device><scrollMethod>* [none|twofinger|edge|onbutton]
|
||||||
Configure the method by which physical movements are mapped to scroll events.
|
Configure the method by which physical movements are mapped to scroll
|
||||||
|
events.
|
||||||
|
|
||||||
The scroll methods available are:
|
The scroll methods available are:
|
||||||
- *twofinger* - Scroll by two fingers being placed on the surface of the
|
- *twofinger* - Scroll by two fingers being placed on the surface of the
|
||||||
|
|
@ -1275,7 +1278,8 @@ Note: To rotate touch events with output rotation, use the libinput
|
||||||
*<libinput><device><scrollButton>* [button]
|
*<libinput><device><scrollButton>* [button]
|
||||||
Set the button used for the *onbutton* scroll method.
|
Set the button used for the *onbutton* scroll method.
|
||||||
|
|
||||||
*button* is the decimal form of a value from `linux/input-event-codes.h`.
|
*button* is the decimal form of a value
|
||||||
|
from `linux/input-event-codes.h`.
|
||||||
|
|
||||||
*<libinput><device><sendEventsMode>* [yes|no|disabledOnExternalMouse]
|
*<libinput><device><sendEventsMode>* [yes|no|disabledOnExternalMouse]
|
||||||
Optionally enable or disable sending any device events.
|
Optionally enable or disable sending any device events.
|
||||||
|
|
@ -1521,7 +1525,7 @@ This is the full list of interfaces that can be controlled with this mechanism:
|
||||||
|
|
||||||
*XCURSOR_PATH*
|
*XCURSOR_PATH*
|
||||||
Specify a colon-separated list of paths to look for mouse cursors in.
|
Specify a colon-separated list of paths to look for mouse cursors in.
|
||||||
Default
|
Default is
|
||||||
~/.local/share/icons:
|
~/.local/share/icons:
|
||||||
~/.icons:
|
~/.icons:
|
||||||
/usr/share/icons:
|
/usr/share/icons:
|
||||||
|
|
@ -1532,7 +1536,7 @@ This is the full list of interfaces that can be controlled with this mechanism:
|
||||||
|
|
||||||
*XCURSOR_SIZE*
|
*XCURSOR_SIZE*
|
||||||
Specify an alternative mouse cursor size in pixels. Requires
|
Specify an alternative mouse cursor size in pixels. Requires
|
||||||
XCURSOR_THEME to be set also. Default 24.
|
XCURSOR_THEME to be set also. Default is 24.
|
||||||
|
|
||||||
*XCURSOR_THEME*
|
*XCURSOR_THEME*
|
||||||
Specify a mouse cursor theme within XCURSOR_PATH.
|
Specify a mouse cursor theme within XCURSOR_PATH.
|
||||||
|
|
|
||||||
|
|
@ -135,7 +135,7 @@ window.*.title.bg.colorTo.splitTo: #557485
|
||||||
|
|
||||||
*window.active.title.bg*
|
*window.active.title.bg*
|
||||||
Texture for the focused window's titlebar. See texture section above.
|
Texture for the focused window's titlebar. See texture section above.
|
||||||
Default is *Solid*
|
Default is *Solid*.
|
||||||
|
|
||||||
*window.active.title.bg.color*
|
*window.active.title.bg.color*
|
||||||
Background color for the focused window's titlebar. See texture section
|
Background color for the focused window's titlebar. See texture section
|
||||||
|
|
@ -144,7 +144,7 @@ window.*.title.bg.colorTo.splitTo: #557485
|
||||||
|
|
||||||
*window.inactive.title.bg*
|
*window.inactive.title.bg*
|
||||||
Texture for non-focused windows' titlebars. See texture section above.
|
Texture for non-focused windows' titlebars. See texture section above.
|
||||||
Default is *Solid*
|
Default is *Solid*.
|
||||||
|
|
||||||
*window.inactive.title.bg.color*
|
*window.inactive.title.bg.color*
|
||||||
Background color for non-focused windows' titlebars. See texture section
|
Background color for non-focused windows' titlebars. See texture section
|
||||||
|
|
@ -470,7 +470,7 @@ all are supported.
|
||||||
Width of magnifier window border in pixels. Default is 1.
|
Width of magnifier window border in pixels. Default is 1.
|
||||||
|
|
||||||
*magnifier.border.color*
|
*magnifier.border.color*
|
||||||
Color of the magnfier window border. Default is #ff0000 (red).
|
Color of the magnifier window border. Default is #ff0000 (red).
|
||||||
|
|
||||||
# BUTTONS
|
# BUTTONS
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -75,7 +75,7 @@ the `--exit` and `--reconfigure` options use.
|
||||||
(i.e. nested in a compositor). <fmtstr> is a format string to be used as
|
(i.e. nested in a compositor). <fmtstr> is a format string to be used as
|
||||||
the window title, replacing `%o` with the name of the output
|
the window title, replacing `%o` with the name of the output
|
||||||
region. This is useful when simulating multiple screens, such as with
|
region. This is useful when simulating multiple screens, such as with
|
||||||
running labwc with the enviornment variable `WLR_WL_OUTPUTS=2`. In this
|
running labwc with the environment variable `WLR_WL_OUTPUTS=2`. In this
|
||||||
case, `%o` will be unique per simulated screen.
|
case, `%o` will be unique per simulated screen.
|
||||||
|
|
||||||
*-v, --version*
|
*-v, --version*
|
||||||
|
|
|
||||||
|
|
@ -130,7 +130,7 @@ void scaled_buffer_request_update(struct scaled_buffer *self,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* scaled_buffer_invalidate_sharing - clear the list of entire cached
|
* scaled_buffer_invalidate_sharing - clear the list of entire cached
|
||||||
* scaled_buffers used to share visually dupliated buffers. This should
|
* scaled_buffers used to share visually duplicated buffers. This should
|
||||||
* be called on Reconfigure to force updates of newly created
|
* be called on Reconfigure to force updates of newly created
|
||||||
* scaled_buffers rather than reusing ones created before Reconfigure.
|
* scaled_buffers rather than reusing ones created before Reconfigure.
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
|
|
@ -145,7 +145,7 @@ struct action_arg_list {
|
||||||
* Will expand to:
|
* Will expand to:
|
||||||
*
|
*
|
||||||
* enum action_type {
|
* enum action_type {
|
||||||
* ACTION_TYPE_INVALID,
|
* ACTION_TYPE_INVALID = 0,
|
||||||
* ACTION_TYPE_NONE,
|
* ACTION_TYPE_NONE,
|
||||||
* ACTION_TYPE_CLOSE,
|
* ACTION_TYPE_CLOSE,
|
||||||
* ACTION_TYPE_KILL,
|
* ACTION_TYPE_KILL,
|
||||||
|
|
|
||||||
|
|
@ -226,7 +226,7 @@ out:
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Openbox built-in icons are not bigger than 8x8, so have only written this
|
* Openbox built-in icons are not bigger than 8x8, so have only written this
|
||||||
* function to cope wit that max size
|
* function to cope with that max size
|
||||||
*/
|
*/
|
||||||
#define LABWC_BUILTIN_ICON_MAX_SIZE (8)
|
#define LABWC_BUILTIN_ICON_MAX_SIZE (8)
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -172,7 +172,7 @@ item_parse_accelerator(struct menuitem *item, const char *text)
|
||||||
accel_ptr = underscore + 1;
|
accel_ptr = underscore + 1;
|
||||||
break;
|
break;
|
||||||
} else {
|
} else {
|
||||||
/* Ignore empty accelertor */
|
/* Ignore empty accelerator */
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -788,7 +788,7 @@ entry(struct theme *theme, const char *key, const char *value)
|
||||||
value, "window.button.spacing");
|
value, "window.button.spacing");
|
||||||
}
|
}
|
||||||
|
|
||||||
/* botton hover overlay */
|
/* button hover overlay */
|
||||||
if (match_glob(key, "window.button.hover.bg.color")) {
|
if (match_glob(key, "window.button.hover.bg.color")) {
|
||||||
parse_color(value, theme->window_button_hover_bg_color);
|
parse_color(value, theme->window_button_hover_bg_color);
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue