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

« back to all changes in this revision

Viewing changes to doc/tools.texi

  • Committer: Bazaar Package Importer
  • Author(s): Eric Dorland
  • Date: 2009-03-08 22:46:47 UTC
  • mfrom: (1.1.11 upstream)
  • Revision ID: james.westby@ubuntu.com-20090308224647-gq17gatcl71lrc2k
Tags: 2.0.11-1
* New upstream release. (Closes: #496663)
* debian/control: Make the description a little more distinctive than
  gnupg v1's. Thanks Jari Aalto. (Closes: #496323)

Show diffs side-by-side

added added

removed removed

Lines of Context:
18
18
* gpg-connect-agent::     Communicate with a running agent.
19
19
* gpgparsemail::          Parse a mail message into an annotated format
20
20
* symcryptrun::           Call a simple symmetric encryption tool.
 
21
* gpg-zip::               Encrypt or sign files into an archive.
21
22
@end menu
22
23
 
23
24
@c
74
75
 
75
76
@item --version
76
77
@opindex version
77
 
print version of the program and exit
 
78
Print version of the program and exit.
78
79
 
79
80
@item --help
80
81
@opindex help
81
 
Display a brief help page and exit
 
82
Display a brief help page and exit.
82
83
 
83
84
@end table
84
85
 
229
230
@item --change-options @var{component}
230
231
Change the options of the component @var{component}.
231
232
 
 
233
@item --check-options @var{component}
 
234
Check the options for the component @var{component}.
 
235
 
232
236
@item --apply-defaults
233
237
Update all configuration files with values taken from the global
234
238
configuration file (usually @file{/etc/gnupg/gpgconf.conf}).
235
239
 
 
240
@item --list-dirs
 
241
Lists the directories used by @command{gpgconf}.  One directory is
 
242
listed per line, and each line consists of a colon-separated list where
 
243
the first field names the directory type (for example @code{sysconfdir})
 
244
and the second field contains the percent-escaped directory.  Although
 
245
they are not directories, the socket file names used by
 
246
@command{gpg-agent} and @command{dirmngr} are printed as well.  Note
 
247
that the socket file names and the @code{homedir} lines are the default
 
248
names and they may be overridden by command line switches.
 
249
 
236
250
@item --list-config [@var{filename}]
237
251
List the global configuration file in a colon separated format.  If
238
252
@var{filename} is given, check that file instead.
259
273
Outputs additional information while running.  Specifically, this
260
274
extends numerical field values by human-readable descriptions.
261
275
 
262
 
@c FIXME: Not yet supported.
263
 
@c @item -n
264
 
@c @itemx --dry-run
265
 
@c Do not actually change anything.  Useful together with
266
 
@c @code{--change-options} for testing purposes.
 
276
@item -n
 
277
@itemx --dry-run
 
278
Do not actually change anything.  This is currently only implemented
 
279
for @code{--change-options} and can be used for testing purposes.
267
280
 
268
281
@item -r
269
282
@itemx --runtime
530
543
dirmngr:Directory Manager:/usr/local/bin/dirmngr:0:0:
531
544
@end example
532
545
 
 
546
@noindent
 
547
The command @w{@code{--check-options @var{component}}} will verify the
 
548
configuration file in the same manner as @code{--check-programs}, but
 
549
only for the component @var{component}.
 
550
 
533
551
 
534
552
@node Listing options
535
553
@subsection Listing options
678
696
@item sec key (36)
679
697
A @emph{string} that describes a certificate with a key by user ID,
680
698
key ID or fingerprint.
 
699
 
 
700
@item alias list (37)
 
701
A @emph{string} that describes an alias list, like the one used with
 
702
gpg's group option.  The list consists of a key, an equal sign and space
 
703
separated values.
681
704
@end table
682
705
 
683
706
More types will be added in the future.  Please see the @var{alt-type}
768
791
option).  Otherwise, the option will be set to the specified value.
769
792
@end table
770
793
 
 
794
@noindent
 
795
The output of the command is the same as that of
 
796
@code{--check-options} for the modified configuration file.
 
797
 
771
798
Examples:
772
799
 
773
800
To set the force option, which is of basic type @code{none (0)}:
955
982
.B  gpg-preset-passphrase
956
983
.RI [ options ]
957
984
.RI [ command ]
958
 
.I keygrip
 
985
.I cache-id
959
986
@end ifset
960
987
 
961
988
@mansect description
985
1012
@command{gpg-preset-passphrase} is invoked this way:
986
1013
 
987
1014
@example
988
 
gpg-preset-passphrase [options] [command] @var{keygrip}
 
