diff options
| author | Richard Hughes <richard@hughsie.com> | 2011-02-04 16:21:11 +0000 |
|---|---|---|
| committer | Richard Hughes <richard@hughsie.com> | 2011-02-04 20:46:05 +0000 |
| commit | 31a8600ca6272f834a08b350f1bbbd44aa0c8226 (patch) | |
| tree | 88f928bc5cc96d8e3fc388df238d112ed09a3c1b | |
| parent | ba396ad466314105a93b9d67a6f513964b69147d (diff) | |
| download | colord-31a8600ca6272f834a08b350f1bbbd44aa0c8226.tar.gz | |
Add the website to revision control
31 files changed, 1309 insertions, 31 deletions
@@ -23,32 +23,4 @@ What colord does: * Provides the session for a way to set system settings, for instance setting the display profile for all users and all sessions. -colord also provides a debugging utility tool called colormgr that -allows the end user to add, remove and assign color devices. - -FAQ: - -Q: So, how does this work with gnome-color-manager? -A: At startup GCM sends it's per-session database and virtual devices to - colord, and the session devices are removed when the user logs off. - -Q: How do system daemons add devices and profiles? -A: Like this: - - for device in self.devices: - o = CreateDevice(device.name) - for profile in device.profiles: - p = AddProfile(profile.id) - if profile.icc_filename: - p.SetFilename(profile.icc_filename) - p.SetQualifier(profile.qualifier) - o.AddProfile(p) - -Q: How would a system daemon like CUPS use colord? -A: Like this: - - d = FindDeviceById(device.name) - if d: - p = d.GetProfileForQualifier(qualifier) - if p: - p.Use() +See http://colord.hughsie.com/ for more details. @@ -41,5 +41,7 @@ colord is a system activated daemon that maps devices to color profiles. It is used by gnome-color-manager for system integration and use when there are no users logged in. +See http://colord.hughsie.com/ for more details. + Tarballs can be found here: http://people.freedesktop.org/~hughsient/releases/ @@ -9,5 +9,3 @@ to ensure hard work is not duplicated. * device.Modified has to be saved in the database (even for temp devices) * Test device.Modified gets changed on profile changes - -* CUPS needs to call commit diff --git a/doc/website/bugs.html b/doc/website/bugs.html new file mode 100644 index 0000000..13cf528 --- /dev/null +++ b/doc/website/bugs.html @@ -0,0 +1,98 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>colord - Reporting Bugs</title> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8"/> +<link rel="stylesheet" href="style.css" type="text/css" media="screen"/> +</head> +<body> + +<p>Back to the <a href="index.html">main page</a></p> + +<h1>Reporting Bugs</h1> + +<p> +First, please look at the <a href="http://tinyurl.com/2s4tnt">list of bugs</a> +so that you are sure the bug you are reporting isn't a duplicate bug that +someone else has fixed or reported. +If not present, then please create a new bug attaching all the information +to this new bug. +</p> + +<h2>General Bugs</h2> + +<p> +When colord doesn't work, there is lots that could be wrong. +To help us diagnose the problem, please supply the following information: +</p> + +<ul> +<li>The version of colord installed</li> +<li>The version of gnome-color-manager installed</li> +<li>The installation method you used (i.e. distribution RPM, tarball)</li> +<li>Your distribution and version</li> +<li>The verbose debugging from colord</li> +<li>Any other information that may be relevant</li> +</ul> + +<h2>colord Verbose Trace</h2> + +<p> +This will turn on verbose debugging for the colord daemon that will be +useful when debugging problems. +</p> + +<pre> +sudo killall colord +sudo /usr/libexec/colord --verbose +</pre> + +<h2>Segfaults or random crashes</h2> +<p> +We would really appreciate it if you could send us more information about the +crash, specifically a backtrace with gdb. +Make sure you have the colord-debuginfo or colord-gdb package installed, +else the reports from gdb won't mean much to any of us. +</p> + +<pre> +gdb /usr/libexec/colord +</pre> +<p> +The GNU debugger (gdb) will start and put you at a prompt: +</p> +<pre> +(gdb) _ +</pre> + +<p> +Then type the following. +</p> + +<pre> +(gdb) run --verbose +</pre> + +<p> +In another command window, you may have to exeute the action that is crashing +the daemon, for instance selecting a profile in the gnome-color-manager profile viewer. +</p> +<p> +You should be back in the gdb shell if the daemon has crashed. +Then type bt at the prompt and send us all the output that follows. +This will tell us exactly what the program was doing when it crashed. +</p> +<p> +This <a href="http://sources.redhat.com/gdb/current/onlinedocs/gdb_toc.html">link</a> will +give you more information. +</p> +<p>Back to the <a href="index.html">main page</a></p> + +<p class="footer"> + Copyright <a href="mailto:richard@hughsie.com">Richard Hughes 2011</a><br/> + <a href="http://validator.w3.org/check/referer">Optimized</a> + for <a href="http://www.w3.org/">standards</a>. +</p> + +</body> +</html> diff --git a/doc/website/competitors.html b/doc/website/competitors.html new file mode 100644 index 0000000..a554f44 --- /dev/null +++ b/doc/website/competitors.html @@ -0,0 +1,152 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>colord - What is colord?</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> +<link rel="stylesheet" href="style.css" type="text/css" media="screen"/> +</head> +<body> + +<p>Back to the <a href="index.html">main page</a></p> + +<h1>Other CMS Frameworks:</h1> + +<p> +GNOME Color Management started development in 2009 and colord in late 2010. +Two other CMS solutions were evaluated before starting development, Oyranos and Ookala MCF. +</p> + +<h2>Oyranos</h2> +<p> +<a href="http://www.oyranos.org/">Oyranos</a> is a Colour Management System (CMS) on operating system level. +</p> + +<h3>Positives:</h3> +<ul> +<li>Developed for many years.</li> +<li>Concrete use cases and ample documentation.</li> +<li>New BSD license (the profiles are <a href="http://www.zlib.net/zlib_license.html">zlib</a>) which makes it Free Software.</li> +<li>Supports the <a href="http://www.oyranos.org/wiki/index.php?title=ICC_Profiles_in_X_Specification_0.4">ICC Profiles in X specification</a>.</li> +<li>Established developer base.</li> +<li>Full screen colour management example plugin for compiz</li> +<li>Used by <a href="http://www.cinepaint.org/">CinePaint</a> and ICC Examin, as well as <a href="http://www.oyranos.org/wiki/index.php?title=Kolor-manager">Kolor Manager</a> in KDE.</li> +</ul> + +<h3>Negatives:</h3> +<ul> +<li>Hard dependency of <a href="http://elektra.g4ii.com/Main_Page">elektra</a>, which is dead upstream. Elektra ''could'' be replaced by an other configuration engine, although the maintainer is unwilling to do so.</li> +<li>Requiring <a href="http://www.fltk.org/">FLTK</a> for UI.</li> +<li>Mixing the presentation with the mechanism, for instance, see oyranos_xml.c, oyXFORMsFromModelAndUi().</li> +<li>Configuration, UI and modules are separated through complex APIs</li> +<li>Reliance on compiz for full screen color management.</li> +<li>Including a whole type and object system and memory allocation framework.</li> +<li>Including the processing integration points themselves (lcms, libraw, etc) in the CMS, rather than in the application or toolkit</li> +<li>No distribution is planning to ship elektra or Oyranos by default.</li> +<li>Oyranos has the concept of profiles: ''office'', ''photographer'', ''prepress'' and ''designer''. GCM has no such profiles. This is a deliberate choice as users vary rarely sit into well defined groups and putting profiles in the UI abstracts the settings one stage further from what the user is trying to achieve.</li> +</ul> + +<p> +So, in summary: Oyranos tries to to be a ''thick solution'' where it tries to do everything, but relies on several of obsolete or undesirable toolkits. +</p> + +<h2>Ookala MCF</h2> + +<p> +The <a href="http://sourceforge.net/projects/ookala-mcf/">Ookala Modular Calibration Framework</a> (OMCF) is an open-source project designed to support extensible, +standardized color calibration of color-critical display environments. The modular architecture allows for easy +customization of a variety of display output and color sensor scenarios. +</p> + +<h3>Positives:</h3> +<ul> +<li>Strong support of Hewlett-Packard, although no new development for quite some time.</li> +<li>Well documented and great modular design.</li> +<li>Great system and session split.</li> +<li>Used by several big-name studios.</li> +</ul> + +<h3>Negatives:</h3> +<ul> +<li>Does not conform to any existing standard, relies on ucal.xml files for configuration.</li> +<li>Only supports the HP !DreamColor LP2480zx Professional Display and the HP !DreamColor colorimeter.</li> +<li>Uses <a href="http://www.wxwidgets.org/">wxWidgets</a> (although plans for additional DE's).</li> +<li>Requires proprietary <a href="http://www.xrite.com/">X-Rite SDK</a>.</li> +<li>Unclear copyright and licence.</li> +<li>No translatable content or translations.</li> +<li>No distribution is planning to ship the X-Rite SDK or Ookala MCF.</li> +</ul> + +<p> +So, in summary: Ookala MCF is a nice project with a clean design that only supports two devices and has little to none upstream development. +</p> + +<h2>GNOME Color Manager</h2> + +<p> +GNOME Color Manager is a session framework that makes it easy to manage, install and generate color profiles in the GNOME desktop. +</p> + +<h3>Positives:</h3> +<ul> +<li>Deep integration into GNOME and GTK+.</li> +<li>Planned for official inclusion in the GNOME 2.31 release.</li> +<li>Well documented, both on the wiki and in the code.</li> +<li>36 official translations.</li> +<li>Shipped by most of the big distributions already.</li> +<li>Allows per-user and per-system configuration and defaults.</li> +<li>Simple extendable keyfiles provide the configuration, where GConf/GSettings provides the preferences</li> +<li>Supports the ICC Profiles in X specification.</li> +<li>Uses <a href="http://www.argyllcms.com/">Argyllcms</a>, so huge number of calibration devices supported.</li> +<li>Supports the Huey device as a native device which does not use the Argyllcms driver</li> +<li>GPLv2+ licence which makes it Free Software.</li> +<li>Provides a simple to use cross-platform <a href="http://git.gnome.org/browse/gnome-color-manager/plain/src/org.gnome.ColorManager.xml">DBus interface</a> for applications to use.</li> +<li>Used by <a href="https://launchpad.net/simple-scan">simple scan</a> for calibration data.</li> +<li>Used by gnome-screenshot for the window ICC profile.</li> +</ul> + +<h3>Negatives:</h3> +<ul> +<li>Uses argyllcms and screen-scrapes data, rather than using a library (although huey is now a native driver, the profiles it produces are poor).</li> +<li>Relies on a lot of fairly new GNOME technologies, e.g. gudev, Gio, DBus, libnotify, XRandR, VTE and libcanberra.</li> +<li>Forces the pixel-transforming into the toolkit or application.</li> +</ul> + +<p> +GNOME Color Manager is a ''thin solution'' where it defers to the application the pixbuf transforming (using something like <a href="http://www.littlecms.com/">lcms</a>, or <a href="http://cairographics.org/">cairo</a>) and only providing a <a href="http://projects.gnome.org/gnome-color-manager/screenshots.html">simple UI</a> and minimalist DBus interface for interested applications to query. +</p> + +<h2>General points:</h2> + +<p> +I think most of the CMS functionality can be (and should be) integrated into the platform, e.g. <a href="http://www.gtk.org/">GTK</a> and Cairo. +</p> +<p> +It's my opinion that it's best to have two different applications for something that share a common spec, rather than trying to be a jack-of-all-trades. It's a cliché, but KDE users do want options, and GNOME users do want things to 'just work'. You can't design a library, or even an application for those different user types. This is why I developed '''GNOME''' color manager, not !ColorManager. +</p> +<p> +I do think the concept of a ''monolithic CMS'' is flawed. Color management has to be integral to the stack, so Xorg, GTK, Cairo, etc. all have to play their part. You can't really push a monolithic library when you need to interface with so many parts of the stack. I see GCM as a the cherry on a cake, with all the heavy lifting being done by cairo, lcms and argyll. GCM just provides the configuration widgets in the session and makes the data available to applications. +</p> + +<h2>References</h2> +<ul> +<li><a href="http://www.oyranos.org/wiki/index.php?title=ICC_Profiles_in_X_Specification_0.4">ICC Profiles in X Specification</a></li> +<li><a href="http://www.oyranos.org/wiki/index.php?title=OpenIccDirectoryProposal">Directory paths shared with other CMMs</a> </li> +<li><a href="http://mail.gnome.org/mailman/listinfo/gnome-color-manager-list">GCM mailing list</a></li> +<li><a href="http://www.freedesktop.org/wiki/OpenIcc">OpenICC</a></li> +<li><a href="http://www.color.org">International Colour Consortium</a></li> +<li><a href="http://www.oyranos.org/wiki/index.php?title=Oyranos">Oyranos CMM</a></li> +<li><a href="http://sourceforge.net/projects/ookala-mcf/">Ookala Modular Calibration Framework</a></li> +<li><a href="http://www.argyllcms.com/">ArgyllCMS</a></li> +<li><a href="http://www.littlecms.com">LittleCMS, colour conversion engine</a></li> +</ul> + +<p>Back to the <a href="index.html">main page</a></p> + +<p class="footer"> + Copyright <a href="mailto:richard@hughsie.com">Richard Hughes 2011</a><br/> + <a href="http://validator.w3.org/check/referer">Optimized</a> + for <a href="http://www.w3.org/">standards</a>. +</p> + +</body> +</html> diff --git a/doc/website/download.html b/doc/website/download.html new file mode 100644 index 0000000..8beec02 --- /dev/null +++ b/doc/website/download.html @@ -0,0 +1,116 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>colord - Where can I download it?</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> +<link rel="stylesheet" href="style.css" type="text/css" media="screen"/> +</head> +<body> + +<p>Back to the <a href="index.html">main page</a></p> + +<h1>Where do I download it?</h1> + +<h2>Precompiled Packages</h2> +<p> +Your distribution may already have compiled packages that are much +easier to install. Refer to the <a href="users.html">users</a> page for +more details or use the instructions provided below to get you going using +your native package manager. +</p> +<ul> +<!-- + <li> + Conary: Yes, just run: <code>sudo conary update colord gnome-color-manager</code> + </li> +--> + <li> + Fedora: Just run: <code>yum install colord gnome-color-manager</code> (as root) + </li> +<!-- + <li> + Debian: Yes, packages are available for Debian Sid. + Just install <code>colord</code> via APT. + </li> +--> +<!-- + <li> + Ubuntu: Yes, starting with Hardy Heron (8.04). + Newer versions are used by more recent releases, but you can find the latest versions of colord for all releases in this <a href="https://edge.launchpad.net/~colord/+archive">Personal Package Archive</a>. + <a href="https://help.ubuntu.com/8.04/add-applications/C/extra-repositories-adding.html">Add</a> + the repository and <a href="https://help.ubuntu.com/8.04/add-applications/C/advanced.html"> + install</a> the packages <code>colord</code> and <code>gnome-color-manager</code>. + </li> +--> +<!-- + <li> + openSUSE: Yes, starting with 11.0, add <a href="http://download.opensuse.org/distribution/11.0/repo/oss/">this</a> + repository file and run: <code>zypper install colord gnome-color-manager</code> (as root) + </li> +--> +<!-- + <li> + Mandriva: Yes, starting with 2009, just run: <code>urpmi colord gnome-color-manager</code> (as root) + </li> +--> + <li> + Others: Probably not, although you can compile from source. See below for more details. + </li> +</ul> + +<h2>Released Versions</h2> +<p> +Released versions are found on +<a href="http://colord.freedesktop.org/releases/">http://colord.freedesktop.org/releases/</a>. +</p> +<p> +These are versions which have new features for each release. +We are also willing to break ABI and API to fix bugs and will merge new or +modified translations as required or suggested. +</p> +<table> +<tr><td><b>Version</b></td><td> </td><td><b>Date</b></td></tr> +<tr><td>0.1.1</td><td></td><td>2011-01-26</td></tr> +<tr><td>0.1.0</td><td></td><td>2011-01-13</td></tr> +</table> + +<h2>Dependencies</h2> +<p> +The actual colord daemon requires: +</p> +<ul> +<li><code>glib</code> 2.14.0</li> +<li><code>polkit</code> 0.9</li> +</ul> + +<p> +gnome-color-manager will need all the usual GNOME libs as well. +Just make sure you install colord before gnome-color-manager! +</p> + +<h2>Compiling the latest code</h2> +<p> +You can get the latest colord daemon and GNOME frontend from the +<a href="http://gitorious.org/colord/colord">public git repositories</a> +on <a href="http://gitorious.org/">gitorious.org</a>: +</p> +<pre> +git clone git://gitorious.org/colord/master.git +git clone git://git.gnome.org/gnome-color-manager +</pre> + +<p> +If you want to help with an item on the TODO or fix known bugs, file bugs in [[https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-color-manager|GNOME Bugzilla]]. +If color doesn't compile for you, send patches! Thanks. +</p> + +<p>Back to the <a href="index.html">main page</a></p> + +<p class="footer"> + Copyright <a href="mailto:richard@hughsie.com">Richard Hughes 2011</a><br/> + <a href="http://validator.w3.org/check/referer">Optimized</a> + for <a href="http://www.w3.org/">standards</a>. +</p> + +</body> +</html> diff --git a/doc/website/faq.html b/doc/website/faq.html new file mode 100644 index 0000000..31e2840 --- /dev/null +++ b/doc/website/faq.html @@ -0,0 +1,107 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>colord - Frequently Asked Questions</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> +<link rel="stylesheet" href="style.css" type="text/css" media="screen"/> +</head> +<body> + +<p>Back to the <a href="index.html">main page</a></p> + +<h1>Frequently asked questions</h1> + +<h2>Table Of Contents</h2> +<ul> +<li><a href="#spelling">Can I type colord with leading upper case 'C'?</a></li> +<li><a href="#gcm">How does this work with gnome-color-manager?</a></li> +<li><a href="#daemon">How do system daemons add devices and profiles?</a></li> +<li><a href="#cups">How would a system daemon like CUPS use colord?</a></li> +<!-- +<li><a href="#xxx">xxx</a></li> +--> +<li><a href="#translation">How do I translate gnome-color-manager?</a></li> +<li><a href="#corporate-sponsor">Is there an organization sponsoring development of colord?</a></li> +</ul> + +<!-- +<hr/> +<h3><a name="xxxxxxxxxxxxxxxxxxxxxxxxxxx">ccccccccccccccccccccccccccccccc</a></h3> +<p> +ccccccccccccccccccccccccccccccccccccccccccccccccccccc. +</p> +--> + +<hr/> +<h3><a name="spelling">Can I type colord with leading upper case 'C'</a></h3> +<p> +No. +</p> + +<hr/> +<h3><a name="gcm">How does this work with gnome-color-manager?</a></h3> +<p> +At startup GCM sends it's per-session database and virtual devices to +colord, and the session devices are removed when the user logs off.. +</p> + +<hr/> +<h3><a name="daemon">How do system daemons add devices and profiles?</a></h3> +<p> +Like this: +<pre> + for device in self.devices: + o = CreateDevice(device.name) + for profile in device.profiles: + p = AddProfile(profile.id) + if profile.icc_filename: + p.SetFilename(profile.icc_filename) + p.SetQualifier(profile.qualifier) + o.AddProfile(p) +</pre> +</p> + +<hr/> +<h3><a name="cups">How would a system daemon like CUPS use colord?</a></h3> +<p> +Like this: +<pre> + d = FindDeviceById(device.name) + if d: + p = d.GetProfileForQualifier(qualifier) + if p: + p.Use() +</pre> +</p> + +<hr/> +<h3><a name="translation">How do I translate gnome-color-manager?</a></h3> +<p> +See the <a href="http://l10n.gnome.org/teams">GNOME Translation Team</a> +web pages for how to contribute to GNOME localisation. +</p> + +<hr/> +<h3><a name="corporate-sponsor">Is there an organization or corporation sponsoring development of colord?</a></h3> +<p> +Colord is not sponsored by anyone, although Red Hat gives me the time to +work on random open source projects. Thanks! +</p> + +<p>Back to the <a href="index.html">main page</a></p> + +<!-- space for the links to be at the top --> +<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/> +<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/> +<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/> +<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/> + +<p class="footer"> + Copyright <a href="mailto:richard@hughsie.com">Richard Hughes 2011</a><br/> + <a href="http://validator.w3.org/check/referer">Optimized</a> + for <a href="http://www.w3.org/">standards</a>. +</p> + +</body> +</html> + diff --git a/doc/website/help.html b/doc/website/help.html new file mode 100644 index 0000000..7ca4667 --- /dev/null +++ b/doc/website/help.html @@ -0,0 +1,55 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>colord - How can I help?</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> +<link rel="stylesheet" href="style.css" type="text/css" media="screen"/> +</head> +<body> + +<p>Back to the <a href="index.html">main page</a></p> + +<h1>How can I help?</h1> + +<p> +Anyone interested in colord development is invited to join the +channel <code>#gnome-color-manager</code> on <code>freenode</code>. +We are a friendly bunch, and can answer questions on DBus interfaces, +general lcms questions or anything else colord related. +</p> + +<p> +There is also a subscription-only <a +href="http://mail.gnome.org/mailman/listinfo/gnome-color-manager-list">mailing +list</a> where we discuss colord development, patches and future +development. +</p> + +<p> +You can file bugs, or track the status at <a href="http://bugs.freedesktop.org"> +bugs.freedesktop.org</a> +</p> + +<table class="noteinformation"> +<tr> + <td><img src="img/dialog-information.png" alt="[NOTE]"/></td> + <td> + <p> + If colord cannot do what you need then please ask on the mailing list. + It might already be on the TODO, or we might have to slightly tweak the API + to make it possible. + </p> + </td> +</tr> +</table> + +<p>Back to the <a href="index.html">main page</a></p> + +<p class="footer"> + Copyright <a href="mailto:richard@hughsie.com">Richard Hughes 2011</a><br/> + <a href="http://validator.w3.org/check/referer">Optimized</a> + for <a href="http://www.w3.org/">standards</a>. +</p> + +</body> +</html> diff --git a/doc/website/img/architecture-plan.png b/doc/website/img/architecture-plan.png Binary files differnew file mode 100644 index 0000000..121c805 --- /dev/null +++ b/doc/website/img/architecture-plan.png diff --git a/doc/website/img/dialog-information.png b/doc/website/img/dialog-information.png Binary files differnew file mode 100644 index 0000000..18af8ec --- /dev/null +++ b/doc/website/img/dialog-information.png diff --git a/doc/website/img/kpk-update.png b/doc/website/img/kpk-update.png Binary files differnew file mode 100644 index 0000000..a1acf92 --- /dev/null +++ b/doc/website/img/kpk-update.png diff --git a/doc/website/img/large-accessories-text-editor.png b/doc/website/img/large-accessories-text-editor.png Binary files differnew file mode 100644 index 0000000..78d55f9 --- /dev/null +++ b/doc/website/img/large-accessories-text-editor.png diff --git a/doc/website/img/large-application-certificate.png b/doc/website/img/large-application-certificate.png Binary files differnew file mode 100644 index 0000000..14f5054 --- /dev/null +++ b/doc/website/img/large-application-certificate.png diff --git a/doc/website/img/large-applications-development.png b/doc/website/img/large-applications-development.png Binary files differnew file mode 100644 index 0000000..170bcd0 --- /dev/null +++ b/doc/website/img/large-applications-development.png diff --git a/doc/website/img/large-authors.png b/doc/website/img/large-authors.png Binary files differnew file mode 100644 index 0000000..993c460 --- /dev/null +++ b/doc/website/img/large-authors.png diff --git a/doc/website/img/large-dialog-information.png b/doc/website/img/large-dialog-information.png Binary files differnew file mode 100644 index 0000000..0a5e281 --- /dev/null +++ b/doc/website/img/large-dialog-information.png diff --git a/doc/website/img/large-emblem-favorite.png b/doc/website/img/large-emblem-favorite.png Binary files differnew file mode 100644 index 0000000..8606418 --- /dev/null +++ b/doc/website/img/large-emblem-favorite.png diff --git a/doc/website/img/large-emblem-photos.png b/doc/website/img/large-emblem-photos.png Binary files differnew file mode 100644 index 0000000..222a2b9 --- /dev/null +++ b/doc/website/img/large-emblem-photos.png diff --git a/doc/website/img/large-help-browser.png b/doc/website/img/large-help-browser.png Binary files differnew file mode 100644 index 0000000..11cbe55 --- /dev/null +++ b/doc/website/img/large-help-browser.png diff --git a/doc/website/img/large-preferences-system.png b/doc/website/img/large-preferences-system.png Binary files differnew file mode 100644 index 0000000..9d66730 --- /dev/null +++ b/doc/website/img/large-preferences-system.png diff --git a/doc/website/img/large-system-users.png b/doc/website/img/large-system-users.png Binary files differnew file mode 100644 index 0000000..a44367c --- /dev/null +++ b/doc/website/img/large-system-users.png diff --git a/doc/website/img/profile-bevan.png b/doc/website/img/profile-bevan.png Binary files differnew file mode 100644 index 0000000..1333f3c --- /dev/null +++ b/doc/website/img/profile-bevan.png diff --git a/doc/website/img/profile-graham.png b/doc/website/img/profile-graham.png Binary files differnew file mode 100644 index 0000000..a7aa84c --- /dev/null +++ b/doc/website/img/profile-graham.png diff --git a/doc/website/img/profile-suzan.png b/doc/website/img/profile-suzan.png Binary files differnew file mode 100644 index 0000000..7d37625 --- /dev/null +++ b/doc/website/img/profile-suzan.png diff --git a/doc/website/index.html b/doc/website/index.html new file mode 100644 index 0000000..3ac342b --- /dev/null +++ b/doc/website/index.html @@ -0,0 +1,73 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>colord - Makes color managed hardware work</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> +<link rel="stylesheet" href="style.css" type="text/css" media="screen"/> +</head> +<body> + +<h1>colord = color daemon</h1> +<img src="img/architecture-plan.png" alt="[logo]"/> + +<table cellpadding="12px" border="0"> +<tr> + <td align="center"> + <a href="intro.html"><img src="img/large-accessories-text-editor.png" width="64" alt=""/></a> + </td> + <td><p><a href="intro.html" class="indextitle">What is colord?</a></p></td> +</tr> +<tr> + <td align="center"> + <a href="using.html"><img src="img/large-preferences-system.png" width="64" alt=""/></a> + </td> + <td><p><a href="using.html" class="indextitle">How do I use colord?</a></p></td> +</tr> +<tr> + <td align="center"> + <a href="download.html"><img src="img/large-dialog-information.png" width="64" alt=""/></a> + </td> + <td><p><a href="download.html" class="indextitle">Where can I download it?</a></p></td> +</tr> +<tr> + <td align="center"> + <a href="screenshots.html"><img src="img/large-emblem-photos.png" width="64" alt=""/></a> + </td> + <td><p><a href="screenshots.html" class="indextitle">Cool Screenshots</a></p></td> +</tr> +<tr> + <td align="center"> + <a href="profiles.html"><img src="img/large-system-users.png" width="64" alt=""/></a> + <td><p><a href="profiles.html" class="indextitle">Typical User Profiles</a></p></td> + </td> +</tr> +<tr> + <td align="center"><a href="users.html"><img src="img/large-application-certificate.png" width="64" alt=""/></a></td> + <td><p><a href="specifics.html" class="indextitle">How it works</a></p></td> +</tr> + <tr> + <td align="center"><a href="bugs.html"><img src="img/large-applications-development.png" width="64" alt=""/></a></td> + <td><p><a href="bugs.html" class="indextitle">Reporting bugs</a></p></td> +</tr> +<tr> + <td align="center"><a href="help.html"><img src="img/large-emblem-favorite.png" width="64" alt=""/></a></td> + <td><p><a href="help.html" class="indextitle">How can I help?</a></p></td> +</tr> +<tr> + <td align="center"><a href="competitors.html"><img src="img/large-authors.png" width="64" alt=""/></a></td> + <td><p><a href="competitors.html" class="indextitle">Other CMS frameworks?</a></p></td> +</tr> +<tr> + <td align="center"><a href="faq.html"><img src="img/large-help-browser.png" width="64" alt=""/></a></td> + <td><p><a href="faq.html" class="indextitle">Frequently asked questions</a></p></td> +</tr> +</table> + +<p class="footer"> + Copyright <a href="mailto:richard@hughsie.com">Richard Hughes 2011</a><br/> + <a href="http://validator.w3.org/check/referer">Optimized</a> + for <a href="http://www.w3.org/">standards</a>. +</p> + +</body> +</html> diff --git a/doc/website/intro.html b/doc/website/intro.html new file mode 100644 index 0000000..63f23b5 --- /dev/null +++ b/doc/website/intro.html @@ -0,0 +1,166 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>colord - What is colord?</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> +<link rel="stylesheet" href="style.css" type="text/css" media="screen"/> +</head> +<body> + +<p>Back to the <a href="index.html">main page</a></p> + +<h1>Introduction</h2> +<p> +colord is a system service that makes it easy to manage, install and +generate color profiles to accuratly color manage input and output devices. +</p> + +<h2>What colord does:</h2> +<ul> +<li> + Provides a DBus API for system frameworks to query, e.g. + <i>Get me the profiles for device $foo</i> or + <i>Create a device and assign it profile $bar</i>. +</li> +<li> + Provides a persistant database backed store that is preserved accross + reboots. +</li> +<li> + Provides the session for a way to set system settings, for instance + setting the display profile for all users and all sessions. +</li> +</ul> +</p> + +<!-- +<table class="noteinformation"> +<tr> + <td><img src="img/dialog-information.png" alt="[NOTE]"/></td> + <td> + <p>If you're easily bored, checkout the + <a href="http://www.hughsie.com/public/introduction-to-colord.pdf">presentation</a> + or the + <a href="http://video.fosdem.org/2008/maintracks/FOSDEM2008-colord.ogg">video</a> + I prepared for FOSDEM 2008 and skip the rest of this page. + </p> + </td> +</tr> +</table> +--> + +<p> +colord itself is a system activated daemon called +<code>colord</code>. +Being system activated means that it's only started when the user is +using a text mode or graphical tool. +</p> + +<p> +GNOME Color Manager is the name of the graphical tools for +colord to be used in the GNOME desktop. +GNOME Color Manager acts as a client to colord. +</p> + +<table class="noteinformation"> +<tr> + <td><img src="img/dialog-information.png" alt="[NOTE]"/></td> + <td> + <p> + By default, colord uses PolicyKit for user authentication. + This means that you, as an admin, can specify with fine-grained control + what your users can and cannot do. + </p> + <p> + For instance, an admin could specify that unprivileged users can create + color devices but not delete them. + For home users it's typical to ask the user for their own, or the + administrator's <code>root</code> password. + </p> + </td> +</tr> +</table> + +<h2>Use cases:</h2> +<p> +colord and GNOME Color Manager was designed to solve a few discrete use cases. +The DBus interface was designed to fulfil the following scenarios. +</p> + +<ul> +<li>An image viewer wants to show an image with an embedded color profile to the screen, where the screen also has an assigned profile. The image has to be transformed from the embedded profile to the current display profile.</li> +<li>A scanner application wants to get the correct color profile for a device so it can be embedded in the output file.</li> +<li>An image viewer wants to show a photograph without an embedded profile, but where a virtual device profile has been assigned. This needs to be fast as there are many similar photos in the same directory.</li> +<li>An application wants to softproof for a printer device to show the user how the colors are going to be clipped when the file is printed.</li> +<li>A photo editor wants to know the default RGB space to use for new image canvasses.</li> +<li>A photo viewer wants to know what color space to use for untagged content with no embedded profile.</li> +<li>A print preview application wants to know what installed profiles are suitable for printer devices.</li> +<li>A user wants to have two profiles for a digital SLR, one for the studio and one for outside with full sun.</li> +<li>A user has two different monitors attached and the desktop is spanned across each one. Each one has a different profile, and applications can be dragged from one window to another.</li> +<li>One user may want to assign color profiles to devices and set these as the system default for all users</li> +</ul> + +<h2>Features:</h2> +<p> +This project has the following features: +</p> +<ul> +<li>Deep integration into the GNOME and free software stack.</li> +<li>Setting output gamma tables (with local brightness and adjustments) to any Xrandr output.</li> +<li>Setting of per-user and system settings at session start, and when monitors are hotplugged.</li> +<li>Easy install of vendor supplied .ICC or .ICM files, just by double clicking on the file.</li> +<li>Easy display calibration using an external calibration device, and scanner calibration using a inexpensive IT 8.7 target. For calibration, the ArgyllCMS package is currently required.</li> +<li>Spot color reading using dozens of supported spectrophotometers.</li> +<li>Integration X11 by setting the per-screen and per-output _ICC_PROFILE atom, which makes applications such as the GIMP use a color managed output.</li> +<li>Easy to use DBus interface for applications to query what ICC profiles should be used for a specific device or device type.</li> +</ul> + +<h2>Subsystems:</h2> +<p> +colord and GNOME Color Manager supports the following subsystems: +</p> +<ul> +<li>XRandR (monitors)</li> +<li>SANE (scanners)</li> +<li>UDEV (cameras)</li> +<li>CUPS (printers)</li> +<li>Virtual (scanners, cameras, printers)</li> +</ul> +<p> +Virtual devices are not backed by a physical device, and so can be things like ''Snapfish Processing Lab'' or ''Tommys Camera''. +</p> + +<h2>Licensing:</h2> +<p> +colord and gnome-color-manager are (L)GPLv2+ licensed. This means that +you can redistribute and/or modify colord and gnome-color-manager +under the terms of the GNU General Public License as published by the +Free Software foundation; either version 2 of the License, or (at your +option) any later version. See the license information included with +the software for more details. +</p> + +<p> +What colord is not: +</p> +<ul> + <li>A huge daemon with lots of dependencies.</li> + <li>100% API stable. The API may change a little until we ship +1.0.0</li> + <li>Targeted to a particular architecture or platform.</li> +<!-- + <li>Produced by any one vendor. There are many contributors helping to +get this done.</li> +--> +</ul> + +<p>Back to the <a href="index.html">main page</a></p> + +<p class="footer"> + Copyright <a href="mailto:richard@hughsie.com">Richard Hughes 2011</a><br/> + <a href="http://validator.w3.org/check/referer">Optimized</a> + for <a href="http://www.w3.org/">standards</a>. +</p> + +</body> +</html> diff --git a/doc/website/profiles.html b/doc/website/profiles.html new file mode 100644 index 0000000..86724c7 --- /dev/null +++ b/doc/website/profiles.html @@ -0,0 +1,117 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>colord - Typical User Profiles</title> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8"/> +<link rel="stylesheet" href="style.css" type="text/css" media="screen"/> +</head> +<body> + +<p>Back to the <a href="index.html">main page</a></p> + +<p> +Here are listed three actual users, friends and family. +These are actual users that we can refer (and get to test) to when +designing colord and tools like GNOME Color Manager. +</p> + +<h2>User Profile: Suzan</h2> +<table cellpadding="10px"><tr> +<td><img src="img/profile-suzan.png" alt=""/></td> +<td> +<p> +<b>Suzan is a 23 year old 4th year medical student.</b> +She uses Linux because she does not want viruses or trojans, and finds Linux is +quicker on her 3 year old laptop than Windows XP. +She does not understand programming and has no need to change the way the +computer works. +</p> +<p> +She can use the OpenOffice programs proficiently, but does not know what +a ICC profile is. +She wants to take photographs on her DSLR, tweak them, and print them on +a local printer. +</p> +<p> +She watches DVD's with her friends on her laptop every now and then and +occasionally plays other media files sent to her by her medical colleagues. +She absolutely loves facebook and flickr. +</p> +<p> +If there are any problems with her computer, she rings her brother who +is a Linux expert. +He can normally walk her through problems on the phone to get the problem +sorted. +Suzan has a low speed dial up connection that she uses a few times a week +for up to 40 minutes. +</p> +</td> +</tr></table> +<hr/> + +<h2>User Profile: Bevan</h2> +<table cellpadding="10px"><tr> +<td><img src="img/profile-bevan.png" alt=""/></td> +<td> +<p> +<b>Bevan is a 30 year old computer wizz and an adrenaline junkie.</b> +He is an expert in Microsoft products and is starting to play with live CD's on +popular Linux distributions. +</p> +<p> +He wants ultimately to replace his Windows XP installation with a Linux +installation, and also wants to play with the latest stuff like compiz and +also experiment by trying to compile software from source. +</p> +<p> +He wants to install and run some of the proprietary Windows programs on his +Linux computer. +He also has a 40Gb MP3 music collection and many hundreds of gigabytes of media +files that he shares on the LAN with other computers on the network. +</p> +<p> +Bevan has deep pockets, and doesn't mind spending money on hardware to +get things looking just right. +Bevan has a unlimited bandwidth high speed broadband internet connection. +</p> +</td> +</tr></table> +<hr/> + +<h2>User Profile: Graham</h2> +<table cellpadding="10px"><tr> +<td><img src="img/profile-graham.png" alt=""/></td> +<td> +<p> +<b>Graham is a 55 year old retired painter and decorator.</b> +Graham's son has installed Linux on their new computer and moved away to university. +Graham does not know much about computers, and gets quite confused when +application icons change or if the start button is moved. +Graham uses GNOME as it's simpler, but does now know what it means. +Needless to say, Graham doesn't understand ICC profiles or color management. +</p> +<p> +Words like "perceptual rendering" scare Graham, and a phone call to his +son is expected if anything technical pops up on the screen he doesn't +understand. +</p> +<p> +He does not generally edit photos, but opens files sent to him from his +daughter from the Internet. +</p> +<p> +Graham has a low bandwidth broadband package that limits him to 1GB a month. +</p> +</td> +</tr></table> + +<p>Back to the <a href="index.html">main page</a></p> + +<p class="footer"> + Copyright <a href="mailto:richard@hughsie.com">Richard Hughes 2011</a><br/> + <a href="http://validator.w3.org/check/referer">Optimized</a> + for <a href="http://www.w3.org/">standards</a>. +</p> + +</body> +</html> diff --git a/doc/website/screenshots.html b/doc/website/screenshots.html new file mode 100644 index 0000000..3e3d802 --- /dev/null +++ b/doc/website/screenshots.html @@ -0,0 +1,66 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>colord - Screenshots</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> +<link rel="stylesheet" href="style.css" type="text/css" media="screen"/> +</head> +<body> + +<p>Back to the <a href="index.html">main page</a></p> + +<h2>Table Of Contents</h2> +<ul> +<li><a href="#gnome">Colord Screenshots</a></li> +<li><a href="#gcm">GNOME Color Manager Screenshots</a></li> +</ul> + +<h1><a name="gnome">Colord Screenshots</a></h1> + +<center> +<table cellpadding="5px"> +<tr> +<td width="300"> + <center><a href="img/gpk-application-search.png"><img src="http://people.freedesktop.org/~hughsient/temp/colord-gui-devices.png" alt=""/></a></center> + <p class="caption">colorgui device pane</p> +</td> +</tr> +<tr> +<td width="300"> + <center><a href="img/kpk-update.png"><img src="http://people.freedesktop.org/~hughsient/temp/colord-gui-profiles.png" alt=""/></a></center> + <p class="caption">colorgui profile pane</p> +</td> +</tr> +</table> +</center> + +<h1><a name="kde">GNOME Color Manager Screenshots</a></h1> + +<center> +<table cellpadding="5px"> +<tr> +<td width="300"> + <center><a href="img/kpk-update.png"><img src="http://projects.gnome.org/gnome-color-manager/images/gcm-basic.png" alt=""/></a></center> + <p class="caption">GNOME Color Manager main screen</p> +</td> +</tr> +<tr> +<td width="300"> + <center><a href="img/kpk-update.png"><img src="http://projects.gnome.org/gnome-color-manager/images/gcm-device-configure.png" alt=""/></a></center> + <p class="caption">GCM calibration dialog</p> +</td> +</tr> +</table> +</center> + +<p>Back to the <a href="index.html">main page</a></p> + +<p class="footer"> + Copyright <a href="mailto:richard@hughsie.com">Richard Hughes 2011</a><br/> + <a href="http://validator.w3.org/check/referer">Optimized</a> + for <a href="http://www.w3.org/">standards</a>. +</p> + +</body> +</html> + diff --git a/doc/website/specifics.html b/doc/website/specifics.html new file mode 100644 index 0000000..a040e4b --- /dev/null +++ b/doc/website/specifics.html @@ -0,0 +1,139 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>colord - What is colord?</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> +<link rel="stylesheet" href="style.css" type="text/css" media="screen"/> +</head> +<body> + +<p>Back to the <a href="index.html">main page</a></p> + +<h1>How it works:</h1> + +<h2>Mapping the device to the profile</h2> + +<p> +Preferences are per-user and are stored in GConf in GNOME 2-30, or GSettings in newer versions. +There is need for configuration of devices to profiles, and to store metadata about each device. +This is stored in the colord mapping database, which is +<code>/var/lib/colord/mapping.db</code> by default. +The schema is really simple, and as follows: +</p> +<pre> +CREATE TABLE mappings (id TEXT PRIMARY KEY,device TEXT,profile TEXT); +</pre> + +<p> +Multiple profiles can of course be assigned to the same device. +Persistent devices and profiles can also be saved to the storage database, which is +<code>/var/lib/colord/storage.db</code> by default. +The schema is really simple, and as follows: +</p> +<pre> +CREATE TABLE devices (device_id TEXT PRIMARY KEY,device TEXT); +CREATE TABLE properties (device_id TEXT,property TEXT,value TEXT); +</pre> + +<h3>Comparison to UCMM</h3> +<p> +<a href="http://www.argyllcms.com/doc/ucmm.html">ucmm</a> (Unix micro Color Management Module) is a color management config file designed just to handle the necessary configuration needed to track the installation and association of ICC profiles with X11 displays. +</p> +<pre> +{ + "devices": { + "display": { + "1": { + "EDID": "0x00FFFFFFFFFFFF0034A1731751720000150901010C1F17CDE8A11E9E554A982712474FA4CE0045598180315961590101010101010101000000FE004D6F6E69746F720A2020202020000000FE004D6F6E69746F720A2020202020000000FE004D6F6E69746F720A2020202020000000FE004D6F6E69746F720A2020202020003D", + "ICC_PROFILE": "/home/graeme/.local/share/color/devices/display/mon1.icc" + }, + "2": { + "NAME": ":0.1", + "ICC_PROFILE": "/home/graeme/.local/share/color/devices/display/mon2.icc" + } + } + } +} +</pre> + +The colord database differs from UCMM in the following ways: + +<ul> +<li>UCMM is a <a href="http://www.json.org/">JSON</a> (!JavaScript Object Notation) file format, whilst colord is a ''key=value'' style store</li> +<li>UCMM allows mapping from a monitor EDID or display name to a device profile, where colord maps <i>device IDs</i> to <i>profile IDs</i>.</li> +<li>UCMM stores the EDID in the file as a huge hex number, but colord stores other "junk" details such as a the device colorspace and device serial number which are useful to some GUI tools.</li> +<li>UCMM is a well documented standard used for a long time by ArgyllCMS whilst colord has only ever been used by GCM.</li> +<li>UCMM has to be parsed using a parser such as JNCF, whilst colord queried by any client that spaeks <code>DBus</code>.</li> +<li>UCMM only supports one profile per device, unlike colord which supports an ordered list of profiles.</li> +</ul> + +<p> +All that said, UCMM is already used by ArgyllCMS and we should probably +import the existing files on the first run of GCM. +</p> + +<h3>Using Elektra</h3> +<p> +Oyranos puts device settings in the session and system +<a href="http://elektra.g4ii.com/Main_Page">Elektra</a> database. +Elektra is not a supported library in any mainstream distribution and is +not used by any modern open source projects or frameworks. +GCM will not import settings from Elektra (as this would make GCM itself +depend on Elektra) nor can it propagate settings back into the Oyranos +configuration system. +</p> +<p> +Until Oyranos moves away from Elektra there is no way it can work alongside GCM. +The GCM author would be willing to work with the Oyranos developers to +define a standard compatible with both systems, but Elektra is simply +not a viable option for GCM. +</p> + +<h2>Setting the system default</h2> +<p> +One user may want to set the default for all users. +We cannot reference files in <code>/home/foo/.icc/</code> when logged in +as user bar, as the user will not have access permissions, or in the +worst case, <code>/home/foo</code> may be encrypted and inaccessible even as root. +For this reason, colord copies the ICC profiles to a systemwide directory, +<code>/usr/lib/color</code> that is per-machine and accessible to all users. +</p> +<p> +It is <a href="http://lists.freedesktop.org/archives/openicc/2010q2/002167.html">encouraged</a> that other CMS implementations also read ICC profiles from the per-machine +<code>/usr/lib/color</code> directory. +</p> + +<h2>What the binaries do</h2> + +<p> +GCM ships quite a few data files and binary files. Most users will interact with ICC files by double clicking on them, and with color management using ''System->Preferences->Color Profiles''. It's not expected that users should need to run any command line programs at all. +</p> + +For interest, the different binaries are listed here. + +<h3>GTK programs</h3> + +<ul> +<li><code>gcm-import</code> - Helper to import an ICC file. This is normally run by the <code>gcm-import.desktop</code> file. +<li><code>gcm-picker</code> - Simple program to pick a spot color using a photospectrometer. +</ul> + +<h3>Command line tools</h3> +<ul> +<li><code>gcm-inspect</code> - Command line tool to inspect settings and test the DBus API.</li> +<li><code>gcm-fix-profile</code> - Tries to fix a corrupted or invalid ICC profile file.</li> +<li><code>gcm-session</code> - DBus session service that is started on demand.</li> +<li><code>gcm-dump-edid</code> - Debugging program that dumps the EDID to a file.</li> +<li><code>gcm-dump-profile</code> - Debugging program that dumps all details about a profile.</li> +</ul> + +<p>Back to the <a href="index.html">main page</a></p> + +<p class="footer"> + Copyright <a href="mailto:richard@hughsie.com">Richard Hughes 2011</a><br/> + <a href="http://validator.w3.org/check/referer">Optimized</a> + for <a href="http://www.w3.org/">standards</a>. +</p> + +</body> +</html> diff --git a/doc/website/style.css b/doc/website/style.css new file mode 100644 index 0000000..d426cfe --- /dev/null +++ b/doc/website/style.css @@ -0,0 +1,102 @@ +body { + background: #fefeff; + color: #000000; + font-family: 'Lucida Grande', Verdana, Arial, Sans-Serif; + margin-top: 2em; + margin-left: 5%; + margin-right: 5%; + } + +h1, h2, h3 { + color: #000000; + font-family: 'Trebuchet MS', 'Lucida Grande', Verdana, Arial, Sans-Serif; + font-weight: bold; + } + +table.noteinformation { + background: #f5f5ff; + border: 1px outset #000000; + margin-left: 5px; + margin-right: 5px; + padding: 3px; + width: 40%; + } + +p.title { + color: #000000; + text-align: center; + font-weight: bolder; + font-size: 20px; + } + +p.footer { + color: #000000; + text-align: center; + font-size: 6px; + } + +p.caption { + color: #000000; + text-align: center; + font-style: italic; + } + +th { + color: #000000; + text-align: left; + } + +a.indextitle { + color: #000147; + font-weight: bolder; + font-size: 20px; + } + +p.indextitle { + text-align: center; + } + +table.title { + color: #000000; + background-color: #f5f5ff; + border: 1px outset #000000; + } + +img { + border: 0; + } + +img.caption { + border: 0; + text-align: center; + } + +code { + color: #000000; + font: 1.1em 'Courier New', Courier, Fixed; + margin-left: .3em; + margin-right: .3em; + } + +pre { + color: #000000; + background: #eeeeee; + border: 1px outset #000000; + padding: 3px; +} + +a:hover { + color: #147; + text-decoration: none; + } + +a { + color: #147; + text-decoration: none; + } + +td.title { + color: #000000; + font-weight: bold; + } + diff --git a/doc/website/using.html b/doc/website/using.html new file mode 100644 index 0000000..dcb1706 --- /dev/null +++ b/doc/website/using.html @@ -0,0 +1,115 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<title>colord - How do I use colord?</title> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8"/> +<link rel="stylesheet" href="style.css" type="text/css" media="screen"/> +</head> +<body> + +<p>Back to the <a href="index.html">main page</a></p> + +<h1>How do I use colord?</h1> + +<h2>Using the command line</h2> +<p> +The <code>colormgr</code> text-mode program allows you to interact with +colord on the command line. For example: +</p> +<pre> +[hughsie@hughsie-work ~]$ colormgr get-devices +Object Path: /org/freedesktop/ColorManager/devices/sysfs_chicony_electronics_co___ltd__integrated_camera +Created: 1296825093 +Modified: 1296825093 +Kind: camera +Model: Integrated Camera +Vendor: Chicony Electronics Co. Ltd. +Serial: +Colorspace: rgb +Device ID: sysfs_chicony_electronics_co___ltd__integrated_camera +Object Path: /org/freedesktop/ColorManager/devices/Photosmart_B109a_m +Created: 1296825095 +Modified: 1296825095 +Kind: printer +Model: HP Photosmart b109a-m, hpcups 3.10.9 +Vendor: +Serial: +Colorspace: unknown +Device ID: Photosmart-B109a-m +Profile 1: /org/freedesktop/ColorManager/profiles/Photosmart_B109a_m_DeviceN__ +Profile 2: /org/freedesktop/ColorManager/profiles/Photosmart_B109a_m_RGB__ +</pre> +<p>or</p> +<pre> +[hughsie@hughsie-work ~]$ colormgr --help +Usage: + colormgr [OPTION...] + + create-device Create a device + create-profile Create a profile + delete-device Deletes a device + delete-profile Deletes a profile + device-add-profile Add a profile to a device + device-get-default-profile Gets the default profile for a device + device-get-profile-for-qualifier Returns all the profiles that match a qualifier + device-make-profile-default Makes a profile default for a device + device-set-kind Sets the device kind + device-set-model Sets the device model + device-set-serial Sets the device serial + device-set-vendor Sets the device vendor + find-device Find a device + find-profile Find a profile + get-devices Gets all the color managed devices + get-devices-by-kind Gets all the color managed devices of a specific kind + get-profiles Gets all the available color profiles + profile-set-filename Sets the profile filename + profile-set-qualifier Sets the profile qualifier + +Help Options: + -h, --help Show help options +</pre> + +<h2>Using graphical tools:</h2> +<p> +<code>gnome-color-manager</code> provides a rich set of GTK tools for +automatically managing color devices and profiles. +See the <a href="screenshots.html">screenshots page</a> for more details. +</p> + +<h2>Using libcolord:</h2> +<p> +The <a href="gtk-doc/CdClient.html">libcolord gobject library</a> +wraps the DBUS interface in a nice glib-style API. +This makes designing programs that use libcolord can concentrate on +core functionality rather that the DBUS and colord internals. +CdClient in libcolord can be used as easily as: +</p> +<pre> +CdClient *client; +GError *error; +GPtrArray *devices; +client = cd_client_new (); +devices = cd_client_get_devices_sync (client, cancellable, &error); +g_object_unref (client); +g_ptr_array_unref (devices); +</pre> + +<h2>Using the raw DBUS API:</h2> +<p> +Using the DBUS methods and signals directly means that no glib or +gobject dependency is needed. +This is not difficult, although does require more code than just using +libcolord. +The latest interface is available in the source tree or <a href="http://gitweb.freedesktop.org/?p=colord.git;a=blob;f=src/org.freedesktop.colord.xml">on-line</a>. +</p> + +<p>Back to the <a href="index.html">main page</a></p> + +<p class="footer"> + Copyright <a href="mailto:richard@hughsie.com">Richard Hughes 2011</a><br/> + <a href="http://validator.w3.org/check/referer">Optimized</a> + for <a href="http://www.w3.org/">standards</a>. +</p> + +</body> +</html> |
