aboutsummaryrefslogtreecommitdiffstats
path: root/redshift
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--redshift.112
-rw-r--r--redshift.conf.sample56
2 files changed, 62 insertions, 6 deletions
diff --git a/redshift.1 b/redshift.1
index c9667aa..9064eea 100644
--- a/redshift.1
+++ b/redshift.1
@@ -1,6 +1,6 @@
-.TH REDSHIFT: "1" "October 2011" "redshift" "User Commands"
+.TH REDSHIFT 1 2011-10-01 redshift
.SH NAME
-redshift \- Set color temperature of display according to time of day.
+redshift \- set color temperature of display according to time of day
.SH SYNOPSIS
.B redshift
\fI[\-l LAT:LON | \-l PROVIDER:OPTIONS] [\-t DAY:NIGHT] \fR[\fIOPTIONS\fR...]
@@ -17,7 +17,7 @@ twilight and early morning, the color temperature transitions smoothly
from night to daytime temperature to allow your eyes to slowly
adapt over a period of about an hour. At night the color temperature
should be set to match the lamps in your room. This is typically a low
-temperature at around 3000K\-4000K (default is 3700K). During the day,
+temperature at around 3000K\-4000K (default is 3500K). During the day,
the color temperature should match the light from outside, typically
around 5500K\-6500K (default is 5500K). The light has a higher
temperature on an overcast day.
@@ -80,7 +80,7 @@ more red light.
Default temperature values:
.IP
-Daytime: 5500K, night: 3700K
+Daytime: 5500K, night: 3500K
.SH CONFIGURATION FILE
A configuration file with the name `redshift.conf' can optionally be
placed in `~/.config/'. The file has standard INI format. General
@@ -149,14 +149,14 @@ lat=55.7
lon=12.6
.fi
.SH HOOKS
-Executable files (e.g. scripts) placed in `~/.config/redshift/hooks'
+Executables (e.g. scripts) placed in folder `~/.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'.
+`none'. Any dotfiles in the folder are skipped.
A simple script to handle these events can be written like this:
.IP
diff --git a/redshift.conf.sample b/redshift.conf.sample
new file mode 100644
index 0000000..633d0b3
--- /dev/null
+++ b/redshift.conf.sample
@@ -0,0 +1,56 @@
+; Global settings for redshift
+[redshift]
+; Set the day and night screen temperatures
+temp-day=5700
+temp-night=3500
+
+; Enable/Disable a smooth transition between day and night
+; 0 will cause a direct change from day to night screen temperature.
+; 1 will gradually increase or decrease the screen temperature.
+transition=1
+
+; Set the screen brightness. Default is 1.0.
+;brightness=0.9
+; It is also possible to use different settings for day and night
+; since version 1.8.
+;brightness-day=0.7
+;brightness-night=0.4
+; Set the screen gamma (for all colors, or each color channel
+; individually)
+gamma=0.8
+;gamma=0.8:0.7:0.8
+; This can also be set individually for day and night since
+; version 1.10.
+;gamma-day=0.8:0.7:0.8
+;gamma-night=0.6
+
+; Set the location-provider: 'geoclue', 'geoclue2', 'manual'
+; type 'redshift -l list' to see possible values.
+; The location provider settings are in a different section.
+location-provider=manual
+
+; Set the adjustment-method: 'randr', 'vidmode'
+; type 'redshift -m list' to see all possible values.
+; 'randr' is the preferred method, 'vidmode' is an older API.
+; but works in some cases when 'randr' does not.
+; The adjustment method settings are in a different section.
+adjustment-method=randr
+
+; Configuration of the location-provider:
+; type 'redshift -l PROVIDER:help' to see the settings.
+; ex: 'redshift -l manual:help'
+; Keep in mind that longitudes west of Greenwich (e.g. the Americas)
+; are negative numbers.
+[manual]
+lat=48.1
+lon=11.6
+
+; Configuration of the adjustment-method
+; type 'redshift -m METHOD:help' to see the settings.
+; ex: 'redshift -m randr:help'
+; In this example, randr is configured to adjust screen 1.
+; Note that the numbering starts from 0, so this is actually the
+; second screen. If this option is not specified, Redshift will try
+; to adjust _all_ screens.
+[randr]
+screen=1