Argyll CMS documentation index (V1.4.0)

Introduction

This is Version 1.4.0, a bug fix and feature update to V1.3.7 released on 26th March 2012. The first public release of icclib was in November 1998, and of Argyll was in October 2000. Code development commenced in 1995. See Changes Summary for an overview of changes since the last release. Changes between revisions is detailed in the log.txt file that accompanies the source code.

The latest source code is available from here.

Argyll is known to compile and run in at least nine environments:

but may well compile and run correctly in many more than this.

If you've decided to buy a color instrument because Argyll supports it, please let the dealer and manufacturer know that "You bought it because Argyll CMS supports it" - thanks.

Please direct any queries or problems regarding operation of color instruments in combination with Argyll, to the Author(s) of Argyll, and not to any other party.

Copyright and Licensing:

Most of the source code and provided executable files are copyrighted works, licensed under the Affero GNU Version 3 license, and therefore they (or works derived from them) can't be copied, sold or made available to users interacting with them remotely through a computer network, without providing the source code. Nothing other than your agreement and compliance with the Affero GNU License grants you permission to use, modify or distribute Argyll source code, executables or its derivative works. You could be sued for copyright infringement if you use or distribute Argyll without a valid license. The Affero GNU license prohibits extending these tools (i.e. by combining them with other programs or scripts that make use of, depend on, or work with the Argyll code) and distributing them, unless the all the elements of the extensions are also made available under a GPL compatible license. It is permissible to provide Argyll tools with other non GPL components if the elements of the package are not related, such that the packaging is mere aggregation. For all the gory details, please read the accompanying license.

The Argyll CMS is Copyright 1995 - 2012 Graeme W. Gill, and is made available under the terms of the Affero GNU General Public License Version 3, as detailed in the License.txt file. Documentation is licensed under the terms of the GNU Free Documentation License, Version 1.3. The author asserts his moral rights over this material in relationship to the attribution and integrity of these works. In particular, if these works are modified in a way that materially changes their functionality, then the modified works should be renamed in a way that clearly distinguishes them from "Argyll" or "ArgyllCMS" so that the effects of such changes do not reflect on the original works integrity or the original authors reputation. A subset of files (those that are related to the color istrument drivers, and are collected together into the instlib.zip archive by the spectro/instlib.ksh script + xicc/ccmx.h and xicc/ccmx.c) are licensed under the General Public License Version 2 or later, as detailed in the License2.txt file.

Portions of the ColorHug instrument library (spectro/colorhug.[ch]) are Copyright 2011, Richard Hughes, and is licensed under the General Public License Version 2 or later, as detailed in the License2.txt file.

The tool spectro/spec2cie.c is Copyright 2005 Gerhard Fuernkranz, and is made available under the terms of the GNU General Public License Version 2 or later, and is licensed here under the Version 3 license, as detailed in the License3.txt file.

The UNIX USB library libusb included in this distribution, is copyright Johannes Erdfelt, Thomas Sailer and Brad Hards, and is licensed under the GNU LGPL Version 2 or later. See  libusb/LICENSE and libusb/COPYING for details.

The Win32 USB library libusb-win32, included in this distribution, is copyright Stephan Meyer, Johannes Erdfelt and Thomas Sailer, and is licensed under the GNU LGPL Version 2 or latter (the DLL)  and GNU GPL Version 2 or later (the drivers, services, installer). See  libusbw/License.txt, libusbw/COPYING_LGPL.txt and libusbw/COPYING_GPL.txt for details.

The USB library libusb V1.0 included in this distribution, is copyright by the authors listed in the libusb1/AUTHORS file, and is licensed under the GNU LGPL Version 2 or later. See  libusb1/COPYING for details of this license. The MSWindows kernel driver is Copyright Stephan Meyer, and is licesed under the GNU GPL Version 2 or later - See libusb1/KDRIVER_LICENSE and libusb1/COPYING_GPL. The WinUSB CoInstaller redistributable files from the Microsoft Windows Driver Kit are  licensed by Microsoft according to the terms indicated in the libusb1/license.rtf file, section 2. These operating system files are provided ("aggregated") here under the terms of the Microsoft license purely for convenience, and do not form part of the libusb V1.0 package, and are therefore not subject to the terms of the libusb V1.0 license(s). The .inf files that make use of the CoInstallers are provided under a free use, "MIT" type license.

