summaryrefslogtreecommitdiff
path: root/doc/Installing_OSX.html
blob: 1d7bb8d2387aa481254c7ff814ed8fa0551bac01 (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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html;
      charset=windows-1252">
    <meta http-equiv="content-type" content="text/html;
      charset=windows-1252">
    <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I)
      [Netscape]">
    <title>Argyll Installation on Apple OS X</title>
  </head>
  <body>
    <h1> <u>Installing the software on Apple OS X<br>
      </u></h1>
    <br>
    You will need to unpack the downloaded file in such a way that the
    files it contains end up in the location you have chosen to hold its
    contents.<br>
    <br>
    If you want to install it system wide, then you probably want to
    unpack it in the <i>/Applications</i> folder, so that it ends up in
    the <i>/Applications/Argyll_VX.X.X</i> folder.<br>
    Another option is just to install it somewhere under your $HOME
    folder, such as <span style="font-style: italic;">$HOME/</span><i>Argyll_VX.X.X</i>
    or <span style="font-style: italic;">$HOME/</span><i>bin/Argyll_VX.X.X</i>,
    depending on how you like to organize your applications and utility
    programs. ($HOME is the shell symbolic name for your home folder,
    typically /Users/<i>username</i>. Another abbreviation for it is the
    ~ character.)<br>
    <br>
    You can unpack it by control-click on the downloaded file and “Open
    With” BOMArchiveHelper or Archive Utility. Drag the resulting folder
    to where you want it, e.g. into <i>/Applications</i>, <i>$HOME</i>
    or <i>$HOME/bin</i>.<br>
    <br>
    Alternatively you can unpack it on the command line using&nbsp; the
    command <span style="font-weight: bold;">tar -zxf</span> <span
      style="font-weight: bold;">archivename.tgz</span>, which will
    create a folder <span style="font-weight: bold;">Argyll_VX.X.X</span>
    in your current folder, where X.X.X is the version number, and the
    executables will be in <span style="font-weight: bold;">Argyll_VX.X.X/bin</span>
    sub-folder.<br>
    <br>
    Open a Terminal shell. This will be in
    Applications-&gt;Utilities-&gt;Terminal (Dragging it to the dock is
    a good idea to make it more accessible).<br>
    <br>
    You should configure your $PATH environment variable to give the
    shell access to the executable from your command line environment
    without having to spell out the whole path every time, by editing
    your <span style="font-weight: bold;">.profile</span> file, which
    will be in your $HOME folder. You can open a graphical editor on
    this file by using the open command:<br>
    <br>
    &nbsp; open $HOME/.profile<br>
    <br>
    or alternatively, use some other text editor that you are familiar
    with.<br>
    <br>
    Add a line similar to the following line to your .profile file:<br>
    <br>
    &nbsp; PATH=$PATH:/Applications/Argyll_VX.X.X/bin<br>
    <br>
    where "/Applications/Argyll_VX.X.X/bin" is the path to the folder
    that contains the ArgyllCMS executables.<br>
    Save your changes and exit the editor.<br>
    <br>
    If you want further guidance in setting up and using a command line
    environment, then please consult an appropriate tutorial, e.g. &lt;<a
href="http://heather.cs.ucdavis.edu/matloff/public_html/UnixAndC/Unix/ShellIntro.pdf">ShellIntro</a>&gt;.<br>
    <br>
    The .tgz file also contains several useful reference files (such as
    scanner chart recognition templates, sample illumination spectrum
    etc.) in the <b>ref</b> sub-folder, as well as all the current
    documentation in a <b>doc</b> sub-folder.<br>
    <br>
    For most devices there is nothing special to do. Plug in and go.
    Some devices may not work without some extra help though:<br>
    <h3><a name="ColorMunki"></a><span style="text-decoration:
        underline;">X-Rite ColorMunki</span></h3>
    Some version of X-Rite's ColorMunki drivers released between 2009
    and 2011 install an X-Rite daemon that runs as root and grabs the
    device, preventing any other programs (such as Argyll) from opening
    them. Latter versions seem to be more cooperative, and don't suffer
    from this problem. There are three ways of working around this
    problem:<br>
    <br>
    1) Turn off the X-Rite service for the ColorMunki. See &lt;<a
      class="moz-txt-link-freetext"
