summaryrefslogtreecommitdiff
path: root/doc/Environment.html
blob: a3195134cd7625458bfd84b1ca84f818ec628873 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html;
      charset=ISO-8859-1">
    <meta http-equiv="content-type" content="text/html;
      charset=ISO-8859-1">
    <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I)
      [Netscape]">
    <title>Argyll Environment Variables</title>
  </head>
  <body>
    <br>
    <h2> <u>Environment variables<br>
      </u></h2>
    The following environment variables affect behaviour:<br>
    <br>
    <span style="font-weight: bold;">ARGYLL_NOT_INTERACTIVE</span><br>
    <br>
    <div style="margin-left: 40px;">Normally Argylls tools expect that
      they are directly interacting with a user, and use a couple of
      techniques for communicating with them through the command line.
      One is to output progress information by re-writing the same
      display line by using a Carriage Return rather than a Line Feed at
      the end of each line. Another is to allow a single key stroke to
      trigger an action or interrupt operations.<br>
      <br>
      If the <span style="font-weight: bold;">ARGYLL_NOT_INTERACTIVE</span>
      environment variable is set, then:<br>
      <br>
      &nbsp;&nbsp;&nbsp; A Line Feed will be added to the end of each
      progress line.<br>
      <br>
      &nbsp;&nbsp;&nbsp; Any time it would wait for a single keystroke
      input, it will instead wait for and read the next character from
      stdin.<br>
      &nbsp;&nbsp;&nbsp; To facilitate flushing stdin, any return or
      line feed characters will be ignored, so a character other than
      return or line feed must be used to trigger activity.<br>
      <br>
      &nbsp;&nbsp;&nbsp; Note that while a reading is being made, a
      character input can abort the reading, just as with normal
      interactive mode.<br>
    </div>
    <span style="font-weight: bold;"></span><br>
    <span style="font-weight: bold;">ARGYLL_COLMTER_CAL_SPEC_SET</span><br>
    <span style="font-weight: bold;">ARGYLL_COLMTER_COR_MATRIX</span><br>
    <br>
    <div style="margin-left: 40px;">Both of these can be used to set a
      default <span style="font-weight: bold;">CCMX</span> or <span
        style="font-weight: bold;">CCSS</span> colorimeter calibration
      file, equivalent to supplying a <span style="font-weight: bold;">-X</span>
      argument to spotread, dispcal, dispread and any other utility that
      allows using a colorimteter. The ARGYLL_COLMTER_CAL_SPEC_SET will
      take priority if both are set.<br>
      <br>
    </div>
    <br>
    <span style="font-weight: bold;">ARGYLL_MIN_DISPLAY_UPDATE_DELAY_MS<br>
      <br>
    </span>
    <div style="margin-left: 40px;"><span style="font-weight: bold;"><span
          style="font-weight: bold;"><span style="font-weight: bold;"></span></span></span>Normally

      a delay of 200 msec is allowed between changing a patch color on a
      display, and reading the color with an instrument, although some
      instruments (ie. i1d3) will automatically measure and set an
      appropriate delay during instrument calibration. In rare
      situations this delay may not be sufficient (ie. some TV's with
      extensive image processing features turned on), and a larger delay
      can be set using the <span style="font-weight: bold;"><span
          style="font-weight: bold;"><span style="font-weight: bold;"></span></span></span>ARGYLL_MIN_DISPLAY_UPDATE_DELAY_MS

      environment variable, ie. ARGYLL_MIN_DISPLAY_UPDATE_DELAY_MS=400
      would set a 400 msec minimum delay.<br>
    </div>
    <span style="font-weight: bold;"><br>
      ARGYLL_IGNORE_XRANDR1_2<br>
      <br>
    </span>
    <div style="margin-left: 40px;">On an X11 system, if this is <span
        style="font-weight: bold;"></span>set (ie. set it to "yes"),
      then the presence of the XRandR 1.2 extension will be ignored, and
      other extensions such as Xinerama and XF86VidMode extension will
      be used. This may be a way to work around buggy XRandR 1.2
      implementations.<br>
      <br>
    </div>
    <span style="font-weight: bold;">ARGYLL_DISABLE_I1PRO2_DRIVER<br>
      <br>
    </span>
    <div style="margin-left: 40px;">There is now partial support for the
      Eye-One Pro Rev E (aka Eye-One Pro 2) instrument, 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>
    </div>
    <span style="font-weight: bold;"></span><br>
    <span style="font-weight: bold;">XDG_CACHE_HOME<br>
      <span style="font-weight: bold;"><br>
      </span></span>
    <div style="margin-left: 40px;">Argyll tries to follow the <a
href="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG

        Base Directory Specification</a>, and uses the <span
        style="font-weight: bold;">XDG_CACHE_HOME</span> environment
      variable to place per instrument calibration information (Eye-One
      Pro and ColorMunki instruments).<br>
    </div>
    <br>
    <span style="font-weight: bold;">XDG_CONFIG_DIRS<br>
      XDG_DATA_DIRS<span style="font-weight: bold;"><br>
        <span style="font-weight: bold;"></span></span></span><br>
    <div style="margin-left: 40px;">On Unix type operating systems,
      configuration and profiles for displays are placed relative to
      these environment variables.<br>
    </div>
    <br>
    &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp; <br>
    <br>
    See <a href="Performance.html">Performance Tuning</a> for other
    variables.<br>
    <br>
    <br>
  </body>
</html>