slight modifications

FelixKratz · Oct 15, 2023 · b07a1dd · b07a1dd
1 parent f865fa7
commit b07a1dd
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 31 deletions.
diff --git a/docs/build.sh b/docs/build.sh
@@ -1,3 +1,5 @@
+#!/bin/sh
+
 rm -rf build
 mkdir build
 scdoc < sketchybar-animate.5.scd > build/sketchybar-animate.5

diff --git a/docs/sketchybar-animate.5.scd b/docs/sketchybar-animate.5.scd
@@ -44,7 +44,7 @@ animation beginning at the current state.
 	animation in seconds is given by _DURATION_ / 60.
 
 The animation system *always* animates between all *current* values and the
-values specified in a configuration command (i.e. `--bar` or `--set` commands).
+values specified in a configuration command (i.e. *--bar* or *--set* commands).
 
 # EXAMPLES
 

diff --git a/docs/sketchybar-components.5.scd b/docs/sketchybar-components.5.scd
@@ -116,7 +116,7 @@ sketchybar --set space_name script=path/to/script
 ```
 
 For performance reasons the space script is only run on a change in the
-$SELECTED variable, i.e. if the associated space has become active or has
+*$SELECTED* variable, i.e. if the associated space has become active or has
 resigned being active.
 
 
@@ -172,7 +172,7 @@ those items.
 	bar item to be aliased.
 
 	If an application has multiple menu bar widgets, the command can be overloaded
-	by providing a _WINDOW_OWNER_ and _WINDOW_NAME_. See the note below how to
+	by providing a _WINDOW_OWNER_ and _WINDOW_NAME_. See the note below on how to
 	list all available widgets.
 
 	Then, say, the default system items can be aliased as in:
@@ -209,7 +209,7 @@ those items.
 ## Notes
 
 All macOS menu bar items currently available on the system with their respective
-owners and names can be listed via (see *sketchybar-query*(5))
+owners and names can be listed via (see *sketchybar-query*(5)):
 ```
 sketchybar --query default_menu_items
 ```
@@ -284,9 +284,9 @@ do sid=$(($i+1))
 done
 ```
 Should you wish to focus the respective spaces with a click on the item in the
-bar, you can add a click_script to the items which triggers a space change (e.g.
-via yabai or by synthetically emitting the space focus keyboard shortcuts via
-skhd)
+bar, you can add a *click_script* to the items which triggers a space change
+(e.g. via yabai, or via skhd by synthetically emitting the space focus keyboard
+shortcuts).
 
 # SEE ALSO
 

diff --git a/docs/sketchybar-events.5.scd b/docs/sketchybar-events.5.scd
@@ -19,7 +19,7 @@ used to create more reactive and performant items which react to events rather
 than to poll changes.
 
 Some events send additional information through the *$INFO* environment
-variable. When a script is run due to an event the *$SENDER* variable is passed.
+variable. When a script is run due to an event, the *$SENDER* variable is passed.
 This variable holds the event name (see EVENTS) and can be used to distinguish
 between different events in a script. It is thus possible to have a script
 that reacts differently to various events (consider: a switch statement via
@@ -76,7 +76,7 @@ the system is sleeping.
 	A list of events can be found in EVENTS. See below.
 
 *--trigger* _NAME_ [_ENVVAR_=_VALUE_ ... _ENVVAR_=_VALUE_]
-	Trigger any custom event. Optionally, specify _ENVVAR with value _VALUE_ 
+	Trigger any custom event. Optionally, specify _ENVVAR_ with value _VALUE_ 
 	(or a series of such variables) to pass them on to the *script* or 
 	*click_script*.
 
@@ -93,11 +93,11 @@ the system is sleeping.
 :< *returned $INFO*
 |  front_app_switched
 :  When the front application changes (not triggered if a different window of
-  the same app is focused)
+   the same app is focused)
 :  front application name
 |  space_change
 :  When the active mission control space changes
-:  JSON for active spaces on all displays
+:  list of active spaces on all displays in a JSON structure
 |  display_change
 :  When the active display is changed
 :  new active display id
@@ -140,19 +140,19 @@ the system is sleeping.
 |  mouse.scrolled
 :  When the mouse is scrolled over an item
 :  scroll wheel delta
-|  mouse.scrolled.globa
+|  mouse.scrolled.global
 :  When the mouse is scrolled over an empty region of the bar
 :  scroll wheel delta
 
 # EXAMPLES
 
-A simple plugin that uses the com.spotify.client.PlaybackStateChanged* 
-*notification sent by Spotify can be found at 
+A simple plugin that uses the *com.spotify.client.PlaybackStateChanged*
+notification sent by Spotify can be found at
 https://github.com/FelixKratz/SketchyBar/discussions/12#discussioncomment-1455842
 
