Changeset View
Changeset View
Standalone View
Standalone View
doc/tools.texi
Context not available. | |||||
Some fields contain strings that are described to be | Some fields contain strings that are described to be | ||||
@emph{percent-escaped}. Such strings need to be de-escaped before | @emph{percent-escaped}. Such strings need to be de-escaped before | ||||
their content can be presented to the user. A percent-escaped string | their content can be presented to the user. A percent-escaped string | ||||
is de-escaped by replacing all occurences of @code{%XY} by the byte | is de-escaped by replacing all occurrences of @code{%XY} by the byte | ||||
that has the hexadecimal value @code{XY}. @code{X} and @code{Y} are | that has the hexadecimal value @code{XY}. @code{X} and @code{Y} are | ||||
from the set @code{0-9a-f}. | from the set @code{0-9a-f}. | ||||
Context not available. | |||||
The command @code{--check-programs} is similar to | The command @code{--check-programs} is similar to | ||||
@code{--list-components} but works on backend programs and not on | @code{--list-components} but works on backend programs and not on | ||||
components. It runs each program to test wether it is installed and | components. It runs each program to test whether it is installed and | ||||
runnable. This also includes a syntax check of all config file options | runnable. This also includes a syntax check of all config file options | ||||
of the program. | of the program. | ||||
Context not available. | |||||
config file is syntactically okay. | config file is syntactically okay. | ||||
@item cfgfile | @item cfgfile | ||||
If an error occured in the configuraion file (as indicated by a false | If an error occurred in the configuration file (as indicated by a false | ||||
value in the field @code{okay}), this field has the name of the failing | value in the field @code{okay}), this field has the name of the failing | ||||
configuration file. It is @emph{percent-escaped}. | configuration file. It is @emph{percent-escaped}. | ||||
@item line | @item line | ||||
If an error occured in the configuration file, this field has the line | If an error occurred in the configuration file, this field has the line | ||||
number of the failing statement in the configuration file. | number of the failing statement in the configuration file. | ||||
It is an @emph{unsigned number}. | It is an @emph{unsigned number}. | ||||
@item error | @item error | ||||
If an error occured in the configuration file, this field has the error | If an error occurred in the configuration file, this field has the error | ||||
text of the failing statement in the configuration file. It is | text of the failing statement in the configuration file. It is | ||||
@emph{percent-escaped} and @emph{localized}. | @emph{percent-escaped} and @emph{localized}. | ||||
Context not available. | |||||
@item value | @item value | ||||
This field is defined only for options. Its format is that of an | This field is defined only for options. Its format is that of an | ||||
@emph{option argument}. If it is empty, then the option is not | @emph{option argument}. If it is empty, then the option is not | ||||
explicitely set in the current configuration, and the default applies | explicitly set in the current configuration, and the default applies | ||||
(if any). Otherwise, it contains the current value of the option. | (if any). Otherwise, it contains the current value of the option. | ||||
Note that this field is also meaningful if the option itself does not | Note that this field is also meaningful if the option itself does not | ||||
take a real argument (in this case, it contains the number of times | take a real argument (in this case, it contains the number of times | ||||
Context not available. | |||||
@end table | @end table | ||||
@noindent | @noindent | ||||
Unknown record typs should be ignored. Note that there is intentionally | Unknown record types should be ignored. Note that there is intentionally | ||||
no feature to change the global option file through @command{gpgconf}. | no feature to change the global option file through @command{gpgconf}. | ||||
Context not available. | |||||
@end ifset | @end ifset | ||||
@mansect description | @mansect description | ||||
This is a simple tool to interactivly generate a certificate request | This is a simple tool to interactively generate a certificate request | ||||
which will be printed to stdout. | which will be printed to stdout. | ||||
@manpause | @manpause | ||||
Context not available. | |||||
The @command{gpg-connect-agent} is a utility to communicate with a | The @command{gpg-connect-agent} is a utility to communicate with a | ||||
running @command{gpg-agent}. It is useful to check out the commands | running @command{gpg-agent}. It is useful to check out the commands | ||||
gpg-agent provides using the Assuan interface. It might also be useful | gpg-agent provides using the Assuan interface. It might also be useful | ||||
for scripting simple applications. Inputis expected at stdin and out | for scripting simple applications. Input is expected at stdin and out | ||||
put gets printed to stdout. | put gets printed to stdout. | ||||
It is very similar to running @command{gpg-agent} in server mode; but | It is very similar to running @command{gpg-agent} in server mode; but | ||||
Context not available. | |||||
@item /let @var{name} @var{value} | @item /let @var{name} @var{value} | ||||
Set the variable @var{name} to @var{value}. Variables are only | Set the variable @var{name} to @var{value}. Variables are only | ||||
substituted on the input if the @command{/subst} has been used. | substituted on the input if the @command{/subst} has been used. | ||||
Variables are referenced by prefixing the name with a dollr sign and | Variables are referenced by prefixing the name with a dollar sign and | ||||
optionally include the name in curly braces. The rules for a valid name | optionally include the name in curly braces. The rules for a valid name | ||||
are identically to those of the standard bourne shell. This is not yet | are identically to those of the standard bourne shell. This is not yet | ||||
enforced but may be in the future. When used with curly braces no | enforced but may be in the future. When used with curly braces no | ||||
Context not available. | |||||
@item unpercent @var{args} | @item unpercent @var{args} | ||||
@itemx unpercent+ @var{args} | @itemx unpercent+ @var{args} | ||||
Remove percent style ecaping from @var{args}. Note that @code{%00} | Remove percent style escaping from @var{args}. Note that @code{%00} | ||||
terminates the string implicitly. The string to be converted are the | terminates the string implicitly. The string to be converted are the | ||||
entire arguments right behind the delimiting space of the function | entire arguments right behind the delimiting space of the function | ||||
name. @code{unpercent+} also maps plus signs to a spaces. | name. @code{unpercent+} also maps plus signs to a spaces. | ||||
@item percent @var{args} | @item percent @var{args} | ||||
@itemx percent+ @var{args} | @itemx percent+ @var{args} | ||||
Escape the @var{args} using percent style ecaping. Tabs, formfeeds, | Escape the @var{args} using percent style escaping. Tabs, formfeeds, | ||||
linefeeds, carriage returns and colons are escaped. @code{percent+} also | linefeeds, carriage returns and colons are escaped. @code{percent+} also | ||||
maps spaces to plus signs. | maps spaces to plus signs. | ||||
Context not available. | |||||
@item /datafile @var{name} | @item /datafile @var{name} | ||||
Write all data lines from the server to the file @var{name}. The file | Write all data lines from the server to the file @var{name}. The file | ||||
is opened for writing and created if it does not exists. An existsing | is opened for writing and created if it does not exists. An existing | ||||
file is first truncated to 0. The data written to the file fully | file is first truncated to 0. The data written to the file fully | ||||
decoded. Using a singel dash for @var{name} writes to stdout. The | decoded. Using a single dash for @var{name} writes to stdout. The | ||||
file is kept open until a new file is set using this command or this | file is kept open until a new file is set using this command or this | ||||
command is used without an argument. | command is used without an argument. | ||||
Context not available. | |||||
For decryption vice versa. | For decryption vice versa. | ||||
@var{CLASS} describes the calling conventions of the external tool. | @var{CLASS} describes the calling conventions of the external tool. | ||||
Currently it must be given as @samp{confucius}. @var{PROGRAM} is the | Currently it must be given as @samp{confucius}. @var{PROGRAM} is | ||||
the full filename of that external tool. | the full filename of that external tool. | ||||
For the class @samp{confucius} the option @option{--keyfile} is | For the class @samp{confucius} the option @option{--keyfile} is | ||||
Context not available. | |||||
@item --log-file @var{file} | @item --log-file @var{file} | ||||
@opindex log-file | @opindex log-file | ||||
Append all logging output to @var{file}. Default is to write logging | Append all logging output to @var{file}. Default is to write logging | ||||
informaton to STDERR. | information to STDERR. | ||||
@end table | @end table | ||||
Context not available. |