diff --git a/doc/ChangeLog b/doc/ChangeLog index 080a97bc3..476b5865d 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2008-01-28 Justin Pryzby (wk) + + * gpg-agent.texi, yat2m.c, scdaemon.texi, qualified.txt + * tools.texi, gpgsm.texi: Typo fixes and minor grammer fixes. + 2008-01-10 Werner Koch * qualified.txt: Add missing country tag to the last entries. diff --git a/doc/gpg-agent.texi b/doc/gpg-agent.texi index 3acb17ac8..6c3970117 100644 --- a/doc/gpg-agent.texi +++ b/doc/gpg-agent.texi @@ -117,8 +117,8 @@ one (e.g. @file{/usr/bin/pinentry}). @node Agent Commands @section Commands -Commands are not distinguished from options execpt for the fact that -only one one command is allowed. +Commands are not distinguished from options except for the fact that +only one command is allowed. @table @gnupgtabopt @item --version @@ -214,7 +214,7 @@ one of: @end table How these messages are mapped to the actual debugging flags is not -specified and may change with newer releaes of this program. They are +specified and may change with newer releases of this program. They are however carefully selected to best aid in debugging. @item --debug @var{flags} @@ -256,7 +256,7 @@ debugger. @item --no-detach @opindex no-detach -Don't detach the process from the console. This is manly usefule for +Don't detach the process from the console. This is mainly useful for debugging. @item -s @@ -268,9 +268,9 @@ debugging. @opindex c @opindex csh Format the info output in daemon mode for use with the standard Bourne -shell respective the C-shell . The default is to guess it based on the +shell respective the C-shell. The default is to guess it based on the environment variable @code{SHELL} which is in almost all cases -sufficient. +correct. @item --write-env-file @var{file} @opindex write-env-file @@ -304,7 +304,7 @@ seeing what the agent actually does. @opindex allow-mark-trusted Allow clients to mark keys as trusted, i.e. put them into the @file{trustlist.txt} file. This is by default not allowed to make it -harder for users to inadvertly accept Root-CA keys. +harder for users to inadvertently accept Root-CA keys. @item --ignore-cache-for-signing @opindex ignore-cache-for-signing @@ -314,25 +314,25 @@ control this behaviour but this command line option takes precedence. @item --default-cache-ttl @var{n} @opindex default-cache-ttl -Set the time a cache entry is valid to @var{n} seconds. The default are +Set the time a cache entry is valid to @var{n} seconds. The default is 600 seconds. @item --default-cache-ttl-ssh @var{n} @opindex default-cache-ttl Set the time a cache entry used for SSH keys is valid to @var{n} -seconds. The default are 1800 seconds. +seconds. The default is 1800 seconds. @item --max-cache-ttl @var{n} @opindex max-cache-ttl Set the maximum time a cache entry is valid to @var{n} seconds. After -this time a cache entry will get expired even if it has been accessed -recently. The default are 2 hours (7200 seconds). +this time a cache entry will be expired even if it has been accessed +recently. The default is 2 hours (7200 seconds). @item --max-cache-ttl-ssh @var{n} @opindex max-cache-ttl-ssh Set the maximum time a cache entry used for SSH keys is valid to @var{n} -seconds. After this time a cache entry will get expired even if it has -been accessed recently. The default are 2 hours (7200 seconds). +seconds. After this time a cache entry will be expired even if it has +been accessed recently. The default is 2 hours (7200 seconds). @item --enforce-passphrase-constraints @opindex enforce-passphrase-constraints @@ -362,8 +362,8 @@ Security note: It is known that checking a passphrase against a list of pattern or even against a complete dictionary is not very effective to enforce good passphrases. Users will soon figure up ways to bypass such a policy. A better policy is to educate users on good security -behavior and optional to run a passphrase cracker regularly on all -users passphrases t catch the very simple ones. +behavior and optionally to run a passphrase cracker regularly on all +users passphrases to catch the very simple ones. @item --max-passphrase-days @var{n} @opindex max-passphrase-days @@ -378,11 +378,11 @@ This option does nothing yet. @item --pinentry-program @var{filename} @opindex pinentry-program Use program @var{filename} as the PIN entry. The default is installation -dependend and can be shown with the @code{--version} command. +dependent and can be shown with the @code{--version} command. @item --pinentry-touch-file @var{filename} @opindex pinentry-touch-file -By default the file name of the socket gpg-agent is listening for +By default the filename of the socket gpg-agent is listening for requests is passed to Pinentry, so that it can touch that file before exiting (it does this only in curses mode). This option changes the file passed to Pinentry to @var{filename}. The special name @@ -394,7 +394,7 @@ modification and access time. @item --scdaemon-program @var{filename} @opindex scdaemon-program Use program @var{filename} as the Smartcard daemon. The default is -installation dependend and can be shown with the @code{--version} +installation dependent and can be shown with the @code{--version} command. @item --disable-scdaemon @@ -411,7 +411,7 @@ By enabling this option @command{gpg-agent} will listen on the socket named @file{S.gpg-agent}, located in the home directory, and not create a random socket below a temporary directory. Tools connecting to @command{gpg-agent} should first try to connect to the socket given in -environment variable @var{GPG_AGENT_INFO} and the fall back to this +environment variable @var{GPG_AGENT_INFO} and then fall back to this socket. This option may not be used if the home directory is mounted as a remote file system. Note, that @option{--use-standard-socket} is the default on Windows systems. @@ -436,7 +436,7 @@ information. @itemx --keep-display @opindex keep-tty @opindex keep-display -Ignore requests to change change the current @code{tty} respective the X +Ignore requests to change the current @code{tty} respective the X window system's @code{DISPLAY} variable. This is useful to lock the pinentry to pop up at the @code{tty} or display you started the agent. @@ -448,7 +448,7 @@ Enable emulation of the OpenSSH Agent protocol. In this mode of operation, the agent does not only implement the gpg-agent protocol, but also the agent protocol used by OpenSSH -(through a seperate socket). Consequently, it should possible to use +(through a separate socket). Consequently, it should be possible to use the gpg-agent as a drop-in replacement for the well known ssh-agent. SSH Keys, which are to be used through the agent, need to be added to @@ -459,7 +459,7 @@ gpg-agent to ask for a passphrase, which is to be used for encrypting the newly received key and storing it in a gpg-agent specific directory. -Once, a key has been added to the gpg-agent this way, the gpg-agent +Once a key has been added to the gpg-agent this way, the gpg-agent will be ready to use the key. Note: in case the gpg-agent receives a signature request, the user might @@ -468,7 +468,7 @@ the stored key. Since the ssh-agent protocol does not contain a mechanism for telling the agent on which display/terminal it is running, gpg-agent's ssh-support will use the TTY or X display where gpg-agent has been started. To switch this display to the current one, the -follwing command may be used: +following command may be used: @smallexample echo UPDATESTARTUPTTY | gpg-connect-agent @@ -556,17 +556,17 @@ fails, try again using the chain validation model. This file is used when support for the secure shell agent protocol has been enabled (@pxref{option --enable-ssh-support}). Only keys present in this file are used in the SSH protocol. The @command{ssh-add} tool -y be used to add new entries to this file; you may also add them +may be used to add new entries to this file; you may also add them manually. Comment lines, indicated by a leading hash mark, as well as -empty lines are ignored. An entry starts with optional white spaces, +empty lines are ignored. An entry starts with optional whitespace, followed by the keygrip of the key given as 40 hex digits, optionally followed by the caching TTL in seconds and another optional field for -arbitrary flags. A @code{!} may be prepended to the keygrip to +arbitrary flags. The keygrip may be prefixed with a @code{!} to disable this entry. -The follwoing example lists exactly one key. Note that keys available +The following example lists exactly one key. Note that keys available through a OpenPGP smartcard in the active smartcard reader are -implictly added to this list; i.e. there is no need to list them. +implicitly added to this list; i.e. there is no need to list them. @example # Key added on 2005-02-25 15:08:29 @@ -585,7 +585,7 @@ implictly added to this list; i.e. there is no need to list them. Note that on larger installations, it is useful to put predefined files into the directory @file{/etc/skel/.gnupg/} so that newly created users start up with a working configuration. For existing users the -a small helper script is provied to create these files (@pxref{addgnupghome}). +a small helper script is provided to create these files (@pxref{addgnupghome}). @@ -604,7 +604,7 @@ Here is a list of supported signals: @item SIGHUP @cpindex SIGHUP -This signal flushes all chached passphrases and if the program has been +This signal flushes all cached passphrases and if the program has been started with a configuration file, the configuration file is read again. Only certain options are honored: @code{quiet}, @code{verbose}, @code{debug}, @code{debug-all}, @code{debug-level}, @code{no-grab}, @@ -650,7 +650,7 @@ $ eval `gpg-agent --daemon` An alternative way is by replacing @command{ssh-agent} with @command{gpg-agent}. If for example @command{ssh-agent} is started as -part of the Xsession intialization you may simply replace +part of the Xsession initialization, you may simply replace @command{ssh-agent} by a script like: @cartouche diff --git a/doc/gpgsm.texi b/doc/gpgsm.texi index 12f882e09..3a831a671 100644 --- a/doc/gpgsm.texi +++ b/doc/gpgsm.texi @@ -58,7 +58,7 @@ Developer information: @node GPGSM Commands @section Commands -Commands are not distinguished from options execpt for the fact that +Commands are not distinguished from options except for the fact that only one command is allowed. @menu @@ -612,7 +612,7 @@ all of the debug messages you can get @end table How these messages are mapped to the actual debugging flags is not -specified and may change with newer releaes of this program. They are +specified and may change with newer releases of this program. They are however carefully selected to best aid in debugging. @item --debug @var{flags} @@ -738,7 +738,7 @@ signatures in the same way as handwritten signatures are. Comments start with a hash mark and empty lines are ignored. Lines do have a length limit but this is not a serious limitation as the format of the entries is fixed and checked by gpgsm: A non-comment line starts with -optional white spaces, followed by exactly 40 hex character, white space +optional whitespace, followed by exactly 40 hex character, white space and a lowercased 2 letter country code. Additional data delimited with by a white space is current ignored but might late be used for other purposes. diff --git a/doc/scdaemon.texi b/doc/scdaemon.texi index 25e9d4938..423d84b39 100644 --- a/doc/scdaemon.texi +++ b/doc/scdaemon.texi @@ -58,8 +58,8 @@ options. @node Scdaemon Commands @section Commands -Commands are not distinguished from options execpt for the fact that -only one one command is allowed. +Commands are not distinguished from options except for the fact that +only one command is allowed. @table @gnupgtabopt @item --version @@ -140,7 +140,7 @@ all of the debug messages you can get @end table How these messages are mapped to the actual debugging flags is not -specified and may change with newer releaes of this program. They are +specified and may change with newer releases of this program. They are however carefully selected to best aid in debugging. @quotation Note @@ -208,7 +208,7 @@ dump. This options enables it and also changes the working directory to @item --no-detach @opindex no-detach -Don't detach the process from the console. This is manly usefule for +Don't detach the process from the console. This is mainly useful for debugging. @item --log-file @var{file} @@ -646,7 +646,7 @@ Send an APDU to the current reader. This command bypasses the high level functions and sends the data directly to the card. @var{hexstring} is expected to be a proper APDU. If @var{hexstring} is not given no commands are send to the card; However the command will -implictly check whether the card is ready for use. +implicitly check whether the card is ready for use. Using the option @code{--atr} returns the ATR of the card as a status message before any data like this: diff --git a/doc/tools.texi b/doc/tools.texi index 2b8d153e0..58430271a 100644 --- a/doc/tools.texi +++ b/doc/tools.texi @@ -1187,7 +1187,7 @@ have been given to return a useful value. @item unescape @var{args} Remove C-style escapes from @var{args}. Note that @code{\0} and -@code{\x00} terminate the returned string implictly. The string to be +@code{\x00} terminate the returned string implicitly. The string to be converted are the entire arguments right behind the delimiting space of the function name. @@ -1274,7 +1274,7 @@ Same as the command line option @option{--decode}. @itemx /nosubst Enable and disable variable substitution. It defaults to disabled unless the command line option @option{--subst} has been used. -If /subst as been enabled once, leading white spaces are removed from +If /subst as been enabled once, leading whitespace is removed from input lines which makes scripts easier to read. @item /while @var{condition} diff --git a/doc/yat2m.c b/doc/yat2m.c index 9411e3419..587428fa0 100644 --- a/doc/yat2m.c +++ b/doc/yat2m.c @@ -42,7 +42,7 @@ the next input line if that line begins with @section, @subsection or @chapheading. - To insert verbatim troff markup, the follwing texinfo code may be + To insert verbatim troff markup, the following texinfo code may be used: @ifset manverb @@ -842,7 +842,7 @@ parse_file (const char *fname, FILE *fp, char **section_name, int in_pause) { char *line; int lnr = 0; - /* Fixme: The follwing state variables don't carry over to include + /* Fixme: The following state variables don't carry over to include files. */ int in_verbatim = 0; int skip_to_end = 0; /* Used to skip over menu entries. */