glfs/general/genutils/pinentry.xml
Bruce Dubbs 9811e7455a Clarify pinentry program descriptions
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@16075 af4574ff-66df-0310-9fd7-8a98e5e911e0
2015-06-02 22:39:17 +00:00

241 lines
8.6 KiB
XML

<?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 " ">
<!ENTITY pinentry-download-ftp "ftp://ftp.gnupg.org/gcrypt/pinentry/pinentry-&pinentry-version;.tar.bz2">
<!ENTITY pinentry-md5sum "b81321407466a6263ebbfd34145cd6e8">
<!ENTITY pinentry-size "500 KB">
<!ENTITY pinentry-buildsize "15 MB (with <command>pinentry-qt4</command>)">
<!ENTITY pinentry-time "less than 0.1 SBU (with <command>pinentry-qt4</command>)">
]>
<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>
<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), and for the common
<application>GTK</application> and <application>Qt</application>
toolkits.</para>
&lfs77_checked; &gcc5_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">PIN-Entry Dependencies</bridgehead>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="gtk2"/>,
<xref linkend="libcap-pam"/>,
<xref linkend="libsecret"/> and
<xref linkend="qt4"/>
</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>sed -i 's:ncursesw/::' pinentry/pinentry-curses.c &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make</userinput></screen><!-- &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>If you wish to build alternate formats of the documentation, you
must have <xref linkend="texlive"/> installed,
then issue the following command:</para>
<screen><userinput>make -k -C doc pdf ps html</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</userinput></screen><!-- &amp;&amp;
install -v -m755 -d /usr/share/doc/pinentry-&pinentry-version;/html &amp;&amp;
install -v -m644 README doc/pinentry{_*.html,.txt,.texi} \
/usr/share/doc/pinentry-&pinentry-version;</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 -m644 doc/pinentry.html/* \
/usr/share/doc/pinentry-&pinentry-version;/html &amp;&amp;
install -v -m644 doc/pinentry.{pdf,ps,dvi} \
/usr/share/doc/pinentry-&pinentry-version;</userinput></screen> -->
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<command>sed -i ... pinentry/pinentry-curses.c</command>: Help
<command>configure</command> script to find
<application>ncursesw</application> headers -
<application>ncursesw</application> is the default in LFS/BLFS.
</para>
<para>
<option>--enable-pinentry-qt4</option>: Use this switch if ypu wish to
install <command>pinentry-qt4</command>. If both <xref linkend="qt4"/>
and <xref linkend="qt5"/> are installed, use <command>source
setqt4</command>, before starting. Also, you need to modify the
configuration step, using <command>CXX="g++ -std=c++11"
MOC="$QT4DIR/bin/moc" ./configure ...</command>, to fix building with
gcc-5 and for Qt4 <command>moc</command> (Qt4 meta object compiler)
detection.
</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directory</segtitle>
<seglistitem>
<seg>
pinentry (symlink), pinentry-curses, pinentry-gnome3, pinentry-gtk-2,
pinentry-qt4, and pinentry-tty
</seg>
<seg>None</seg>
<seg>None</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="b-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> ihelper program.</para>
<indexterm zone="pinentry pinentry-curses">
<primary sortas="b-pinentry-curses">pinentry-curses</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pinentry-gnome3">
<term><command>pinentry-gnome3</command></term>
<listitem>
<para> is a <application>GNOME-3</application>
<application>PIN-Entry</application> helper program.</para>
<indexterm zone="pinentry pinentry-gnome3">
<primary sortas="b-pinentry-gnome3">pinentry-gnome3</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pinentry-gtk-2">
<term><command>pinentry-gtk-2</command></term>
<listitem>
<para> is a <application>GTK+2</application>
<application>PIN-Entry</application> program program.</para>
<indexterm zone="pinentry pinentry-gtk-2">
<primary sortas="b-pinentry-gtk-2">pinentry-gtk-2</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pinentry-qt4">
<term><command>pinentry-qt4</command></term>
<listitem>
<para> is a <application>Qt4</application>
<application>PIN-Entry</application> helper program.</para>
<indexterm zone="pinentry pinentry-qt4">
<primary sortas="b-pinentry-qt4">pinentry-qt4</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pinentry-tty">
<term><command>pinentry-tty</command></term>
<listitem>
<para> is a <application>tty</application>
<application>PIN-Entry</application> helper program.</para>
<indexterm zone="pinentry pinentry-tty">
<primary sortas="b-pinentry-tty">pinentry-tty</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>