source: chapter06/mktemp.xml@ c11bcb7

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>

<sect1 id="ch-system-mktemp" role="wrap">
  <?dbhtml filename="mktemp.html"?>

  <sect1info condition="script">
    <productname>mktemp</productname>
    <productnumber>&mktemp-version;</productnumber>
    <address>&mktemp-url;</address>
  </sect1info>

  <title>Mktemp-&mktemp-version;</title>

  <indexterm zone="ch-system-mktemp">
    <primary sortas="a-Mktemp">Mktemp</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Mktemp package contains programs used to create secure temporary
    files in shell scripts.</para>

    <segmentedlist>
      <segtitle>&buildtime;</segtitle>
      <segtitle>&diskspace;</segtitle>

      <seglistitem>
        <seg>&mktemp-ch6-sbu;</seg>
        <seg>&mktemp-ch6-du;</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Mktemp</title>

    <para>Many scripts still use the deprecated
    <command>tempfile</command> program, which has functionality similar
    to <command>mktemp</command>. Patch Mktemp to include a
    <command>tempfile</command> wrapper:</para>

<screen><userinput>patch -Np1 -i ../&mktemp-tempfile-patch;</userinput></screen>

    <para>Prepare Mktemp for compilation:</para>

<screen><userinput>./configure --prefix=/usr --with-libc</userinput></screen>

    <variablelist>
      <title>The meaning of the configure options:</title>

      <varlistentry>
        <term><parameter>--with-libc</parameter></term>
        <listitem>
          <para>This causes the <command>mktemp</command> program to use the
          <emphasis>mkstemp</emphasis> and <emphasis>mkdtemp</emphasis>
          functions from the system C library instead of its own implementation
          of them. </para>
        </listitem>
      </varlistentry>

    </variablelist>

    <para>Compile the package:</para>

<screen><userinput>make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Install the package:</para>

<screen><userinput>make install
make install-tempfile</userinput></screen>

  </sect2>

  <sect2 id="contents-mktemp" role="content">
    <title>Contents of Mktemp</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>

      <seglistitem>
        <seg>mktemp and tempfile</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="mktemp">
        <term><command>mktemp</command></term>
        <listitem>
          <para>Creates temporary files in a secure manner; it is used in
          scripts</para>
          <indexterm zone="ch-system-mktemp mktemp">
            <primary sortas="b-mktemp">mktemp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tempfile">
        <term><command>tempfile</command></term>
        <listitem>
          <para>Creates temporary files in a less secure manner than
          <command>mktemp</command>; it is installed for
          backwards-compatibility</para>
          <indexterm zone="ch-system-mktemp tempfile">
            <primary sortas="b-tempfile">tempfile</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>