wp

a wallpaper switcher
Log | Files | Refs | README | LICENSE

README (972B)


      1 wp -- a wallpaper switcher
      2 ==========================
      3 
      4 `wp` uses `feh` to display a wallpaper on your desktop.
      5 
      6 
      7 PLUGINS
      8 -------
      9 
     10 `wp` itself does nothing without a plugin which provides an image.
     11 
     12 A plugin is an executable which echoes an image's path to stdout.
     13 
     14 The `default` plugin just grabs a random file from `$HOME/.wp/*jpg`.
     15 
     16 The `pexels` plugin downloads an image from pexels.com and saves it to a
     17 temporary file. Don't forget to edit the configuration in the plugin to fit
     18 your needs!
     19 
     20 Requirements are mentioned in a comment in each plugin's source code.
     21 
     22 Note that `feh` can also show remote files if it is linked against `libcurl`.
     23 
     24 You are welcome to bring your own plugins!
     25 
     26 
     27 EXAMPLES
     28 --------
     29 
     30 $ wp default  # use wp's `default` plugin
     31 $ wp          # shorthand for the `default` plugin
     32 $ wp pexels   # use wp's `pexels` plugin
     33 
     34 You may want to write this to your `.xinitrc`:
     35 wp default &
     36 
     37 Or in your crontab:
     38 30    *  *   *   *     DISPLAY=:0 wp default