← Back to branch summary

~ubuntu-branches/ubuntu/raring/gnupg2/raring-proposed

« back to all changes in this revision

Viewing changes to doc/tools.texi

  • Committer: Bazaar Package Importer
  • Author(s): Eric Dorland
  • Date: 2009-09-07 20:38:23 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20090907203823-d7hsk7lnfqoc4yom
Tags: 2.0.13-1
* New upstream release.
* debian/control: Depend instead of Recommend gnupg-agent. (Closes:
  #538947)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/tools.texi
334
334
Some fields contain strings that are described to be
335
335
@emph{percent-escaped}.  Such strings need to be de-escaped before
336
336
their content can be presented to the user.  A percent-escaped string
337
 
is de-escaped by replacing all occurences of @code{%XY} by the byte
 
337
is de-escaped by replacing all occurrences of @code{%XY} by the byte
338
338
that has the hexadecimal value @code{XY}.  @code{X} and @code{Y} are
339
339
from the set @code{0-9a-f}.
340
340
 
477
477
 
478
478
The command @code{--check-programs} is similar to
479
479
@code{--list-components} but works on backend programs and not on
480
 
components.  It runs each program to test wether it is installed and
 
480
components.  It runs each program to test whether it is installed and
481
481
runnable.  This also includes a syntax check of all config file options
482
482
of the program.
483
483
 
514
514
config file is syntactically okay.
515
515
 
516
516
@item cfgfile
517
 
If an error occured in the configuraion file (as indicated by a false
 
517
If an error occurred in the configuration file (as indicated by a false
518
518
value in the field @code{okay}), this field has the name of the failing
519
519
configuration file.  It is @emph{percent-escaped}.
520
520
 
521
521
@item line
522
 
If an error occured in the configuration file, this field has the line
 
522
If an error occurred in the configuration file, this field has the line
523
523
number of the failing statement in the configuration file.  
524
524
It is an @emph{unsigned number}.
525
525
 
526
526
@item error
527
 
If an error occured in the configuration file, this field has the error
 
527
If an error occurred in the configuration file, this field has the error
528
528
text of the failing statement in the configuration file.  It is
529
529
@emph{percent-escaped} and @emph{localized}.
530
530
 
747
747
@item value
748
748
This field is defined only for options.  Its format is that of an
749
749
@emph{option argument}.  If it is empty, then the option is not
750
 
explicitely set in the current configuration, and the default applies
 
750
explicitly set in the current configuration, and the default applies
751
751
(if any).  Otherwise, it contains the current value of the option.
752
752
Note that this field is also meaningful if the option itself does not
753
753
take a real argument (in this case, it contains the number of times
865
865
@end table
866
866
 
867
867
@noindent
868
 
Unknown record typs should be ignored.  Note that there is intentionally
 
868
Unknown record types should be ignored.  Note that there is intentionally
869
869
no feature to change the global option file through @command{gpgconf}.
870
870
 
871
871
 
947
947
@end ifset
948
948
 
949
949
@mansect description
950
 
This is a simple tool to interactivly generate a certificate request
 
950
This is a simple tool to interactively generate a certificate request
951
951
which will be printed to stdout.
952
952
 
953
953
@manpause
1089
1089
The @command{gpg-connect-agent} is a utility to communicate with a
1090
1090
running @command{gpg-agent}.  It is useful to check out the commands
1091
1091
gpg-agent provides using the Assuan interface.  It might also be useful
1092
 
for scripting simple applications.  Inputis expected at stdin and out
 
1092
for scripting simple applications.  Input is expected at stdin and out
1093
1093
put gets printed to stdout.
1094
1094
 
1095
1095
It is very similar to running @command{gpg-agent} in server mode; but
1192
1192
@item /let @var{name} @var{value}
1193
1193
Set the variable @var{name} to @var{value}.  Variables are only
1194
1194
substituted on the input if the @command{/subst} has been used.
1195
 
Variables are referenced by prefixing the name with a dollr sign and
 
1195
Variables are referenced by prefixing the name with a dollar sign and
1196
1196
optionally include the name in curly braces.  The rules for a valid name
1197
1197
are identically to those of the standard bourne shell.  This is not yet
1198
1198
enforced but may be in the future.  When used with curly braces no
1237
1237
 
1238
1238
@item unpercent @var{args}
1239
1239
@itemx unpercent+ @var{args}
1240
 
Remove percent style ecaping from @var{args}.  Note that @code{%00}
 
1240
Remove percent style escaping from @var{args}.  Note that @code{%00}
1241
1241
terminates the string implicitly.  The string to be converted are the
1242
1242
entire arguments right behind the delimiting space of the function
1243
1243
name. @code{unpercent+} also maps plus signs to a spaces.
1244
1244
 
1245
1245
@item percent @var{args}
1246
1246
@itemx percent+ @var{args}
1247
 
Escape the @var{args} using percent style ecaping.  Tabs, formfeeds,
 
1247
Escape the @var{args} using percent style escaping.  Tabs, formfeeds,
1248
1248
linefeeds, carriage returns and colons are escaped. @code{percent+} also
1249
1249
maps spaces to plus signs.
1250
1250
 
1290
1290
 
1291
1291
@item /datafile @var{name}
1292
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
 
1293
is opened for writing and created if it does not exists.  An existing
1294
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
 
1295
decoded.  Using a single dash for @var{name} writes to stdout.  The
1296
1296
file is kept open until a new file is set using this command or this
1297
1297
command is used without an argument.
1298
1298
 
1466
1466
For decryption vice versa.
1467
1467
 
1468
1468
@var{CLASS} describes the calling conventions of the external tool.
1469
 
Currently it must be given as @samp{confucius}.  @var{PROGRAM} is the
 
1469
Currently it must be given as @samp{confucius}.  @var{PROGRAM} is
1470
1470
the full filename of that external tool.
1471
1471
 
1472
1472
For the class @samp{confucius} the option @option{--keyfile} is
1499
1499
@item --log-file @var{file}
1500
1500
@opindex log-file
1501
1501
Append all logging output to @var{file}.  Default is to write logging
1502
 
informaton to STDERR.
 
1502
information to STDERR.
1503
1503
 
1504
1504
@end table
1505
1505