href="http://www.xrite.com/product_overview.aspx?ID=1161&amp;Action=support&amp;SupportID=4980">http://www.xrite.com/product_overview.aspx?ID=1161&amp;Action=support&amp;SupportID=4980</a>&gt;.<br>
    <br>
    2) Run all Argyll programs that need to access the instrument as
    root. For instance:<br>
    <br>
    &nbsp;&nbsp;&nbsp; sudo spotread<br>
    <br>
    and then you will be asked for the root password.<br>
    While these methods will work, they are inconvenient. <br>
    <br>
    3) Alter the X-Rite drivers Daeomon so that it runs under your user
    account.<br>
    <br>
    To do this you need to edit the script that controls the X-Rite
    Daemon.<br>
    <br>
    &nbsp;&nbsp;&nbsp; cd ~<br>
    &nbsp;&nbsp;&nbsp; whoami<br>
    &nbsp;&nbsp;&nbsp; cp
    /Library/LaunchDaemons/com.xrite.device.colormunki.plist temp.plist<br>
    &nbsp;&nbsp;&nbsp; open temp.plist<br>
    <br>
    and add one child below the root:<br>
    <br>
    &nbsp;&nbsp;&nbsp; <span style="text-decoration: underline;">Item&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;










      Value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
    </span><br>
    &nbsp;&nbsp;&nbsp; UserName &nbsp;
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;










    myusername<br>
    <br>
    where "myusername" is your username shown by whoami, and save the
    file. You then need to copy the modified file back: <br>
    <br>
    &nbsp;&nbsp;&nbsp; sudo cp temp.plist
    /Library/LaunchDaemons/com.xrite.device.colormunki.plist<br>
    <br>
    You will then need to restart the machine for this change to take
    effect, or invoke the following commands:<br>
    <br>
    &nbsp;&nbsp; sudo launchctl unload
    /Library/LaunchDaemons/com.xrite.device.colormunki.plist<br>
    &nbsp;&nbsp; sudo launchctl load
    /Library/LaunchDaemons/com.xrite.device.colormunki.plist<br>
    <br>
    <span style="font-weight: bold;">NOTE</span> that after running
    Argyll tools, you may have to turn the X-Rite service off then on
    again, or disconnect and reconnect the instrument.<br>
    <br>
    <h3><a name="ColorMunki"></a><span style="text-decoration:
        underline;">X-Rite EyeOne Pro</span><br>
    </h3>
    Some version of X-Rite's EyeOne Pro drivers drivers released between
    2009 and 2011 install an X-Rite daemon that runs as root and grabs
    the device, preventing any other programs (such as Argyll) from
    opening them. Latter versions seem to be more cooperative, and don't
    suffer from this problem. There are three ways of working around
    this problem:<br>
    <br>
    1) Turn off the X-Rite service for the EyeOne Pro. See &lt;<a
      class="moz-txt-link-freetext"
href="http://www.xrite.com/product_overview.aspx?ID=1161&amp;Action=support&amp;SupportID=4980">http://www.xrite.com/product_overview.aspx?ID=1161&amp;Action=support&amp;SupportID=4980</a>&gt;.<br>
    <br>
    2) Run all Argyll programs that need to access the instrument as
    root. For instance:<br>
    <br>
    &nbsp;&nbsp;&nbsp; sudo spotread<br>
    <br>
    and then you will be asked for the root password.<br>
    While these methods will work, they are inconvenient. <br>
    <br>
    3) Alter the X-Rite drivers Daemon so that it runs under your user
    account.<br>
    <br>
    To do this you need to edit the script that controls the X-Rite
    Daemon.<br>
    <br>
    &nbsp;&nbsp;&nbsp; cd ~<br>
    &nbsp;&nbsp;&nbsp; whoami<br>
    &nbsp;&nbsp;&nbsp; cp
    /Library/LaunchDaemons/com.xrite.device.i1.plist temp.plist<br>
    &nbsp;&nbsp;&nbsp; open temp.plist<br>
    <br>
    and add one child below the root:<br>
    <br>
    &nbsp;&nbsp;&nbsp; <span style="text-decoration: underline;">Item&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;










      Value&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
    </span><br>
    &nbsp;&nbsp;&nbsp; UserName &nbsp;
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;










    myusername<br>
    <br>
    where "myusername" is your username shown by whoami, and save the
    file. You then need to copy the modified file back: <br>
    <br>
    &nbsp;&nbsp;&nbsp; sudo cp temp.plist
    /Library/LaunchDaemons/com.xrite.device.i1.plist<br>
    <br>
    You will then need to restart the machine for this change to take
    effect, or invoke the following commands:<br>
    <br>
    &nbsp;&nbsp; sudo launchctl unload
    /Library/LaunchDaemons/com.xrite.device.i1.plist<br>
    &nbsp;&nbsp; sudo launchctl load
    /Library/LaunchDaemons/com.xrite.device.i1.plist<br>
    <br>
    <span style="font-weight: bold;">NOTE</span> that after running
    Argyll tools, you may have to turn the X-Rite service off then on
    again, or disconnect and reconnect the instrument.<br>
    <br>
    <h3><a name="specbos"></a><span style="text-decoration: underline;">JETI