-A more advanced plugin that uses the *com.apple.screenIsUnlocked* notification 
-sent by the system and the animation feature (see *sketchybar-animate*(5)) can 
-be found at 
+A more advanced plugin that uses the *com.apple.screenIsUnlocked* notification
+sent by the system and the animation feature (see *sketchybar-animate*(5)) can
+be found at
 https://github.com/FelixKratz/SketchyBar/discussions/12?sort=new#discussioncomment-2979651
 
 # SEE ALSO

diff --git a/docs/sketchybar-items.5.scd b/docs/sketchybar-items.5.scd
@@ -223,7 +223,7 @@ Note:
 |  highlight_color
 :  <argb_hex>
 :  0xff000000
-:  Highlight color of the text (e.g. for active space icon
+:  Highlight color of the text (e.g. for active space icon)
 |  padding_left
 :  <integer>
 :  0

diff --git a/docs/sketchybar-tips.5.scd b/docs/sketchybar-tips.5.scd
@@ -68,15 +68,15 @@ sketchybar --bar "${bar[@]}"
 If you are experiencing problems with the configuration process, it might be
 helpful to work through the following steps:
 
-. Start sketchybar directly from the commandline to see the verbose error or,
+. Start sketchybar directly from the command line to see the verbose error or
   warning messages.
 . Make sure you have no trailing whitespaces after the newline escape character
   *\\*.
 . Make sure your scripts are made executable (that is via chmod +x script.sh).
 . Reduce the configuration to a minimal example and narrow down the problematic
   region.
 . Try running erroneous scripts directly in the command line.
-. Query sketchybar for relevant properties and use them to deduce the,
+. Query sketchybar for relevant properties and use them to deduce the
   problems root cause.
 . Create and file an issue at https://github.com/FelixKratz/SketchyBar/issues.
   A second pair of eyes might now be the only thing that helps. 
@@ -127,8 +127,8 @@ The config path for this additional bar is in _$HOME/.config/bottom_bar/_. Of
 course *bottom_bar* is only an example and can be freely replaced with any other
 identifier.
 
-You can bootstrap the additional bar by invoking it at the very bottom of your
-main bar's sketchybarrc.
+You can bootstrap the additional bar by invoking it at the very end of your
+main bar's configuration file.
 
 ## Performance optimizations
 

diff --git a/docs/sketchybar.1.scd b/docs/sketchybar.1.scd
@@ -110,13 +110,13 @@ A sketchybar configuration file is a regular shell script file that resides
 at _$HOME/.config/sketchybar/sketchybarrc_. It is executed when sketchybar
 launches. Everything persistent should be set up in this file.
 
-It is possible to play with properties in the commandline and change them on the
-fly while the bar is running. Once a fitting value is found, the configuration
-can then be included in the configuration file. The configuration is then
-restored on restart.
+It is possible to play with properties in the command line and change them
+on the fly while the bar is running. Once a fitting value is found, the
+configuration can then be included in the configuration file. The configuration
+is then restored on restart.
 
 When configuring the bar, it can be helpful to *stop the brew service* and *run
-sketchybar* from the commandline directly to see all relevant error messages
+sketchybar* from the command line directly to see all relevant error messages
 and warnings directly.
 
 Refer to
@@ -168,7 +168,7 @@ If sketchybar is run from the command line directly with the command
 *sketchybar*, all outputs and error messages from scripts will be printed in
 stdout.
 
-The default plugin folder is located in _$HOME/.config/sketchybar/plugins_.
+The default plugin folder is located at _$HOME/.config/sketchybar/plugins_.
 Plugins need to be referenced with absolute paths because relative paths will
 not be resolved correctly.
 

diff --git a/docs/sketchybar.5.scd b/docs/sketchybar.5.scd
@@ -23,7 +23,7 @@ The possible settings to configure the bar include
 |  border_color
 :  <argb_hex>
 :  0xffff0000
-:  Color of the bars border
+:  Color of the bar's border
 |  position
 :  top, bottom
 :  top
@@ -47,7 +47,7 @@ The possible settings to configure the bar include
 |  border_width
 :  <positive_integer>
 :  0
-:  Border width of the bars border
+:  Border width of the bar's border
 |  blur_radius
 :  <positive_integer>
 :  0
@@ -83,7 +83,7 @@ The possible settings to configure the bar include
 |  sticky
 :  <boolean>
 :  off
-:  Makes the bar sticky (only use with disabled space change animations [See issue #220]
+:  Makes the bar sticky (only use with disabled space change animations)
 |  font_smoothing
 :  <boolean>
 :  off
@@ -93,6 +93,10 @@ The possible settings to configure the bar include
 :  off
 :  If the bar should draw a shadow
 
+
+For details about *sticky*, see
+https://github.com/FelixKratz/SketchyBar/issues/220
+
 # EXAMPLES
 
 ```