1015
gpg-preset-passphrase [options] [command] @var{cacheid}
989
1016
@end example
990
1017
 
991
 
@var{keygrip} is a 40 character string of hexadecimal characters
992
 
identifying the key for which the passphrase should be set or cleared.
993
 
This keygrip is listed along with the key when running the command:
994
 
@code{gpgsm --dump-secret-keys}. One of the following command options
995
 
must be given:
 
1018
@var{cacheid} is either a 40 character keygrip of hexadecimal
 
1019
characters identifying the key for which the passphrase should be set
 
1020
or cleared.  The keygrip is listed along with the key when running the
 
1021
command: @code{gpgsm --dump-secret-keys}.  Alternatively an arbitrary
 
1022
string may be used to identify a passphrase; it is suggested that such
 
1023
a string is prefixed with the name of the application (e.g
 
1024
@code{foo:12346}).
 
1025
 
 
1026
@noindent
 
1027
One of the following command options must be given:
996
1028
 
997
1029
@table @gnupgtabopt
998
1030
@item --preset
1003
1035
 
1004
1036
@item --forget
1005
1037
@opindex forget
1006
 
Flush the passphrase for the given keygrip from the cache.
 
1038
Flush the passphrase for the given cache ID from the cache.
1007
1039
 
1008
1040
@end table
1009
1041
 
1050
1082
@mansect synopsis
1051
1083
@ifset manverb
1052
1084
.B  gpg-connect-agent
1053
 
.RI [ options ]
 
1085
.RI [ options ] [commands]
1054
1086
@end ifset
1055
1087
 
1056
1088
@mansect description
1076
1108
@command{gpg-connect-agent} is invoked this way:
1077
1109
 
1078
1110
@example
1079
 
gpg-connect-agent [options]
 
1111
gpg-connect-agent [options] [commands]
1080
1112
@end example
1081
1113
@mancont
1082
1114
 
1113
1145
@smallexample
1114
1146
 gpg-connect-agent --exec gpgsm --server
1115
1147
@end smallexample
1116
 
 
 
1148
Note that you may not use options on the command line in this case.
1117
1149
 
1118
1150
@item --no-ext-connect
1119
1151
@opindex no-ext-connect
1124
1156
@item --run @var{file}
1125
1157
@opindex run 
1126
1158
Run the commands from @var{file} at startup and then continue with the
1127
 
regular input method.
 
1159
regular input method.  Note, that commands given on the command line are
 
1160
executed after this file.
1128
1161
 
1129
1162
@item -s
1130
1163
@itemx --subst
1161
1194
substituted on the input if the @command{/subst} has been used.
1162
1195
Variables are referenced by prefixing the name with a dollr sign and
1163
1196
optionally include the name in curly braces.  The rules for a valid name
1164
 
are idnetically to those of the standard bourne shell.  This is not yet
 
1197
are identically to those of the standard bourne shell.  This is not yet
1165
1198
enforced but may be in the future.  When used with curly braces no
1166
1199
leading or trailing white space is allowed. 
1167
1200
 
1255
1288
Run @var{prog} for inquiries matching @var{name} and pass the
1256
1289
entire line to it as command line arguments.
1257
1290
 
 
1291
@item /datafile @var{name}
 
1292
Write all data lines from the server to the file @var{name}.  The file
 
1293
is opened for writing and created if it does not exists.  An existsing
 
1294
file is first truncated to 0.  The data written to the file fully
 
1295
decoded.  Using a singel dash for @var{name} writes to stdout.  The
 
1296
file is kept open until a new file is set using this command or this
 
1297
command is used without an argument.
 
1298
 
1258
1299
@item /showdef
1259
1300
Print all definitions
1260
1301
 
1279
1320
experimental and might change in future versions.
1280
1321
 
1281
1322
@item /showopen
1282
 
Show a listy of open files.
 
1323
Show a list of open files.
1283
1324
 
1284
1325
@item /serverpid
1285
1326
Send the Assuan command @command{GETINFO pid} to the server and store
1485
1526
@end ifset
1486
1527
@include see-also-note.texi
1487
1528
 
 
1529
 
 
1530
@c
 
1531
@c  GPG-ZIP
 
1532
@c
 
1533
@c The original manpage on which this section is based was written 
 
1534
@c by Colin Tuckley  <colin@tuckley.org> and Daniel Leidert 
 
1535
@c <daniel.leidert@wgdd.de> for the Debian distribution (but may be used by
 
1536
@c others).
 
1537
@manpage gpg-zip.1
 
1538
@node gpg-zip
 
1539
@section Encrypt or sign files into an archive
 
1540
@ifset manverb
 
1541
.B gpg-zip \- Encrypt or sign files into an archive
 
