doc/apt-extracttemplates.1.xml

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