Fix typos in sway-ipc.7.scd

Some sections of the man page were difficult to understand. This fixes
several typos and grammatical errors.
This commit is contained in:
someever 2026-04-12 20:10:59 +03:00 committed by Simon Ser
parent 81246fc6dc
commit e51f9d7183

View file

@ -802,7 +802,7 @@ node and will have the following properties:
Retrieve the currently set marks Retrieve the currently set marks
*REPLY*++ *REPLY*++
An array of marks current set. Since each mark can only be set for one An array of marks currently set. Since each mark can only be set for one
container, this is a set so each value is unique and the order is undefined. container, this is a set so each value is unique and the order is undefined.
*Example Reply:* *Example Reply:*
@ -833,13 +833,13 @@ An array of bar IDs, which are strings
*MESSAGE*++ *MESSAGE*++
When sent with a bar ID as the payload, this retrieves the config associated When sent with a bar ID as the payload, this retrieves the config associated
with the specified by the bar ID in the payload. This is used by swaybar, but with the bar ID specified in the payload. This is used by swaybar, but could
could also be used for third party bars also be used for third-party bars
*REPLY*++ *REPLY*++
An object that represents the configuration for the bar with the bar ID sent as An object that represents the configuration for the bar with the bar ID sent as
the payload. The following properties exists and more information about what the payload. The following properties exist, with more information about their
their value mean can be found in *sway-bar*(5): values in *sway-bar*(5):
[- *PROPERTY* [- *PROPERTY*
:- *DATA TYPE* :- *DATA TYPE*
@ -1040,7 +1040,7 @@ An object containing the following properties:
## 8. GET_BINDING_MODES ## 8. GET_BINDING_MODES
*MESSAGE*++ *MESSAGE*++
Retrieve the list of binding modes that currently configured Retrieve the list of binding modes that are currently configured
*REPLY*++ *REPLY*++
An array of strings, with each string being the name of a binding mode. This An array of strings, with each string being the name of a binding mode. This
@ -1154,13 +1154,13 @@ following properties:
_tablet\_tool_, _tablet\_pad_, or _switch_ _tablet\_tool_, _tablet\_pad_, or _switch_
|- xkb_active_layout_name |- xkb_active_layout_name
: string : string
: (Only keyboards) The name of the active keyboard layout in use : (Only keyboards) The name of the active keyboard layout
|- xkb_layout_names |- xkb_layout_names
: array : array
: (Only keyboards) A list a layout names configured for the keyboard : (Only keyboards) A list a layout names configured for the keyboard
|- xkb_active_layout_index |- xkb_active_layout_index
: integer : integer
: (Only keyboards) The index of the active keyboard layout in use : (Only keyboards) The index of the active keyboard layout
|- scroll_factor |- scroll_factor
: floating : floating
: (Only pointers) Multiplier applied on scroll event values. : (Only pointers) Multiplier applied on scroll event values.
@ -1467,7 +1467,7 @@ one seat. Each object has the following properties:
# EVENTS # EVENTS
Events are a way for client to get notified of changes to sway. A client can Events are a way for clients to get notified of changes to sway. A client can
subscribe to any events it wants to be notified of changes for. The event is subscribe to any events it wants to be notified of changes for. The event is
sent in the same format as a reply. The following events are currently sent in the same format as a reply. The following events are currently
available: available:
@ -1478,7 +1478,7 @@ available:
|- 0x80000000 |- 0x80000000
: workspace : workspace
:[ Sent whenever an event involving a workspace occurs such as initialization :[ Sent whenever an event involving a workspace occurs such as initialization
of a new workspace or a different workspace gains focus of a new workspace or another workspace gaining focus
|- 0x80000001 |- 0x80000001
: output : output
: Sent when outputs are updated : Sent when outputs are updated
@ -1487,7 +1487,7 @@ available:
: Sent whenever the binding mode changes : Sent whenever the binding mode changes
|- 0x80000003 |- 0x80000003
: window : window
: Sent whenever an event involving a window occurs such as being reparented, : Sent whenever an event involving a window occurs such as it being reparented,
focused, or closed focused, or closed
|- 0x80000004 |- 0x80000004
: barconfig_update : barconfig_update
@ -1503,7 +1503,7 @@ available:
: Sent when an ipc client sends a _SEND\_TICK_ message : Sent when an ipc client sends a _SEND\_TICK_ message
|- 0x80000014 |- 0x80000014
: bar_state_update : bar_state_update
: Send when the visibility of a bar should change due to a modifier : Sent when the visibility of a bar should change due to a modifier
|- 0x80000015 |- 0x80000015
: input : input
: Sent when something related to input devices changes : Sent when something related to input devices changes
@ -1522,10 +1522,10 @@ single object with the following properties:
:[ The type of change that occurred. See below for more information :[ The type of change that occurred. See below for more information
|- current |- current
: object : object
: An object representing the workspace effected or _null_ for _reload_ changes : An object representing the affected workspace or _null_ for _reload_ changes
|- old |- old
: object : object
: For a _focus_ change, this is will be an object representing the workspace : For a _focus_ change, this will be an object representing the workspace
being switched from. Otherwise, it is _null_ being switched from. Otherwise, it is _null_
@ -1543,7 +1543,7 @@ The following change types are currently available:
|- rename |- rename
: The workspace was renamed : The workspace was renamed
|- urgent |- urgent
: A window on the workspace has had their urgency hint set or all urgency hints : A window on the workspace has had its urgency hint set or all urgency hints
for windows on the workspace have been cleared for windows on the workspace have been cleared
|- reload |- reload
: The configuration file has been reloaded : The configuration file has been reloaded
@ -1653,7 +1653,7 @@ object with the following properties:
:[ The type of change that occurred. See below for more information :[ The type of change that occurred. See below for more information
|- container |- container
: object : object
: An object representing the window effected : An object representing the affected window
The following change types are currently available: The following change types are currently available:
@ -1816,7 +1816,7 @@ event is a single object with the following properties:
: Whether this event was triggered by subscribing to the tick events : Whether this event was triggered by subscribing to the tick events
|- payload |- payload
: string : string
: The payload given with a _SEND\_TICK_ message, if any. Otherwise, an empty : The payload provided in a _SEND\_TICK_ message, if any. Otherwise, an empty
string string
@ -1838,7 +1838,7 @@ event is a single object with the following properties:
:- *DESCRIPTION* :- *DESCRIPTION*
|- id |- id
: string : string
:[ The bar ID effected :[ The bar ID affected
|- visible_by_modifier |- visible_by_modifier
: boolean : boolean
: Whether the bar should be made visible due to a modifier being pressed : Whether the bar should be made visible due to a modifier being pressed
@ -1854,7 +1854,7 @@ event is a single object with the following properties:
## 0x80000015. INPUT ## 0x80000015. INPUT
Sent when something related to the input devices changes. The event is a single Sent when something related to input devices changes. The event is a single
object with the following properties: object with the following properties:
[- *PROPERTY* [- *PROPERTY*
@ -1865,7 +1865,7 @@ object with the following properties:
:[ What has changed :[ What has changed
|- input |- input
: object : object
: An object representing the input that is identical the ones GET_INPUTS gives : An object representing the input that is identical to the ones GET_INPUTS gives
The following change types are currently available: The following change types are currently available:
[- *TYPE* [- *TYPE*