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 <!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>29 February 2004</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 DebConf config and templates from Debian packages</refpurpose>
  34  </refnamediv>
  35
  36  <!-- Arguments -->
  37  <refsynopsisdiv>
  38    <cmdsynopsis>
  39       <command>apt-extracttemplates</command>
  40       <arg><option>-hv</option></arg>
  41       <arg><option>-t=<replaceable>temporary directory</replaceable></option></arg>
  42       <arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg>
  43    </cmdsynopsis>
  44  </refsynopsisdiv>
  45
  46  <refsect1><title>Description</title>
  47    <para><command>apt-extracttemplates</command> will take one or more Debian package files
  48    as input and write out (to a temporary directory) all associated config
  49    scripts and template files. For each passed in package that contains
  50    config scripts and templates, one line of output will be generated
  51    in the format:</para>
  52    <para>package version template-file config-script</para>
  53    <para>template-file and config-script are written to the temporary directory
  54    specified by the -t or --tempdir (<literal>APT::ExtractTemplates::TempDir</literal>)
  55    directory, with filenames of the form <filename>package.template.XXXX</filename> and
  56    <filename>package.config.XXXX</filename></para>
  57  </refsect1>
  58
  59  <refsect1><title>options</title>
  60    &apt-cmdblurb;
  61
  62    <variablelist>
  63      <varlistentry><term><option>-t</option></term><term><option>--tempdir</option></term>
  64      <listitem><para>
  65      Temporary directory in which to write extracted debconf template files
  66      and config scripts.
  67      Configuration Item: <literal>APT::ExtractTemplates::TempDir</literal></para></listitem>
  68      </varlistentry>
  69
  70      &apt-commonoptions;
  71
  72    </variablelist>
  73
  74
  75  </refsect1>
  76
  77  <refsect1><title>See Also</title>
  78    <para>&apt-conf;</para>
  79  </refsect1>
  80
  81  <refsect1><title>Diagnostics</title>
  82    <para><command>apt-extracttemplates</command> returns zero on normal operation, decimal 100 on error.</para>
  83  </refsect1>
  84
  85  &manbugs;
  86
  87 </refentry>