diff options
Diffstat (limited to 'doc/Environment.html')
| -rw-r--r-- | doc/Environment.html | 258 |
1 files changed, 237 insertions, 21 deletions
diff --git a/doc/Environment.html b/doc/Environment.html index b4cd9ca..c4c1aed 100644 --- a/doc/Environment.html +++ b/doc/Environment.html @@ -10,9 +10,53 @@ <title>Argyll Environment Variables</title> </head> <body> + <h2><u>Setting an environment variable</u></h2> + To set an environment variable an MSWindows DOS shell, either + use set, e.g.;<br> <br> - <h2> <u>Environment variables<br> - </u></h2> + set ARGYLL_REV_CACHE_MULT=1.5<br> + <br> + which will set the value for that session, or set it in<br> + <br> + Control Panel->System->Advanced->Environment Variables..<br> + <br> + in either user or system variables.<br> + <br> + You can examine individual variables using<br> + <br> + echo %VARIABLE_NAME%<br> + <br> + or see all of them using<br> + <br> + set<br> + <br> + <br> + For OS X or Linux, the exact procedure will depend on the shell you + are running, but<br> + is usually something like:<br> + <br> + export ARGYLL_REV_CACHE_MULT=1.5<br> + or<br> + set ARGYLL_REV_CACHE_MULT=1.5<br> + or<br> + ARGYLL_REV_CACHE_MULT=1.5<br> + <br> + and may need separately exporting, something like:<br> + <br> + export ARGYLL_REV_CACHE_MULT<br> + <br> + Generally it should be configured in the shell start-up + script, if you want the setting to be used<br> + for every session.<br> + <br> + You can examine individual variables using<br> + <br> + echo $VARIABLE_NAME<br> + <br> + or see all of them using<br> + <br> + set<br> + <h2><u>Environment variables</u></h2> The following environment variables affect behaviour:<br> <br> <span style="font-weight: bold;"><a name="ARGYLL_NOT_INTERACTIVE"></a>ARGYLL_NOT_INTERACTIVE</span><br> @@ -45,6 +89,14 @@ Note that on MSWin systems, the character and return or line fee characters must be written to stdin in a single operation (i.e. testing <span style="font-weight: bold;">ARGYLL_NOT_INTERACTIVE + + + + + + + + </span>mode manually will probably fail, because the character and return get split up.)<br> </div> @@ -58,12 +110,28 @@ + + + + + + + + </b>or <b>X3DOM</b>, which will result in <b>.wrl</b>, <b>.x3d</b> and <b>.x3d.html</b> files respectively. See <a href="3dformat">3d + + + + + + + + Viewing Format</a>.<br> </blockquote> <b><br> @@ -97,6 +165,14 @@ a + + + + + + + + delay of 200 msec is allowed between changing a patch color in software, and that change appearing in the displayed color itself. For some instuments (ie. i1d3, i1pro, ColorMunki, Klein K10-A) @@ -116,6 +192,14 @@ environment + + + + + + + + variable, ie. ARGYLL_MIN_DISPLAY_UPDATE_DELAY_MS=400 would set a 400 msec minimum delay.<br> <span style="font-weight: bold;"><br> @@ -158,19 +242,19 @@ environment as being recommended practice in modelling chromatic adaption. The ICC profile format though, specifies the use of a non-cone space XYZ adaptation (so called "Wrong Von Kries" - chromatic adaptation) [ ICC Specification<br> - ICC.1:2001-04 (ICCV2.4) Annex A, pp 66, equations A.1, A.2 & - A.3 ], so ArgyllCMS profiles have a very slight incompatibility - with ICC profiles created strictly according to the ICC - specifications, depending on how close to white Output (i.e. - print) profiles media white is to the perfect diffuser. (Note that - CMM's that strictly follow the ICC specifications have much more - gross incompatibilities due to this, when dealing with the HP - & Microsoft sRGB and AdobeRGB profiles.) By setting this - environment variable, Output (i.e. print) profiles will be created - that better conform to the ICC specification, and therefore - have better inter-interoperability with some other CMMs, at the - cost of poorer color behavior.<br> + chromatic adaptation) [ ICC Specification ICC.1:2001-04 (ICCV2.4) + Annex A, pp 66, equations A.1, A.2 & A.3 ], so ArgyllCMS + profiles have a very slight incompatibility with ICC profiles + created strictly according to the ICC specifications, depending on + how close to white Output (i.e. print) profiles media white is to + the perfect diffuser. (Note that CMM's that strictly follow the + ICC specifications have much more gross incompatibilities due to + this, when dealing with the HP & Microsoft sRGB and AdobeRGB + profiles.) By setting this environment variable, Output (i.e. + print) profiles will be created that better conform to the ICC + specification, and therefore have better + inter-interoperability with some other CMMs, at the cost of poorer + color behavior.<br> See also the <a href="ArgyllCMS_arts_tag.html">ArgyllCMS 'arts' tag</a>.<br> <span style="font-weight: bold;"><span style="font-weight: bold;"><span @@ -199,7 +283,7 @@ environment later on with the introduction of the ChromaticAdapation ('chad') tag, but this did not restore the Absolute Colorimetric capability to Display profiles. The latter approach has also been adopted - more formally in the ICC V4 specifications. To improve restore the + more formally in the ICC V4 specifications. To restore the Absolute Intent for such profiles, ArgyllCMS will make use of the 'chad' tag in such profiles when Absolute Colorimetric intent is requested, but by default does not create such profiles. Setting @@ -209,8 +293,117 @@ environment D50 matrix in the 'chad' tag. (This approach has slightly poorer accuracy for Absolute Intent than ArgyllCMS's default.) <br> </blockquote> + <br> <span style="font-weight: bold;"><span style="font-weight: bold;"><span - style="font-weight: bold;"><a + style="font-weight: bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><a + name="ARGYLL_CREATE_OUTPUT_PROFILE_WITH_CHAD"></a>ARGYLL_CREATE_OUTPUT_PROFILE_WITH_CHAD<br> + </span></span></span></span></span></span></span></span></span></span></span></span> + <blockquote>For Output type devices (i.e. Printers), the assumption + is that test patches are measured under D50 illuminant. It can be + very useful for proofing to calculate color corrections for other, + real world illuminants, and ArgyllCMS makes provision for this + with the <a href="colprof.html#i">coloprof -i</a> parameter, or + the <a href="spec2cie.html#i">spec2cie -i</a> parameter. To be + broadly useful, this change in illuminant needs to be available to + CMM's, which the ArgyllCMS's implementation makes possible by + incorporating the illuminant change into the absolute XYZ values + and hence the white point tag, so that Absolute Colorimetric + rendering intent returns XYZ values under that illuminant using + any CMM.<br> + <br> + The ICC specification have provision for hiding this difference in + illuminant by chromatically transforming the absolute values to be + functionally equivalent to having been measured using a D50 + illuminant, and recording this transform in the ChromaticAdapation + ('chad') tag. This appears to motivated by the assumption that the + difference in illuminant is a quirk or limitation of the + instrument that is to be worked around, as well as the limitation + of the ICC Absolute to Relative chromatic transformation being + based on the inferior non-cone space XYZ adaptation (so called + "Wrong Von Kries" chromatic adaptation), while the + ChromaticAdapation tag allows for the use of a superior cone-space + based transformation. (see <span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;">ARGYLL_CREATE_WRONG_VON_KRIES_OUTPUT_CLASS_REL_WP</span></span></span></span></span></span></span></span></span></span></span></span><span + style="font-weight: bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"> </span></span></span></span></span></span></span></span></span></span></span></span>above + for more details.)<span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"> <br> + <br> + </span></span></span></span></span></span></span></span></span></span></span></span>To + allow for strict conformance to the ICC specification when using + non-standard illuminants, setting the <span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;">ARGYLL_CREATE_OUTPUT_PROFILE_WITH_CHAD + </span></span></span></span></span></span></span></span></span></span></span></span>environment + variable causes a non-D50 illuminant white point change to be + hidden in the ChromaticAdapation Tag, and to still allow this to + be useful in a proofing situation, ArgyllCMS will incorporate the + effect of the ChromaticAdapation Tag when Absolute Colorimetric + Intent is chosen. Note that other CMM's may not do. For full + conformance with ICC specifications, the <span + style="font-weight: bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;">ARGYLL_CREATE_WRONG_VON_KRIES_OUTPUT_CLASS_REL_WP</span></span></span></span></span></span></span></span></span></span></span></span> + variable would also be set, but neither of these options is + recommended, since ArgyllCMS's default behavior will give superior + results.<span style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"><br> + </span></span></span></span></span></span></span></span></span></span></span></span></blockquote> + <span style="font-weight: bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span style="font-weight: + bold;"><span style="font-weight: bold;"><span + style="font-weight: bold;"><span + style="font-weight: bold;"></span></span></span></span></span></span></span></span></span><a name="ARGYLL_CCAST_DEFAULT_RECEIVER"></a>ARGYLL_CCAST_DEFAULT_RECEIVER<br> </span></span></span> <blockquote>By default the ChromeCast test patch source uses a @@ -236,12 +429,27 @@ environment name="ARGYLL_DISABLE_I1PRO2_DRIVER"></a>ARGYLL_DISABLE_I1PRO2_DRIVER<br> <br> </span> - <div style="margin-left: 40px;">There is now support for most of the - the Eye-One Pro Rev E (aka Eye-One Pro 2) instrument features, but - a Rev E can be operated in legacy mode if the environment variable + <div style="margin-left: 40px;">ArgyllCMS supports most of the the + Eye-One Pro Rev E (aka Eye-One Pro 2) instrument features, but a + Rev E can be operated in legacy mode if the environment variable ARGYLL_DISABLE_I1PRO2_DRIVER is set (ie. set it to "yes").<br> + <br> </div> - <span style="font-weight: bold;"></span><br> + <span style="font-weight: bold;"></span><span style="font-weight: + bold;"><a name="ARGYLL_XRGA"></a>ARGYLL_XRGA</span><br> + <blockquote>If the <span style="font-weight: bold;">ARGYLL_XRGA </span> + environment variable is set to:<br> + <br> + <b>XRGA</b>, then all Getag-MacBeth/X-Rite + reflective measurements will be converted to XRGA.<br> + <b> XRDI</b>, then all Getag-MacBeth/X-Rite + reflective measurements will be converted to XRDI.<br> + <b> GMDI</b>, then all Getag-MacBeth/X-Rite + reflective measurements will be converted to GMDI.<br> + <br> + If not set (or set to some other string), then the native + calibration will be used. Note that the values must be upper case.<br> + </blockquote> <span style="font-weight: bold;"><a name="XDG_CACHE_HOME"></a>XDG_CACHE_HOME<br> <span style="font-weight: bold;"><br> </span></span> @@ -257,6 +465,14 @@ Base + + + + + + + + Directory Specification</a>, and uses the <span style="font-weight: bold;">XDG_CACHE_HOME</span> environment variable to place per instrument calibration information, and |