wallpaperctl/readme.md

# Wallpaperctl
- **Note:** Adjust paths as applicable to the desired OS.
- **Note:** The "$" represents the terminal prompt.
- **Note:** Verified to work on Arch Linux with Gnome v3.14 to v42.

## Installation Instructions

1. Download "wallpaperctl.service", "wallpaperctl.timer" and "gnome_rotate_wallpaper".
2. Move the 3 files to where Systemd user files are stored.
```bash
$ mv wallpaperctl.service wallpaperctl.timer /etc/systemd/user/
```
3. Move the BASH script "gnome_rotate_wallpaper".
```bash
$ mv gnome_rotate_wallpaper /usr/local/bin/
```
4. Set execute permissions.
```bash
$ chmod +x /usr/local/bin/gnome_rotate_wallpaper
```
5. Enable the timer.
```bash
$ systemctl --user enable wallpaperctl.timer
```
6. Verify the timer is enabled.
```bash
$ systemctl --user list-unit-files
wallpaperctl.service disabled
wallpaperctl.timer   enabled
2 unit files listed.
```
7. Start the timer.
```bash
$ systemctl --user start wallpaperctl.timer
```
8. Verify the timer has been started.
```bash
$ systemctl --user list-timers
NEXT                         LEFT    LAST                        PASSED UNIT               ACTIVATES
Thu 2016-03-10 18:49:00 CST  1s left Thu 2016-03-10 18:48:56 CST 1s ago wallpaperctl.timer wallpaperctl.service
1 timers listed.
Pass --all to see loaded but inactive timers, too.
```

## User Configuration

### Change the default wallpaper directory.

1. Create the required directories.
```bash
$ mkdir  ~/.config/systemd ~/.config/systemd/user
```
2. Create the configuration file. Replace "username" with applicable value.
```bash
$ nano ~/.config/systemd/user/wallpaperctl.conf
```

    WALLPAPER_DIR=/home/username/Pictures/wallpaper

### Set the Interval to When the Wallpaper Changes.

Create the timer file and then change the "OnCalendar" value to the desired interval. Refer to [ArchLinux: systemd/Timers](https://wiki.archlinux.org/index.php/Systemd/Timers#Realtime_timer) for further details.

1. Create the required directories.
```bash
$ mkdir  ~/.config/systemd ~/.config/systemd/user
```
2. Create the configuration file.
```bash
$ nano ~/.config/systemd/user/wallpaperctl.timer
```

```
[Unit]
Description=Wallpaperctl - Systemd GNOME wallpaper changer

[Timer]
OnCalendar=*:0/1
Persistent=true
Unit=wallpaperctl.service

[Install]
WantedBy=wallpaperctl.service
```

## Available picture-options

- none
- wallpaper
- centered
- scaled
- stretched
- zoom
- spanned

## External Links

 * https://wiki.archlinux.org/index.php/Systemd/User
 * https://wiki.archlinux.org/index.php/Systemd/Timers
 * https://major.io/2015/02/11/rotate-gnome-3s-wallpaper-systemd-user-units-timers/
 * https://stackoverflow.com/questions/10374520/gsettings-with-cron