From 75ad3de1fea95244035271f09ade1c98cb21a912 Mon Sep 17 00:00:00 2001 From: Jon Lund Steffensen Date: Sun, 28 Dec 2014 15:19:04 -0500 Subject: redshift.1: Add description of hooks in man page --- redshift.1 | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'redshift.1') diff --git a/redshift.1 b/redshift.1 index db51c87..9443d26 100644 --- a/redshift.1 +++ b/redshift.1 @@ -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 . -- cgit v1.2.3-70-g09d2