path: root/README.org

#+TITLE: Cetus

Cetus is a wallpaper tool written in Go. It can set wallpapers from various
sources. Default behaviour is to set a random wallpaper.

* Defaults
| flag | var  | default                                   |
|------+------+-------------------------------------------|
| mode | mode | random (daily when random is unavailable) |
| src  | src  | random                                    |
** Astronomy Picture of the Day
| flag         | var        | default                             |
|--------------+------------+-------------------------------------|
| apod-api     | apodAPI    | https://api.nasa.gov/planetary/apod |
| apod-api-key | apodAPIKey | DEMO_KEY                            |
| mode         | mode       | daily                               |
** Bing Photo of the Day
| flag     | var     | default                                  |
|----------+---------+------------------------------------------|
| bpod-api | bpodAPI | https://www.bing.com/HPImageArchive.aspx |
| bpod-num | bpodNum | 16                                       |
** Unsplash Source
| flag         | var         | default                     |
|--------------+-------------+-----------------------------|
| unsplash-api | unsplashAPI | https://source.unsplash.com |
* Dependency
- [[https://feh.finalrewind.org/][feh]]
* Features
- Set Daily, Weekly or Random wallpaper

* Examples
** Daily wallpaper
*** from Astronomy Picture of the Day
#+BEGIN_SRC sh
cetus -src=apod -mode=daily
#+END_SRC
*** from Bing Photo of the Day
#+BEGIN_SRC sh
cetus -src=bpod -mode=daily
#+END_SRC
*** from Unsplash Source
#+BEGIN_SRC sh
cetus -src=unsplash -mode=daily
#+END_SRC
*** from any service (choosen randomly)
#+BEGIN_SRC sh
cetus -src=random -mode=daily

cetus -mode=daily # This is same as above
#+END_SRC
** Weekly wallpaper
*** from Unsplash Source
#+BEGIN_SRC shp
cetus -src=unsplash -mode=weekly
#+END_SRC
** Random wallpaper
*** from Bing Photo of the Day
#+BEGIN_SRC sh
cetus -src=bpod -bpod-num 16 -mode=random # select from last 16 images

cetus -src=bpod # This is same as above
#+END_SRC
*** from Unsplash Source
#+BEGIN_SRC sh
cetus -src=unsplash -mode=random

cetus -src=unsplash # This is same as above
#+END_SRC
*** from any service (choosen randomly)
#+BEGIN_SRC sh
cetus -src=random -mode=random

cetus # This is same as above
#+END_SRC