diff options
| -rw-r--r-- | README | 396 | ||||
| -rw-r--r-- | TODO | 11 | ||||
| -rw-r--r-- | redshift.1 | 1318 | ||||
| -rw-r--r-- | redshift.conf.sample | 71 | ||||
| -rw-r--r-- | src/common.h | 198 | ||||
| -rw-r--r-- | src/config-ini.c | 80 | ||||
| -rw-r--r-- | src/config.c | 38 | ||||
| -rw-r--r-- | src/gamma-coopgamma.c | 10 | ||||
| -rw-r--r-- | src/gamma-drm.c | 14 | ||||
| -rw-r--r-- | src/gamma-randr.c | 6 | ||||
| -rw-r--r-- | src/gamma-w32gdi.c | 2 | ||||
| -rw-r--r-- | src/hooks.c | 2 | ||||
| -rw-r--r-- | src/redshift.c | 64 | ||||
| -rw-r--r-- | src/signals.c | 90 |
14 files changed, 1931 insertions, 369 deletions
@@ -8,14 +8,10 @@ NAME redshift - Automatically adjust display colour temperature according the Sun SYNOPSIS - redshift [-b brightness] [-c file] [-D | +D] [-g gamma] + redshift [-b brightness] [-c config-file] [-D | +D] [-g gamma] [-l latitude:longitude | -l provider[:options]] [-m method[:options]] [-P | +P] [-r | +r] [-dv] - [-O temperature | -o | -p | -t temperature | -x] - - redshift -h - - redshift -V + [-O temperature | -o | -p | -t temperature | -x] | -h | -V DESCRIPTION redshift adjusts the colour temperature of your screen according to your @@ -34,7 +30,7 @@ DESCRIPTION outside. Typically around 5500K–6500K (default is 6500K). The light has a lower temperature on an overcast day. - In addition to the command-line tool redshift, the GUI redshift-gtk + In addition to the command-line tool redshift, the GUI redshift-gtk(1) provides an alternative interface that shows up as a notification icon in the desktop environment. @@ -45,17 +41,22 @@ OPTIONS Synonym for "-b brightness:brightness". -b day:night - Screen brightness to apply at daytime and at nighttime. - (Default: 1:1) + Monitor whitepoint brightness to apply at daytime and at + nighttime. (Default: 1:1) The values most be between 0.1 and 1.0. day or night may be omitted, to keep unmodified, however at least one must be specified. - -c file + -c config-file Load settings from specified configuration file. + /dev/null can be used to tell redshift not to load the + configuration file. + + If "-", the standard input will be used. + -D Start in enabled state. (Default) @@ -77,8 +78,12 @@ OPTIONS -g day:night Synonym for "-g day:day:day:night:night:night". - -g r:g:b - Synonym for "-g r:g:b:r:g:b". + However, if day is omitted, it is a synonym for + "-g :night:night:night", or if night is omitted, it is a + synonym for "-g day:day:day:". + + -g red:green:blue + Synonym for "-g red:green:blue:red:green:blue". -g day-r:day-g:day-b:night-r:night-g:night-b Additional gamma correction to apply at daytime and @@ -160,6 +165,12 @@ OPTIONS Values must be at least 1000 and integral. + The value 6500 is equivalent to no colour temperature + adjustment. + + Default mode, but default values may change between + versions. + -V Show program implementation and verison. @@ -201,6 +212,63 @@ ASYNCHRONOUS EVENTS Disable the effects of redshift, or if already disabled, reenable them. + SIGUSR2 with value 0 + Normally signals may be processed out of order, however + when this signal is received, SIGUSR2 will be blocked until + all pending SIGUSR2 signals has been processed, creating + signal processing order barrier. This is useful when mixing + SIGUSR2 value 3 (reloading configuration file) with other + configuration changing SIGUSR2 values. + + SIGUSR2 with value 1 + Disable the effects of redshift. + + SIGUSR2 with value 2 + Enable the effects of redshift. + + SIGUSR2 with value 3 + Reload the configuration file. + + Settings from the command line will be overriden. + + SIGUSR2 with value 4 + Execute into the currently installed version of the program. + + Only available on Linux. + + SIGUSR2 with value 5 + Set the "fade" setting to off. + + SIGUSR2 with value 6 + Set the "fade" setting to on. + + SIGUSR2 with value 7 + Set the "preserve-gamma" setting to off. + + SIGUSR2 with value 8 + Set the "preserve-gamma" setting to on. + + SIGUSR2 with value 9 + Exit the process without removing the its effects. + If the used adjustment method does not support leaving + the effects, they will be removed. + + SIGUSR2 with value 10 + Do not terminate redshift the standard output and + standard error are closed. + + SIGUSR2 with value 11 + Enable verbose mode. (The -v option will be treated as + specified.) + + SIGUSR2 with value 12 + Disable verbose mode. + + Ignore if started in verbose mode (-v option). + + SIGUSR2 with other values or no value + Ignored. + STDOUT The standard output is used to print state information and requested help information. The output is subject to localisation, and the @@ -210,7 +278,7 @@ STDOUT it may change between versions and applications should not expect any particular precision to be used. - When "-m list" is specified the available gamma ramp adjustment methods + When "-m list" is specified, the available gamma ramp adjustment methods are printed with the header "Available adjustment methods:\n" followed by the list in the format @@ -219,7 +287,7 @@ STDOUT The list is terminated by an empty line. Additional information for human users is printed after the empty line. - When "-l list" is specified the available location providers are + When "-l list" is specified, the available location providers are printed with the header "Available location providers:\n" followed by the list in the format @@ -250,6 +318,11 @@ STDOUT If "-v" is specified and the colour settings depend on the clock time, the time schedule is printed to the standard output, with the header + "Schedule:\n" and the footer "(End of schedule)\n", in the format + + "%s%f%% day at %02u:%02u:%02u\n", <arbitrary whitespace>, + <dayness level (0–100)>, <start hour (0–23)>, + <start minute (0–59)>, <start second (0–59)>. These lines may be printed, if "-v" is specified, if redshift is configured. @@ -289,7 +362,7 @@ STDOUT where <period> is "None", "Daytime", or "Night", or in the format - "Period: Transition (%f%% day)", <dayness level>. + "Period: Transition (%f%% day)\n", <dayness level> * 100. <dayness level> is exclusively between 0 (night) and 1 (daytime). @@ -303,15 +376,25 @@ STDOUT "Color temperature: %luK\n", <colour temperature>; - "Brightness: %f\n", <whitepoint brightness level (0-1)>; + "Brightness: %f\n", <whitepoint brightness level (0–1)>; "Gamma: %f, %f, %f\n", <red gamma>, <green gamma>, <blue gamma>. - If "-v" is specified, and if running and continual mode, the program + If "-v" is specified, and if running in continual mode, the program will print "Status: Enabled\n" if starting in or when entering enabled mode, and "Status: Disabled\n" if starting in or when entering disabled mode. + If "-v" is specified, and if running in continual mode, the program + will print "Fade: Enabled\n" or "Fade: Disabled\n" to indicate whether + the "fade" setting is enabled, when the program starts and when the + setting is modified. + + If "-v" is specified, and if running in continual mode, the program + will print "Preserve gamma: Enabled\n" or "Preserve gamma: Disabled\n" + to indicate whether the "preserve-gamma" setting is enabled, when the + program starts and when the setting is modified. + If the "dummy" gamma ramp adjustment method is used, any time a colour change is applied (including each fade step), the colour temperature is output, for debugging purposes (brightness and gamma are not printed), @@ -326,9 +409,239 @@ OUTPUT FILES None. FILES - TODO + Unless the -c option is used, redshift will look for its configuration + file, and if found, load it. When searching for the configuration file, + redshift will load the first found file. It will primary look for + "redshift-ng/redshift.conf", secondarily for "redshift/redshift.conf", + and tertiarily for "redshift.conf", in each directory it searches. It + will search the following directories in order: the directory set in + the environment variable XDG_CONFIG_HOME, the directory set in the + environment variable localappdata (Windows only), the ".config" + directory inside directory set in the environment variable HOME, and + the ".config" directory inside the user's home directory. For the two + latter, it will quaternarily look for the file ".redshift.conf". If not + found, it will also look for the file in each directory listed in the + environment variable XDG_CONFIG_DIRS (delimited by colon (:) on + Unix-like systems and by semicolon (;) on Windows), however it try each + directory before moving on to then next filename option. Lastly, on + Unix-like systems, it will look for the file in /etc. This means that + the preferred location for the configuration file is + ${XDG_CONFIG_HOME}/redshift-ng/redshift.conf. + + redshift will use the same pattern to find the hook directory, and the + tested subdirectories for each search directory are "/redshift-ng/hooks" + and secondarily "/redshift/hooks". All executable files, in the found + directory, that are neither prefixed with a period (.) or suffixed with + a tilde (~) will be used as hooks scripts, and will be executed in + arbitrary order. Subdirectories are not search for executable files. + This means that the preferred location for the hook scripts is (directly + inside) ${XDG_CONFIG_HOME}/redshift-ng/hooks/. EXTENDED DESCRIPTION + Configuration file + The configuration file uses the standard INI format. General program + options are placed under the redshift header ("[redshift]"), while + options for location providers are adjustment methods are placed under + a hader with the name of that proivder or method. + + General options are: + + temp = temperature + temperature = temperature + Set temperature for daytime and nighttime. The value shall be + format in the same way as with the -O and -t options. + + temp-day = integer + temperature-day = integer + Set temperature for daytime. That value shall be an integer no + less than 1000 (Kelvin). + + temp-night = integer + temperature-night = integer + Set temperature for nighttime. That value shall be an integer + no less than 1000 (Kelvin). + + brightness = brightness + Set whitepoint brightness for daytime and nighttime. The value + shall be format in the same way as with the -b option. + + brightness-day = 0.1–1.0 + Set whitepoint brightness for daytime. That value shall be an + within [0.1, 1.0]. + + brightness-night = 0.1–1.0 + Set whitepoint brightness for nighttime. That value shall be an + within [0.1, 1.0]. + + gamma = gamma + Set gamma correction for daytime and nighttime. The value shall + be format in the same way as with the -g option. + + gamma-day = 0.1–10.0 + gamma-day = red:green:blue + Set gamma correction for daytime. Values must be within [0.1, + 10.0], and are applied to each colour channel individually, + however if only one value is specified it is applied to all + each channels. + + gamma-night = 0.1–10.0 + gamma-night = red:green:blue + Set gamma correction for nighttime. Values must be within [0.1, + 10.0], and are applied to each colour channel individually, + however if only one value is specified it is applied to all + each channels. + + fade = 0 or 1 + Disable (if 0) or enable (if 1) fading between colour settings + with large differences. + + The -r and +r options can be used to override this setting. + + preserve-gamma = 0 or 1 + If 1, preapplied colour calibrations (all applied effects are + assumed to be colour calibrations) will be preserved, if 0, + colour calibrations will be reset while redshift is running. + + The -P and +P options can be used to override this setting. + + Note that if 0, colour calibrations will be reset even when + redshift is running but is disabled. This is necessary to + support the -o and -O options. + + This setting is ignored when coopgamma is used as coopgamma + allows multiple programs to modify the gamma ramps at the + same time. + + start-disabled = 0 or 1 + Start redshift in disabled (if 1) or enabled (if 0) state. + + The -D and +D options can be used to override this setting. + + elevation-high = decimal + The lowest solar elevation, in degrees, during daytime. + + elevation-low = decimal + The highest solar elevation, in degrees, during nighttime. + + dawn-time = HH:MM[:SS][-HH:MM[:SS]] + dusk-time = HH:MM[:SS][-HH:MM[:SS]] + Custom time interval for the transition from night to day + (dawn-time) and for the transition from day to night + (dusk-time). + + When specified, both settings must be specified and the + solar elevation will not be used to determine the current + daytime/nighttime period, nor will a location provider + used. + + The left-hand hour must be within [0, 23], but the right-hand + hour may be within [0, 47], the timespan must not be greater + than 24 hours. The minutes and seconds must be within [0, 59], + and the default value for the seconds is 0. + + adjustment-method = name + Select adjustment method. Options for the adjustment method can + be given under the configuration file heading of the same name. + + Not used if the -p option is specified. + + location-provider = name + Select location provider. Options for the location provider can + be given under the configuration file heading of the same name. + + Not used if dawn-time and dusk-time are used or if the colours + settings are specified to be the same during the day and the + night. + + Options for the location provider "manual" are: + + lat = decimal + The GPS latitude of the user's geographical location. + Shall be specified in degrees and formatted a single + real number, rather than split into integer degrees, + minutes and seconds. Positive values used for the + northern hemisphere and negative values are ued for + the southern hemisphere. + + lon = decimal + The GPS longitude of the user's geographical location. + Shall be specified in degrees and formatted a single + real number, rather than split into integer degrees, + minutes and seconds. Positive values used for the + eastern hemisphere and negative values are ued for + the western hemisphere. + + There are no options for the location providers "geoclue2" (may be + available on Unix-like systems) and "corelocation" (available on + Mac OS X). + + Options for the location provider "randr" (preferred method for X) are: + + screen = integer + X screen to apply adjustments to. Default is determined + by the environment variable DISPLAY. + + crtc = integer list or all + Comma-separated (,) list of CRTC indices for monitors to + apply adjustments to. All available CRTCs are used if the + list is empty or if the setting is omitted. + + "all" may be specified as a synonym for an empty list. + + The index of the first CRTC is 0. + + Options for the location provider "vidmode" (fallback method for X) are: + + screen = integer + X screen to apply adjustments to. Default is determined + by the environment variable DISPLAY. + + Options for the location provider "drm" (method for Linux without + display server) are: + + card = integer + Index of graphics card to apply adjustments to. + + crtc = integer or all + Index of CRTC for monitor to apply adjustments to. + + "all" may be specified to apply adjustments to each available + CRTC on the graphics card. + + The index of the first CRTC is 0. + + There are no options for the adjustment methods "wingdi" (available + on Windows), "quartz" (available on Mac OS X), and "dummy" (used for + debugging, does not apply any colour effects). + + Hooks + Executable files (that are not dotfiles or tilde files) in the hook + directory (see the FILES section), are executed on certain events. + The file inherit the redshift process standard input and standard + error, however the standard output is redirected to the standard error. + + Each file is executed with at least one argument. This first argument + indicate what event has taked place. Additional arguments may be + provided for additional event data. + + redshift will be the parent process of the executed script. + + Currently available events are: + + period-changed + This indicate that the period of the day has changed (and at + start of continual mode). The script will be provided two + additional arguments (the second argument and the third + argument). The second argument will the previous period, and + the third argument will be the new period. The argument values + will be either of "night", "daytime", "transition" (transition + in either direction between night and daytime), or "none" (not + previously or no longer calculated). "none" appears as the + previous period at start up and can also appear when the when + redshift is reconfigured if the colour settings no longer + depending on the period of the day or has started depending + on the period of the day. + Gamma ramps redshift applies a redness effect to the graphical display. The intensity of the redness can be customised and scheduled to only be @@ -338,7 +651,7 @@ EXTENDED DESCRIPTION gamma ramps or gamma correction ramps, to apply this effect. Colour temperature - The redness effect applies by redshift is modelled after black-body + The redness effect applied by redshift is modelled after black-body radiation, specifically with a 10 degree observer. Although black-body radiation starts at 0, redshift's model start at the conventional 1000K (1000 Kelvin). For this reason, no colour temperature below 1000K can be @@ -366,7 +679,30 @@ EXIT STATUS Default. EXAMPLES - TODO + Example for the superelliptical roundabout in Stockholm, Sweden: + + redshift -l 59.333:18.065 -t 5700:3600 -b 1:0.8 + + Example configuration file equivalent to above command: + + [redshift] + temperature-day=5700 + temperature-night=3600 + brightness-day=1 + brightness-night=0.8 + location-provider=manual + + [manual] + lat=59.333 + lon=18.065 + + Sample hook script: + + #!/bin/sh + case "$1" in + period-changed) + notify-send "redshift-ng" "Period changed from $2 to $3";; + esac KNOWN ISSUES No or incorrect effect on cursor @@ -381,11 +717,11 @@ KNOWN ISSUES Limited hardware support Low-end hardware, especially embedded devices, often lack colour - correction features redshift abuse to apply it's affect. redshift is not + correction features redshift abuse to apply its effect. redshift is not always able to tell if support is missing. Limited software support - redshift does not yet support Waylaid. If your environment contains the + redshift does not yet support Wayland. If your environment contains the variable WAYLAND_DISPLAY, you are using a Wayland compositor and cannot currently expect redshift to work. Even with Wayland support, it would be up to each individual Wayland compositor to opt in to support @@ -412,12 +748,13 @@ KNOWN ISSUES there is no standardised why have multiple applications applying different effects without overriding each other. This can cause continuous flicker if multiple instance are running or effects - temporarily disappearing. By default, redshift uses coopgammad, which is - a daemon applications can opt to use instead of directly setting the - gamma ramps themselves, coopgammad can then calculate the result of all - of the effects and apply them as one, allowing the user to use multiple - applications that apply different effects. However coopgammad still has - to compete with applications that does not use it. + temporarily disappearing. By default, redshift uses coopgammad(1), which + is a daemon applications can opt to use instead of directly setting the + gamma ramps themselves, coopgammad(1) can then calculate the result of + all of the effects and apply them as one, allowing the user to use + multiple applications that apply different effects. However + coopgammad(1) still has to compete with applications that does not use + it. DRM and display servers Using the DRM gamma ramp adjustment method can block starting or @@ -437,6 +774,9 @@ RATIONALE To prevent colour distortion and making the screen too white, brightness level above 1.0 are forbidden. + Gamma correction is preserved for backwards compatibility and is + deprecated (gamma parameters in particular). + NOTES "Colour temperature", or just "temperature", is actually short for "correlated colour temperature". (Your monitor is not a black-body @@ -30,7 +30,6 @@ https://github.com/jonls/redshift/issues/218 multiple redshift-gtk and redshift https://github.com/jonls/redshift/issues/219 Linux Mint Xfce 17.1: redshift-gtk does not show in panel https://github.com/jonls/redshift/issues/222 redshift fails to run on startup or launch from script https://github.com/jonls/redshift/issues/226 Redshift exits if no provider is found (no internet connection) -https://github.com/jonls/redshift/issues/232 Windows 7 - redshift.exe doesn't close https://github.com/jonls/redshift/issues/235 The print option does not tell if redshift is active or not. https://github.com/jonls/redshift/issues/242 Is it possible to redshift 2 out of 3 CRTCs? https://github.com/jonls/redshift/issues/248 changing temperature in manual mode not working? @@ -43,10 +42,8 @@ https://github.com/jonls/redshift/issues/286 Tray icon and checkmarks missing https://github.com/jonls/redshift/issues/302 Redshift closes when connecting a monitor https://github.com/jonls/redshift/issues/303 No GLSL Back-end https://github.com/jonls/redshift/issues/306 Redshift does not adjust the display if a negative longitude and a "-t DAY:NIGHT" argument are given. -https://github.com/jonls/redshift/issues/310 Option to preserve gamma corrections is not properly documented https://github.com/jonls/redshift/issues/316 kde + 32gb ram + haswell igpu = flicker https://github.com/jonls/redshift/issues/318 Unable to connect to GeoClue. Unable to get location from provider. -https://github.com/jonls/redshift/issues/323 Using DRM, console goes black after redshift exits https://github.com/jonls/redshift/issues/324 Add settings window and open it on redshift-gtk first start https://github.com/jonls/redshift/issues/333 Redshift fails on startup https://github.com/jonls/redshift/issues/336 redshift-gtk won't open; redshift won't adjust color temperature throughout the day @@ -108,21 +105,16 @@ https://github.com/jonls/redshift/issues/758 failed (Result: start-limit-hit) https://github.com/jonls/redshift/issues/759 Enabling monitor requires loading its gamma ramps, but Redshift resets them https://github.com/jonls/redshift/issues/764 Memory Leak detected on Linux, both with version 1.10 and latest version 1.12 https://github.com/jonls/redshift/issues/767 per output settings -https://github.com/jonls/redshift/issues/771 Remove before midnight restriction on custom dusk-time https://github.com/jonls/redshift/issues/773 [Feature Request] https://github.com/jonls/redshift/issues/774 Changing brightness of a running instance -https://github.com/jonls/redshift/issues/779 Redshift Refuses to Change From Default https://github.com/jonls/redshift/issues/783 Allow icon click to toggle redshift when AppIndicator3 is used https://github.com/jonls/redshift/issues/784 Redshift-gtk icon is blank https://github.com/jonls/redshift/issues/785 request: a cheap way to check if redshift is active https://github.com/jonls/redshift/issues/789 Redshift uses the deleted file /memfd:pulseaudio https://github.com/jonls/redshift/issues/792 [Feature Request] Additional tray menu options for custom colors and suspend/disable -https://github.com/jonls/redshift/issues/794 Redshift Behaves like a Virus. -https://github.com/jonls/redshift/issues/795 explain default options and provide more details https://github.com/jonls/redshift/issues/804 [Question] win 10 autostart server https://github.com/jonls/redshift/issues/805 On a wired connection geoclue is unable to determine current location https://github.com/jonls/redshift/issues/809 Allow to run without geoservices -https://github.com/jonls/redshift/issues/810 With manually specified lat/long redshift toggles between day and night https://github.com/jonls/redshift/issues/813 Start Redshift on ubuntu HIRSUTE https://github.com/jonls/redshift/issues/815 Robustness improvement suggestion https://github.com/jonls/redshift/issues/816 Allow forcing of night mode or night color temperature @@ -142,7 +134,6 @@ https://github.com/jonls/redshift/issues/853 Add a status icon that signals that https://github.com/jonls/redshift/issues/862 (redshift-gtk:6420): Gdk-CRITICAL https://github.com/jonls/redshift/issues/863 randr value -1 error https://github.com/jonls/redshift/issues/868 [Feature Request] Separate Monitor Control -https://github.com/jonls/redshift/issues/869 clarify documentation/configuration/sample to configure times better? https://github.com/jonls/redshift/issues/870 redshift-gtk doesn't read conf files at log-in https://github.com/jonls/redshift/issues/880 "Unable to set gamma ramps. Temperature adjustment failed." in win10 https://github.com/jonls/redshift/issues/887 Error!!!, no more methods to try @@ -175,3 +166,5 @@ po/sv.po: NBSP before units (after ° which should also be added) Optionally use METAR data adjust day-time colour temperature according the cloudiness read the monitor's chromas to determine it's colour space and correct the RGB multipliers according Use coordinates (zone1970.tab, be aware that the coordinates are store in degress and minutes, and sometimes also seconds, not degrees with decimals), for the user's timezone, from tzdata as a fallback +Add support for solar time. +When disabled, redshift should be periodically set the gamma ramps @@ -1,238 +1,1174 @@ .TH REDSHIFT 1 REDSHIFT-NG .SH NAME -redshift \- set color temperature of display according to time of day +redshift \- Automatically adjust display colour temperature according the Sun + .SH SYNOPSIS .B redshift -\fR[\fB\-l\fR \fILAT\fB:\fILON\fR | \fB\-l\fR \fIPROVIDER\fB:\fIOPTIONS\fR] [\fB\-t\fR \fIDAY\fB:\fINIGHT\fR] [\fIOPTIONS\fR...] +[-b +.IR brightness ] +[-c +.IR config-file ] +[-D | +D] +[-g +.IR gamma ] +[-l +.IB latitude : longitude +| -l +.IR provider [\fB:\fP options ]] +[-m +.IR method [\fB:\fP options ] +[-P | +P] [-r | +r] [-dv] +[-O +.I temperature +| -o | -p | -t +.I temperature +| -x] | -h | -V + .SH DESCRIPTION .B redshift -adjusts the color temperature of your screen according to your +adjusts the colour 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 4500K). During the day, -the color temperature should match the light from outside, typically -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. +The colour temperature is set according the the position of the Sun. +A different colour temperature is set during the night and during the +day. During dawn and early morning, the colour temperature transitions +smoothly from night- to day-time temperature to allow your eyes to +slowly adapt over a period of about an hour. At night, the colour +temperature should be set to match the maps in your room. This is +typically a low temperature at around 3000K-4000K (default is 4500K). +During the day, the colour temperature should match the light from +outside. Typically around 5500K-6500K (default is 6500K). The light has +a lower temperature on an overcast day. +.PP +In addition to the command-line tool +.BR redshift , +the GUI +.BR redshift-gtk (1) +provides an alternative interface that shows up as a notification icon +in the desktop environment. + .SH OPTIONS +The following options are supported: +.TP +.BI -b\fR\ brightness +Synonym for +.B -b +.IB brightness : brightness\fR. +.TP +.BI -b\fR\ day : night +Monitor whitepoint brightness to apply at daytime and at +nighttime. (Default: 1:1) + +The values most be between 0.1 and 1.0. + +.I day +or +.I night +may be omitted, to keep unmodified, however +at least one must be specified. +.TP +.BI -c\fR\ config-file +Load settings from specified configuration file. + +.B /dev/null +can be used to tell +.B redshift +not to load the configuration file. + +If +.RB \(dq - \(dq, +the standard input will be used. +.TP +.B -D +Start in enabled state. (Default) +.TP +.B +D +Start in disabled state. + +Ignored in one-shot mode. +.TP +.B -d +Keep the process alive and remove the colour effects +when killed. + +Ignored for +.B -p +and +.BR -x ; +always active for +.B -t +and the +.B quartz +adjustment method. +.TP +.BI -g\fR\ gamma +Synonym for +.B -g +.IB gamma : gamma\fR. .TP -\fB\-h\fR +.BI -g\fR\ day : night +Synonym for +.B -g +.IB day : day : day : night : night : night\fR. + +However, if +.I day +is omitted, it is a synonym for +.B -g +.BI : night : night : night\fR, +or if +.I night +is omitted, it is a synonym for +.B -g +.IB day : day : day :\fR. +.TP +.BI -g\fR\ red : green : blue +Synonym for +.B -g +.IB red : green : blue : red : green : blue\fR. +.TP +.BI -g\fR\ day-r : day-g : day-b : night-r : night-g : night-b +Additional gamma correction to apply at daytime and +at nighttime. (Default: 1:1:1:1:1:1) + +The values most be between 0.1 and 10.0. + +.IB day-r : day-g : day-b +or +.IB night-r : night-g : night-b +may be omitted, +to keep unmodified, however at least one set must be specified. +Individual components of one set cannot be omitted, either +nothing is omitted or an entire set, including its two colons +.RB ( : ) +are omitted. +.TP +.B -h Display help message. .TP -\fB\-v\fR -Enable verbose output. +.BI -l\fR\ latitude : longitude +Your current location, in degrees. Shall be formatted a single +real number, rather than split into integer degrees, minutes +and seconds. The location should be specified using the GPS +coordinate system. .TP -\fB\-V\fR -Show program version. +.BI -l\fR\ provider\fR[ : options\fR] +Select provider for automatic location updates. + +Use +.B -l list +to see available providers. + +Use +.BI -l\ provider :help +to see available options. .TP -\fB\-b\fR \fIDAY\fB:\fINIGHT\fR -Screen brightness to apply (between 0.1 and 1.0). +.BI -m\fR\ method\fR[ : options\fR] +Method to use to set colour temperature. +Use +.B -m list +to see available methods. + +Use +.BI -m\ method :help +to see available options. .TP -\fB\-c\fR \fIFILE\fR -Load settings from specified configuration file. +.BI -O\ temperature +This is a synonym for +.B -O +.IB temperature : temperature\fR. .TP -\fB\-g\fR \fIR\fB:\fIG\fB:\fIB\fR -Additional gamma correction to apply. -.TP -\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 \fIPROVIDER\fR[\fB:\fIOPTIONS\fR] -Select provider for automatic location updates -(Use \fB"\-l list"\fR to see available providers). -.TP -\fB\-m\fR \fIMETHOD\fR[\fB:\fIOPTIONS\fR] -Method to use to set color temperature -(Use \fB"\-m list"\fR to see available methods). -.TP -\fB\-o\fR -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 \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). -.TP -\fB\-P\fR -Reset existing gamma ramps before applying new color effect. -.TP -\fB\-x\fR -Reset mode (remove adjustment from screen). -.TP -\fB\-r\fR -Disable fading between color temperatures. -.TP -\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: 6500K, night: 4500K -.SH CONFIGURATION FILE -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\fR = \fIday\fB:\fInight\fR +.BI -O\ day : night +One-shot manual mode (set colour temperature). The colour set +is interpolated between day and night depending on the Sun's +elevation or the clock time (depending on which +.B redshift +is configured to use). + +Values must be at least 1000 and integral. + +Use this with the +.B -P +option to clear the existing gamma ramps +before applying the new color temperature. + +This is a synonym for +.B -t +.IB day : night +.BR -o . +.TP +.B -o +One-shot mode (do not continuously adjust colour temperature). + +Use this with the +.B -P +option to clear the existing gamma ramps +before applying the new color temperature. +.TP +.B -P +Reset exiting gamma ramps before applying new colour effects. +.TP +.B +P +Preserve preexisting gamma adjustments. (Default) +.TP +.B -p +Print parameter and exit. +.TP +.B -r +Disable fading between colour temperatures. +.TP +.B +r +Enable fading between colour temperatures. (Default) +.TP +.BI -t\fR\ temperature +This is a synonym for +.B -t +.IB temperature : temperature\fR. +.TP +.BI -t\fR\ day : night +Colour temperature to set at daytime and at nighttime. + +Values must be at least 1000 and integral. + +The value 6500 is equivalent to no colour temperature +adjustment. + +Default mode, but default values may change between +versions. +.TP +.B -V +Show program implementation and verison. +.TP +.B -v +Enable verbose output. +.TP +.B -x +Remove adjustments from screen. +.PP +For mutually exclusive options or options specified multiple times, +the last specified takes effect, except the first specified option +that outputs text (except +.BR -p ) +is used. However, if the daytime +alue or nighttime value is omitted for an option, the last previously +pecified value will be used; that is, for example, +.B -t 5000: +and +.B -t :3000 +do not override each other, but +.B -t 5000: +overrides, if specified later, +.B 6000 +but not +.B 3000 +in +.BR "-t 6000:3000" . +.PP +Options in the command line override settings from the configuration +file. + +.SH OPERANDS +None. + +.SH STDIN +Not used. + +.SH INPUT FILES +None. + +.SH ASYNCHRONOUS EVENTS +.B redshift +takes the standard action for all signals except: +.TP +.B SIGINT .TQ -\fBtemp\fR = \fIinteger\fR +.B SIGTERM .TQ -\fBtemperature\-day\fR = \fIday\fB:\fInight\fR +.B SIGQUIT +Smoothly disable the effects of +.B redshift +and terminate the +process. If already sent, immediately disable the effects +and terminate the process. +.TP +.B SIGUSR1 +Disable the effects of +.BR redshift , +or if already disabled, reenable them. +.TP +.BR SIGUSR2 \ with\ value\ \fI0\fR +Normally signals may be processed out of order, however +when this signal is received, +.B SIGUSR2 +will be blocked until all pending +.B SIGUSR2 +signals has been processed, creating signal processing +order barrier. This is useful when mixing +.B SIGUSR2 +value +.I 3 +(reloading configuration file) with other configuration changing +.I SIGUSR2 +values. +.TP +.BR SIGUSR2 \ with\ value\ \fI1\fR +Disable the effects of +.BR redshift . +.TP +.BR SIGUSR2 \ with\ value\ \fI2\fR +Enable the effects of +.BR redshift . +.TP +.BR SIGUSR2 \ with\ value\ \fI3\fR +Reload the configuration file. + +Settings from the command line will be overriden. +.TP +.BR SIGUSR2 \ with\ value\ \fI4\fR +Execute into the currently installed version of +.BR redshift . + +Only available on Linux. +.TP +.BR SIGUSR2 \ with\ value\ \fI5\fR +Set the +.B fade +setting to off. +.TP +.BR SIGUSR2 \ with\ value\ \fI6\fR +Set the +.B fade +setting to on. +.TP +.BR SIGUSR2 \ with\ value\ \fI7\fR +Set the +.B preserve-gamma +setting to off. +.TP +.BR SIGUSR2 \ with\ value\ \fI8\fR +Set the +.B preserve-gamma +setting to on. +.TP +.BR SIGUSR2 \ with\ value\ \fI9\fR +Exit the process without removing the its effects. +If the used adjustment method does not support leaving +the effects, they will be removed. +.TP +.BR SIGUSR2 \ with\ value\ \fI10\fR +Do not terminate +.B redshift +the standard output and standard error are closed. +.TP +.BR SIGUSR2 \ with\ value\ \fI11\fR +Enable verbose mode. (The +.B -v +option will be treated as specified.) +.TP +.BR SIGUSR2 \ with\ value\ \fI12\fR +Disable verbose mode. + +Ignore if started in verbose mode +.RB ( -v +option). +.TP +.BR SIGUSR2 " with other values or no value" +Ignored. + +.SH STDOUT +The standard output is used to print state information and requested +help information. The output is subject to localisation, and the +following formats apply for the +.RB \(dq C \(dq +locale. Applications taking use of this information must make sure +to set the message locale to +.RB \(dq C \(dq. +For floating-point values +.RB (\(dq %f \(dq) +the precision is not documented as it may change between versions and +applications should not expect any particular precision to be used. +.PP +When +.B -m list +is specified, the available gamma ramp adjustment methods +are printed with the header +.B \(dqAvailable adjustment methods:\en\(dq +followed by the list in the format +.RS +.nf + +\fB\(dq%s%s\en\(dq, \fI<arbitrary whitespace>\fP, \fP<method name>\fR. + +.fi +.RE +.PP +The list is terminated by an empty line. Additional information for +human users is printed after the empty line. +.PP +When +.B -l list +is specified, the available location providers are +printed with the header +.B \(dqAvailable location providers:\en\(dq +followed by the list in the format +.RS +.nf + +\fB\(dq%s%s\en\(dq, \fI<arbitrary whitespace>\fP, \fP<provider name>\fR. + +.fi +.RE +.PP +The list is terminated by an empty line. Additional information for +human users is printed after the empty line. +.PP +When +.BR "-m method:help" , +.BR "-l provider:help" , +or +.B -h +is specified help information is printed on in unspecified format, +intended only for human users. +.PP +When +.B -V +is specified, the used version of the program is printed to +the standard output in the format +.RS +.nf + +\fB\(dq%s %s\en\(dq, \fI<implementation name>\fP, \fP<version number>\fR. + +.fi +.RE +.PP +If +.B -v +is specified and the colour settings depend on the Sun's +elevation, the elevation thresholds are printed to the standard +output in the format +.RS +.nf + +\fB\(dqSolar elevations: day above %f, night below %f\en\(dq,\fR +\fI<minimum solar elevation at daytime>\fB,\fR +\fI<maximum solar elevation at nighttime>\fR. + +.fi +.RE +This line may be printed, if +.B -v +is specified, if +.B redshift +is configured. +.PP +If +.B -v +is specified and the colour settings depend on the clock time, +the time schedule is printed to the standard output, with the header +.B \(dqSchedule:\en\(dq +and the footer +.BR "\(dq(End of schedule)\e\n\(dq" , +in the format +.RS +.nf + +\fB\(dq%s%f%% day at %02u:%02u:%02u\en\(dq, \fI<arbitrary whitespace>\fP,\fR +\fI<dayness level (0-100)>\fB, \fP<start hour (0-23)>\fP,\fR +\fI<start minute (0-59)>\fB, \fP<start second (0-59)>\fR. + +.fi +.RE +These lines may be printed, if +.B -v +is specified, if +.B redshift +is configured. +.PP +If +.B -v +is specified, the colour settings is printed to the standard +output in the format +.RS +.nf + +\fB\(dqTemperatures: %luK at day, %luK at night\en\(dq\fR +\fB\(dqBrightness: %f:%f\en\(dq\fR +\fB\(dqGamma (Daytime): %f, %f, %f\en\(dq\fR +\fB\(dqGamma (Night): %f, %f, %f\en\(dq,\fR +\fI<daytime colour temperature>\fB, \fP<nighttime temperature>\fP,\fR +\fI<daytime whitepoint brightness>\fB, \fP<nighttime brightness>\fP,\fR +\fI<daytime red gamma>\fB, \fP<daytime green gamma>\fP,\fR +\fI<daytime blue gamma>\fB, \fP<nighttime red gamma>\fP,\fR +\fI<nighttime green gamma>\fB, \fP<nighttime blue gamma>\fR. + +.fi +.RE +Each line may be printed, if +.B -v +is specified, if +.B redshift +is configured. +.PP +If the colour effects depend on the Sun's elevation, the user's +geographical location will printed to the standard output in the +format +.RS +.nf + +\fB\(dqLocation: %f %c, %f %c\en\(dq,\fR +\fIfabs(<GPS latitude>)\fB, \fPsignbit(<GPS latitude>) ? 'S' : 'N'\fP,\fR +\fIfabs(<GPS longitude>)\fB, \fPsignbit(<GPS longitude>) ? 'W' : 'E'\fR. + +.fi +.RE +This message is printed when the program starts and any time the +location is updated. +.PP +If the colour effects are non-static, the current period of the day +(which determine the colour effects) is printed to standard output, if +.B -v +or +.B -p +is specified, in the format +.RS +.nf + +\fB\(dqPeriod: %s\en\(dq, \fI<period>\fR + +.fi +.RE +where +.I <period> +is +.BR None , +.BR Daytime , +or +.BR Night , +or in the format +.RS +.nf + +\fB\(dqPeriod: Transition (%f%% day)\en\(dq, \fI<dayness level> * 100\fR. + +.fi +.RE +.I <dayness level> +is exclusively between 0 (night) and 1 (daytime). +.PP +This message is printed when the program starts and any time it +changes (if +.B -v +is specified). +.PP +If +.B -v +or +.B -p +is specified, the colour settings are printed to the +standard output when the program standard and any time it changes +(fade effect is ignored). These are printed in three different +messages and, on chagne, only the settings that changed are printed: +.RS +.nf + +\fB\(dqColor temperature: %luK\en\(dq, \fI<colour temperature>\fR; + +\fB\(dqBrightness: %f\en\(dq, \fI<whitepoint brightness level (0-1)>\fR; + +\fB\(dqGamma: %f, %f, %f\en\(dq, \fI<red gamma>\fP, \fP<green gamma>\fP, \fP<blue gamma>\fR. + +.fi +.RE +.PP +If +.B -v +is specified, and if running in continual mode, the program will print +.B \(dqStatus: Enabled\en\(dq +if starting in or when entering enabled mode, and +.B \(dqStatus: Disabled\en\(dq +if starting in or when entering disabled mode. +.PP +If +.B -v +is specified, and if running in continual mode, the program will print +.B \(dqFade: Enabled\en\(dq +or +.B \(dqFade: Disabled\en\(dq +to indicate whether the +.B fade +setting is enabled, when the program starts and when the +setting is modified. +.PP +If +.B -v +is specified, and if running in continual mode, the program will print +.B \(dqPreserve gamma: Enabled\en\(dq +or +.B \(dqPreserve gamma: Disabled\en\(dq +to indicate whether the +.B preserve-gamma +setting is enabled, when the +program starts and when the setting is modified. +.PP +If the +.B dummy +gamma ramp adjustment method is used, any time a colour +change is applied (including each fade step), the colour temperature +is output, for debugging purposes (brightness and gamma are not printed), +to the standard output in the format +.RS +.nf + +\fB\(dqTemperature: %lu\en\(dq, \fI<colour temperature>\fR. +.fi +.RE + +.SH STDERR +Default. + +.SH OUTPUT FILES +None. + +.SH FILES +Unless the +.B -c +option is used, +.B redshift +will look for its configuration +file, and if found, load it. When searching for the configuration file, +.B redshift +will load the first found file. It will primary look for +.IR redshift-ng/redshift.conf , +secondarily for +.IR redshift/redshift.conf , +and tertiarily for +.IR redshift.conf , +in each directory it searches. It +will search the following directories in order: the directory set in +the environment variable +.IR XDG_CONFIG_HOME , +the directory set in the +environment variable +.I localappdata +(Windows only), the +.I .config +directory inside directory set in the environment variable +.IR HOME , +and the +.I .config +directory inside the user's home directory. For the two +latter, it will quaternarily look for the file +.IR .redshift.conf . +If not found, it will also look for the file in each directory listed in the +environment variable +.I XDG_CONFIG_DIRS +(delimited by colon +.RB ( : ) +on Unix-like systems and by semicolon +.RB ( ; ) +on Windows), however it try each +directory before moving on to then next filename option. Lastly, on +Unix-like systems, it will look for the file in +.IR /etc . +This means that the preferred location for the configuration file is +.IB ${XDG_CONFIG_HOME} /redshift-ng/redshift.conf\fR. +.PP +.B redshift +will use the same pattern to find the hook directory, and the +tested subdirectories for each search directory are +.I /redshift-ng/hooks +and secondarily +.IR /redshift/hooks . +All executable files, in the found +directory, that are neither prefixed with a period +.BR ( . ) +or suffixed with a tilde +.RB ( ~ ) +will be used as hooks scripts, and will be executed in +arbitrary order. Subdirectories are not search for executable files. +This means that the preferred location for the hook scripts is (directly +inside) +.IB ${XDG_CONFIG_HOME} /redshift-ng/hooks/\fR. + +.SH EXTENDED DESCRIPTION +.SS Configuration file +The configuration file uses the standard INI format. General program +options are placed under the +.B redshift +header +.RB ( [redshift] ), +while options for location providers are adjustment methods are +placed under a hader with the name of that proivder or method. +.PP +General options are: +.TP +.BI temp\fR\ =\ temperature .TQ -\fBtemperature\-day\fR = \fIinteger\fR -Temperature (day and night) +.BI temperature\fR\ =\ temperature +Set temperature for daytime and nighttime. The value shall be +format in the same way as with the +.B -O +and +.B -t +options. .TP -\fBtemp\-day\fR = \fIinteger\fR +.BI temp-day\fR\ =\ integer .TQ -\fBtemperature\-day\fR = \fIinteger\fR -Daytime temperature +.BI temperature-day\fR\ =\ integer +Set temperature for daytime. That value shall be an integer no +less than 1000 (Kelvin). .TP -\fBtemp\-night\fR = \fIinteger\fR +.BI temp-night\fR\ =\ integer .TQ -\fBtemperature\-night\fR = \fIinteger\fR -Night temperature +.BI temperature-night\fR\ =\ integer +Set temperature for nighttime. That value shall be an integer +no less than 1000 (Kelvin). +.TP +.BI brightness\fR\ =\ brightness +Set whitepoint brightness for daytime and nighttime. The value +shall be format in the same way as with the +.B -b +option. +.TP +.BI brightness-day\fR\ =\ 0.1-1.0 +Set whitepoint brightness for daytime. That value shall be an +within [0.1, 1.0]. .TP -\fBfade\fR = \fI0 or 1\fR -Disable or enable fading between color temperatures when Redshift starts or -stops +.BI brightness-night\fR\ =\ 0.1-1.0 +Set whitepoint brightness for nighttime. That value shall be an +within [0.1, 1.0]. .TP -\fBbrightness\fR = \fIday\fB:\fInight\fR +.BI gamma\fR\ =\ gamma +Set gamma correction for daytime and nighttime. The value shall +be format in the same way as with the +.B -g +option. +.TP +.BI gamma-day\fR\ =\ 0.1-10.0 .TQ -\fBbrightness\fR = \fI0.1\-1.0\fR -Screen brightness (day and night) +.BI gamma-day\fR\ =\ red : green : blue +Set gamma correction for daytime. Values must be within [0.1, +10.0], and are applied to each colour channel individually, +however if only one value is specified it is applied to all +each channels. .TP -\fBbrightness\-day\fR = \fI0.1\-1.0\fR -Screen brightness at daytime +.BI gamma-night\fR\ =\ 0.1-10.0 +.TQ +.BI gamma-night\fR\ =\ red : green : blue +Set gamma correction for nighttime. Values must be within [0.1, +10.0], and are applied to each colour channel individually, +however if only one value is specified it is applied to all +each channels. .TP -\fBbrightness\-night\fR = \fI0.1\-1.0\fR -Screen brightness at night +.BI fade\fR\ =\ \fP0 " or " 1 +Disable (if +.BR 0 ) +or enable (if +.BR 1 ) +fading between colour settings with large differences. + +The +.B -r +and +.B +r +options can be used to override this setting. .TP -\fBelevation-high\fR = \fIdecimal\fR -The solar elevation in degrees for the transition to daytime +.BI preserve-gamma\fR\ =\ \fP0 " or " 1 +If +.BR 1 , +preapplied colour calibrations (all applied effects are +assumed to be colour calibrations) will be preserved, if +.BR 0 , +colour calibrations will be reset while +.B redshift +is running. + +The +.B -P +and +.B +P +options can be used to override this setting. + +Note that if +.BR 0 , +colour calibrations will be reset even when +.B redshift +is running but is disabled. This is necessary to +support the +.B -o +and +.B -O +options. + +This setting is ignored when +.B coopgamma +is used as +.B coopgamma +allows multiple programs to modify the gamma ramps +at the same time. .TP -\fBelevation-low\fR = \fIdecimal\fR -The solar elevation in degrees for the transition to night +.BI start-disabled\fR\ =\ \fP0 " or " 1 +Start +.B redshift +in disabled (if +.BR 1 ) +or enabled (if +.BR 0 ) +state. + +The +.B -D +and +.B +D +options can be used to override this setting. .TP -\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. +.BI elevation-high\fR\ =\ decimal +The lowest solar elevation, in degrees, during daytime. .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. +.BI elevation-low\fR\ =\ decimal +The highest solar elevation, in degrees, during nighttime. .TP -\fBgamma\fR = \fIday\fB:\fInight\fR -.TQ -\fBgamma\fR = \fI0.1\-10.0\fR +.BI dawn-time\fR\ =\ HH : MM\fR[ : SS\fR][ - HH : MM\fR[ : SS\fR]] .TQ -\fBgamma\fR = \fIR\fB:\fIG\fB:\fIB\fR -Gamma adjustment to apply (day and night) +.BI dusk-time\fR\ =\ HH : MM\fR[ : SS\fR][ - HH : MM\fR[ : SS\fR]] +Custom time interval for the transition from night to day +.RB ( dawn-time ) +and for the transition from day to night +.BR ( dusk-time ). + +When specified, both settings must be specified and the +solar elevation will not be used to determine the current +daytime/nighttime period, nor will a location provider +used. + +The left-hand hour must be within [0, 23], but the right-hand +hour may be within [0, 47], the timespan must not be greater +than 24 hours. The minutes and seconds must be within [0, 59], +and the default value for the seconds is 0. .TP -\fBgamma-day\fR = \fI0.1\-10.0\fR -.TQ -\fBgamma-day\fR = \fIR\fB:\fIG\fB:\fIB\fR -Gamma adjustment to apply at daytime +.BI adjustment-method\fR\ =\ name +Select adjustment method. Options for the adjustment method can +be given under the configuration file heading of the same name. + +Not used if the +.B -p +option is specified. .TP -\fBgamma-night\fR = \fI0.1\-10.0\fR -.TQ -\fBgamma-night\fR = \fIR\fB:\fIG\fB:\fIB\fR -Gamma adjustment to apply at night -.TP -\fBpreserve-gamma\fR = \fI0 or 1\fR -Reset existing gamma ramps before applying new color effect. (On by default) -.TP -\fBstart-disabled\fR = \fI0 or 1\fR -Start redshift in disabled state. (Off by default) -This option is only used when started in continual mode. -.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 = \fIname\fR -Select location provider. Options for the location provider can be -given under the configuration file heading of the same name. -.PP -Options for location providers and adjustment methods can be found in -the help output of the providers and methods. -.SH EXAMPLE -Example for Copenhagen, Denmark: -.IP -\fB$\fR redshift \-l 55.7:12.6 \-t 5700:3600 \-g 0.8 \-m randr \-v -.PP -An example configuration file with the same effect as the above -command line: -.IP +.BI location-provider\fR\ =\ name +Select location provider. Options for the location provider can +be given under the configuration file heading of the same name. + +Not used if +.B dawn-time +and +.B dusk-time +are used or if the colours +settings are specified to be the same during the day and the +night. +.PP +Options for the location provider +.B manual +are: +.TP +.BI lat\fR\ =\ decimal +The GPS latitude of the user's geographical location. +Shall be specified in degrees and formatted a single +real number, rather than split into integer degrees, +minutes and seconds. Positive values used for the +northern hemisphere and negative values are ued for +the southern hemisphere. +.TP +.BI lon\fR\ =\ decimal +The GPS longitude of the user's geographical location. +Shall be specified in degrees and formatted a single +real number, rather than split into integer degrees, +minutes and seconds. Positive values used for the +eastern hemisphere and negative values are ued for +the western hemisphere. +.PP +There are no options for the location providers +.B geoclue2 +(may be available on Unix-like systems) and +.B corelocation +(available on Mac OS X). +.PP +Options for the location provider +.B randr +(preferred method for X) are: +.TP +.BI screen\fR\ =\ integer +X screen to apply adjustments to. Default is determined +by the environment variable +.IR DISPLAY . +.TP +.BI crtc\fR\ =\ "integer list or " all +Comma-separated (,) list of CRTC indices for monitors to +apply adjustments to. All available CRTCs are used if the +list is empty or if the setting is omitted. + +.B all +may be specified as a synonym for an empty list. + +The index of the first CRTC is 0. +.PP +Options for the location provider +.B vidmode +(fallback method for X) are: +.TP +.BI screen\fR\ =\ integer +X screen to apply adjustments to. Default is determined +by the environment variable +.IR DISPLAY . +.PP +Options for the location provider +.B drm +(method for Linux without display server) are: +.TP +.BI card\fR\ =\ integer +Index of graphics card to apply adjustments to. +.TP +.BI crtc\fR\ =\ "integer or " all +Index of CRTC for monitor to apply adjustments to. + +.B all +may be specified to apply adjustments to each available +CRTC on the graphics card. + +The index of the first CRTC is 0. +.PP +There are no options for the adjustment methods +.B wingdi +(available on Windows), +.B quartz +(available on Mac OS X), and +.B dummy +(used for debugging, does not apply any colour effects). + +.SS Hooks +Executable files (that are not dotfiles or tilde files) in the hook +directory (see the +.B FILES +section), are executed on certain events. +The file inherit the +.B redshift +process standard input and standard +error, however the standard output is redirected to the standard error. +.PP +Each file is executed with at least one argument. This first argument +indicate what event has taked place. Additional arguments may be +provided for additional event data. +.PP +.B redshift +will be the parent process of the executed script. +.PP +Currently available events are: +.TP +.B period-changed +This indicate that the period of the day has changed (and at +start of continual mode). The script will be provided two +additional arguments (the second argument and the third +argument). The second argument will the previous period, and +the third argument will be the new period. The argument values +will be either of +.BR night , +.BR daytime , +.BR transition +(transition in either direction between night and daytime), or +.B none +(not previously or no longer calculated). +.B none +appears as the +previous period at start up and can also appear when the when +.B redshift +is reconfigured if the colour settings no longer +depending on the period of the day or has started depending +on the period of the day. + +.SS Gamma ramps +.B redshift +applies a redness effect to the graphical display. The +intensity of the redness can be customised and scheduled to only be +applied at night or to be applied with more intensity at night. +.PP +.B redshift +uses colour correction lookup tables (CLUTs), usually called +gamma ramps or gamma correction ramps, to apply this effect. + +.SS Colour temperature +The redness effect applied by +.B redshift is modelled after black-body +radiation, specifically with a 10 degree observer. Although black-body +radiation starts at 0, +.BR redshift 's +model start at the conventional 1000K +(1000 Kelvin). For this reason, no colour temperature below 1000K can be +specified. However, as there is a limit can be determined for the colour +when the colour temperature appreciates infinity, the upper limit for +allow colour temperature is instead determined by the data type it is +stored in. However, it also means that it is meaningless to use colour +temperatures above 40000K. +.PP +The sRGB colour space, and modern monitors, use the standard illuminant +D65 as the reference for pure white, modelling ideal day light. The +correlated colour temperature of D65 is called 6500K, however it's +actually 6504K, but +.BR redshift 's +defines this illuminant has having the colour temperature 6500K. +This means that 6500K is the neutral (no effect) colour temperature. +.PP +The current version +.B redshift +assumes the monitor uses sRGB. However +this is usually only true for CRT monitors. HDR-capable monitors +particular diverges significant for sRGB. This means that the display +colour does not perfectly correlated to the specified colour temperate. +Lower (more red) colour temperatures, about 1900K and below, are out of +gamut, and thus incorrect even on sRGB monitors. + +.SH EXIT STATUS +Default. + +.SH EXAMPLES +Example for the superelliptical roundabout in Stockholm, Sweden: +.RS +.nf + +redshift -l 59.333:18.065 -t 5700:3600 -b 1:0.8 +.fi +.RE +.PP +Example configuration file equivalent to above command: +.RS .nf -[\fBredshift\fR] -temp\-day=5700 -temp\-night=3600 -gamma=0.8 -adjustment\-method=randr -location\-provider=manual - -[\fBmanual\fR] -lat=55.7 -lon=12.6 + +[redshift] +temperature-day=5700 +temperature-night=3600 +brightness-day=1 +brightness-night=0.8 +location-provider=manual + +[manual] +lat=59.333 +lon=18.065 .fi -.SH 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 \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 -\fBnone\fR. Any dotfiles in the folder are skipped. -.PP -A simple script to handle these events can be written like this: -.IP +.RE +.PP +Sample hook script: +.RS .nf + #!/bin/sh -case \fB$1\fR in - \fBperiod-changed\fR) - exec notify-send "Redshift" "Period changed to \fB$3\fR" +case "$1" in + period-changed) + notify-send "redshift-ng" "Period changed from $2 to $3";; esac .fi -.SH AUTHOR +.RE + +.SH KNOWN ISSUES +.SS No or incorrect effect on cursor +Some graphics drivers apply the effect (colour corrects) twice or not at +all on hardware cursors. It is often possible to reconfigure the display +server to use software cursors, to avoid this problem, however at mouse +pointer performance cost that may be noticeable on very low-end computer. + +.SS D65-flashes +For some versions of some graphics drivers, there will be an occasional +flash where gamma ramps are not applied to the output. + +.SS Limited hardware support +Low-end hardware, especially embedded devices, often lack colour +correction features .B redshift -was written by Jon Lund Steffensen <jonlst@gmail.com>. -.PP -Both +abuse to apply its effect. .B redshift -and this manual page are released under the GNU General Public -License, version 3. -.SH KNOWN ISSUES +is not always able to tell if support is missing. + +.SS Limited software support +.B redshift +does not yet support Wayland. If your environment contains the +variable +.IR WAYLAND_DISPLAY , +you are using a Wayland compositor and cannot +currently expect +.B redshift +to work. Even with Wayland support, it would be up to each individual +Wayland compositor to opt in to support applications like +.BR redshift . + +.SS Backlight control +.B redshift +uses gamma ramps rather than backlight control to adjust +brightness. This actually intentional and for your best. Most +contemporary monitors require Pulse-Width Modulation, which causes +flicker than can cause eye-strain and headaches, to adjust backlight. +Using gamma ramps is a safe option, it's also considerably less work +basically no extra code and posses no additional limitations. It's often +not possible to adjust backlight on desktop monitors from software, for +devices for which it is possible (mostly telephones and laptops, however +not all have fine-grained enough configurability to be usable) it's not +possible from software to determine well enough how changing the +backlight settings changes the backlight physically. If you still want +backlight to be controlled, you can hook in a tool such as +.BR adjbacklight (1). + +.SS Flickering and temporary suspension +.B redshift +uses the gamma ramps for the monitor to apply it's effect. The +gamma ramps where originally intended for colour correction. Therefore +there is no standardised why have multiple applications applying +different effects without overriding each other. This can cause +continuous flicker if multiple instance are running or effects +temporarily disappearing. By default, .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. +uses +.BR coopgammad (1), +which is a daemon applications can opt to use instead of directly +setting the gamma ramps themselves, +.BR coopgammad (1) +can then calculate the result of all +of the effects and apply them as one, allowing the user to use multiple +applications that apply different effects. However +.BR coopgammad (1) +still has to compete with applications that does not use it. + +.SS DRM and display servers +Using the DRM gamma ramp adjustment method can block starting or +switching to and already started display server (like X). Users may +also find that trying to switch to and an already started display cases +the computer hang, or more precisely appear to hang, as the display +server is not beign presented, the screen freezes, and the keyboard +doesn't do anything. (Once upon a time, this wasn't as catastrophic, +and it probably depend on display server implementation details.) The +only solution, abort from restarting the computer, is to remote into +it and kill the display server. + +.SH RATIONALE +To prevent the user from accidental making the screen black, brightness +level below 0.1 are forbidden. +.PP +To prevent colour distortion and making the screen too white, brightness +level above 1.0 are forbidden. +.PP +Gamma correction is preserved for backwards compatibility and is +deprecated (gamma parameters in particular). + +.SH NOTES +\(dqColour temperature\(dq, or just \(dqtemperature\(dq, is actually short for +\(dqcorrelated colour temperature\(dq. (Your monitor is not a black-body +radiator.) And specifically the correlated colour temperature of the +monitor's whitepoint. +.PP +It's common for users to miss to specify a coordinate as negative, +which, if missed on the longitude can swap day and night. The latitude +is negative on the southern hemisphere and the longitude is negative on +the western hemisphere. + +.SH SEE ALSO +.BR cg-tools (7), +.BR coopgammad (1), +.BR radharc (1) diff --git a/redshift.conf.sample b/redshift.conf.sample deleted file mode 100644 index 2f237cb..0000000 --- a/redshift.conf.sample +++ /dev/null @@ -1,71 +0,0 @@ -; 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 diff --git a/src/common.h b/src/common.h index cc1852d..e6d62da 100644 --- a/src/common.h +++ b/src/common.h @@ -431,6 +431,85 @@ enum setting_source { /** + * SIGUSR2 signal values as bitmask values + */ +enum signals { + /** + * Block SIGUSR2 until all signals have been processed + */ + SIGNAL_ORDER_BARRIER = 1 << 0, + + /** + * Disable the effects of redshift + */ + SIGNAL_DISABLE = 1 << 1, + + /** + * Enable the effects of redshift + */ + SIGNAL_ENABLE = 1 << 2, + + /** + * Reload the configuration file + * + * Settings from the command line will be overriden + */ + SIGNAL_RELOAD = 1 << 3, + + /** + * Execute into the currently installed version of redshift + */ + SIGNAL_REEXEC = 1 << 4, + + /** + * Set the "fade" setting to off + */ + SIGNAL_USE_FADE_OFF = 1 << 5, + + /** + * Set the "fade" setting to on + */ + SIGNAL_USE_FADE_ON = 1 << 6, + + /** + * Set the "preserve-gamma" setting to off + */ + SIGNAL_PRESERVE_GAMMA_OFF = 1 << 7, + + /** + * Set the "preserve-gamma" setting to on + */ + SIGNAL_PRESERVE_GAMMA_ON = 1 << 8, + + /** + * Exit the process without removing the its effects + * + * If the used adjustment method does not support + * leaving the effects, they will be removed + */ + SIGNAL_EXIT_WITHOUT_RESET = 1 << 9, + + /** + * Do not terminate redshift the standard output + * and standard error are closed + */ + SIGNAL_IGNORE_SIGPIPE = 1 << 10, + + /** + * Enable verbose mode + */ + SIGNAL_VERBOSE_ON = 1 << 11, + + /** + * Disable verbose mode + * + * Ignore if started in verbose mode (-v option) + */ + SIGNAL_VERBOSE_OFF = 1 << 12 +}; + + +/** * Specification for a path that consists of a two parts: * the first being defined by the environment, and the * seocnd being a static string @@ -611,34 +690,79 @@ struct config_ini_state { }; +/** + * `int` valued setting (used for booleans) with setting source + */ struct setting_i { - enum setting_source source; - int value; + enum setting_source source; /**< Setting source */ + int value; /**< Setting value */ }; +/** + * `unsigned long int` valued setting with setting source + */ struct setting_lu { - enum setting_source source; - unsigned long int value; + enum setting_source source; /**< Setting source */ + unsigned long int value; /**< Setting value */ }; +/** + * `double` valued setting with setting source + */ struct setting_f { - enum setting_source source; - double value; + enum setting_source source; /**< Setting source */ + double value; /**< Setting value */ }; +/** + * `double[3]` valued setting with setting source + */ struct setting_f3 { - enum setting_source source; - double value[3]; + enum setting_source source; /**< Setting source */ + double value[3]; /**< Setting values */ }; +/** + * `time_t` valued setting with setting source + */ struct setting_time { - enum setting_source source; - time_t value; + enum setting_source source; /**< Setting source */ + time_t value; /**< Setting value */ }; +/** + * Intermediate settings representation of colour settings + * (for a non-transitional period) with settings sources + * used for determining whether settings from the configuration + * file (which is parsed after the command line) applied or are + * specified multiple times in the configuration file + */ struct setting_colour { + /** + * Colour temperature, in Kelvin + * + * Set by the "-t" and "-o" options and the "temperature" + * ("temp") settings, optionally suffixed "-day" if + * a daytime setting or "-night" if a nighttime setting + */ struct setting_lu temperature; + + /** + * Whitepoint brightness level, as a [0, 1] value + * + * Set by the "-b" option and the "brightness" settings, + * optionally suffixed "-day" if a daytime setting or + * "-night" if a nighttime setting + */ struct setting_f brightness; + + /** + * Gamma values, in the order red, green, blue + * + * Set by the "-g" option and the "gamma" settings, + * optionally suffixed "-day" if a daytime setting or + * "-night" if a nighttime setting + */ struct setting_f3 gamma; }; @@ -705,12 +829,53 @@ struct settings { */ struct setting_colour night; + /** + * The lowest solar elevation, in degrees, at daytime, + * when using solar scheme + * + * This represents the "elevation-high" setting + */ struct setting_f elevation_high; /* TODO no cmdline option */ + + /** + * The highest solar elevation, in degrees, at nighttime, + * when using solar scheme + * + * This represents the "elevation-high" setting + */ struct setting_f elevation_low; /* TODO no cmdline option */ - struct { - struct setting_time start; - struct setting_time end; - } dawn, dusk; /* TODO no cmdline option */ + + /** + * The wall-clock time that marks the end of nighttime, + * when using clock scheme + * + * This represents the left value of the "dawn-time" setting + */ + struct setting_time dawn_start; /* TODO no cmdline option */ + + /** + * The wall-clock time that marks the start of daytime, + * when using clock scheme + * + * This represents the right value of the "dawn-time" setting + */ + struct setting_time dawn_end; /* TODO no cmdline option */ + + /** + * The wall-clock time that marks the end of daytime, + * when using clock scheme + * + * This represents the left value of the "dusk-time" setting + */ + struct setting_time dusk_start; /* TODO no cmdline option */ + + /** + * The wall-clock time that marks the start of nighttime, + * when using clock scheme + * + * This represents the right value of the "dusk-time" setting + */ + struct setting_time dusk_end; /* TODO no cmdline option */ /* Selected gamma method */ const struct gamma_method *method; @@ -956,6 +1121,11 @@ extern volatile sig_atomic_t exiting; extern volatile sig_atomic_t disable; /** + * Bitwise or OR of received SIGUSR2 signal values + */ +extern volatile enum signals signals; + +/** * The colour settings applied at daytime */ extern struct colour_setting day_settings; diff --git a/src/config-ini.c b/src/config-ini.c index 015668f..d5056dc 100644 --- a/src/config-ini.c +++ b/src/config-ini.c @@ -55,23 +55,29 @@ static const struct env_path paths[] = { /** * Open the configuration file for reading * - * @param path The path to the configuration file, or `NULL` if the - * application should look for it in the default paths - * @param path_out Output parameter for the configuration file path - * @param pathbuf_out Output parameter for the memory allocation for `*path_out`; - * will be set to `NULL` unless `path` is `NULL`; shall be - * free(3)d by the caller - * @return `FILE` object for the reading the file; `NULL` if not - * found and `path` is `NULL` + * @param path The path to the configuration file, or `NULL` if the + * application should look for it in the default paths + * @param path_out Output parameter for the configuration file path + * @param pathbuf_out Output parameter for the memory allocation for `*path_out`; + * will be set to `NULL` unless `path` is `NULL`; shall be + * free(3)d by the caller + * @param should_close_out Output parameter for whether the file should be closed + * @return `FILE` object for the reading the file; `NULL` if not + * found and `path` is `NULL` */ static FILE * -open_config_file(const char *path, const char **path_out, char **pathbuf_out) +open_config_file(const char *path, const char **path_out, char **pathbuf_out, int *should_close_out) { FILE *f = NULL; size_t i; +#ifndef WINDOWS + const char *s; + int fd, old_fd = -1; +#endif *path_out = path; *pathbuf_out = NULL; + *should_close_out = 1; if (!path) { for (i = 0; !f && i < ELEMSOF(paths); i++) @@ -80,7 +86,57 @@ open_config_file(const char *path, const char **path_out, char **pathbuf_out) weprintf(_("Found configuration file `%s'."), *path_out); else weprintf(_("No configuration file found.")); + } else if (!strcmp(path, "/dev/null")) { /* needed to allow /dev/null to be specified on Windows */ + return NULL; + } else if (!strcmp(path, "-")) { + *should_close_out = 0; + return stdin; +#ifndef WINDOWS + } else if (!strcmp(path, "/dev/stdin")) { + *should_close_out = 0; + return stdin; + } else if (!strcmp(path, "/dev/stdout")) { + fd = STDOUT_FILENO; + goto use_fd; + } else if (!strcmp(path, "/dev/stderr")) { + fd = STDERR_FILENO; + goto use_fd; + } else if (!strncmp(path, "/dev/fd/", sizeof("/dev/fd/") - 1U)) { + s = &path[sizeof("/dev/fd/") - 1U]; +# if defined(__linux__) + goto parse_fd; + } else if (!strncmp(path, "/proc/self/fd/", sizeof("/proc/self/fd/") - 1U)) { + s = &path[sizeof("/proc/self/fd/") - 1U]; + parse_fd: +# endif + fd = 0; + if (!*s) + goto fallback; + while (isdigit(*s)) { + if (fd > (INT_MAX - (*s & 15)) / 10) + goto fallback; + fd = fd * 10 + (*s & 15); + } + if (*s) + goto fallback; + use_fd: + if (fd > 2) { + fd = dup(old_fd = fd); + if (fd < 0) + eprintf("dup %i:", old_fd); + } + f = fdopen(fd, "r"); + if (!f) { + if (old_fd < 0) + eprintf("fdopen %i \"r\":", fd); + else + eprintf("fdopen <duplicate of %i> \"r\":", old_fd); + } +#endif } else { +#ifndef WINDOWS + fallback: +#endif f = fopen(path, "r"); if (!f) eprintf("fopen %s \"r\":", path); @@ -100,10 +156,11 @@ config_ini_init(struct config_ini_state *state, const char *path) size_t size = 0; ssize_t len = 0; /* initialised to silence false warning from clang */ FILE *f; + int should_close; state->sections = NULL; - f = open_config_file(path, &path, &pathbuf); + f = open_config_file(path, &path, &pathbuf, &should_close); if (!f) return; @@ -172,7 +229,8 @@ again: free(pathbuf); free(line); - fclose(f); + if (should_close) + fclose(f); } diff --git a/src/config.c b/src/config.c index bb6f1d5..751b882 100644 --- a/src/config.c +++ b/src/config.c @@ -27,7 +27,7 @@ static void usage(void) { fprintf(stderr, _("usage: %s %s\n"), argv0, - _("[-b brightness] [-c file] [-D | +D] [-g gamma] " + _("[-b brightness] [-c config-file] [-D | +D] [-g gamma] " "[-l latitude:longitude | -l provider[:options]] " "[-m method[:options]] [-P | +P] [-r | +r] [-dv]" "[-O temperature | -o | -p | -t temperature | -x] " @@ -879,11 +879,11 @@ load_from_config_ini(struct settings *settings, const char *key, char *value) settings->elevation_low.value = checked_atof(value, key); } else if (!strcasecmp(key, "dawn-time")) { - if (!set_transition_time(value, &settings->dawn.start, &settings->dawn.end, key)) + if (!set_transition_time(value, &settings->dawn_start, &settings->dawn_end, key)) eprintf(_("Malformed dawn-time setting `%s'."), value); } else if (!strcasecmp(key, "dusk-time")) { - if (!set_transition_time(value, &settings->dusk.start, &settings->dusk.end, key)) + if (!set_transition_time(value, &settings->dusk_start, &settings->dusk_end, key)) eprintf(_("Malformed dusk-time setting `%s'."), value); } else if (!strcasecmp(key, "adjustment-method")) { @@ -922,28 +922,28 @@ load_settings(struct settings *settings, int argc, char *argv[]) load_from_config_ini(settings, setting->name, setting->value); /* Further validate settings */ - n = !!settings->dawn.start.source + !!settings->dawn.end.source; - n += !!settings->dusk.start.source + !!settings->dusk.end.source; + n = !!settings->dawn_start.source + !!settings->dawn_end.source; + n += !!settings->dusk_start.source + !!settings->dusk_end.source; if (n) { scheme.type = CLOCK_SCHEME; if (n != 4) eprintf(_("Partial time-configuration not supported!")); - if (settings->dawn.start.value >= ONE_DAY || settings->dusk.start.value >= ONE_DAY || - labs((long)settings->dawn.end.value - (long)settings->dawn.start.value) > (long)ONE_DAY || - labs((long)settings->dusk.end.value - (long)settings->dusk.start.value) > (long)ONE_DAY) + if (settings->dawn_start.value >= ONE_DAY || settings->dusk_start.value >= ONE_DAY || + labs((long)settings->dawn_end.value - (long)settings->dawn_start.value) > (long)ONE_DAY || + labs((long)settings->dusk_end.value - (long)settings->dusk_start.value) > (long)ONE_DAY) goto invalid_twilight; /* TODO deal with edge-case where one of the twilights last 24 hour */ - settings->dawn.end.value %= ONE_DAY; - settings->dusk.end.value %= ONE_DAY; - if (settings->dawn.start.value <= settings->dawn.end.value) { - if (BETWEEN(settings->dawn.start.value, settings->dusk.start.value, settings->dawn.end.value) || - BETWEEN(settings->dawn.start.value, settings->dusk.end.value, settings->dawn.end.value)) + settings->dawn_end.value %= ONE_DAY; + settings->dusk_end.value %= ONE_DAY; + if (settings->dawn_start.value <= settings->dawn_end.value) { + if (BETWEEN(settings->dawn_start.value, settings->dusk_start.value, settings->dawn_end.value) || + BETWEEN(settings->dawn_start.value, settings->dusk_end.value, settings->dawn_end.value)) goto invalid_twilight; } else { - if (!WITHIN(settings->dawn.end.value, settings->dusk.start.value, settings->dawn.start.value) || - !WITHIN(settings->dawn.end.value, settings->dusk.end.value, settings->dawn.start.value)) + if (!WITHIN(settings->dawn_end.value, settings->dusk_start.value, settings->dawn_start.value) || + !WITHIN(settings->dawn_end.value, settings->dusk_end.value, settings->dawn_start.value)) goto invalid_twilight; } } @@ -984,13 +984,13 @@ load_settings(struct settings *settings, int argc, char *argv[]) scheme.elevation.range = scheme.elevation.high - scheme.elevation.low; } else if (scheme.type == CLOCK_SCHEME) { scheme.time.periods = &scheme.time.periods_array[0]; - scheme.time.periods_array[0].start = settings->dawn.start.value; + scheme.time.periods_array[0].start = settings->dawn_start.value; scheme.time.periods_array[0].day_level = 0.0; - scheme.time.periods_array[1].start = settings->dawn.end.value; + scheme.time.periods_array[1].start = settings->dawn_end.value; scheme.time.periods_array[1].day_level = 1.0; - scheme.time.periods_array[2].start = settings->dusk.start.value; + scheme.time.periods_array[2].start = settings->dusk_start.value; scheme.time.periods_array[2].day_level = 1.0; - scheme.time.periods_array[3].start = settings->dusk.end.value; + scheme.time.periods_array[3].start = settings->dusk_end.value; scheme.time.periods_array[3].day_level = 0.0; for (i = 0; i < 4; i++) { j = (i + 1) % 4; diff --git a/src/gamma-coopgamma.c b/src/gamma-coopgamma.c index 6f9edb7..5343e08 100644 --- a/src/gamma-coopgamma.c +++ b/src/gamma-coopgamma.c @@ -362,32 +362,28 @@ static void coopgamma_free(struct gamma_state *state) { free(state->methods); - state->methods = NULL; free(state->method); - state->method = NULL; free(state->site); - state->site = NULL; while (state->n_crtcs--) { state->crtcs[state->n_crtcs].filter.class = NULL; libcoopgamma_filter_destroy(&state->crtcs[state->n_crtcs].filter); libcoopgamma_ramps_destroy(&state->crtcs[state->n_crtcs].plain_ramps); } - state->n_crtcs = 0; free(state->crtcs); - state->crtcs = NULL; libcoopgamma_context_destroy(&state->ctx, 1); while (state->n_outputs--) free(state->outputs[state->n_outputs].edid); state->n_outputs = 0; free(state->outputs); - state->outputs = NULL; + + free(state); } static void -coopgamma_print_help(FILE *f) +coopgamma_print_help(FILE *f) /* TODO not documented in readme and manpage */ { fputs(_("Adjust gamma ramps with coopgamma.\n"), f); fputs("\n", f); diff --git a/src/gamma-drm.c b/src/gamma-drm.c index 2098e0d..1713024 100644 --- a/src/gamma-drm.c +++ b/src/gamma-drm.c @@ -221,7 +221,7 @@ drm_print_help(FILE *f) /* TRANSLATORS: DRM help output left column must not be translated */ fputs(_(" card=N\tGraphics card to apply adjustments to\n" - " crtc=N\tCRTC to apply adjustments to\n"), f); + " crtc=N\tCRTC to apply adjustments to\n"), f); /* TODO list is not supported */ fputs("\n", f); } @@ -232,10 +232,14 @@ drm_set_option(struct gamma_state *state, const char *key, const char *value) if (!strcasecmp(key, "card")) { state->card_num = atoi(value); } else if (!strcasecmp(key, "crtc")) { - state->crtc_num = atoi(value); - if (state->crtc_num < 0) { - weprintf(_("CRTC must be a non-negative integer")); - return -1; + if (!strcasecmp(value, "all")) { + state->crtc_num = -1; + } else { + state->crtc_num = atoi(value); + if (state->crtc_num < 0) { + weprintf(_("CRTC must be a non-negative integer")); + return -1; + } } } else { weprintf(_("Unknown method parameter: `%s'."), key); diff --git a/src/gamma-randr.c b/src/gamma-randr.c index 10ea277..9438d17 100644 --- a/src/gamma-randr.c +++ b/src/gamma-randr.c @@ -287,6 +287,12 @@ randr_set_option(struct gamma_state *state, const char *key, const char *value) /* Check how many crtcs are configured */ const char *local_value = value; + if (!*local_value || !strcasecmp(local_value, "all")) { + state->crtc_num_count = 0; + free(state->crtc_num); + state->crtc_num = NULL; + return 0; + } for (;;) { errno = 0; parsed = strtol(local_value, &tail, 0); diff --git a/src/gamma-w32gdi.c b/src/gamma-w32gdi.c index 6912167..6c9f458 100644 --- a/src/gamma-w32gdi.c +++ b/src/gamma-w32gdi.c @@ -198,4 +198,4 @@ done: } -const struct gamma_method w32gdi_gamma_method = GAMMA_METHOD_INIT("winfdi", 1, 0, w32gdi); +const struct gamma_method w32gdi_gamma_method = GAMMA_METHOD_INIT("wingdi", 1, 0, w32gdi); diff --git a/src/hooks.c b/src/hooks.c index 5412582..be02b18 100644 --- a/src/hooks.c +++ b/src/hooks.c @@ -49,7 +49,7 @@ static size_t dirpathlen; /** * Paths, in order of priority, to test when looking for - * the hooks directory for redshift + * the hook directory for redshift */ static const struct env_path paths[] = { {0, "XDG_CONFIG_HOME", "/redshift-ng/hooks"}, diff --git a/src/redshift.c b/src/redshift.c index ddab891..6e9b627 100644 --- a/src/redshift.c +++ b/src/redshift.c @@ -281,7 +281,9 @@ run_continual_mode(void) { enum period period, prev_period = PERIOD_NONE; double day_level = FNAN, prev_day_level = FNAN; - int disabled = 0, prev_disabled = !disabled; + int disabled = disable, prev_disabled = !disable; + int prev_use_fade = !use_fade; + int prev_preserve_gamma = !preserve_gamma; int done = 0; struct colour_setting colour; struct colour_setting target_colour, prev_target_colour; @@ -292,8 +294,15 @@ run_continual_mode(void) double fade_progress, eased_fade_progress; #ifndef WINDOWS int location_fd; + sigset_t sigusr2_mask, old_mask; + enum signals commands; + + sigemptyset(&sigusr2_mask); + sigaddset(&sigusr2_mask, SIGUSR2); #endif + disable = 0; + prev_target_colour = COLOUR_SETTING_NEUTRAL; colour = COLOUR_SETTING_NEUTRAL; @@ -310,9 +319,49 @@ run_continual_mode(void) break; /* On second signal stop the ongoing fade */ done = 1; } - if (verbose && disabled != prev_disabled) - printf(_("Status: %s\n"), disabled ? _("Disabled") : _("Enabled")); +#ifndef WINDOWS + while (signals) { + if (sigprocmask(SIG_BLOCK, &sigusr2_mask, &old_mask)) + eprintf("sigprocmask:"); + commands = signals; + signals = 0; + + if (commands & SIGNAL_ORDER_BARRIER) sigdelset(&old_mask, SIGUSR2); + if (commands & SIGNAL_DISABLE) disabled = 1; + if (commands & SIGNAL_ENABLE) disabled = 0; + if (commands & SIGNAL_RELOAD) {} /* TODO */ + if (commands & SIGNAL_USE_FADE_OFF) use_fade = 0; + if (commands & SIGNAL_USE_FADE_ON) use_fade = 1; + if (commands & SIGNAL_PRESERVE_GAMMA_OFF) preserve_gamma = 0; + if (commands & SIGNAL_PRESERVE_GAMMA_ON) preserve_gamma = 1; + if (commands & SIGNAL_EXIT_WITHOUT_RESET) {} /* TODO */ + if (commands & SIGNAL_VERBOSE_ON) verbose |= 2; + if (commands & SIGNAL_VERBOSE_OFF) verbose &= ~2; + + if (commands & SIGNAL_IGNORE_SIGPIPE) + if (signal(SIGPIPE, SIG_IGN) == SIG_ERR) + weprintf("signal SIGPIPE SIG_IGN:"); + + if (sigprocmask(SIG_SETMASK, &old_mask, NULL)) + eprintf("sigprocmask:"); + +# if defined(__linux__) + if (commands & SIGNAL_REEXEC) { /* TODO */ + } +# endif + } +#endif + if (verbose) { + if (disabled != prev_disabled) + printf(_("Status: %s\n"), disabled ? _("Disabled") : _("Enabled")); + if (use_fade != prev_use_fade) + printf(_("Fade: %s\n"), use_fade ? _("Disabled") : _("Enabled")); + if (preserve_gamma != prev_preserve_gamma) + printf(_("Preserve gamma: %s\n"), use_fade ? _("Disabled") : _("Enabled")); + } prev_disabled = disabled; + prev_use_fade = use_fade; + prev_preserve_gamma = preserve_gamma; /* Get dayness level and corresponding colour settings */ if (disabled) { @@ -462,8 +511,14 @@ main(int argc, char *argv[]) eprintf(_("Temperature adjustment failed.")); if (mode == PROGRAM_MODE_UNTIL_DEATH || method->autoreset) { weprintf(_("Press ctrl-c to stop...")); - while (!exiting) + while (!exiting) { pause(); + if (signals & SIGNAL_EXIT_WITHOUT_RESET) { + /* TODO disable reset if if using coopgamma */ + goto out; + } + } + /* TODO reset if not using coopgamma */ } break; @@ -477,6 +532,7 @@ main(int argc, char *argv[]) #endif } +out: if (provider_state) provider->free(provider_state); if (method_state) diff --git a/src/signals.c b/src/signals.c index 390d684..cd23773 100644 --- a/src/signals.c +++ b/src/signals.c @@ -22,6 +22,7 @@ volatile sig_atomic_t exiting = 0; volatile sig_atomic_t disable = 0; +volatile enum signals signals = 0; /** @@ -40,19 +41,19 @@ sigexit(int signo) } +#ifndef WINDOWS + /** * Signal handler for disable signal (SIGUSR1) * * @param signo The received signal */ -#ifndef WINDOWS static void sigdisable(int signo) { disable = 1; (void) signo; } -#endif /** @@ -61,7 +62,6 @@ sigdisable(int signo) * * @param signo The received signal */ -#ifndef WINDOWS static void sigalrm(int signo) { @@ -70,6 +70,71 @@ sigalrm(int signo) exiting = 1; alarm(1U); } + + +/** + * Signal handler for SIGUSR2 + * + * @param signo The received signal + * @param info The received signal data + * @param uctx Interrupted stack context + */ +static void +sigipc(int signo, siginfo_t *info, void *uctx) +{ + int set, mask; + sigset_t sigusr2_mask; + + (void) signo; + (void) uctx; + + if (info->si_code != SI_QUEUE) + return; + + switch (info->si_value.sival_int) { + case 1: + case 2: + mask = 3 << 1; + break; + + case 5: + case 6: + mask = 3 << 5; + break; + + case 7: + case 8: + mask = 3 << 7; + break; + + case 11: + case 12: + mask = 3 << 11; + break; + + case 0: + case 3: + case 4: + case 9: + case 10: + mask = 0; + break; + + default: + return; + } + + signals |= set = 1 << info->si_value.sival_int; + signals &= ~mask | set; + + if (set == SIGNAL_ORDER_BARRIER) { + sigemptyset(&sigusr2_mask); + sigaddset(&sigusr2_mask, SIGUSR2); + if (sigprocmask(SIG_BLOCK, &sigusr2_mask, NULL)) + eprintf("sigprocmask:"); + } +} + #endif @@ -89,23 +154,32 @@ install_signal_handlers(void) memset(&sigact, 0, sizeof(sigact)); sigemptyset(&sigset); sigact.sa_mask = sigset; - sigact.sa_flags = 0; + + sigact.sa_flags = SA_NODEFER; sigact.sa_handler = &sigexit; if (sigaction(SIGINT, &sigact, NULL)) - eprintf("sigaction SIGINT &{.sa_handler=<function pointer>, .sa_mask={}, .sa_flags=0} NULL:"); + eprintf("sigaction SIGINT &{.sa_handler=<function pointer>, .sa_mask={}, .sa_flags=SA_NODEFER} NULL:"); if (sigaction(SIGTERM, &sigact, NULL)) - eprintf("sigaction SIGTERM &{.sa_handler=<function pointer>, .sa_mask={}, .sa_flags=0} NULL:"); + eprintf("sigaction SIGTERM &{.sa_handler=<function pointer>, .sa_mask={}, .sa_flags=SA_NODEFER} NULL:"); if (sigaction(SIGQUIT, &sigact, NULL)) - eprintf("sigaction SIGQUIT &{.sa_handler=<function pointer>, .sa_mask={}, .sa_flags=0} NULL:"); + eprintf("sigaction SIGQUIT &{.sa_handler=<function pointer>, .sa_mask={}, .sa_flags=SA_NODEFER} NULL:"); sigact.sa_handler = &sigdisable; if (sigaction(SIGUSR1, &sigact, NULL)) - eprintf("sigaction SIGUSR1 &{.sa_handler=<function pointer>, .sa_mask={}, .sa_flags=0} NULL:"); + eprintf("sigaction SIGUSR1 &{.sa_handler=<function pointer>, .sa_mask={}, .sa_flags=SA_NODEFER} NULL:"); + + sigact.sa_flags = 0; sigact.sa_handler = SIG_IGN; /* cause child processes (hooks) to be reaped automatically */ if (sigaction(SIGCHLD, &sigact, NULL)) eprintf("sigaction SIGCHLD &{.sa_handler=SIG_IGN, .sa_mask={}, .sa_flags=0} NULL:"); + + sigact.sa_flags = SA_SIGINFO; + + sigact.sa_sigaction = &sigipc; + if (sigaction(SIGUSR2, &sigact, NULL)) + eprintf("sigaction SIGUSR2 &{.sa_sigaction=<function pointer>, .sa_mask={}, .sa_flags=SA_SIGINFO} NULL:"); #endif } |