1542
@end ifset
 
1543
 
 
1544
@mansect synopsis
 
1545
@ifset manverb
 
1546
.B  gpg-zip
 
1547
.RI [ options ]
 
1548
.I filename1
 
1549
.I [ filename2, ... ]
 
1550
.I directory1
 
1551
.I [ directory2, ... ]
 
1552
@end ifset
 
1553
 
 
1554
@mansect description
 
1555
@command{gpg-zip} encrypts or signs files into an archive.  It is an
 
1556
gpg-ized tar using the same format as used by PGP's PGP Zip.
 
1557
 
 
1558
@manpause
 
1559
@noindent
 
1560
@command{gpg-zip} is invoked this way:
 
1561
 
 
1562
@example
 
1563
gpg-zip [options] @var{filename1} [@var{filename2}, ...] @var{directory} [@var{directory2}, ...]
 
1564
@end example
 
1565
 
 
1566
@mansect options
 
1567
@noindent
 
1568
@command{gpg-zip} understands these options:
 
1569
 
 
1570
@table @gnupgtabopt
 
1571
 
 
1572
@item --encrypt
 
1573
@itemx -e
 
1574
@opindex encrypt
 
1575
Encrypt data.  This option may be combined with @option{--symmetric} (for  output that may be decrypted via a secret key or a passphrase).
 
1576
 
 
1577
@item --decrypt
 
1578
@itemx -d
 
1579
@opindex decrypt
 
1580
Decrypt data.
 
1581
 
 
1582
@item --symmetric
 
1583
@itemx -c
 
1584
Encrypt with a symmetric cipher using a passphrase.  The default
 
1585
symmetric cipher used is CAST5, but may be chosen with the
 
1586
@option{--cipher-algo} option to @command{gpg}.
 
1587
 
 
1588
@item --sign
 
1589
@itemx -s
 
1590
Make a signature.  See @command{gpg}.
 
1591
 
 
1592
@item --recipient @var{user}
 
1593
@itemx -r @var{user}
 
1594
@opindex recipient
 
1595
Encrypt for user id @var{user}. See @command{gpg}.
 
1596
 
 
1597
@item --local-user @var{user}
 
1598
@itemx -u @var{user}
 
1599
@opindex local-user
 
1600
Use @var{user} as the key to sign with.  See @command{gpg}.
 
1601
 
 
1602
@item --list-archive
 
1603
@opindex list-archive
 
1604
List the contents of the specified archive.
 
1605
 
 
1606
@item --output @var{file}
 
1607
@itemx -o @var{file}
 
1608
@opindex output
 
1609
Write output to specified file @var{file}.
 
1610
 
 
1611
@item --gpg @var{gpgcmd}
 
1612
@opindex gpg
 
1613
Use the specified command @var{gpgcmd} instead of @command{gpg}.
 
1614
 
 
1615
@item --gpg-args @var{args}
 
1616
@opindex gpg-args
 
1617
Pass the specified options to @command{gpg}.
 
1618
 
 
1619
@item --tar @var{tarcmd}
 
1620
@opindex tar
 
1621
Use the specified command @var{tarcmd} instead of @command{tar}.
 
1622
 
 
1623
@item --tar-args @var{args}
 
1624
@opindex tar-args
 
1625
Pass the specified options to @command{tar}.
 
1626
 
 
1627
@item --version
 
1628
@opindex version
 
1629
Print version of the program and exit.
 
1630
 
 
1631
@item --help
 
1632
@opindex help
 
1633
Display a brief help page and exit.
 
1634
 
 
1635
@end table
 
1636
 
 
1637
@mansect diagnostics
 
1638
@noindent
 
1639
The program returns 0 if everything was fine, 1 otherwise.
 
1640
 
 
1641
 
 
1642
@mansect examples
 
1643
@ifclear isman
 
1644
@noindent
 
1645
Some examples:
 
1646
 
 
1647
@end ifclear
 
1648
@noindent
 
1649
Encrypt the contents of directory @file{mydocs} for user Bob to file
 
1650
@file{test1}:
 
1651
 
 
1652
@example
 
1653
gpg-zip --encrypt --output test1 --gpg-args  -r Bob mydocs
 
1654
@end example
 
1655
 
 
1656
@noindent
 
1657
List the contents of archive @file{test1}:
 
1658
 
 
1659
@example
 
1660
gpg-zip --list-archive test1
 
1661
@end example
 
1662
 
 
1663
 
 
1664
@mansect see also
 
1665
@ifset isman
 
1666
@command{gpg}(1), 
 
1667
@command{tar}(1), 
 
1668
@end ifset
 
1669
@include see-also-note.texi
 
1670