From 59f50395d29d7809a31716b1bdefea8005a790ae Mon Sep 17 00:00:00 2001 From: giraffedata Date: Tue, 2 Sep 2014 03:19:37 +0000 Subject: Improve comments git-svn-id: http://svn.code.sf.net/p/netpbm/code/trunk@2264 9d0c8265-081b-0410-96cb-a4ca84ce46f8 --- pm_config.in.h | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) (limited to 'pm_config.in.h') diff --git a/pm_config.in.h b/pm_config.in.h index 758f0612..d282cab7 100644 --- a/pm_config.in.h +++ b/pm_config.in.h @@ -54,10 +54,25 @@ #endif -/* CONFIGURE: If you have an X11-style rgb color names file, define its -** path here. This is used by PPM to parse color names into rgb values. -** If you don't have such a file, comment this out and use the alternative -** hex and decimal forms to specify colors (see ppm/pgmtoppm.1 for details). */ +/* CONFIGURE: This is the name of an environment variable that tells +** where the color names database is. If the environment variable isn't +** set, Netpbm tries the hardcoded defaults per macro 'RGB_DB_PATH' +** (see below). +*/ +#define RGBENV "RGBDEF" /* name of env-var */ + +/* CONFIGURE: There should be an environment variable telling where the color +** names database (color dictionary) is for Netpbm to use, e.g. to determine +** what colord name "Salmon" is. The name of that environment variable is +** above. But as some people prefer hardcoded file paths to environment +** variables, if such environment variable is not set, Netpbm looks for the +** first existing file in the list which is the value of 'RGB_DB_PATH'. And +** if none of those exist (including if the list is empty), Netpbm simply +** doesn't understand any color names. Note that Netpbm comes with a color +** database (lib/rgb.txt in the source tree), but you might choose to have +** Netpbm use a different one. See the documentation of ppm_parsecolor() +** for the format of the color database file. +*/ #define RGB_DB_PATH \ "/usr/share/netpbm/rgb.txt:" \ @@ -65,12 +80,6 @@ "/usr/share/X11/rgb.txt:" \ "/usr/X11R6/lib/X11/rgb.txt" -/* CONFIGURE: This is the name of an environment variable that tells -** where the color names database is. If the environment variable isn't -** set, Netpbm tries the hardcoded defaults set above. -*/ -#define RGBENV "RGBDEF" /* name of env-var */ - #if (defined(SYSV) || defined(__amigaos__)) #include -- cgit 1.4.1