doc/apt-extracttemplates.1.sgml

   1 <!-- -*- mode: sgml; mode: fold -*- -->
   2 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
   3
   4 <!ENTITY % aptent SYSTEM "apt.ent">
   5 %aptent;
   6
   7 ]>
   8
   9 <refentry>
  10  &apt-docinfo;
  11
  12  <refmeta>
  13    <refentrytitle>apt-extracttemplates</>
  14    <manvolnum>1</>
  15  </refmeta>
  16
  17  <!-- Man page title -->
  18  <refnamediv>
  19     <refname>apt-extracttemplates</>
  20     <refpurpose>Utility to extract DebConf config and templates from Debian packages</>
  21  </refnamediv>
  22
  23  <!-- Arguments -->
  24  <refsynopsisdiv>
  25    <cmdsynopsis>
  26       <command>apt-extracttemplate</>
  27       <arg><option>-hv</></arg>
  28       <arg><option>-t=<replaceable/temporary directory/</></arg>
  29       <arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg>
  30    </cmdsynopsis>
  31  </refsynopsisdiv>
  32
  33  <RefSect1><Title>Description</>
  34    <para>
  35    <command/apt-extracttemplates/ will take one or more Debian package files
  36    as input and write out (to a temporary directory) all associated config
  37    scripts and template files. For each passed in package that contains
  38    config scripts and templates, one line of output will be generated
  39    in the format:
  40    <para>
  41    package version template-file config-script
  42    <para>
  43    template-file and config-script are written to the temporary directory
  44    specified by the -t or --tempdir (<literal/APT::ExtractTemplates::TempDir/>)
  45    directory, with filenames of the form <filename>package.template.XXXX</> and
  46    <filename>package.config.XXXX</>
  47  </RefSect1>
  48
  49  <RefSect1><Title>Options</>
  50    &apt-cmdblurb;
  51
  52    <VariableList>
  53      <VarListEntry><term><option/-t/</><term><option/--tempdir/</>
  54      <ListItem><Para>
  55      Temporary directory in which to write extracted debconf template files
  56      and config scripts
  57      Configuration Item: <literal/APT::ExtractTemplates::TempDir/.
  58      </VarListEntry>
  59
  60      &apt-commonoptions;
  61
  62    </VariableList>
  63
  64
  65  </RefSect1>
  66
  67  <RefSect1><Title>See Also</>
  68    <para>
  69    &apt-conf;
  70  </RefSect1>
  71
  72  <RefSect1><Title>Diagnostics</>
  73    <para>
  74    <command/apt-extracttemplates/ returns zero on normal operation, decimal 100 on error.
  75  </RefSect1>
  76
  77  &manbugs;
  78  &manauthor;
  79
  80 </refentry>