summaryrefslogtreecommitdiff
path: root/man/colormgr.xml
diff options
context:
space:
mode:
Diffstat (limited to 'man/colormgr.xml')
-rw-r--r--man/colormgr.xml335
1 files changed, 335 insertions, 0 deletions
diff --git a/man/colormgr.xml b/man/colormgr.xml
new file mode 100644
index 0000000..d2d7840
--- /dev/null
+++ b/man/colormgr.xml
@@ -0,0 +1,335 @@
+<!-- Please adjust the date whenever revising the manpage. -->
+<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <info>
+ <address>
+ <email>richard@hughsie.com</email>;
+ </address>
+ <author><personname><firstname>Richard</firstname><surname>Hughes</surname></personname></author>
+ <copyright>
+ <year>2010-2013</year>
+ <holder>Richard Hughes</holder>
+ </copyright>
+ <date>18 June,2013</date>
+ </info>
+ <refmeta>
+ <refentrytitle>colormgr</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">User Commands</refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname>colormgr</refname>
+ <refpurpose>Color Manager Testing Tool</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>colormgr</command>
+ <arg><option>--verbose</option></arg>
+ <arg><option>--version</option></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+ <para>
+ This manual page documents briefly the <command>colormgr</command> command.
+ </para>
+ <para>
+ <command>colormgr</command> allows an administrator to view and
+ change color profile to device mappings.
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+ <para>
+ This program follows the usual <acronym>GNU</acronym> command line syntax,
+ with long options starting with two dashes (`-'). A summary of
+ options is included below.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>--help</option>
+ </term>
+ <listitem>
+ <para>Show summary of options.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>COMMANDS</title>
+ <para>
+ This program takes commands with a variable number of arguments.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>create-device</option>
+ <parameter>device_id</parameter>
+ <parameter>scope</parameter>
+ </term>
+ <listitem>
+ <para>Create a device</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>create-profile</option>
+ <parameter>profile_id</parameter>
+ <parameter>scope</parameter>
+ </term>
+ <listitem>
+ <para>Create a profile</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>delete-device</option>
+ <parameter>device</parameter>
+ </term>
+ <listitem>
+ <para>Deletes a device</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>delete-profile</option>
+ <parameter>profile</parameter>
+ </term>
+ <listitem>
+ <para>Deletes a profile</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>device-add-profile</option>
+ <parameter>device</parameter>
+ <parameter>profile</parameter>
+ </term>
+ <listitem>
+ <para>Add a profile to a device that already exists</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>device-get-default-profile</option>
+ <parameter>device</parameter>
+ </term>
+ <listitem>
+ <para>Gets the default profile for a device</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>device-get-profile-for-qualifier</option>
+ <parameter>device</parameter>
+ <parameter>qualifier</parameter>
+ </term>
+ <listitem>
+ <para>Returns all the profiles that match a qualifier</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>device-inhibit</option>
+ <parameter>device</parameter>
+ <parameter>timeout</parameter>
+ </term>
+ <listitem>
+ <para>Inhibits colour profiles for this device</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>device-make-profile-default</option>
+ <parameter>device</parameter>
+ <parameter>profile</parameter>
+ </term>
+ <listitem>
+ <para>Makes a profile default for a device</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>device-set-enabled</option>
+ </term>
+ <listitem>
+ <para>Enables or disables the device</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>device-set-kind</option>
+ <parameter>device</parameter>
+ <parameter>kind</parameter>
+ </term>
+ <listitem>
+ <para>Sets the device kind</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>device-set-model</option>
+ <parameter>device</parameter>
+ <parameter>model</parameter>
+ </term>
+ <listitem>
+ <para>Sets the device model</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>device-set-serial</option>
+ <parameter>device</parameter>
+ <parameter>serial</parameter>
+ </term>
+ <listitem>
+ <para>Sets the device serial</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>device-set-vendor</option>
+ <parameter>device</parameter>
+ <parameter>vendor</parameter>
+ </term>
+ <listitem>
+ <para>Sets the device vendor</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>find-device</option>
+ <parameter>device_id</parameter>
+ </term>
+ <listitem>
+ <para>Find a device from the device ID</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>find-device-by-property</option>
+ <parameter>key</parameter>
+ <parameter>value</parameter>
+ </term>
+ <listitem>
+ <para>Find a device with a given property value</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>find-profile</option>
+ <parameter>profile_id</parameter>
+ </term>
+ <listitem>
+ <para>Find a profile from the profile ID</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>find-profile-by-filename</option>
+ <parameter>filename</parameter>
+ </term>
+ <listitem>
+ <para>Find a profile by filename</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>get-devices</option>
+ </term>
+ <listitem>
+ <para>Gets all the color managed devices</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>get-devices-by-kind</option>
+ <parameter>kind</parameter>
+ </term>
+ <listitem>
+ <para>Gets all the color managed devices of a specific kind</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>get-profiles</option>
+ </term>
+ <listitem>
+ <para>Gets all the available color profiles</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>get-sensor-reading</option>
+ <parameter>display_type</parameter>
+ </term>
+ <listitem>
+ <para>Gets a reading from a sensor</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>get-sensors</option>
+ </term>
+ <listitem>
+ <para>Gets all the available colour sensors</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>get-standard-space</option>
+ <parameter>standard_space</parameter>
+ </term>
+ <listitem>
+ <para>Get a standard colourspace</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>import-profile</option>
+ <parameter>filename</parameter>
+ </term>
+ <listitem>
+ <para>
+ Copies an .icc file into the correct per-user directory and shows
+ information about the imported profile.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>profile-set-property</option>
+ <parameter>profile</parameter>
+ <parameter>name</parameter>
+ <parameter>value</parameter>
+ </term>
+ <listitem>
+ <para>Sets extra properties on the profile</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>sensor-lock</option>
+ </term>
+ <listitem>
+ <para>Locks the colour sensor</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>sensor-set-options</option>
+ <parameter>name</parameter>
+ <parameter>value</parameter>
+ </term>
+ <listitem>
+ <para>Sets one or more sensor options</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+ <para>This manual page was written by Richard Hughes <email>richard@hughsie.com</email>.
+ </para>
+ </refsect1>
+</refentry>