Skip to content

Commit

Permalink
docs: fix various typos (#223)
Browse files Browse the repository at this point in the history
idleinhibit, mpd, network, widgets and main
  • Loading branch information
01micko committed Aug 28, 2024
1 parent 3d43e97 commit f50fbcd
Show file tree
Hide file tree
Showing 10 changed files with 36 additions and 36 deletions.
2 changes: 1 addition & 1 deletion doc/sfwbar-idleinhibit.1
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Requires: none
.sp
The IdleInhibit module, allows attaching idle inhibitor to any widget in the
taskbar. If an idle inhibitor is active on a visible widget, it will prevent
any the compiositor to going into an idle state (i.e. blanking a screen,
the compositor to going into an idle state (i.e. blanking a screen,
going into a suspend mode or activating a screensaver)
.SH EXPRESSION FUNCTIONS
.SS IdleInhibitState()
Expand Down
2 changes: 1 addition & 1 deletion doc/sfwbar-idleinhibit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ SYNOPSIS

The IdleInhibit module, allows attaching idle inhibitor to any widget in the
taskbar. If an idle inhibitor is active on a visible widget, it will prevent
any the compiositor to going into an idle state (i.e. blanking a screen,
the compositor to going into an idle state (i.e. blanking a screen,
going into a suspend mode or activating a screensaver)

Expression Functions
Expand Down
2 changes: 1 addition & 1 deletion doc/sfwbar-mpd.1
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Genre of the current song.
Current playback volume.
.TP
.B \(dqrepeat\(dq
Repet flag of the current playlist: \(dq1\(dq/\(dq0\(dq.
Repeat flag of the current playlist: \(dq1\(dq/\(dq0\(dq.
.TP
.B \(dqrandom\(dq
Random flag of the current playlist: \(dq1\(dq/\(dq0\(dq.
Expand Down
2 changes: 1 addition & 1 deletion doc/sfwbar-mpd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ the following queries are supported:
"volume"
Current playback volume.
"repeat"
Repet flag of the current playlist: "1"/"0".
Repeat flag of the current playlist: "1"/"0".
"random"
Random flag of the current playlist: "1"/"0".
"queue_len"
Expand Down
4 changes: 2 additions & 2 deletions doc/sfwbar-network.1
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ Filename: network.so
Requires: none
.SH SYNOPSIS
.sp
The network module tracks te state of the current network connection.
The network module tracks the state of the current network connection.
.SH EXPRESSION FUNCTIONS
.SS NetInfo(Query[,Interface])
.sp
Function NetInfo queries the parameter of the connection on the network
interface specified. If Interface is not specifies, NetInfo will query the
interface specified. If Interface is not specified, NetInfo will query the
interface of the default gateway (if one exists). The queries supported are:
.INDENT 0.0
.TP
Expand Down
4 changes: 2 additions & 2 deletions doc/sfwbar-network.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Requires: none
SYNOPSIS
========

The network module tracks te state of the current network connection.
The network module tracks the state of the current network connection.

Expression Functions
====================
Expand All @@ -24,7 +24,7 @@ NetInfo(Query[,Interface])
--------------------------

Function NetInfo queries the parameter of the connection on the network
interface specified. If Interface is not specifies, NetInfo will query the
interface specified. If Interface is not specified, NetInfo will query the
interface of the default gateway (if one exists). The queries supported are:

"ip"
Expand Down
4 changes: 2 additions & 2 deletions doc/sfwbar-widgets.1
Original file line number Diff line number Diff line change
Expand Up @@ -75,15 +75,15 @@ by using a status change notification from one of the more efficient methods.
.sp
The data we obtain from various sources isn\(aqt always presented in a directly
useable format. We may need to parse these data dumps to extract the data
points we need. Sfwbar allows extracting iinfromation the data dump using
points we need. Sfwbar allows extracting information the data dump using
regular expression or json parsers. I.e. if the /proc file contains several
strings of text, sfwbar can identify a string matching a pattern, extract a
segment of this string, using a regular expression capture buffer and save this
outout in an internal variable. Sfwbar can extract multiple patterns from the
same data dump and populate multiple variables.
.SH MANIPULATE INFORMATION
.sp
Once infromation is parsed, we can manipulate it into a format we need for
Once information is parsed, we can manipulate it into a format we need for
display. It can be something simple, such as rounding a number for decimal
precision or a complex requiring flow control, mathematical calculations and
text manipulation (i.e. calculating color gradients and generating an svg
Expand Down
4 changes: 2 additions & 2 deletions doc/sfwbar-widgets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ EXTRACT DATAPOINTS

The data we obtain from various sources isn't always presented in a directly
useable format. We may need to parse these data dumps to extract the data
points we need. Sfwbar allows extracting iinfromation the data dump using
points we need. Sfwbar allows extracting information the data dump using
regular expression or json parsers. I.e. if the /proc file contains several
strings of text, sfwbar can identify a string matching a pattern, extract a
segment of this string, using a regular expression capture buffer and save this
Expand All @@ -67,7 +67,7 @@ same data dump and populate multiple variables.
MANIPULATE INFORMATION
----------------------

Once infromation is parsed, we can manipulate it into a format we need for
Once information is parsed, we can manipulate it into a format we need for
display. It can be something simple, such as rounding a number for decimal
precision or a complex requiring flow control, mathematical calculations and
text manipulation (i.e. calculating color gradients and generating an svg
Expand Down
24 changes: 12 additions & 12 deletions doc/sfwbar.1
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,7 @@ menu (\(dqmenu_name\(dq) {
Command MenuClear deletes any existing items from a menu.
Each menu has a name used to link the menu to the widget action and a
list of menu items. If a menu with the same name is defined more than
once, the items from subsequence declarations will be appended to the
once, the items from subsequent declarations will be appended to the
original menu. If you want to re\-define the menu, use MenuClear action
to clear the original menu.
.sp
Expand Down Expand Up @@ -675,7 +675,7 @@ monitor name can be prefixed by \(dqstatic:\(dq, i.e. \(dqstatic:eDP\-1\(dq, if
is set and the specified monitor doesn\(aqt exist or gets disconnected,
the bar will not jump to another montior, but will be hidden and won\(aqt
reappear until the monitor is reconnected.
** This action is deperecated, please use property \fImonitor\fP instead **
** This action is deprecated, please use property \fImonitor\fP instead **
.TP
.B SetMirror [<bar_name>,]<string>
mirror the bar to monitors matching any of the specified patterns. If
Expand All @@ -686,40 +686,40 @@ i.e. \(dqeDP\-\fI:HDMI\-1\(dq will mirror to any monitor with name starting with
\(dqeDP\-\(dq or monitor named \(dqHDMI\-1\(dq. The patterns are specified in glob style
\(aq\fP\(aq and \(aq?\(aq are used as wildcards. A simplest use is \fISetMirror \(dq*\(dq\fP will
mirror all bars across all monitors.
** This action is deperecated, please use property \fImirror\fP instead **
** This action is deprecated, please use property \fImirror\fP instead **
.TP
.B SetLayer [<bar_name>,]<string>
move bar to a specified layer (supported parameters are \(dqtop\(dq, \(dqbottom\(dq,
\(dqbackground\(dq and \(dqoverlay\(dq.
** This action is deperecated, please use property \fIlayer\fP instead **
** This action is deprecated, please use property \fIlayer\fP instead **
.TP
.B SetBarSize [<bar_name>,]<string>
set size of the bar (width for top or bottom bar, height for left or right
bar). The argument is a string. I.e. \(dq800\(dq for 800 pixels or \(dq50%\(dq for
50% of screen size
** This action is deperecated, please use property \fIsize\fP instead **
** This action is deprecated, please use property \fIsize\fP instead **
.TP
.B SetBarMargin [<bar_name>,]<string>
set margin around the bar to the number of pixels specified by string.
** This action is deperecated, please use property \fImargin\fP instead **
** This action is deprecated, please use property \fImargin\fP instead **
.TP
.B SetBarSensor [<bar_name>],<string>
Specify whether the bar should be hidden once the pointer leaves the bar
window. Once hidden, the bar will popup again if the pointer touches the
sensor located along the screen edge along which the bar is placed.
String specifies the bar pop\-down delay in milliseconds.
** This action is deperecated, please use property \fIsensor\fP instead **
** This action is deprecated, please use property \fIsensor\fP instead **
.TP
.B SetBarID <string>
specify bar ID to listen on for mode and hidden_state signals. If no
bar ID is specified, SfwBar will listen to signals on all IDs
** This action is deperecated, please use property \fIsway_bar_id\fP instead **
** This action is deprecated, please use property \fIsway_bar_id\fP instead **
.TP
.B SetExclusiveZone [<bar_name>,]<string>
specify exclusive zone policy for the bar window. Acceptable values are
\(dqauto\(dq, \(dq\-1\(dq, \(dq0\(dq or positive integers. These have meanings in line with
exclusive zone setting in the layer shell protocol. Default value is \(dqauto\(dq
** This action is deperecated, please use property \fIexclusive_zone\fP instead **
** This action is deprecated, please use property \fIexclusive_zone\fP instead **
.TP
.B SetValue [<widget>,]<string>
set the value of the widget. This action applies to the widget from which
Expand Down Expand Up @@ -775,7 +775,7 @@ function(\(dqfancy_menu\(dq) {
The above example clears a menu, executes a script that builds a menu again
and opens the resulting menu.
.sp
Function \(dqSfwBarInit\(dq executed on startup. You can use this functions to set
Function \(dqSfwBarInit\(dq executed on startup. You can use this function to set
initial parameters for the bar, such as default monitor and layer.
.SS Scanner
.sp
Expand Down Expand Up @@ -896,11 +896,11 @@ Variable should be set to the first occurrence of the pattern in the source
Variable should be set to the last occurrence of the pattern in the source
.TP
.B Sum
Variable should be set to the sum of all occurrences of the pattern in the
Variable should be set to the sum of all occurrences of the pattern in the
source
.TP
.B Product
Variable should be set to the product of all occurrences of the pattern in
Variable should be set to the product of all occurrences of the pattern in
the source
.UNINDENT
.sp
Expand Down
24 changes: 12 additions & 12 deletions doc/sfwbar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ The example syntax is as following: ::
Command MenuClear deletes any existing items from a menu.
Each menu has a name used to link the menu to the widget action and a
list of menu items. If a menu with the same name is defined more than
once, the items from subsequence declarations will be appended to the
once, the items from subsequent declarations will be appended to the
original menu. If you want to re-define the menu, use MenuClear action
to clear the original menu.

Expand Down Expand Up @@ -560,7 +560,7 @@ SetMonitor [<bar_name>,]<string>
is set and the specified monitor doesn't exist or gets disconnected,
the bar will not jump to another montior, but will be hidden and won't
reappear until the monitor is reconnected.
** This action is deperecated, please use property `monitor` instead **
** This action is deprecated, please use property `monitor` instead **

SetMirror [<bar_name>,]<string>
mirror the bar to monitors matching any of the specified patterns. If
Expand All @@ -571,40 +571,40 @@ SetMirror [<bar_name>,]<string>
"eDP-" or monitor named "HDMI-1". The patterns are specified in glob style
'*' and '?' are used as wildcards. A simplest use is `SetMirror "*"` will
mirror all bars across all monitors.
** This action is deperecated, please use property `mirror` instead **
** This action is deprecated, please use property `mirror` instead **

SetLayer [<bar_name>,]<string>
move bar to a specified layer (supported parameters are "top", "bottom",
"background" and "overlay".
** This action is deperecated, please use property `layer` instead **
** This action is deprecated, please use property `layer` instead **

SetBarSize [<bar_name>,]<string>
set size of the bar (width for top or bottom bar, height for left or right
bar). The argument is a string. I.e. "800" for 800 pixels or "50%" for
50% of screen size
** This action is deperecated, please use property `size` instead **
** This action is deprecated, please use property `size` instead **

SetBarMargin [<bar_name>,]<string>
set margin around the bar to the number of pixels specified by string.
** This action is deperecated, please use property `margin` instead **
** This action is deprecated, please use property `margin` instead **

SetBarSensor [<bar_name>],<string>
Specify whether the bar should be hidden once the pointer leaves the bar
window. Once hidden, the bar will popup again if the pointer touches the
sensor located along the screen edge along which the bar is placed.
String specifies the bar pop-down delay in milliseconds.
** This action is deperecated, please use property `sensor` instead **
** This action is deprecated, please use property `sensor` instead **

SetBarID <string>
specify bar ID to listen on for mode and hidden_state signals. If no
bar ID is specified, SfwBar will listen to signals on all IDs
** This action is deperecated, please use property `sway_bar_id` instead **
** This action is deprecated, please use property `sway_bar_id` instead **

SetExclusiveZone [<bar_name>,]<string>
specify exclusive zone policy for the bar window. Acceptable values are
"auto", "-1", "0" or positive integers. These have meanings in line with
exclusive zone setting in the layer shell protocol. Default value is "auto"
** This action is deperecated, please use property `exclusive_zone` instead **
** This action is deprecated, please use property `exclusive_zone` instead **

SetValue [<widget>,]<string>
set the value of the widget. This action applies to the widget from which
Expand Down Expand Up @@ -655,7 +655,7 @@ dynamically constructed menus generated by an external script: ::
The above example clears a menu, executes a script that builds a menu again
and opens the resulting menu.

Function "SfwBarInit" executed on startup. You can use this functions to set
Function "SfwBarInit" executed on startup. You can use this function to set
initial parameters for the bar, such as default monitor and layer.

Scanner
Expand Down Expand Up @@ -765,11 +765,11 @@ Last
Variable should be set to the last occurrence of the pattern in the source

Sum
Variable should be set to the sum of all occurrences of the pattern in the
Variable should be set to the sum of all occurrences of the pattern in the
source

Product
Variable should be set to the product of all occurrences of the pattern in
Variable should be set to the product of all occurrences of the pattern in
the source

For string variables, Sum and Product aggregators are treated as Last.
Expand Down

0 comments on commit f50fbcd

Please sign in to comment.