doc/apt-extracttemplates.1.xml

   1 <?xml version="1.0" encoding="utf-8" standalone="no"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4
   5 <!ENTITY % aptent SYSTEM "apt.ent">
   6 %aptent;
   7
   8 <!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
   9 %aptverbatiment;
  10
  11 ]>
  12
  13 <refentry>
  14
  15  <refentryinfo>
  16    &apt-author.jgunthorpe;
  17    &apt-author.team;
  18    &apt-email;
  19    &apt-product;
  20    <!-- The last update date -->
  21    <date>2012-06-09T00:00:00Z</date>
  22  </refentryinfo>
  23
  24  <refmeta>
  25    <refentrytitle>apt-extracttemplates</refentrytitle>
  26    <manvolnum>1</manvolnum>
  27    <refmiscinfo class="manual">APT</refmiscinfo>
  28  </refmeta>
  29
  30  <!-- Man page title -->
  31  <refnamediv>
  32     <refname>apt-extracttemplates</refname>
  33     <refpurpose>Utility to extract <command>debconf</command> config and templates from Debian packages</refpurpose>
  34  </refnamediv>
  35
  36  &synopsis-command-apt-extracttemplates;
  37
  38  <refsect1><title>Description</title>
  39    <para><command>apt-extracttemplates</command> will take one or more Debian package files
  40    as input and write out (to a temporary directory) all associated config
  41    scripts and template files. For each passed in package that contains
  42    config scripts and templates, one line of output will be generated
  43    in the format:</para>
  44    <para>package version template-file config-script</para>
  45    <para>template-file and config-script are written to the temporary directory
  46    specified by the <option>-t</option> or <option>--tempdir</option>
  47    (<literal>APT::ExtractTemplates::TempDir</literal>) directory,
  48    with filenames of the form <filename>package.template.XXXX</filename> and
  49    <filename>package.config.XXXX</filename></para>
  50  </refsect1>
  51
  52  <refsect1><title>options</title>
  53    &apt-cmdblurb;
  54
  55    <variablelist>
  56      <varlistentry><term><option>-t</option></term><term><option>--tempdir</option></term>
  57      <listitem><para>
  58      Temporary directory in which to write extracted <command>debconf</command> template files
  59      and config scripts.
  60      Configuration Item: <literal>APT::ExtractTemplates::TempDir</literal></para></listitem>
  61      </varlistentry>
  62
  63      &apt-commonoptions;
  64
  65    </variablelist>
  66
  67
  68  </refsect1>
  69
  70  <refsect1><title>See Also</title>
  71    <para>&apt-conf;</para>
  72  </refsect1>
  73
  74  <refsect1><title>Diagnostics</title>
  75    <para><command>apt-extracttemplates</command> returns zero on normal operation, decimal 100 on error.</para>
  76  </refsect1>
  77
  78  &manbugs;
  79
  80 </refentry>