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