diff options
Diffstat (limited to '')
| -rw-r--r-- | redshift.1 | 139 | ||||
| -rw-r--r-- | redshift.conf.sample | 71 |
2 files changed, 153 insertions, 57 deletions
@@ -1,128 +1,154 @@ -.TH REDSHIFT: "1" "October 2011" "redshift" "User Commands" +.TH REDSHIFT 1 REDSHIFT-NG .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...] +\fR[\fB\-l\fR \fILAT\fB:\fILON\fR | \fB\-l\fR \fIPROVIDER\fB:\fIOPTIONS\fR] [\fB\-t\fR \fIDAY\fB:\fINIGHT\fR] [\fIOPTIONS\fR...] .SH DESCRIPTION .B redshift adjusts the color temperature of your screen according to your surroundings. This may help your eyes hurt less or reduce the risk for delayed sleep phase syndrome if you are working in front of the screen at night. - +.PP The color temperature is set according to the position of the sun. A different color temperature is set during night and daytime. During 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 4500K). During the day, the color temperature should match the light from outside, typically -around 5500K\-6500K (default is 5500K). The light has a higher +around 5500K\-6500K (default is 6500K). The light has a higher temperature on an overcast day. +.PP +In addition to the command-line tool \fBredshift\fR, the GUI +\fBredshift-gtk\fR provides an alternative interface that shows up as a +notification icon in the desktop environment. .SH OPTIONS .TP \fB\-h\fR -Display this help message +Display help message. .TP \fB\-v\fR -Verbose output +Enable verbose output. .TP \fB\-V\fR -Show program version +Show program version. .TP -\fB\-b\fR DAY:NIGHT -Screen brightness to apply (between 0.1 and 1.0) +\fB\-b\fR \fIDAY\fB:\fINIGHT\fR +Screen brightness to apply (between 0.1 and 1.0). .TP -\fB\-c\fR FILE -Load settings from specified configuration file +\fB\-c\fR \fIFILE\fR +Load settings from specified configuration file. .TP -\fB\-g\fR R:G:B -Additional gamma correction to apply +\fB\-g\fR \fIR\fB:\fIG\fB:\fIB\fR +Additional gamma correction to apply. .TP -\fB\-l\fR LAT:LON +\fB\-l\fR \fILAT\fB:\fILON\fR Your current location, in degrees, given as floating point numbers, towards north and east, with negative numbers representing south and west, respectively. .TP -\fB\-l\fR PROVIDER[:OPTIONS] +\fB\-l\fR \fIPROVIDER\fR[\fB:\fIOPTIONS\fR] Select provider for automatic location updates -(Use `-l list' to see available providers) +(Use \fB"\-l list"\fR to see available providers). .TP -\fB\-m\fR METHOD[:OPTIONS] +\fB\-m\fR \fIMETHOD\fR[\fB:\fIOPTIONS\fR] Method to use to set color temperature -(Use `-m list' to see available methods) +(Use \fB"\-m list"\fR to see available methods). .TP \fB\-o\fR -One shot mode (do not continuously adjust color temperature) +One-shot mode (do not continuously adjust color temperature). Use this with the +\fB\-P\fR option to clear the existing gamma ramps before applying the new color +temperature. .TP -\fB\-O\fR TEMP -One shot manual mode (set color temperature) +\fB\-O\fR \fITEMP\fR +One-shot manual mode (set color temperature). Use this with the \fB\-P\fR option +to clear the existing gamma ramps before applying the new color temperature. .TP \fB\-p\fR -Print mode (only print parameters and exit) +Print mode (only print parameters and exit). +.TP +\fB\-P\fR +Reset existing gamma ramps before applying new color effect. .TP \fB\-x\fR -Reset mode (remove adjustment from screen) +Reset mode (remove adjustment from screen). .TP \fB\-r\fR -Disable temperature transitions +Disable fading between color temperatures. .TP -\fB\-t\fR DAY:NIGHT -Color temperature to set at daytime/night +\fB\-t\fR \fIDAY\fB:\fINIGHT\fR +Color temperature to set at daytime/night. .PP The neutral temperature is 6500K. Using this value will not change the color temperature of the display. Setting the color temperature to a value higher than this results in more blue light, and setting a lower value will result in more red light. - +.PP Default temperature values: .IP -Daytime: 5500K, night: 3700K +Daytime: 6500K, night: 4500K .SH CONFIGURATION FILE -A configuration file with the name `redshift.conf' can optionally be -placed in `~/.config/'. The file has standard INI format. General -program options are placed under the `redshift' header, while options +A configuration file with the name \fIredshift.conf\fR can optionally be +placed in \fI~/.config/redshift/\fR (if the environment variable +XDG_CONFIG_HOME is undefined) or \fI${XDG_CONFIG_HOME}/redshift/\fR +(if XDG_CONFIG_HOME is defined). The file has standard INI format. General +program options are placed under the \fBredshift\fR header, while options for location providers and adjustment methods are placed under a header with the name of that provider or method. General options are: .TP -\fBtemp\-day\fR = integer +\fBtemp\-day\fR = \fIinteger\fR Daytime temperature .TP -\fBtemp\-night\fR = integer +\fBtemp\-night\fR = \fIinteger\fR Night temperature .TP -\fBtransition\fR = 0 or 1 -Disable or enable transitions +\fBfade\fR = \fI0 or 1\fR +Disable or enable fading between color temperatures when Redshift starts or +stops .TP -\fBbrightness\-day\fR = 0.1\-1.0 +\fBbrightness\-day\fR = \fI0.1\-1.0\fR Screen brightness at daytime .TP -\fBbrightness\-night\fR = 0.1\-1.0 +\fBbrightness\-night\fR = \fI0.1\-1.0\fR Screen brightness at night .TP -\fBelevation-high\fR = decimal -The solar elevation for the transition to daytime +\fBelevation-high\fR = \fIdecimal\fR +The solar elevation in degrees for the transition to daytime .TP -\fBelevation-low\fR = decimal -The solar elevation for the transition to night +\fBelevation-low\fR = \fIdecimal\fR +The solar elevation in degrees for the transition to night .TP -\fBgamma\fR = R:G:B +\fBdawn-time\fR = \fIHH\fB:\fIMM\fR[\fB\-\fIHH\fB:\fIMM\fR] +The custom time interval for the transition from night to day in the morning. +When specified, the solar elevation will not be used to determine the current +daytime/night period. If this option is set, dusk-time must also be specified. +.TP +\fBdusk-time\fR = \fIHH\fB:\fIMM\fR[\fB\-\fIHH\fB:\fIMM\fR] +The custom time interval for the transition from day to night in the evening. +When specified, the solar elevation will not be used to determine the current +daytime/night period. If this option is set, dawn-time must also be specified. +.TP +\fBgamma\fR = \fIR\fB:\fIG\fB:\fIB\fR Gamma adjustment to apply (day and night) .TP -\fBgamma-day\fR = R:G:B +\fBgamma-day\fR = \fIR\fB:\fIG\fB:\fIB\fR Gamma adjustment to apply at daytime .TP -\fBgamma-night\fR = R:G:B +\fBgamma-night\fR = \fIR\fB:\fIG\fB:\fIB\fR Gamma adjustment to apply at night .TP -\fBadjustment\-method\fR = name +\fBpreserve-gamma\fR = \fI0 or 1\fR +Reset existing gamma ramps before applying new color effect. (On by default) +.TP +\fBadjustment\-method\fR = \fIname\fR Select adjustment method. Options for the adjustment method can be given under the configuration file heading of the same name. .TP -\fBlocation\-provider\fR = name +\fBlocation\-provider\fR = \fIname\fR Select location provider. Options for the location provider can be given under the configuration file heading of the same name. .PP @@ -149,15 +175,15 @@ 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 \fI~/.config/redshift/hooks\fR 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 +more details about the event. The event \fBperiod-changed\fR is indicated +when the period changes (\fBnight\fR, \fBdaytime\fR, \fBtransition\fR). 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'. - +\fBnone\fR. Any dotfiles in the folder are skipped. +.PP A simple script to handle these events can be written like this: .IP .nf @@ -175,9 +201,8 @@ Both .B redshift and this manual page are released under the GNU General Public License, version 3. -.SH BUGS -Please report bugs to <https://github.com/jonls/redshift/issues> .SH KNOWN ISSUES -Redshift won't affect the color of your cursor when your graphics driver +.B redshift +will not affect the color of your cursor when your graphics driver is configured to use hardware cursors. Some graphics drivers have an -option to disable hardware cursors in xorg.conf. +option to disable hardware cursors. diff --git a/redshift.conf.sample b/redshift.conf.sample new file mode 100644 index 0000000..2f237cb --- /dev/null +++ b/redshift.conf.sample @@ -0,0 +1,71 @@ +; Global settings for redshift +[redshift] +; Set the day and night screen temperatures +; Defaults: 6500 / 4500 +temp-day=5700 +temp-night=3500 + +; Disable the smooth fade between temperatures when Redshift starts and stops. +; 0 will cause an immediate change between screen temperatures. +; 1 will gradually apply the new screen temperature over a couple of seconds. +fade=1 + +; Solar elevation thresholds. +; By default, Redshift will use the current elevation of the sun to determine +; whether it is daytime, night or in transition (dawn/dusk). When the sun is +; above the degrees specified with elevation-high it is considered daytime and +; below elevation-low it is considered night. +;elevation-high=3 +;elevation-low=-6 + +; Custom dawn/dusk intervals. +; Instead of using the solar elevation, the time intervals of dawn and dusk +; can be specified manually. The times must be specified as HH:MM in 24-hour +; format. +;dawn-time=6:00-7:45 +;dusk-time=18:35-20:15 + +; 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: '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 only screen 0. +; Note that the numbering starts from 0, so this is actually the first screen. +; If this option is not specified, Redshift will try to adjust _all_ screens. +[randr] +screen=0 |