<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Chris</firstname>">
  <!ENTITY dhsurname   "<surname>Cheney</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>November  6, 2002</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>ccheney@debian.org</email>">
  <!ENTITY dhusername  "Chris Cheney">
  <!ENTITY dhucpackage "<refentrytitle>TDEFILE</refentrytitle>">
  <!ENTITY dhpackage   "tdefile">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2002</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>A commandline tool to read and modify metadata of files</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option><replaceable>Qt-options</replaceable></option></arg>
      <arg><option><replaceable>KDE-options</replaceable></option></arg>
      <arg><option><replaceable>options</replaceable></option></arg>
      <arg><option><replaceable>files</replaceable></option></arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para><command>&dhpackage;</command> is a commandline tool to read and modify metadata of files.</para>

  </refsect1>
  <refsect1>
    <title>GENERIC OPTIONS</title>

    <para>This program follows the usual GNU command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.</para>

    <variablelist>
      <varlistentry>
        <term><option>--author</option>
        </term>
        <listitem>
          <para>Show author information.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help</option>
        </term>
        <listitem>
          <para>Show help about options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help-all</option>
        </term>
        <listitem>
          <para>Show all options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help-kde</option>
        </term>
        <listitem>
          <para>Show KDE specific options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help-qt</option>
        </term>
        <listitem>
          <para>Show Qt specific options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--license</option>
        </term>
        <listitem>
          <para>Show license information.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>, <option>--version</option>
        </term>
        <listitem>
          <para>Show version information.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>QT OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>--bg</option>, <option>--background <replaceable>color</replaceable></option>
        </term>
        <listitem>
          <para>Sets the default background color and an application palette (light and dark shades are calculated).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--btn</option>, <option>--button <replaceable>color</replaceable></option>
        </term>
        <listitem>
          <para>Sets the default button color.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--cmap</option>
        </term>
        <listitem>
          <para>Causes the application to install a private color map on an 8-bit display.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--display <replaceable>displayname</replaceable></option>
        </term>
        <listitem>
          <para>Use the X-server display 'displayname'.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--dograb</option>
        </term>
        <listitem>
          <para>Running under a debugger can cause an implicit --nograb, use --dograb to override.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--fg</option>, <option>--foreground <replaceable>color</replaceable></option>
        </term>
        <listitem>
          <para>Sets the default foreground color.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--fn</option>, <option>--font <replaceable>fontname</replaceable></option>
        </term>
        <listitem>
          <para>Defines the application font.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--im <replaceable>XIMserver</replaceable></option>
        </term>
        <listitem>
          <para>Set XIM server.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--inputstyle <replaceable>inputstyle</replaceable></option>
        </term>
        <listitem>
          <para>Sets XIM (X Input Method) input style. Possible values are onthespot, overthespot, offthespot and root.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--name <replaceable>name</replaceable></option>
        </term>
        <listitem>
          <para>Sets the application name.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--ncols <replaceable>count</replaceable></option>
        </term>
        <listitem>
          <para>Limits the number of colors allocated in the color cube on an 8-bit display, if the application is using the QApplication::ManyColor color specification.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--nograb</option>
        </term>
        <listitem>
          <para>Tells Qt to never grab the mouse or the keyboard.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--noxim</option>
        </term>
        <listitem>
          <para>Disable XIM.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--reverse</option>
        </term>
        <listitem>
          <para>Mirrors the whole layout of widgets.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--session <replaceable>sessionId</replaceable></option>
        </term>
        <listitem>
          <para>Restore the application for the given 'sessionId'.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--sync</option>
        </term>
        <listitem>
          <para>Switches to synchronous mode for debugging.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--title <replaceable>title</replaceable></option>
        </term>
        <listitem>
          <para>Sets the application title (caption).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--visual TrueColor</option>
        </term>
        <listitem>
          <para>Forces the application to use a TrueColor visual on an 8-bit display.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>KDE OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>--caption <replaceable>caption</replaceable></option>
        </term>
        <listitem>
          <para>Use 'caption' as name in the titlebar.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--config <replaceable>filename</replaceable></option>
        </term>
        <listitem>
          <para>Use alternative configuration file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--dcopserver <replaceable>server</replaceable></option>
        </term>
        <listitem>
          <para>Use the DCOP Server specified by 'server'.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--geometry <replaceable>geometry</replaceable></option>
        </term>
        <listitem>
          <para>Sets the client geometry of the main widget.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--icon <replaceable>icon</replaceable></option>
        </term>
        <listitem>
          <para>Use 'icon' as the application icon.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--miniicon <replaceable>icon</replaceable></option>
        </term>
        <listitem>
          <para>Use 'icon' as the icon in the titlebar.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--nocrashhandler</option>
        </term>
        <listitem>
          <para>Disable crash handler, to get core dumps.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--style <replaceable>style</replaceable></option>
        </term>
        <listitem>
          <para>Sets the application GUI style.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--waitforwm</option>
        </term>
        <listitem>
          <para>Waits for a WM_NET compatible windowmanager.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>APP OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>--av</option>, <option>--allValues</option>
        </term>
        <listitem>
          <para>Prints all metadata values, available in the given file(s).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--dialog</option>
        </term>
        <listitem>
          <para>Opens a KDE properties dialog to allow viewing and modifying of metadata of the given file(s).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--getValue <replaceable>key</replaceable></option>
        </term>
        <listitem>
          <para>Prints the value for 'key' of the given file(s). 'key' may also be a comma-separated list of keys.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--la</option>, <option>--listavailable</option>
        </term>
        <listitem>
          <para>List all metadata keys which have a value in the given file(s).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--lp</option>, <option>--listpreferred <replaceable>mimetype</replaceable></option>
        </term>
        <listitem>
          <para>List all preferred metadata keys of the given file(s). If mimetype is not specified, the mimetype of the given files is used.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--ls</option>, <option>--listsupported <replaceable>mimetype</replaceable></option>
        </term>
        <listitem>
          <para>List all supported metadata keys of the given file(s). If mimetype is not specified, the mimetype of the given files is used.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-m</option>, <option>--nomimetype</option>
        </term>
        <listitem>
          <para>Print the mimetype of the given file(s).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--pv</option>, <option>--preferredValues</option>
        </term>
        <listitem>
          <para>Prints the preferred metadata values, available in the given file(s).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-q</option>, <option>--quiet</option>
        </term>
        <listitem>
          <para>Don't print a warning when more than one file was given and they don't have all the same mimetype.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--setValue <replaceable>key=value</replaceable></option>
        </term>
        <listitem>
          <para>Attempts to set the value 'value' for the metadata key 'key' for the given file(s).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--sm</option>, <option>--supportedMimetypes</option>
        </term>
        <listitem>
          <para>Prints all mimetypes for which metadata support is available.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername;
      &lt;&dhemail;&gt; for the &debian; system (but may be used by
      others).  Permission is granted to copy, distribute and/or
      modify this document under the terms of the &gnu; General Public
      License, Version 2 or any later version published by the Free
      Software Foundation.
    </para>

    <para>On Debian systems, the complete text of the GNU General
      Public License can be found in /usr/share/common-licenses/GPL.
    </para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->