From 24234fed4e48e86b9733fad169c591fc5c6f9d64 Mon Sep 17 00:00:00 2001 From: Jon Lund Steffensen Date: Thu, 11 Feb 2010 23:56:53 +0100 Subject: Update ChangeLog, NEWS and README for release. Increment version in configure.ac. --- README | 49 +++++++++++++++++++++++++++++++++++-------------- 1 file changed, 35 insertions(+), 14 deletions(-) (limited to 'README') diff --git a/README b/README index 8c819fa..e76fb32 100644 --- a/README +++ b/README @@ -1,10 +1,22 @@ -Redshift 1.1 -============ +Redshift +======== -Adjust color temperature of your screen according to your -surroundings. This may help your eyes hurt less if you are working in -front of the screen at night. +Redshift adjusts the color temperature of your screen according to +your surroundings. This may help your eyes hurt less if you are +working in front of the screen at night. + +Download +-------- + +Latest release is redshift 1.2 published on 2010-02-12. There are also +packages available for some distributions: + + * Ubuntu: Packages for Ubuntu Karmic. + * Gentoo: Redshift is in the Sunrise overlay. + +What is it? +----------- The program uses an X server extension to adjust the color temperature. This is done by setting appropriate gamma ramps. If you @@ -23,18 +35,26 @@ room. This is typically a low temperature at around 3000K--4000K the light from outside, typically around 5500K--6500K (default is 5500K). The light has a higher temperature on an overcast day. -The program will continously update the color temperature at regular +How does it work? +----------------- + +Redshift will continously update the color temperature at regular intervals. One shot mode can be selected if you only want to do one -adjustment. +adjustment. The color adjustments done by Redshift can be temporarily +toggled on and off by sending it the USR1 signal: + + $ killall -USR1 redshift The command line options are explained in the following paragraphs. The only required parameter is your current location, all other options have reasonable defaults. + -h Display help message. + -v Verbose output. + -g R:G:B Additional gamma correction to apply. Can also be specified as -g GAMMA to set all channels to the same gamma value. - -h Display help message. -l LAT:LON Your current location in latitudes and longitudes. -m METHOD Method to use to set color temperature (randr or vidmode). Default is randr. In some cases one of the @@ -47,15 +67,16 @@ have reasonable defaults. temperature when the program is started and stopped. -s SCREEN X screen to apply adjustments to. -t DAY:NIGHT Color temperature to set at daytime/night. - -v Verbose output. Example (location is Copenhagen, Denmark): $ redshift -l 55.7:12.6 -t 5700:3600 -g 0.8 -m vidmode -v -To create a status icon for Redshift in the system tray, start the -program gtk-redshift instead of redshift, with the same arguments as -you would pass to redshift. This will create an icon for Redshift in -the system tray. The icon will allow you to toggle Redshift on and -off. Thanks goes to the Tango Desktop Project for the +Status icon +----------- + +Start the program gtk-redshift instead of redshift, with the same +arguments as you would pass to redshift. This will create an icon for +Redshift in the system tray. The icon will allow you to toggle +Redshift on and off. Thanks goes to the Tango Desktop Project for the icon. gtk-redshift requires at least Python 2.4 and PyGTK 2.12. -- cgit v1.2.3-70-g09d2