glfs/general/genutils/pinentry.xml
2024-03-21 09:26:03 -05:00

299 lines
9.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!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 "&gnupg-http;/pinentry/pinentry-&pinentry-version;.tar.bz2">
<!ENTITY pinentry-download-ftp " ">
<!ENTITY pinentry-md5sum "ccae9619032fda53b234849c7c2253ac">
<!ENTITY pinentry-size "600 KB">
<!ENTITY pinentry-buildsize "17 MB">
<!ENTITY pinentry-time "0.2 SBU">
]>
<sect1 id="pinentry" xreflabel="pinentry-&pinentry-version;">
<?dbhtml filename="pinentry.html"?>
<title>pinentry-&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="https://www.gnupg.org/aegypten/">Ä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>
&lfs121_checked;
<!-- For testing this package, use: "echo GETPIN | pinentry-qt5" -->
<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">Required</bridgehead>
<para role="required">
<xref linkend="libassuan"/> and
<xref linkend="libgpg-error"/>
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="emacs"/>,
<xref linkend="fltk"/>,
<xref linkend="gcr"/>,
<!--<xref linkend="gtk 2"/>, We don't wan to reference this any more -->
<!-- <xref linkend="libcap-pam"/>, This is in LFS already. PAM is not
necessary. -->
<xref linkend="kf6-frameworks"/> (or <xref linkend="lxqt-kwayland"/>),
<!-- If Qt5 is present, it will look for KWayland for Wayland support.-->
<xref linkend="libsecret"/>,
&qt5-deps;, and
<ulink url="https://www.enlightenment.org/about-efl">efl</ulink>
</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-pinentry-tty \
--disable-pinentry-qt5 \
&amp;&amp;
make</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>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<option>--disable-pinentry-qt5</option>: Don't use qt5 even if
it is available. Qt5 is deprecated.
</para>
<para>
<option>--enable-inside-emacs=yes/no</option>: Default is no.
</para>
<para>
<option>--enable-pinentry-qt=yes/no</option>: Default is yes.
</para>
<para>
<option>--enable-pinentry-gtk2=yes/no</option>: Default is yes. Even if
other <command>pinentry-*</command> is installed,
<command>pinentry</command> will be a symlink to
<command>pinentry-gtk-2</command>.
</para>
<para>
<option>--enable-pinentry-gnome3=yes/no</option>: Default is yes.
Actually, it uses <application>Gcr</application> for the pinentry
dialog.
</para>
<para>
<parameter>--enable-pinentry-tty</parameter>: Default is 'maybe'.
</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-emacs, pinentry-fltk,
pinentry-gnome3, pinentry-gtk-2, pinentry-qt, 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> helper program
</para>
<indexterm zone="pinentry pinentry-curses">
<primary sortas="b-pinentry-curses">pinentry-curses</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pinentry-emacs">
<term><command>pinentry-emacs</command></term>
<listitem>
<para>
is an <application>Emacs</application> version of the
<application>PIN-Entry</application> helper program
</para>
<indexterm zone="pinentry pinentry-emacs">
<primary sortas="b-pinentry-emacs">pinentry-emacs</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pinentry-fltk">
<term><command>pinentry-fltk</command></term>
<listitem>
<para>
is a <application>FLTK</application>
<application>PIN-Entry</application> helper program
</para>
<indexterm zone="pinentry pinentry-fltk">
<primary sortas="b-pinentry-fltk">pinentry-fltk</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> helper program
</para>
<indexterm zone="pinentry pinentry-gtk-2">
<primary sortas="b-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>Qt4 or 5</application>
<application>PIN-Entry</application> helper program
</para>
<indexterm zone="pinentry pinentry-qt">
<primary sortas="b-pinentry-qt">pinentry-qt</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>