summary refs log blame commit diff stats
path: root/README.org
blob: dd5e7c0b610150dd7b4e50c4f167529dbbe4d85b (plain) (tree)
ame.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
#+HTML_HEAD: <link rel="stylesheet" href="../static/style.css">
#+HTML_HEAD: <link rel="icon" href="../static/cetus/favicon.png" type="image/png">
#+EXPORT_FILE_NAME: index
#+TITLE: Cetus

Cetus is a simple wallpaper management tool written in Go. It supports multiple
sources for fetching the background. Currently it suports NASA Astronomy Picture
of the Day & Bing Photo of the Day.

| Project Home    | [[https://andinus.nand.sh/cetus/][Cetus]]           |
| Source Code     | [[https://tildegit.org/andinus/cetus][Andinus / Cetus]] |
| GitHub (Mirror) | [[https://github.com/andinus/cetus][Cetus - GitHub]]  |

| Demo Video                 |
|----------------------------|
| [[https://diode.zone/videos/watch/11af8886-7b75-400b-9c4d-05191bd55059][Cetus v0.6.0]]               |
| [[https://diode.zone/videos/watch/6d01245d-a6d0-4958-881d-f6df609d65ab][Cetus v0.6.0 Demo on macOS]] |

*Dependency*: /feh/ (optional), /libnotify/ (optional)

It supports /GNOME/, /Unity/, /LXDE/, /Pantheon/ & WM/DE similar to /i3wm/ (including
i3wm).

*Tested on*:
- OpenBSD 6.6 with i3wm (with /unveil/)
- Lubuntu 18.04 with LXDE
- macOS Catalina 10.15.3

* Examples
Run =cetus help= to get the usage printed & =cetus <command> <service> -help= to get
the flags for that particular service.

#+BEGIN_SRC sh
# set today's image as background
cetus set <service>  # <service>: apod, bpod

# set a random apod image as background
cetus set apod -random

# send a desktop notification
cetus <command> <service> -notify # <command>: set, fetch

# don't set background but fetch the information
cetus fetch <service>

# print details in terminal
cetus <command> <service> -print

# print and notify
cetus <command> <service> -print -notify
#+END_SRC

* Installation
** Pre-built binaries
Pre-built binaries are available for OpenBSD, FreeBSD, NetBSD, DragonFly BSD,
Linux & macOS.

If you don't understand what this command does then don't run it. It doesn't
download the binary, it will just print the steps to install cetus & you have to
run those commands manually.
*** v0.6.4
#+BEGIN_SRC sh
curl -s https://tildegit.org/andinus/cetus/raw/tag/v0.6.4/scripts/install.sh | sh
#+END_SRC
*** v0.6.0
*Warning*: Don't use random flag on BPOD, it has been disabled in v0.6.1 but
v0.6.0 will cause issues if random flag is used with BPOD.

=cetus set bpod -random # don't do this=

#+BEGIN_SRC sh
curl -s https://tildegit.org/andinus/cetus/raw/tag/v0.6.0/scripts/install.sh | sh
#+END_SRC