<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry>
  <refentryinfo>
    <address>
      <email>thijs@debian.org</email>
    </address>
    <author>
      <firstname>Thijs</firstname>
      <surname>Kinkhorst</surname>
    </author>
    <date>May 2012</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>rapt-file</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>rapt-file</refname>
    <refpurpose>
      APT package searching utility -- search remotely
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>rapt-file</command>
      <arg><option>options</option></arg>
      <arg>action</arg>
      <arg><option>pattern</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para><command>rapt-file</command> is a command line tool for
      searching files in packages for the APT package management system.
      It differs from apt-file in that it works with remote package
      indices, so it doesn't need to download full Contents files.</para>
    <variablelist>

      <varlistentry>
	<term>find</term>
	<listitem>
	  <para>
	    Alias for <option>search</option>.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>list</term>
	<listitem>
	  <para>
	    List the contents of a package matching the
	    <option>pattern</option> pattern. This action is very
	    close to the <command>dpkg -L</command> command except the
	    package does not need to be installed or fetched.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>search</term>
	<listitem>
	  <para>
	    Search in which package a file is included. A list of all
	    packages containing the <option>pattern</option> pattern
	    is returned.
	  </para>
	  <para>
	    rapt-file will only search for filenames, not directory names.
	    This is due to the format of the Contents files it searches.
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>show</term>
	<listitem>
	  <para>
	    Alias for <option>list</option>.
	  </para>
	</listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>
    <variablelist>

      <varlistentry>
	<term>
	  <option>-a, --architecture</option>
	  architecture
	</term>
	<listitem>
	  <para>
	  Sets architecture to <literal>architecture</literal>. This
	  option is useful if you search a package for a different
	  architecture from the one installed on your system.
	  It determines how the <literal>$ARCH</literal> variable
	  in sources.list is expanded (but it does not influence
	  the search in any other way).
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-l, --package-only</option>
	</term>
	<listitem>
	  <para>
	    Only display package name; do not display file names.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-v, --verbose</option>
	</term>
	<listitem>
	  <para>
	    Run <command>rapt-file</command> in verbose mode.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-h, --help</option>
	</term>
	<listitem>
	  <para>Display a short help screen.</para>
	</listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>FILES</title>
    <variablelist>
      <varlistentry>
	<term><filename>/etc/apt/sources.list</filename></term>
	<listitem>
	  <para>Locations to fetch package contents from.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><filename>/etc/apt/sources.list.d/</filename></term>
	<listitem>
	  <para>Directory with additional sources.list snippets</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
    <para>
      <command>rapt-file</command> was written by Enrico Zini
      <email>enrico@debian.org</email>.
    </para>
  </refsect1>

</refentry>
