@ifinfo
This file describes the PGG.
-Copyright (C) 2000 Daiki Ueno.
+Copyright (C) 2001 Daiki Ueno.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
@page
@vskip 0pt plus 1filll
-Copyright @copyright{} 2000 Daiki Ueno.
+Copyright @copyright{} 2001 Daiki Ueno.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
@menu
* Overview:: What PGG is.
-* Prerequisites::
-* How to use:: Calling PGP from your applications.
+* Prerequisites:: Complicated stuff you may have to do.
+* How to use:: Getting started quickly.
* Architecture::
* Parsing OpenPGP packets::
* Function Index::
This document assumes that you have already obtained and installed them
and that you are familiar with its basic functions.
-By default, PGG assumes to use GnuPG, but Pretty Good Privacy version 2
-or version 5 are also supported. If you are new to such a system, I
-recomend that you should look over the `GNU Privacy Handbook (GPH)',
-which is available at @uref{http://www.gnupg.org/gph/}.
+By default, PGG uses GnuPG, but Pretty Good Privacy version 2 or version
+5 are also supported. If you are new to such a system, I recomend that
+you should look over the GNU Privacy Handbook (GPH) which is available
+at @uref{http://www.gnupg.org/gph/}.
@node How to use
@chapter How to use
-The toplevel interface of this library is still simple, and only
+The toplevel interface of this library is quite simple, and only
intended to use with public-key cryptographic operation.
To use PGG, evaluate following expression at the beginning of your
@end lisp
If you want to check existence of pgg.el at runtime, instead you can
-list autoload settings for functions you want as follows.
+list autoload setting for desired functions as follows.
@lisp
(autoload 'pgg-encrypt-region "pgg"
@node User Commands
@section User Commands
-At this time you can use various cryptographic commands. The behavior
-of these commands relies on a fashion of invocation because these
-commands are also intended to be used as library functions. For
-example, in case you don't have the signer's public key, the function
-`pgg-verify-region' fails immediately, but if the function had been
-called interactively, it would ask you to retrieve the signer's public
-key from the server.
+At this time you can use some cryptographic commands. The behavior of
+these commands relies on a fashion of invocation because they are also
+intended to be used as library functions. In case you don't have the
+signer's public key, for example, the function @code{pgg-verify-region}
+fails immediately, but if the function had been called interactively, it
+would ask you to retrieve the signer's public key from the server.
@deffn Command pgg-encrypt-region start end recipients
Encrypt the current region between @var{start} and @var{end} for
registered scheme for an implementation of the requested service
associated with the named algorithm. If there are no match, PGG uses
@var{pgg-default-scheme}. In other words, there are two options to
-controll which command is used to process the incoming PGP armors. One
+control which command is used to process the incoming PGP armors. One
is for encrypting and signing, the other is for decrypting and
verifying.
@defvar pgg-cache-passphrase
If non-@code{nil}, store passphrases. The default value of this
variable is @code{t}. If you were worry about security issue, however,
-you could stop caching.
+you could stop caching with setting it @code{nil}.
@end defvar
@defvar pgg-passphrase-cache-expiry
-The elapsed time for expiration in seconds.
+Elapsed time for expiration in seconds.
@end defvar
@node Architecture
projects / elisp / semi.git / blobdiff