diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 207 |
1 files changed, 198 insertions, 9 deletions
@@ -8,9 +8,14 @@ NAME redshift - Automatically adjust display colour temperature according the Sun SYNOPSIS - redshift [-b day:night] [-c file] [-g r:g:b] [-m method[:options]] + redshift [-b brightness] [-c file] [-g gamma] [-m method[:options]] [-l latitude:longitude | -l provider[:options]] - [-o | -O temperature | -t day:night | -x] [-pPrv] | -h | -V + [-O temperature | -o | -p | -t temperature | -x] [-P | +P] + [-r | +r] [-dv] + + redshift -h + + redshift -V DESCRIPTION redshift adjusts the colour temperature of your screen according to your @@ -27,7 +32,7 @@ DESCRIPTION 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 higher temperature on an overcast day. + a lower temperature on an overcast day. In addition to the command-line tool redshift, the GUI redshift-gtk provides an alternative interface that shows up as a notification icon @@ -36,17 +41,48 @@ DESCRIPTION OPTIONS The following options are supported: + -b brightness + Synonym for "-b brightness:brightness". + -b day:night Screen brightness to apply at daytime and at nighttime. (Default: 1:1) - The value most be between 0.1 and 1.0. + 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 Load settings from specified configuration file. + -d + Keep the process alive and remove the colour effects + when killed. + + Ignored for -p and -x; always active for -t and the + "quartz" adjustment method. + + -g gamma + Synonym for "-g gamma:gamma". + + -g day:night + Synonym for "-g day:day:day:night:night:night". + -g r:g:b - Additional gamma correction to apply. (Default: 1:1:1) + Synonym for "-g r:g:b:r:g:b". + + -g 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. + + day-r:day-g:day-b or 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 + (:) are omitted. -h Display help message. @@ -78,23 +114,44 @@ OPTIONS before applying the new color temperature. -O temperature - One-shot manual mode (set colour temperature). + This is a synonym for "-O temperature:temperature". + + -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 redshift is + configured to use). + + Values must be at least 1000 and integral. Use this with the -P option to clear the existing gamma ramps before applying the new color temperature. + This is a synonym for "-t day:night -o". + -p Print parameter and exit. -P - Reset exiting gamma ramps before applying new scolour effects. + Reset exiting gamma ramps before applying new colour effects. + + +P + Preserve preexisting gamma adjustments. (Default) -r Disable fading between colour temperatures. + +r + Enable fading between colour temperatures. (Default) + + -t temperature + This is a synonym for "-t temperature:temperature". + -t day:night Colour temperature to set at daytime and at nighttime. + Values must be at least 1000 and integral. + -v Enable verbose output. @@ -104,6 +161,17 @@ OPTIONS -x Remove adjustments from screen. + For mutually exclusive options or options specified multiple times, + the last specified takes effect, except the first specified option + that outputs text (except -p) is used. However, if the daytime + value or nighttime value is omitted for an option, the last previously + specified value will be used; that is, for example, "-t 5000:" and + "-t :3000" do not override each other, but "-t 5000:" overrides, + if specified later, "6000" but not "3000" in "-t 6000:3000". + + Options in the command line override settings from the configuration + file. + OPERANDS None. @@ -126,7 +194,117 @@ ASYNCHRONOUS EVENTS reenable them. STDOUT - TODO + 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 "C" locale. Applications taking use + of this information must make sure to set the message locale to "C". + For floating-point values ("%f") the precision is not documented as + 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 + are printed with the header "Available adjustment methods:\n" followed + by the list in the format + + "%s%s\n", <arbitrary whitespace>, <method name>. + + 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 + printed with the header "Available location providers:\n" followed by + the list in the format + + "%s%s\n", <arbitrary whitespace>, <provider name>. + + The list is terminated by an empty line. Additional information for + human users is printed after the empty line. + + When "-m method:help", "-l provider:help", or "-h" is specified help + information is printed on in unspecified format, intended only for + human users. + + When "-V" is specified, the used version of the program is printed to + the standard output in the format + + "%s %s\n", <implementation name>, <version number>. + + If "-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 + + "Solar elevations: day above %f, night below %f\n", + <minimum solar elevation at daytime>, + <maximum solar elevation at nighttime>. + + This line may be printed, if "-v" is specified, if redshift is + configured. + + 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 + + These lines may be printed, if "-v" is specified, if redshift is + configured. + + If "-v" is specified, the colour settings is printed to the standard + output in the format + + "Temperatures: %luK at day, %luK at night\n" + "Brightness: %f:%f\n" + "Gamma (Daytime): %f, %f, %f\n" + "Gamma (Night): %f, %f, %f\n", + <daytime colour temperature>, <nighttime temperature>, + <daytime whitepoint brightness>, <nighttime brightness>, + <daytime red gamma>, <daytime green gamma>, + <daytime blue gamma>, <nighttime red gamma>, + <nighttime green gamma>, <nighttime blue gamma>. + + Each line may be printed, if "-v" is specified, if redshift is + configured. + + If the colour effects depend on the Sun's elevation, the user's + geographical location will printed to the standard output in the + format + + "Location: %f %c, %f %c\n", + fabs(<GPS latitude>), signbit(<GPS latitude>) ? 'S' : 'N', + fabs(<GPS longitude>), signbit(<GPS longitude>) ? 'W' : 'E'. + + This message is printed when the program starts and any time the + location is updated. + + If the colour effects are non-static, the current period of the day + (which determine the colour effects) is printed to standard output, + if "-v" or "-p" is specified, in the format + + "Period: %s\n", <period> + + where <period> is "None", "Daytime", or "Night", or in the format + + "Period: Transition (%f%% day)", <dayness level>. + + <dayness level> is exclusively between 0 (night) and 1 (daytime). + + This message is printed when the program starts and any time it + changes (if "-v" is specified). + + If "-v" or "-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: + + "Color temperature: %luK\n", <colour temperature>; + + "Brightness: %f\n", <whitepoint brightness level (0-1)>; + + "Gamma: %f, %f, %f\n", <red gamma>, <green gamma>, <blue gamma>. + + 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), + to the standard output in the format + + "Temperature: %lu\n", <colour temperature>. STDERR Default. @@ -172,7 +350,7 @@ EXTENDED DESCRIPTION gamut, and thus incorrect even on sRGB monitors. EXIT STATUS - TODO + Default. EXAMPLES TODO @@ -228,6 +406,17 @@ KNOWN ISSUES applications that apply different effects. However coopgammad 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 + 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. + RATIONALE To prevent the user from accidental making the screen black, brightness level below 0.1 are forbidden. |