The icc library in icc/, the CGATS library in cgats/, the jcnf library in jcnf/, the files spectro/xdg_bds.*, spectro/aglob.* and the ucmm library in ucmm/ are Copyright 1995 - 2011 Graeme W. Gill, and available according to the "MIT" license granted in the icc/License.txt and cgats/License.txt files, and the licenses at the top of ucmm/ucmm.c and jcnf/jcnf.c.

The yajl library in jcnf/yajl is Copyright 2007-2009, Lloyd Hilaiel and is licensed according to the Berkeley-style License granted in the jcnf/yajl/COPYING files. The yajl library has been repackaged and modified slightly for convenience.

The TIFF library included in this distribution for convenience, has its own copyright and license detailed in tiff/COPYRIGHT (an "MIT"/"BSD" like license).

The Independent JPEG Group's JPEG library included in this distribution for convenience, has its own copyright and license detailed in jpg/README (an "MIT"/"BSD" like license). Executables that include JPEG format support are based in part on the work of the Independent JPEG Group.

xicc/iccjpeg.h and xicc/iccjpeg.c are lcms and they are Copyright (c) 1998-2010 Marti Maria Saguer and is licensed under an "MIT"/"BSD" like license. See the top of the iccjpeg.c file for the detailed copyright and licensing conditions.

The mongoose web server software is Copyright (c) 2004-2011 Sergey Lyubka, and is licensed under an "MIT" license.

What sort of project is this ? (re: contributions)

Compiling

Installing

Graphic User Interfaces

Main Tools and the command line

In order to make use of the tools, it is necessary to keep track of where various files are, and what they are called. There are many possible ways of doing this. One way is to put each source profile and all its associated files (test charts, spectrometer values etc.) in one set of directories for each source profile type. Similarly the device profiles could be stored in a hierarchy of directories ordered by device type, media, resolution, device mode etc. Naturally you will want to set your $PATH so that you can run the tools from whichever directory you are in, as well as specify any necessary directory paths for file arguments so that the tools are able to open them.

Note that there are two ways the Argyll tools deal with filename extensions. In one you supply the extension (ie. you supply the whole file name), so the extension is up to you. In the other (used where one name is used for input and output files, or where there are multiple output files), the program adds the extension. In the documentation this should be indicated by calling it a "base name".

For more information on using a command line environments, consult an appropriate tutorial:

MS Windows :
   <http://www.bleepingcomputer.com/tutorials/tutorial76.html>
   <http://www.pcstats.com/articleview.cfm?articleid=1723&page=1>
   <http://www.voidspace.org.uk/python/articles/command_line.shtml>

    To find more: <http://www.google.com/search?hl=en&q=windows+command+prompt+tutorial>

OS X:
    <http://www.osxfaq.com/Tutorials/LearningCenter/>
    <http://www.atomiclearning.com/macosxterminalx.shtml>
    <http://www.oreillynet.com/pub/a/mac/2001/12/14/terminal_one.html>

    To find more: <http://www.google.com/search?hl=en&q=OS+X+shell+tutorial>

Linux:
    <http://www.linuxcommand.org/index.php>
    <http://www.tuxfiles.org/linuxhelp/shell.html>
    <http://www.ee.surrey.ac.uk/Teaching/Unix/>

    To find more: <http://www.google.com/search?q=linux+command+line+shell+tutorial>

Note that since OS X is based on UNIX, there is much in common between the OS X and Linux command line environments, and many of the UNIX tutorials may be useful:

    <http://www.rain.org/~mkummel/unix.html>

Tutorial: Typical usage scenarios and examples

Topical Discussions

Flow diagram of Major Tools:

Main Tools by category:

Calibrating devices

Creating test targets for profiling or print calibration

Obtaining test results for profiling or print calibration

Creating Device Profiles

Creating Device Link Profiles

Converting colors or applying print calibration

Color Tweaking tools

Creating gamut views

Diagnostic and test tools

Other Tools

Main Tools Alphabetic Listing:

Environment Variables

Performance Tuning

Overview

Limitations

Organization

Source

Minor Tools

File formats that Argyll uses

Errors, Corrections and Omissions: