From f5b396dd73ea28506286e0be09d5e76e802222a2 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 6 Oct 2019 14:54:42 +0200 Subject: Simplify MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- man/libred.h.0 | 152 --------------------------------------------------------- 1 file changed, 152 deletions(-) delete mode 100644 man/libred.h.0 (limited to 'man/libred.h.0') diff --git a/man/libred.h.0 b/man/libred.h.0 deleted file mode 100644 index 95a5144..0000000 --- a/man/libred.h.0 +++ /dev/null @@ -1,152 +0,0 @@ -.\" -*- nroff -*- -.TH LIBRED.H 0 LIBRED "" "Library Headers" -.SH NAME -libred.h \- Solar elevation and blackbody colour calculation -.SH SYNOPSIS -.nf -#include -.fi -.PP -Link with -.IR -lred . -.SH DESCRIPTION -The -.I -header defines macros, symbolic constants, and functions for -calculating solar elevations and blackbody colours. All macros -and symbolic constants in this header are suitable for use in -.B #if -preprocessing directives. -.PP -This header defines the follow symbolic constants: -.TP -.B LIBRED_SOLAR_APPARENT_RADIUS -The approximate apparent size of the Sun in degrees. This -value should be about 0.5(3). -.TP -.B LIBRED_SOLAR_ELEVATION_SUNSET_SUNRISE -The Sun's elevation at sunset and sunrise, measured in degrees. -This value will always be 0.0. -.TP -.B LIBRED_SOLAR_ELEVATION_CIVIL_DUSK_DAWN -The Sun's elevation at civil dusk and civil dawn, measured in -degrees. This value will always be -6.0. -.TP -.B LIBRED_SOLAR_ELEVATION_NAUTICAL_DUSK_DAWN -The Sun's elevation at nautical dusk and nautical dawn, measured -in degrees. This value will always be -12.0. -.TP -.B LIBRED_SOLAR_ELEVATION_ASTRONOMICAL_DUSK_DAWN -The Sun's elevation at astronomical dusk and astronomical dawn, -measured in degrees. This value will always be -18.0. -.TP -.B LIBRED_HIGHEST_TEMPERATURE -The highest temperature, in kelvins, for which there is a colour -temperature in the table of colour temperature. Any temperature -above this is automatically truncated by -.BR libred_get_colour (3), -as higher values shall be unnoticeable. Currently, this value -is 40\ 000. -.TP -.B LIBRED_LOWEST_TEMPERATURE -The lowest temperature, in kelvins, for which there is a colour -temperature in the table of colour temperature. Any temperature -below this results in -.BR libred_get_colour (3) -failing and setting -.B errno -to -.BR EDOM . -Currently this value 1000, hypothetical changes will be very small. -.TP -.B LIBRED_DELTA_TEMPERATURE -The temperatures differences between sequential colour temperatures -in the colour temperatures look up table. Currently this value is 100. -.PP -This header defines the follow macros: -.TP -.BR LIBRED_IS_TWILIGHT "(const double)" -Evaluates to 1 if the given expression is between -18.0 and 0.0 (this is, -between -.B LIBRED_SOLAR_ELEVATION_ASTRONOMICAL_DUSK_DAWN -and -.BR LIBRED_SOLAR_ELEVATION_SUNSET_SUNRISE ), -inclusively, otherwise, this macro evaluates to 0. The input should be the -Sun's apparent elevation, and the macro evaluates to 1 if it is currently -twilight. The given expression is evaluted either once or twice, therefore, -it must not have side-effects. -.TP -.BR LIBRED_IS_CIVIL_TWILIGHT "(const double)" -Evaluates to 1 if the given expression is between -6.0 and 0.0 (this is, -between -.B LIBRED_SOLAR_ELEVATION_CIVIL_DUSK_DAWN -and -.BR LIBRED_SOLAR_ELEVATION_SUNSET_SUNRISE ), -inclusively, otherwise, this macro evaluates to 0. The input should be the -Sun's apparent elevation, and the macro evaluates to 1 if it is currently -civil twilight. The given expression is evaluted either once or twice, -therefore, it must not have side-effects. -.TP -.BR LIBRED_IS_NAUTICAL_TWILIGHT "(const double)" -Evaluates to 1 if the given expression is between -12.0 and -6.0 (this is, -between -.B LIBRED_SOLAR_ELEVATION_NAUTICAL_DUSK_DAWN -and -.BR LIBRED_SOLAR_ELEVATION_CIVIL_DUSK_DAWN ), -inclusively, otherwise, this macro evaluates to 0. The input should be the -Sun's apparent elevation, and the macro evaluates to 1 if it is currently -nautical twilight. The given expression is evaluted either once or twice, -therefore, it must not have side-effects. -.TP -.BR LIBRED_IS_ASTRONOMICAL_TWILIGHT "(const double)" -Evaluates to 1 if the given expression is between -18.0 and -12.0 (this is, -between -.B LIBRED_SOLAR_ELEVATION_ASTRONOMICAL_DUSK_DAWN -and -.BR LIBRED_SOLAR_ELEVATION_NAUTICAL_DUSK_DAWN ), -inclusively, otherwise, this macro evaluates to 0. The input should be the -Sun's apparent elevation, and the macro evaluates to 1 if it is currently -astronomical twilight. The given expression is evaluted either once or twice, -therefore, it must not have side-effects. -.PP -Note that the intervals are closed, and hence their boundaries overlap. -This is intentional. If it is not twilight it is either daytime or night. -It is night only if the Sun's apparent elevation is negative. -.PP -This header defines the following functions: -.TP -* -.BR libred_solar_elevation (3) -.TP -* -.BR libred_check_timetravel (3) -.TP -* -.BR libred_init_colour (3) -.TP -* -.BR libred_term_colour (3) -.TP -* -.BR libred_get_colour (3) -.PP -This header may define -.B extern int libred_fd -iff it does it also defines the macro -.BR LIBRED_HAVE_FD . -If it does, you want to keep this file descriptor open when you daemonise -your process. It is set by -.BR libred_init_colour (3) -and unset by -.BR libred_term_colour (3). -It value is negative (more precisely it is -1) if no file descriptor has -been opened. -.SH "FUTURE DIRECTIONS" -None. -.SH "SEE ALSO" -.BR libred (7), -.BR libred_solar_elevation (3), -.BR libred_check_timetravel (3), -.BR libred_init_colour (3), -.BR libred_term_colour (3), -.BR libred_get_colour (3) -- cgit v1.2.3-70-g09d2