@end tex
+@summarycontents
+@contents
+
@node Top
@top EasyPG Assistant user's manual
-EasyPG Assistant provides convenient tools which allow to use GnuPG
-from Emacs.
+EasyPG Assistant is an Emacs user interface to GNU Privacy Guard
+(GnuPG, @pxref{Top, , Top, gnupg, Using the GNU Privacy Guard}).
+
+EasyPG Assistant is a part of the package called EasyPG, an all-in-one
+GnuPG interface for Emacs. EasyPG also contains the library interface
+called EasyPG Library.
-EasyPG Assistant is a part of EasyPG, an all-in-one GnuPG (@pxref{Top,
-, Top, gnupg, Using the GNU Privacy Guard}) interface for Emacs. This
-manual covers EasyPG version @value{VERSION}.
+@noindent
+This manual covers EasyPG version @value{VERSION}.
@menu
* Overview::
EasyPG Assistant provides the following features.
@itemize @bullet
-@item Keyring browser.
+@item Key manegement.
@item Cryptographic operations on regions.
@item Cryptographic operations on files.
@item Dired integration.
-@item Encryption/decryption of *.gpg files.
+@item Mail-mode integration.
+@item Automatic encryption/decryption of *.gpg files.
@end itemize
@node Quick start
To install, just follow the standard CMMI installation instructions.
+@cartouche
@example
$ ./configure
$ sudo make install
@end example
+@end cartouche
+@noindent
Then, add the following line to your @file{~/.emacs}
+@cartouche
@lisp
(require 'epa-setup)
@end lisp
+@end cartouche
-That's all. Restart emacs and type @kbd{M-x epa- TAB}, and you will see a
+@noindent
+That's all. Restart emacs and type @kbd{M-x epa- @key{TAB}}, and you will see a
lot of commands available. For example,
@itemize @bullet
@item To create a cleartext signature of the region, type @kbd{M-x epa-sign-region}
@end itemize
-You can also do some cryptographic operations from dired.
-
-@example
-M-x dired
-(mark some files)
-: e (or M-x epa-dired-do-encrypt)
-(select recipients by 'm' and click [OK])
-@end example
-
@node Commands
@chapter Commands
Show all keys matched with @var{name} from the public keyring.
@end deffn
+@noindent
The output looks as follows.
@example
u A5B6B2D4B15813FE Daiki Ueno <ueno@@unixuser.org>
@end example
+@noindent
A character on the leftmost column indicates the trust level of the
key. If it is @samp{u}, the key is marked as ultimately trusted. The
second column is the key ID, and the rest is the user ID.
-You can move over entries by @kbd{TAB}. If you type @kbd{RET} or
-clicked button1 on an entry, you will see more detailed information
+You can move over entries by @key{TAB}. If you type @key{RET} or
+click button1 on an entry, you will see more detailed information
about the key you selected.
@example
Fingerprint: 9003 D76B 73B7 4A8A E588 10AF 4447 461B 2A9B EA2D
@end example
+@noindent
To browse your private keyring, use @kbd{M-x epa-list-secret-keys}.
@deffn Command epa-list-secret-keys name
Show all keys matched with @var{name} from the private keyring.
@end deffn
+@noindent
In @samp{*Keys*} buffer, several commands are available. The common
use case is to export some keys to a file. To do that, type @kbd{m}
to select keys, type @kbd{o}, and then supply the filename.
@deffn Command epa-decrypt-region start end
Decrypt the current region between @var{start} and @var{end}. It
-replaces the region with the decrypted plaintext.
+replaces the region with the decrypted text.
@end deffn
@deffn Command epa-decrypt-armor-in-region start end
@deffn Command epa-encrypt-region start end recipients sign signers
Encrypt the current region between @var{start} and @var{end}. It will
let you select recipients. If a prefix argument is given, it will
-also ask you whether or not to sign the plaintext before encryption
-and if you answered yes, it will let you select the signing keys.
+also ask you whether or not to sign the text before encryption and if
+you answered yes, it will let you select the signing keys.
@end deffn
@node Cryptographic operations on files
@section Dired integration
EasyPG Assistant extends Dired Mode for GNU Emacs to allow users to
-easily do cryptographic operations on files. The following keys are
-assigned.
+easily do cryptographic operations on files. For example,
+
+@example
+M-x dired
+(mark some files)
+: e (or M-x epa-dired-do-encrypt)
+(select recipients by 'm' and click [OK])
+@end example
+
+@noindent
+The following keys are assigned.
@table @kbd
@item : d
@node Mail-mode integration
@section Mail-mode integration
-EasyPG Assistant provides a minor mode to help composing clearsigned
-or OpenPGP armored encrypted mails. The following keys are assigned.
+EasyPG Assistant provides a minor mode to help user compose inline PGP
+messages. Inline PGP is sending the OpenPGP blobs directly inside a
+mail message and it is not recommended and you should consider to use
+PGP/MIME. See
+@uref{http://josefsson.org/inline-openpgp-considered-harmful.html,
+Inline PGP in E-mail is bad, Mm'kay?}.
-(not yet written.)
+@noindent
+The following keys are assigned.
+
+@table @kbd
+@item C-c C-e d
+@kindex @kbd{C-c C-e d}
+@findex epa-mail-decrypt
+Decrypt OpenPGP armors in the current buffer.
+
+@item C-c C-e v
+@kindex @kbd{C-c C-e v}
+@findex epa-mail-verify
+Verify OpenPGP cleartext signed messages in the current buffer.
+
+@item C-c C-e s
+@kindex @kbd{C-c C-e s}
+@findex epa-mail-sign
+Compose a signed message from the current buffer.
+
+@item C-c C-e e
+@kindex @kbd{C-c C-e e}
+@findex epa-mail-encrypt
+Compose an encrypted message from the current buffer.
+
+@end table
@node Encrypting/decrypting *.gpg files
@section Encrypting/decrypting *.gpg files
Enable automatic encryption/decryption of *.gpg files.
@end deffn
+@noindent
@code{epa-file} will let you select recipients. If you want to
suppress this question, it might be a good idea to put the following
-line on the first line of the plaintext.
+line on the first line of the text being encrypted.
@vindex epa-file-encrypt-to
+@cartouche
@lisp
;; -*- epa-file-encrypt-to: ("ueno@@unixuser.org") -*-
@end lisp
+@end cartouche
Other variables which control the automatic encryption/decryption
behavior are below.
The default value is @code{t}.
@end defvar
-@summarycontents
-@contents
@bye
@c End:
projects / elisp / epg.git / blobdiff