~logan/ubuntu/trusty/pinentry/0.8.3-1ubuntu1

« back to all changes in this revision

Viewing changes to debian/pinentry.1.in

  • Committer: Bazaar Package Importer
  • Author(s): Peter Eisentraut
  • Date: 2005-01-27 19:10:07 UTC
  • mfrom: (1.1.1 upstream) (2.1.1 hoary)
  • Revision ID: james.westby@ubuntu.com-20050127191007-83ptn4mcw63mu085
Tags: 0.7.2-1
* New upstream release
* Added new -gtk2 flavor.
* Build dependencies revised accordingly.
* Added more copyright holders to debian/copyright.
* Removed compatibility symlinks.
* Converted to CDBS.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
m4_changequote({,})m4_dnl
 
2
.TH PINENTRY-m4_translit(flavor, {a-z}, {A-Z}) 1 "27 Jan 2005"
 
3
.SH NAME
 
4
pinentry\-flavor \- PIN or pass-phrase entry dialog for GnuPG
 
5
.PP
 
6
.SH SYNOPSIS
 
7
\fBpinentry-flavor\fB [\fIOPTION\fR...]
 
8
.SH DESCRIPTION
 
9
\fBpinentry\-flavor\fR is a program that allows for secure entry of PINs or
 
10
pass phrases.  That means it tries to take care that the entered
 
11
information is not swapped to disk or temporarily stored anywhere.
 
12
This functionality is particularly useful for entering pass phrases
 
13
when using encryption software such as GnuPG or e-mail clients using
 
14
the same.  It uses an open protocol and is therefore not tied to
 
15
particular software.
 
16
.PP
 
17
m4_ifelse(
 
18
flavor, {curses},
 
19
{{\fBpinentry-curses\fR implements a PIN entry dialog
 
20
using the curses tool kit, meaning that it is useful for users working
 
21
in text mode without the X Window System.  There are other flavors
 
22
that implement PIN entry dialogs that use an X tool kit.  If you
 
23
have installed any of the latter programs then this program is not necessary
 
24
because the X flavors automatically fall back to text mode if
 
25
X is not active.}},
 
26
flavor, {gtk},
 
27
{{\fBpinentry-gtk\fR implements a PIN entry dialog
 
28
using the GTK+ tool kit version 1.  If the X Window System is not
 
29
active then an alternative text-mode dialog will be used.  There are
 
30
other flavors that implement PIN entry dialogs using other tool kits.}},
 
31
flavor, {gtk-2},
 
32
{{\fBpinentry-gtk-2\fR implements a PIN entry dialog
 
33
using the GTK+ tool kit version 2, so it is especially suitable for
 
34
users of GNOME.  If the X Window System is not active then an alternative
 
35
text-mode dialog will be used.  There are other flavors that
 
36
implement PIN entry dialogs using other tool kits.}},
 
37
flavor, {qt},
 
38
{{\fBpinentry-qt\fR implements a PIN entry dialog
 
39
using the Qt tool kit, so it is especially suitable for users of KDE.
 
40
If the X Window System is not active then an alternative text-mode
 
41
dialog will be used.  There are other flavors that implement PIN
 
42
entry dialogs using other tool kits.}})
 
43
.PP
 
44
\fBpinentry\-flavor\fR is typically used internally by \fBgpg-agent\fR.
 
45
Users don't normally have a reason to call it directly.
 
46
.SH OPTIONS
 
47
.TP
 
48
\fB\-\-version\fR
 
49
Print the program version and licensing information.
 
50
.TP
 
51
\fB\-\-help\fR
 
52
Print a usage message summarizing the most useful command-line options.
 
53
.TP
 
54
\fB\-\-debug\fR, \fB\-d\fR
 
55
Turn on some debugging.  Mostly useful for the maintainers.  Note
 
56
that this may reveal sensitive information like the entered pass phrase.
 
57
.TP
 
58
\fB\-\-enhanced\fR, \fB\-e\fR
 
59
Ask for timeouts and insurance, too.  Note that this is currently
 
60
not fully supported.
 
61
.TP
 
62
\fB\-\-no\-global\-grab\fR, \fB\-g\fR
 
63
Grab the keyboard only when the window is focused.  Use this
 
64
option if you are debugging software using \fBpinentry\-flavor\fR;
 
65
otherwise you may not be able to to access your X session anymore (unless
 
66
you have other means to connect to the machine to kill
 
67
\fBpinentry\-flavor\fR).
 
68
.TP
 
69
\fB\-\-parent\-wid\fR \fIN\fR
 
70
Use window ID \fIN\fR as the parent window for positioning the window.
 
71
Note, that this is not fully supported by all flavors of \fBpinentry\fR.
 
72
.TP
 
73
\fB--display\fR \fISTRING\fR, \fB--ttyname\fR \fISTRING\fR, \fB--ttytype\fR \fISTRING\fR, \fB--lc-type\fR \fISTRING\fR, \fB--lc-messages\fR \fISTRING\fR
 
74
These options are used to pass localization information to
 
75
\fBpinentry-flavor\fR.  They are required because
 
76
\fBpinentry-flavor\fR is usually called by
 
77
some background process which does not have any information on the
 
78
locale and terminal to use.  Assuan protocol options are an
 
79
alternative way to pass these information.
 
80
.SH "SEE ALSO"
 
81
m4_ifelse(flavor, {curses}, {}, {.BR pinentry-curses (1),
 
82
})m4_dnl
 
83
m4_ifelse(flavor, {gtk}, {}, {.BR pinentry-gtk (1),
 
84
})m4_dnl
 
85
m4_ifelse(flavor, {gtk-2}, {}, {.BR pinentry-gtk-2 (1),
 
86
})m4_dnl
 
87
m4_ifelse(flavor, {qt}, {}, {.BR pinentry-qt (1),
 
88
})m4_dnl
 
89
.BR gpg (1),
 
90
.BR gpg-agent (1)
 
91
.PP
 
92
The full documentation for
 
93
.B pinentry-flavor
 
94
is maintained as a Texinfo manual.  If the
 
95
.B pinentry-doc
 
96
package is installed, the command
 
97
.IP
 
98
.B info pinentry
 
99
.PP
 
100
should give you access to the complete manual.
 
101
.SH AUTHOR
 
102
This manual page was written by Peter Eisentraut for the Debian project.