Fix doc typos and optimised PNGs (#2000)

docs/00-authors.md

@@ -1,6 +1,6 @@
 # Authors
 
-## awesome - awesome window manager
+## Awesome - awesome window manager
 
 **Maintainer**:
 

docs/01-readme.md

@@ -1,8 +1,8 @@
 # Readme
 
-## About awesome
+## About Awesome
 
-awesome is a highly configurable, next generation framework window manager for X.
+Awesome is a highly configurable, next generation framework window manager for X.
 
 ## Building and installation
 
@@ -10,7 +10,7 @@ After extracting the dist tarball, run:
 
     make
 
-This will create a build directory, run cmake in it and build awesome.
+This will create a build directory, run cmake in it and build Awesome.
 
 After building is finished, you can either install via `make install`:
 
@@ -24,7 +24,7 @@ or by auto-generating a .deb or .rpm package, for easy removal later on:
     # or
     sudo rpm -Uvh awesome-x.y.z.rpm
 
-NOTE: awesome uses [`cmake`](https://cmake.org) to build. In case you want to
+NOTE: Awesome uses [`cmake`](https://cmake.org) to build. In case you want to
 pass arguments to cmake, please use the `CMAKE_ARGS` environment variable. For
 instance:
 
@@ -78,34 +78,34 @@ Additionally, the following optional dependencies exist:
   generate slightly better backtraces on crashes
 - `Xephyr` or `Xvfb` for running integration tests
 
-## Running awesome
+## Running Awesome
 
-You can directly select awesome from your display manager. If not, you can
+You can directly select Awesome from your display manager. If not, you can
-add the following line to your .xinitrc to start awesome using startx
+add the following line to your .xinitrc to start Awesome using startx
-or to `.xsession` to start awesome using your display manager:
+or to `.xsession` to start Awesome using your display manager:
 
     exec awesome
 
-In order to connect awesome to a specific display, make sure that
+In order to connect Awesome to a specific display, make sure that
 the `DISPLAY` environment variable is set correctly, e.g.:
 
     DISPLAY=foo.bar:1 exec awesome
 
-(This will start awesome on display `:1` of the host foo.bar.)
+(This will start Awesome on display `:1` of the host foo.bar.)
 
 ## Configuration
 
-The configuration of awesome is done by creating a
+The configuration of Awesome is done by creating a
 `$XDG_CONFIG_HOME/awesome/rc.lua` file, typically `~/.config/awesome/rc.lua`.
 
 An example configuration named `awesomerc.lua` is provided in the source.
 
 ## Troubleshooting
 
-On most systems any message printed by awesome (including warnings and errors)
+On most systems any message printed by Awesome (including warnings and errors)
 is written to `~/.xsession-errors`.
 
-If awesome does not start or the configuration file is not producing the
+If Awesome does not start or the configuration file is not producing the
 desired results the user should examine this file to gain insight into the
 problem.
 

docs/02-contributing.md

@@ -6,7 +6,7 @@ Please look at [Github Issues](https://github.com/awesomeWM/awesome/issues).
 
 ## Style
 
-If you intend to patch and contribute to awesome, please respect the
+If you intend to patch and contribute to Awesome, please respect the
 following guidelines.
 
 Imitate the existing code style. For concrete rules:

docs/04-new-widgets.md

@@ -27,11 +27,11 @@ different sizes than the one requested.
 
 The next callback is `:draw`. As the name suggests, this function is called to
 draw the widget. The arguments to this widget are the context that the widget is
-drawn in, the cairo context on which it should be drawn and the widget's size.
+drawn in, the Cairo context on which it should be drawn and the widget's size.
-The cairo context is set up in such a way that the widget as its top-left corner
+The Cairo context is set up in such a way that the widget as its top-left corner
 at (0, 0) and its bottom-right corner at (width, height). In other words, no
 special transformation needs to be done. Note that during this callback a
-suitable clip will already be applied to the cairo context so that this callback
+suitable clip will already be applied to the Cairo context so that this callback
 will not be able to draw outside of the area that was registered for the widget
 by the layout that placed this widget. You should not call `cr:reset_clip()`, as
 redraws will not be handled correctly in this case.

docs/05-awesomerc.md.lua

@@ -138,7 +138,7 @@ sections.DOC_GLOBAL_KEYBINDINGS = [[
 
  Note that both `Mod2` and `Lock` are ignored by default. If you wish to
  use them, add `awful.key.ignore_modifiers = {}` to your `rc.lua`. `Mod3`,
- `Mod5` are usually not bound in most leyboard layouts. There is an X11 utility
+ `Mod5` are usually not bound in most keyboard layouts. There is an X11 utility
  called `xmodmap` to bind them. See
  [the ARCH Linux Wiki](https://wiki.archlinux.org/index.php/xmodmap) for more
  information.

docs/07-my-first-awesome.md

@@ -1,31 +1,31 @@
-# My first awesome
+# My first Awesome
 
 This little tutorial is for people who never used a tiling window manager before
 and don't have fancy hacking skills. We will explore the awesome world of
-awesome step by step and finally come up with a working desktop, providing some
+Awesome step by step and finally come up with a working desktop, providing some
-basic knowledge on how to configure awesome in the process. We will start with
+basic knowledge on how to configure Awesome in the process. We will start with
-the default `rc.lua` that comes with awesome, play around a little and try to
+the default `rc.lua` that comes with Awesome, play around a little and try to
 make it more beautiful and useful with widgets. For this tutorial you don't need
 any programming skills besides using a text editor.
 
-## Explore awesome
+## Explore Awesome
 
-I will assume that you properly installed awesome through your distribution's
+I will assume that you properly installed Awesome through your distribution's
 package manager or compiled it from source. You should now add `exec awesome` to
-your `~/.xinitrc`. As already mentioned, awesome provides a default config file
+your `~/.xinitrc`. As already mentioned, Awesome provides a default config file
 which will be our starting point. You will usually find this `rc.lua` file in
 `/etc/xdg/awesome/`. Copy it to `~/.config/awesome/`, and then start X (for
 example by running `startx`).
 
-Move your mouse to the upper left corner and click on the awesome logo. A little
+Move your mouse to the upper left corner and click on the Awesome logo. A little
 menu opens. Browse through the menu, then click the logo again to close it. Next
-to the awesome menu you see numbers 1-9. These are your tags (or desktops if you
+to the Awesome menu you see numbers 1-9. These are your tags (or desktops if you
 want). You can click on these to change them but nothing will happen because we
 have not opened any programs. On the top right you see the time/date and a
 symbol showing the current layout. You can also click on the symbol to change
 the active layout.
 
-One of awesome's big advantages over other tiling window managers is its good
+One of the big advantages of Awesome over other tiling window managers is its good
 mouse support. Awesome can act as a full floating window manager (almost like
 openbox) if you want. For this basic tutorial we will mainly focus on keyboard
 control, so let's learn some key bindings now.
@@ -54,7 +54,7 @@ and *Mod4+Right* moves to the next tag in the specified direction.
 Use *Mod4+k* and *Mod4+j* to change your focused client - moving your mouse will
 also do that.
 
-*Mod4+Shift+q* quits awesome, but don't do that now.
+*Mod4+Shift+q* quits Awesome, but don't do that now.
 
 For an overview of all key bindings, press *Mod4+s*. Pressing any key closes
 this overview again.
@@ -114,7 +114,7 @@ Open your `rc.lua` and find the layouts section. It should look like this:
         -- awful.layout.suit.corner.se,
     }
 
-These are all possible tiling and floating layouts awesome has. If you don't
+These are all possible tiling and floating layouts Awesome has. If you don't
 find all of them useful, you can comment some of them out by adding "--"
 to the beginning of the line. Awesome already comes with three layouts which are
 not used in the default config, as you can see above.

docs/16-using-cairo.md

@@ -1,6 +1,6 @@
 # Using Cairo and LGI
 
-These days, Awesome's interface is mostly based on a library called LGI. It provides
+The interface of Awesome is mostly based on a library called LGI. It provides
 access to C libraries such as GTK, GLib, Cairo, Pango, PangoCairo and RSVG using
 Lua code without having to write actual "glue" C code.
 
@@ -75,8 +75,8 @@ of surfaces including:
  * Monochrome image surfaces with transparency (`A8`) or without (`A1`)
  * SVG vectorial surfaces
  * Native (XCB) surfaces
- * Framebuffers and other less interesting ones (from an Awesome's point of
+ * Framebuffers and other less interesting ones (from the point of
-   view)
+   view of Awesome)
 
 For more details see [Surfaces](https://cairographics.org/manual/cairo-Image-Surfaces.html).
 
@@ -129,9 +129,9 @@ applying operations.
 
 ### Cairo in Awesome
 
-All of Awesome's `wibox`es, `awful.wibar`s, `gears.wallpaper`s and
+The `wibox`es, `awful.wibar`s, `gears.wallpaper`s and
-`awful.titlebar`s contain Cairo surfaces, which can be accessed through the
+`awful.titlebar`s in Awesome contain Cairo surfaces, which can be accessed through
-`drawin` API.  This allows widgets to use the Cairo context directly.
+the `drawin` API.  This allows widgets to use the Cairo context directly.
 See the
 [declarative layout system](../documentation/03-declarative-layout.md.html)
 and [new widgets](../documentation/04-new-widgets.md.html) articles for more

docs/17-porting-tips.md

@@ -27,12 +27,12 @@ Here is a diff of the 3.5.9 `rc.lua` with the 4.0 one. All changes due to
 new features and new syntaxes have been removed. A `-` in front of the line
 correspond to content of the 3.5 `rc.lua` and `+` its replacement in 4.0.
 
-This document does not cover the new features added in the Awesome 4 `rc.lua`,
+This document does not cover the new features added in the Awesome v4 `rc.lua`,
 it only covers the minimal required changes to have a properly behaving config.
 
 To test during the port, we recommend the `Xephyr` X11 server.
 
-If Awesome4 **is not installed yet**, we recommand to install it in its own
+If Awesome v4 **is not installed yet**, we recommend to install it in its own
 prefix to avoid conflicts in case you wish to stay on 3.5 for a little
 longer:
 
@@ -56,7 +56,7 @@ longer:
         -c $HOME/.config/awesome4/rc.lua \
         --search $HOME/awesome4_test/share/awesome/lib
 
-If Awesome 4 is **already installed**, then backup your old `rc.lua` and overwrite
+If Awesome v4 is **already installed**, then backup your old `rc.lua` and overwrite
 `~/.config/awesome/rc.lua` (replace this by another path if you use a custom
 XDH config local directory). And only execute:
 
@@ -102,7 +102,7 @@ work. Remove this section.
     --- }}}
 
 The `quit` menu command must be wrapped in a function, otherwise an error
-occurs due to mismatched argument types from the v4.0 `awful.menu` library.
+occurs due to mismatched argument types from the v4 `awful.menu` library.
 
      -- {{{ Menu
      -- Create a laucher widget and a main menu

docs/89-NEWS.md

@@ -107,7 +107,7 @@ Various documentation improvements. Thanks for the feedbacks.
 
 The `awful.widget.taglist` now has `volatile` theme variables.
 
-There is now extra enviroment variables such as `AWESOME_ICON_PATH` and
+There is now extra environment variables such as `AWESOME_ICON_PATH` and
 `AWESOME_THEMES_PATH` for those who prefer not installing Awesome.
 
 Dynamic "C" Lua libraries are now detected like pure Lua ones.

docs/90-FAQ.md

@@ -2,9 +2,9 @@
 
 ## General
 
-### Why call it awesome?
+### Why call it Awesome?
 
-The name *awesome* comes from the English word *awesome* often used by the
+The name *Awesome* comes from the English word *awesome* often used by the
 character [Barney Stinson](http://en.wikipedia.org/wiki/Barney_Stinson)
 from the TV series HIMYM.
 
@@ -98,7 +98,7 @@ redirection, pipes and so on, do not use the `awful.spawn` function but
 
 On zsh, any changes to $PATH you do in `~/.zshrc` will not be picked up (because
 this is only run for interactive shells). Use `~/.zshenv` instead to make
-additions to the path you want to use in awesome.
+additions to the path you want to use in Awesome.
 
 ### How to remove gaps between windows?
 
@@ -197,10 +197,10 @@ You can use the `awful.tag.incmwfact` function to resize master clients and
     awful.key({ modkey, "Shift" }, "l", function () awful.client.incwfact(-0.05) end),
     awful.key({ modkey, "Shift" }, "h", function () awful.client.incwfact( 0.05) end),
 
-### How to change awesome configuration while it's running?
+### How to change Awesome configuration while it's running?
 
-You can modify `rc.lua`, but you have to restart awesome for changes to take
+You can modify `rc.lua`, but you have to restart Awesome for changes to take
-effect. The default keybinding for restarting awesome is "Mod4 + Control + r".
+effect. The default keybinding for restarting Awesome is "Mod4 + Control + r".
 
 ### How to find window's class and other identifiers?
 
@@ -210,7 +210,7 @@ from its output:
   $ xprop WM_CLASS WM_NAME
 
 When the cursor changes to "+" click on the client of interest. From the
-terminal output you can use the following to match clients in awesome:
+terminal output you can use the following to match clients in Awesome:
 
     WM_CLASS(STRING) = "smplayer", "Smplayer"
                         |           |
@@ -289,7 +289,7 @@ you don't want new clients to be urgent by default put this in your rc.lua:
 
 Default binding to open a terminal is "Mod4 + Enter" (where Mod4 is usually the
 "Windows" key). You can also click on the desktop background with the right
-button, to open the awesome menu.
+button, to open the Awesome menu.
 
 From there you can proceed to open `man awesome` which has a good guide,
 including the list of default keybindings.
@@ -300,7 +300,7 @@ With the default config, you can cycle through window layouts by pressing
 "mod4+space" ("mod4+shift+space" to go back) or clicking the layout button in
 the upper right corner of the screen.
 
-### How to restart or quit awesome?
+### How to restart or quit Awesome?
 
 You can use the keybinding "Mod4+Ctrl+r" or by selecting restart in the menu.
 You could call `awesome.restart` either from the Lua prompt widget, or via
@@ -308,47 +308,47 @@ You could call `awesome.restart` either from the Lua prompt widget, or via
 
     $ awesome-client 'awesome.restart()'
 
-You can also send the `SIGHUP` signal to the awesome process. Find the PID using
+You can also send the `SIGHUP` signal to the Awesome process. Find the PID using
 `ps`, `pgrep` or use `pkill`:
 
   $ pkill -HUP awesome
 
-You can quit awesome by using "Mod4+Shift+q" keybinding or by selecting quit in
+You can quit Awesome by using "Mod4+Shift+q" keybinding or by selecting quit in
 the menu. You could call `awesome.quit` either from the Lua prompt widget,
 or by passing it to `awesome-client`.
 
     $ echo 'awesome.quit()' | awesome-client
 
-You can also send the `SIGINT` signal to the awesome process. Find the PID using `ps`, `pgrep` or use `pkill`:
+You can also send the `SIGINT` signal to the Awesome process. Find the PID using `ps`, `pgrep` or use `pkill`:
 
     $ pkill -INT awesome
 
-### Why awesome doesn't use my own brand new config?
+### Why Awesome doesn't use my own brand new config?
 
-If awesome cannot find `$XDG_CONFIG_HOME/awesome/rc.lua`, or fails to load it,
+If Awesome cannot find `$XDG_CONFIG_HOME/awesome/rc.lua`, or fails to load it,
 it falls back to using `/etc/xdg/awesome/rc.lua` (you haven't edited it, I hope,
 have you?). Even if `awesome --check` hasn't reported any error, it only means
 that your `rc.lua` is syntactically correct, but absence of runtime errors is
-not guaranteed. Moreover, awesome could apply half of your config then encounter
+not guaranteed. Moreover, Awesome could apply half of your config then encounter
-an error and load stock one, and that could lead to bizzare result, like two
+an error and load stock one, and that could lead to bizarre result, like two
 sets of tags. See the next entry on how to find out where the problem lurks.
 
 ### Where are logs, error messages or something?
 
 When hacking your own configuration, something inevitably would go wrong.
-awesome prints error messages to its `stderr` stream. When run with usual `$
+Awesome prints error messages to its `stderr` stream. When run with usual `$
 startx`, it'd be printed right in tty. If you use something more complicated
 (some kind of DM, like kdm or gdm), stderr is usually redirected somewhere else.
 To see where, run the following command:
 
     $ ls -l /proc/$(pidof awesome)/fd/2
 
-There's handy way to run awesome and redirect both its standard output and error streams to files:
+There's handy way to run Awesome and redirect both its standard output and error streams to files:
 
     exec /usr/bin/awesome >> ~/.cache/awesome/stdout 2>> ~/.cache/awesome/stderr
 
 If you put it into `.xinitrc` (for `startx`) or `~/.xsession`, you'll be able to
-watch (with `tail -f`) everything right from awesome.
+watch (with `tail -f`) everything right from Awesome.
 
 ### Why does Mod4 "swallow" succeeding key presses?
 

docs/common/fixed.ldoc

@@ -12,7 +12,7 @@
 -- and the index.
 -- @param widget The widget to replace
 -- @param widget2 The widget to replace `widget` with
--- @tparam[opt=false] boolean recursive Digg in all compatible layouts to find the widget.
+-- @tparam[opt=false] boolean recursive Dig in all compatible layouts to find the widget.
 -- @treturn boolean If the operation is successful
 -- @name replace_widget
 -- @class function
@@ -31,7 +31,7 @@
 -- if the layouts not the same, then only `widget::replaced` will be emitted.
 -- @param widget1 The first widget
 -- @param widget2 The second widget
--- @tparam[opt=false] boolean recursive Digg in all compatible layouts to find the widget.
+-- @tparam[opt=false] boolean recursive Dig in all compatible layouts to find the widget.
 -- @treturn boolean If the operation is successful
 -- @name swap_widgets
 -- @class function

docs/common/widget.ldoc

@@ -2,7 +2,7 @@
 --- Get a widget index.
 -- @param widget The widget to look for
 -- @param[opt] recursive Also check sub-widgets
--- @param[opt] ... Aditional widgets to add at the end of the path
+-- @param[opt] ... Additional widgets to add at the end of the path
 -- @return The index
 -- @return The parent layout
 -- @return The path between self and widget