← Back to branch summary

~ubuntu-branches/ubuntu/karmic/gnupg2/karmic-security

« back to all changes in this revision

Viewing changes to doc/gpg-agent.texi

  • Committer: Bazaar Package Importer
  • Author(s): Soren Hansen
  • Date: 2009-08-04 12:27:49 UTC
  • mfrom: (1.1.12 upstream)
  • Revision ID: james.westby@ubuntu.com-20090804122749-q0j52zp6xmzvyall
Tags: 2.0.12-0ubuntu1
* New upstream release.
* Add 01-scd-pw2.patch, 03-opgp-writekey.patch, and 06-opgp-sign3072.patch
  from https://bugs.g10code.com/gnupg/issue1094 to make OpenPGP 2.0
  smartcards work.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/gpg-agent.texi
157
157
 
158
158
@item --daemon [@var{command line}]
159
159
@opindex daemon
160
 
Run the program in the background.  This option is required to prevent
161
 
it from being accidently running in the background.  A common way to do
162
 
this is:
163
 
@example
164
 
@end example
165
 
$ eval $(gpg-agent --daemon)
 
160
Start the gpg-agent as a daemon; that is, detach it from the console
 
161
and run it in the background.  Because @command{gpg-agent} prints out
 
162
important information required for further use, a common way of
 
163
invoking gpg-agent is: @code{eval $(gpg-agent --daemon)} to setup the
 
164
environment variables.  The option @option{--write-env-file} is
 
165
another way commonly used to do this.  Yet another way is creating
 
166
a new process as a child of gpg-agent: @code{gpg-agent --daemon
 
167
/bin/sh}.  This way you get a new shell with the environment setup
 
168
properly; if you exit from this shell, gpg-agent terminates as well.
166
169
@end table
167
170
 
168
 
 
169
171
@mansect options
170
172
@node Agent Options
171
173
@section Option Summary
520
522
  you need to enter its fingerprint followed by a space and a capital
521
523
  letter @code{S}.  Colons may optionally be used to separate the bytes of
522
524
  a fingerprint; this allows to cut and paste the fingerprint from a key
523
 
  listing output.
 
525
  listing output.  If the line is prefixed with a @code{!} the key is
 
526
  explicitly marked as not trusted.
524
527
  
525
 
  Here is an example where two keys are marked as ultimately trusted:
 
528
  Here is an example where two keys are marked as ultimately trusted
 
529
  and one as not trusted:
526
530
  
527
531
  @example
528
532
  # CN=Wurzel ZS 3,O=Intevation GmbH,C=DE
530
534
  
531
535
  # CN=PCA-1-Verwaltung-02/O=PKI-1-Verwaltung/C=DE
532
536
  DC:BD:69:25:48:BD:BB:7E:31:6E:BB:80:D3:00:80:35:D4:F8:A6:CD S 
 
537
 
 
538
  # CN=Root-CA/O=Schlapphuete/L=Pullach/C=DE
 
539
  !14:56:98:D3:FE:9C:CA:5A:31:6E:BC:81:D3:11:4E:00:90:A3:44:C2 S
533
540
  @end example
534
541
  
535
542
Before entering a key into this file, you need to ensure its
574
581
empty lines are ignored.  An entry starts with optional whitespace,
575
582
followed by the keygrip of the key given as 40 hex digits, optionally
576
583
followed by the caching TTL in seconds and another optional field for
577
 
arbitrary flags.  The keygrip may be prefixed with a @code{!} to
578
 
disable this entry.
 
584
arbitrary flags.  A non-zero TTL overrides the global default as
 
585
set by @option{--default-cache-ttl-ssh}.
 
586
 
 
587
The keygrip may be prefixed with a @code{!} to disable an entry entry.
579
588
    
580
589
The following example lists exactly one key.  Note that keys available
581
590
through a OpenPGP smartcard in the active smartcard reader are
1049
1058
clients to use the agent with minimum effort.
1050
1059
 
1051
1060
@example
1052
 
  GET_PASSPHRASE [--data] [--check] [--no-ask] @var{cache_id} [@var{error_message} @var{prompt} @var{description}]
 
1061
  GET_PASSPHRASE [--data] [--check] [--no-ask] [--repeat[=N]] [--qualitybar] @var{cache_id} [@var{error_message} @var{prompt} @var{description}]
1053
1062
@end example
1054
1063
 
1055
1064
@var{cache_id} is expected to be a string used to identify a cached
1084
1093
cache the user will not be asked to enter a passphrase but the error
1085
1094
code @code{GPG_ERR_NO_DATA} is returned.  
1086
1095
 
 
1096
If the option @option{--qualitybar} is used and a minimum passphrase
 
1097
length has been configured, a visual indication of the entered
 
1098
passphrase quality is shown.
1087
1099
 
1088
1100
@example
1089
1101
  CLEAR_PASSPHRASE @var{cache_id}