@dircategory GNU Emacs Lisp
@direntry
-* EasyPG Assistant: (epa). EasyPG Assistant
+* epa: (epa). EasyPG Assistant
@end direntry
@ifinfo
This chapter introduces various commands for typical use cases.
@menu
-* Keyring browser::
+* Key management::
* Cryptographic operations on regions::
* Cryptographic operations on files::
* Dired integration::
+* Mail-mode integration::
* Encrypting/decrypting *.gpg files::
@end menu
-@node Keyring browser
-@section Keyring browser
+@node Key management
+@section Key management
Probably the first step of using EasyPG Assistant is to browse your
keyring. @kbd{M-x epa-list-keys} is corresponding to @samp{gpg
--list-keys} from the command line.
@deffn Command epa-list-keys name mode
-Show all keys matched with @var{name} from the keyring.
-If @var{mode} is non-nil, it reads the private keyring. Otherwise, it
-reads the public keyring.
+Show all keys matched with @var{name} from the public keyring.
@end deffn
The output looks as follows.
Fingerprint: 9003 D76B 73B7 4A8A E588 10AF 4447 461B 2A9B EA2D
@end example
+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
+
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.
+Below are other commands related to key management. Some of them take
+a file as input/output, and others take the current region.
+
+@deffn Command epa-insert-keys keys
+Insert selected @var{keys} after the point. It will let you select
+keys before insertion. By default, it will encode keys in the OpenPGP
+armor format.
+@end deffn
+
+@deffn Command epa-import-keys file
+Import keys from @var{file} to your keyring.
+@end deffn
+
+@deffn Command epa-import-keys-region start end
+Import keys from the current region between @var{start} and @var{end}
+to your keyring.
+@end deffn
+
+@deffn Command epa-import-armor-in-region start end
+Import keys in the OpenPGP armor format in the current region between
+@var{start} and @var{end}. The difference from
+@code{epa-import-keys-region} is that
+@code{epa-import-armor-in-region} searches armors in the region and
+applies @code{epa-import-keys-region} to each of them.
+@end deffn
+
+@deffn Command epa-delete-keys allow-secret
+Delete selected keys. If @var{allow-secret} is non-@code{nil}, it
+also delete the secret keys.
+@end deffn
+
@node Cryptographic operations on regions
@section Cryptographic operations on regions
@deffn Command epa-decrypt-armor-in-region start end
Decrypt OpenPGP armors in the current region between @var{start} and
@var{end}. The difference from @code{epa-decrypt-region} is that
-@code{epa-decrypt-armor-in-region} searches ASCII armors in the region
+@code{epa-decrypt-armor-in-region} searches armors in the region
and applies @code{epa-decrypt-region} to each of them. That is, this
-command does not alter the original text around ASCII armors.
+command does not alter the original text around armors.
@end deffn
@deffn Command epa-verify-region start end
not alter the original text around OpenPGP cleartext blocks.
@end deffn
-@deffn Command epa-sign-region start end signers mode
+@deffn Command epa-sign-region start end signers type
Sign the current region between @var{start} and @var{end}. By
default, it creates a cleartext signature. If a prefix argument is
-given, it will ask you to select signing keys, and then a signature
+given, it will let you select signing keys, and then a signature
type.
@end deffn
@deffn Command epa-encrypt-region start end recipients sign signers
Encrypt the current region between @var{start} and @var{end}. It will
-ask you to select recipients. If a prefix argument is given, 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 ask you to select the signing keys.
+and if you answered yes, it will let you select the signing keys.
@end deffn
@node Cryptographic operations on files
@section Cryptographic operations on files
-(not yet written.)
+
+@deffn Command epa-decrypt-file file
+Decrypt @var{file}.
+@end deffn
+
+@deffn Command epa-verify-file file
+Verify @var{file}.
+@end deffn
+
+@deffn Command epa-sign-file file signers type
+Sign @var{file}. If a prefix argument is given, it will let you
+select signing keys, and then a signature type.
+@end deffn
+
+@deffn Command epa-encrypt-file file recipients
+Encrypt @var{file}. It will let you select recipients.
+@end deffn
@node Dired integration
@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.
+
+@table @kbd
+@item C-c
+@kindex @kbd{: d}
+@findex epa-dired-do-decrypt
+Decrypt marked files.
+
+@item : v
+@kindex @kbd{: v}
+@findex epa-dired-do-verify
+Verify marked files.
+
+@item : s
+@kindex @kbd{: s}
+@findex epa-dired-do-sign
+Sign marked files.
+
+@item : e
+@kindex @kbd{: e}
+@findex epa-dired-do-encrypt
+Encrypt marked files.
+
+@end table
+
+@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.
+
(not yet written.)
@node Encrypting/decrypting *.gpg files
@section Encrypting/decrypting *.gpg files
-(not yet written.)
+Once @code{epa-setup} is loaded, every file whose extension is
+@samp{.gpg} will be treated as encrypted. That is, when you attempt
+to open such a file which already exists, the decrypted text is
+inserted in the buffer rather than encrypted one. On the other hand,
+when you attempt to save the buffer to a file whose extension is
+@samp{.gpg}, encrypted data is written.
+
+If you want to temporarily disable this behavior, use @kbd{M-x
+epa-file-disable}, and then to enable this behavior use @kbd{M-x
+epa-file-enable}.
+
+@deffn Command epa-file-disable
+Disable automatic encryption/decryption of *.gpg files.
+@end deffn
+
+@deffn Command epa-file-enable
+Enable automatic encryption/decryption of *.gpg files.
+@end deffn
+
+@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.
+@vindex epa-file-encrypt-to
+
+@lisp
+;; -*- epa-file-encrypt-to: ("ueno@@unixuser.org") -*-
+@end lisp
+
+Other variables which control the automatic encryption/decryption
+behavior are below.
+
+@defvar epa-file-cache-passphrase-for-symmetric-encryption
+If non-@code{nil}, cache passphrase for symmetric encryption. The
+default value is @code{nil}.
+@end defvar
+
+@defvar epa-file-inhibit-auto-save
+If non-@code{nil}, disable auto-saving when opening an encrypted file.
+The default value is @code{t}.
+@end defvar
@summarycontents
@contents
projects / elisp / epg.git / blobdiff