diff options
| author | Jon Lund Steffensen <jonlst@gmail.com> | 2014-12-28 15:19:04 -0500 |
|---|---|---|
| committer | Jon Lund Steffensen <jonlst@gmail.com> | 2014-12-28 15:20:17 -0500 |
| commit | 75ad3de1fea95244035271f09ade1c98cb21a912 (patch) | |
| tree | 743b6fbc25c0974eab6ae691f9e06a2c926b13cb /redshift.1 | |
| parent | redshift: Add hooks for user actions on period switch (diff) | |
| download | redshift-ng-75ad3de1fea95244035271f09ade1c98cb21a912.tar.gz redshift-ng-75ad3de1fea95244035271f09ade1c98cb21a912.tar.bz2 redshift-ng-75ad3de1fea95244035271f09ade1c98cb21a912.tar.xz | |
redshift.1: Add description of hooks in man page
Diffstat (limited to 'redshift.1')
| -rw-r--r-- | redshift.1 | 19 |
1 files changed, 19 insertions, 0 deletions
@@ -136,6 +136,25 @@ location\-provider=manual lat=55.7 lon=12.6 .fi +.SH HOOKS +Executable files (e.g. scripts) placed in `~/.config/redshift/hooks' +will be run when a certain event happens. The first parameter to the +script indicates the event and further parameters may indicate +more details about the event. The event `period-changed' is indicated +when the period changes (`night', `daytime', `transition'). The second +parameter is the old period and the third is the new period. The event +is also signaled when Redshift starts up with the old period set to +`none'. + +A simple script to handle these events can be written like this: +.IP +.nf +#!/bin/sh +case \fB$1\fR in + \fBperiod-changed\fR) + exec notify-send "Redshift" "Period changed to \fB$3\fR" +esac +.fi .SH AUTHOR .B redshift was written by Jon Lund Steffensen <jonlst@gmail.com>. |