Skip to content

Commit

Permalink
Explain the hooks in the Installation section.
Browse files Browse the repository at this point in the history
  • Loading branch information
Kharacternyk committed Sep 16, 2020
1 parent e8daebb commit ae838c5
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ Installation

Install the ``pacwall-git`` `AUR package`_.

``pacwall`` doesn't know how to set a wallpaper by itself. You should provide it
with some shell commands that do it. Such commands are called *hook*. There are
some example hooks for different setups, one of which you should copy to your local
config.

If you use GNOME, run:

.. code-block:: bash
Expand All @@ -42,6 +47,11 @@ If you use Sway, run:
mkdir -p ~/.config/pacwall
cp /usr/share/pacwall/examples/hook/swaymsg ~/.config/pacwall/pacwall.conf
For some setups, such as XFCE, there are no example hooks. Furthermore, the example
hooks can have bugs. In any case, you can always verify that ``pacwall`` itself is
working fine by examining the image that it has generated at
``~/.cache/pacwall/pacwall.png``.

-----
Usage
-----
Expand Down Expand Up @@ -91,8 +101,6 @@ CLI

* ``-k``: do not run the hook

See `List of settings`_ for details about what the hook is.

-------------
Customization
-------------
Expand Down Expand Up @@ -135,10 +143,6 @@ List of settings
hook is expected to set the wallpaper. The path to the graph image is exported
in the ``$W`` environmental variable.

``/usr/share/pacwall/examples/hook`` contains some example hooks for different
setups, one of which you have copied to ``pacwall.conf`` in the Installation_
section.

* ``shell`` (default: ``bash``)

The shell in which the commands specified in ``hook`` ought to be executed.
Expand Down

0 comments on commit ae838c5

Please sign in to comment.