source: general/genutils/pinentry.xml@ 14b8417

<?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;

  <!ENTITY pinentry-download-http "&sources-anduin-http;/p/pinentry-&pinentry-version;.tar.gz">
  <!ENTITY pinentry-download-ftp  "ftp://ftp.gnupg.org/gcrypt/pinentry/pinentry-&pinentry-version;.tar.gz">
  <!ENTITY pinentry-md5sum        "5a4f676375fa882009da02013d77210f">
  <!ENTITY pinentry-size          "464 KB">
  <!ENTITY pinentry-buildsize     "9 MB">
  <!ENTITY pinentry-time          "0.1 SBU">
]>

<sect1 id="pinentry" xreflabel="PIN-Entry-&pinentry-version;">
  <?dbhtml filename="pinentry.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>PIN-Entry-&pinentry-version;</title>

  <indexterm zone="pinentry">
    <primary sortas="a-PIN-Entry">PIN-Entry</primary>
  </indexterm>

  <!--Required section-->
  <sect2 role="package">
    <title>Introduction to PIN-Entry</title>

    <para>The <application>PIN-Entry</application> package contains a
    collection of simple PIN or pass-phrase entry dialogs which utilize the
    Assuan protocol as described by the
    <ulink url="http://www.gnupg.org/aegypten/">&#xC4;gypten project</ulink>.
    <application>PIN-Entry</application> programs are usually invoked by
    the <command>gpg-agent</command> daemon, but can be run from the command
    line as well. There are programs for various text-based and GUI
    environments, including interfaces designed for
    <application>Ncurses</application> (text-based),
    <application>Gtk+</application>, <application>Gtk+-2</application>,
    and <application>Qt-3</application>.</para>

    &lfs65_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&pinentry-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&pinentry-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &pinentry-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &pinentry-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &pinentry-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &pinentry-time;</para>
      </listitem>
    </itemizedlist>

    <!-- <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/pinentry-&pinentry-version;-fixes-1.patch"/></para>
      </listitem>
    </itemizedlist> -->

    <bridgehead renderas="sect3">PIN-Entry Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="GTK"/>,
    <xref linkend="gtk2"/>,
    <xref linkend="qt"/>, and
    <ulink url="http://packages.debian.org/stable/source/libcap">libcap</ulink></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/pinentry"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of PIN-Entry</title>

    <para>Install <application>PIN-Entry</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr \
            --enable-pin-entry-curses        \
            --enable-fallback-curses         \
            --disable-pinentry-gtk           \
            --disable-pinentry-gtk2          \
            --disable-pinentry-qt            &amp;&amp;
make</userinput></screen>

    <para>Only <command>info</command> documentation is shipped in the package
    tarball. If you wish to build alternate formats of the documentation, you
    must have <xref linkend="tetex"/> installed, then issue the following
    commands:</para>

<screen><userinput>make -k -C doc pdf ps html &amp;&amp;
makeinfo --html --no-split -o doc/pinentry_nochunks.html doc/pinentry.texi &amp;&amp;
makeinfo --plaintext       -o doc/pinentry.txt           doc/pinentry.texi</userinput></screen>

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

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install &amp;&amp;
install -v -m644 -D README /usr/share/doc/pinentry-&pinentry-version;/README</userinput></screen>

    <para>If you built the additional documentation, install it by issuing the
    following commands as the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/pinentry-&pinentry-version;/html &amp;&amp;
install -v -m644 doc/pinentry.html/* \
                    /usr/share/doc/pinentry-&pinentry-version;/html &amp;&amp;
install -v -m644 doc/pinentry_*.html \
                    /usr/share/doc/pinentry-&pinentry-version; &amp;&amp;
install -v -m644 doc/pinentry.{pdf,ps,dvi,txt,texi} \
                    /usr/share/doc/pinentry-&pinentry-version;</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--enable-...</parameter>: These two parameters are used to
    fix a problem with the <command>configure</command> script if the optional
    dependencies are not installed. If the dependencies are installed, these
    parameters may be omitted.</para>

    <para><parameter>--disable-...</parameter>: These three parameters are used
    to fix a problem with the <command>configure</command> script if the
    optional dependencies are not installed. If the dependencies are installed,
    these parameters may be omitted.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>pinentry, pinentry-curses, pinentry-gtk, pinentry-gtk-2,
        and pinentry-qt</seg>
        <seg>None</seg>
        <seg>/usr/share/doc/pinentry-&pinentry-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="pinentry-prog">
        <term><command>pinentry</command></term>
        <listitem>
          <para>is a symbolic link to the default
          <application>PIN-Entry</application> program.</para>
          <indexterm zone="pinentry pinentry-prog">
            <primary sortas="g-pinentry">pinentry</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pinentry-curses">
        <term><command>pinentry-curses</command></term>
        <listitem>
          <para> is an <application>Ncurses</application> text-based
          <application>PIN-Entry</application> program.</para>
          <indexterm zone="pinentry pinentry-curses">
            <primary sortas="g-pinentry-curses">pinentry-curses</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pinentry-gtk">
        <term><command>pinentry-gtk</command></term>
        <listitem>
          <para> is a <application>Gtk</application> GUI
          <application>PIN-Entry</application> program.</para>
          <indexterm zone="pinentry pinentry-gtk">
            <primary sortas="g-pinentry-gtk">pinentry-gtk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pinentry-gtk-2">
        <term><command>pinentry-gtk-2</command></term>
        <listitem>
          <para> is a <application>Gtk-2</application> GUI
          <application>PIN-Entry</application> program.</para>
          <indexterm zone="pinentry pinentry-gtk-2">
            <primary sortas="g-pinentry-gtk-2">pinentry-gtk-2</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pinentry-qt">
        <term><command>pinentry-qt</command></term>
        <listitem>
          <para> is a <application>Qt</application> GUI
          <application>PIN-Entry</application> program.</para>
          <indexterm zone="pinentry pinentry-qt">
            <primary sortas="g-pinentry-qt">pinentry-qt</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>