specbos










        1201 and 1211</span> and <u>Klein K10A</u><br>
    </h3>
    <br>
    If you are using the <b>JETI</b> specbos <b>1211</b><b>,&nbsp;</b><b>1201</b><b>,
      1511, 1501</b> and the <b>Klien K10A</b> then you may need to
    install the <a href="http://www.ftdichip.com/Drivers/VCP.htm">FTDI
      Virtual COM Port Drivers</a> (VCP), if they are not already on
    your system. You may have to update to the latest FTDI driver to
    work with the FTDI FT231XS chip that the <b>JETI</b> specbos <b>1511,
      1501</b> use.<br>
    <h3><a name="HCFR"></a><u>HCFR Colorimeter</u></h3>
    The default OS X class drivers will grab this device, preventing
    Argyll from accessing it. To overcome this, you need to install a
    codeless kernel extension if you wish to use the HCFR colorimeter,
    that prevents this from happening. From the command line you need to
    create a folder called Argyll.kext somewhere convenient, and then
    place in it one file called Info.plist, containing the following:<br>
    <br>
    &nbsp;&nbsp;&nbsp; ----------------- cut here ---------------------<br>
    &nbsp;&nbsp; &lt;?xml version="1.0" encoding="UTF-8"?&gt;<br>
    &nbsp;&nbsp; &lt;!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST
    1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"&gt;<br>
    &nbsp;&nbsp; &lt;plist version="1.0"&gt;<br>
    &nbsp;&nbsp; &lt;dict&gt;<br>
    &nbsp; &nbsp;&nbsp; &nbsp;
    &lt;key&gt;CFBundleDevelopmentRegion&lt;/key&gt;
    &lt;string&gt;English&lt;/string&gt;<br>
    &nbsp;&nbsp; &nbsp; &nbsp;
    &lt;key&gt;CFBundleGetInfoString&lt;/key&gt; &lt;string&gt;Libusb
    USB device Shield&lt;/string&gt;<br>
    &nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
    &lt;key&gt;CFBundleIdentifier&lt;/key&gt;
    &lt;string&gt;com.libusb.USB_Shield&lt;/string&gt;<br>
    &nbsp;&nbsp; &nbsp; &nbsp;
    &lt;key&gt;CFBundleInfoDictionaryVersion&lt;/key&gt;
    &lt;string&gt;6.0&lt;/string&gt;<br>
    &nbsp; &nbsp; &nbsp;&nbsp; &lt;key&gt;CFBundleName&lt;/key&gt;
    &lt;string&gt;Libusb USB device Shield&lt;/string&gt;<br>
    &nbsp; &nbsp; &nbsp;&nbsp;
    &lt;key&gt;CFBundlePackageType&lt;/key&gt;
    &lt;string&gt;KEXT&lt;/string&gt;<br>
    &nbsp;&nbsp; &nbsp; &nbsp; &lt;key&gt;CFBundleSignature&lt;/key&gt;
    &lt;string&gt;????&lt;/string&gt;<br>
    &nbsp; &nbsp; &nbsp;&nbsp; &lt;key&gt;CFBundleVersion&lt;/key&gt;
    &lt;string&gt;6.0&lt;/string&gt;<br>
    &nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
    &lt;key&gt;IOKitPersonalities&lt;/key&gt;<br>
    &nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &lt;dict&gt;<br>
    &nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp; &nbsp;
    &lt;key&gt;HCFR&lt;/key&gt;<br>
    &nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &lt;dict&gt;<br>
    &nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp; &nbsp; &nbsp;&nbsp;&nbsp;
    &lt;key&gt;CFBundleIdentifier&lt;/key&gt;
    &lt;string&gt;com.apple.driver.AppleUSBComposite&lt;/string&gt;<br>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;
    &nbsp;&nbsp; &lt;key&gt;IOClass&lt;/key&gt;
    &lt;string&gt;AppleUSBComposite&lt;/string&gt;<br>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;
    &nbsp; &lt;key&gt;IOProviderClass&lt;/key&gt;
    &lt;string&gt;IOUSBDevice&lt;/string&gt;<br>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
    &nbsp;&nbsp; &lt;key&gt;idVendor&lt;/key&gt;
    &lt;integer&gt;1243&lt;/integer&gt;<br>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;










    &nbsp; &lt;key&gt;idProduct&lt;/key&gt;
    &lt;integer&gt;91&lt;/integer&gt;<br>
    &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
    &lt;/dict&gt;<br>
    &nbsp;&nbsp; &nbsp; &nbsp; &lt;/dict&gt;<br>
    &nbsp; &nbsp; &nbsp;&nbsp;
    &lt;key&gt;OSBundleCompatibleVersion&lt;/key&gt;
    &lt;string&gt;1.8&lt;/string&gt;<br>
    &nbsp;&nbsp; &nbsp; &nbsp; &lt;key&gt;OSBundleLibraries&lt;/key&gt;<br>
    &nbsp; &nbsp; &nbsp;&nbsp; &lt;dict&gt;<br>
    &nbsp;&nbsp;&nbsp; &nbsp; &nbsp; &nbsp;&nbsp;
    &lt;key&gt;com.apple.kernel.iokit&lt;/key&gt;
    &lt;string&gt;6.0&lt;/string&gt;<br>
    &nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &lt;/dict&gt;<br>
    &nbsp;&nbsp; &lt;/dict&gt;<br>
    &nbsp;&nbsp; &lt;/plist&gt;<br>
    &nbsp; &nbsp; ----------------- cut here ---------------------<br>
    <br>
    (You can also copy this from the source installation in
    usb/Argyll.kext)<br>
    <br>
    You then need to install it by using:<br>
    <br>
    &nbsp; sudo cp -R Argyll.kext /System/Library/Extensions<br>
    <br>
    supplying the appropriate root password when prompted.<br>
    Reboot the system to activate the extension.<br>
    <br>
    <p><br>
    </p>
  </body>
</html>