Changeset View
Changeset View
Standalone View
Standalone View
doc/pinentry.texi
Context not available. | |||||
This file documents the use and the internals of the @pinentry{}. | This file documents the use and the internals of the @pinentry{}. | ||||
This is edition @value{EDITION}, last updated @value{UPDATED}, of | This is edition @value{EDITION}, last updated @value{UPDATED}, of | ||||
@cite{The `PINEnrty' Manual}, for version @value{VERSION}. | @cite{The `PINEntry' Manual}, for version @value{VERSION}. | ||||
@sp 1 | @sp 1 | ||||
Published by g10 Code GmbH@* | Published by g10 Code GmbH@* | ||||
Hüttenstr. 61@* | Hüttenstr. 61@* | ||||
Context not available. | |||||
@pinentry{} comes in 3 flavors to fit the look and feel of the used | @pinentry{} comes in 3 flavors to fit the look and feel of the used | ||||
GUI toolkit: A @sc{GTK+} based one named @code{pinentry-gtk}, a | GUI toolkit: A @sc{GTK+} based one named @code{pinentry-gtk}, a | ||||
@sc{Qt} based one named @code{pinentry-qt} and a non-graphical one based | @sc{Qt} based one named @code{pinentry-qt} and a non-graphical one based | ||||
on curser and named @code{pinentry-curses}. Not all of them might be | on curses and named @code{pinentry-curses}. Not all of them might be | ||||
available on your installation. If curses is supported on your system, | available on your installation. If curses is supported on your system, | ||||
the GUI based flavors fall back to curses when the @code{DISPLAY} | the GUI based flavors fall back to curses when the @code{DISPLAY} | ||||
variable is not set. | variable is not set. | ||||
Context not available. | |||||
* Copying:: GNU General Public License says | * Copying:: GNU General Public License says | ||||
how you can copy and share PIN-Entry | how you can copy and share PIN-Entry | ||||
as well as this manulal. | as well as this manual. | ||||
Indices | Indices | ||||
Context not available. | |||||
@c man begin DESCRIPTION | @c man begin DESCRIPTION | ||||
You may run @pinentry{} directly from the commandline and pass the | You may run @pinentry{} directly from the command line and pass the | ||||
commands according to the Assuan protocol via stdin/stdout. | commands according to the Assuan protocol via stdin/stdout. | ||||
Context not available. | |||||
@item --help | @item --help | ||||
@opindex help | @opindex help | ||||
Print a usage message summarizing the most usefule command-line options. | Print a usage message summarizing the most useful command-line options. | ||||
@item --debug | @item --debug | ||||
@itemx -d | @itemx -d | ||||
Context not available. | |||||
@opindex lc-type | @opindex lc-type | ||||
@opindex lc-messa | @opindex lc-messa | ||||
These options are used to pass localization information to | These options are used to pass localization information to | ||||
@pinentry{}. They are required because @pinentry{} is usally called | @pinentry{}. They are required because @pinentry{} is usually called | ||||
by some background process which does not have any information on the | by some background process which does not have any information on the | ||||
locale and terminal to use. Assuan protocol options are an | locale and terminal to use. Assuan protocol options are an | ||||
alternative way to pass these information. | alternative way to pass these information. | ||||
Context not available. | |||||
Note that all strings are expected to be encoded as UTF-8; @pinentry{} | Note that all strings are expected to be encoded as UTF-8; @pinentry{} | ||||
takes care of converting it to the locally used codeset. To include | takes care of converting it to the locally used codeset. To include | ||||
lienfeeds or other special characters, you may percent-escape them | linefeeds or other special characters, you may percent-escape them | ||||
(i.e. a line feed is encoded as @code{%0A}, the percent sign itself | (i.e. a line feed is encoded as @code{%0A}, the percent sign itself | ||||
is encoded as @code{%25}). | is encoded as @code{%25}). | ||||
Context not available. | |||||
@end example | @end example | ||||
@item Set the button texts | @item Set the button texts | ||||
There are two text with can be set to overide the English defaults: | There are two text with can be set to override the English defaults: | ||||
To set the text for the button signalling confirmation (in UTF-8). | To set the text for the button signaling confirmation (in UTF-8). | ||||
@example | @example | ||||
C: SETOK Yes | C: SETOK Yes | ||||
S: OK | S: OK | ||||
@end example | @end example | ||||
To set the text for the button signalling cancellation or disagreement | To set the text for the button signaling cancellation or disagreement | ||||
(in UTF-8). | (in UTF-8). | ||||
@example | @example | ||||
C: SETCANCEL No | C: SETCANCEL No | ||||
Context not available. | |||||
S: OK | S: OK | ||||
@end example | @end example | ||||
Note that the passphrase is transmitted in clear using standard data | Note that the passphrase is transmitted in clear using standard data | ||||
responses. Expect it to be in utf-8. | responses. Expect it to be in UTF-8. | ||||
@item Ask for confirmation | @item Ask for confirmation | ||||
To ask for a confirmation (yes or no), you can use this command: | To ask for a confirmation (yes or no), you can use this command: | ||||
Context not available. |