2009-01-31 Carsten Dominik <carsten.dominik@gmail.com>
[bpt/emacs.git] / doc / misc / epa.texi
index 08f3fb4..2008a53 100644 (file)
@@ -9,15 +9,25 @@
 @copying
 This file describes EasyPG Assistant.
 
-Copyright @copyright{} 2007, 2008 Free Software Foundation, Inc.
+Copyright @copyright{} 2007, 2008, 2009 Free Software Foundation, Inc.
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.2 or
+under the terms of the GNU Free Documentation License, Version 1.3 or
 any later version published by the Free Software Foundation; with no
-Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
-Texts.  A copy of the license is included in the section entitled "GNU
-Free Documentation License".
+Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
+and with the Back-Cover Texts as in (a) below.  A copy of the license
+is included in the section entitled ``GNU Free Documentation License''
+in the Emacs manual.
+
+(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
+modify this GNU manual.  Buying copies from the FSF supports it in
+developing GNU and promoting software freedom.''
+
+This document is part of a collection distributed under the GNU Free
+Documentation License.  If you want to distribute this document
+separately from the collection, you can do so by adding a copy of the
+license to the document, as described in section 6 of the license.
 @end quotation
 @end copying
 
@@ -66,7 +76,7 @@ This manual covers EasyPG version @value{VERSION}.
 EasyPG Assistant provides the following features.
 
 @itemize @bullet
-@item Key manegement.
+@item Key management.
 @item Cryptographic operations on regions.
 @item Cryptographic operations on files.
 @item Dired integration.
@@ -77,36 +87,23 @@ EasyPG Assistant provides the following features.
 @node  Quick start
 @chapter Quick start
 
-@c To install, just follow the standard CMMI installation instructions.
-
-@c @cartouche
-@c @example
-@c $ ./configure
-@c $ sudo make install
-@c @end example
-@c @end cartouche
-
-@c @noindent
-@c Then, add the following line to your @file{~/.emacs}
-
-Add the following line to your @file{~/.emacs}.
-
-@cartouche
-@lisp
-(epa-mode 1)
-@end lisp
-@end cartouche
-
-@noindent
-Restart emacs and type @kbd{M-x epa- @key{TAB}}, and you will see a
-lot of commands available.  For example,
+EasyPG Assistant commands are prefixed by @samp{epa-}.  For example,
 
 @itemize @bullet
 @item To browse your keyring, type @kbd{M-x epa-list-keys}
 
 @item To create a cleartext signature of the region, type @kbd{M-x epa-sign-region}
+
+@item To encrypt a file, type @kbd{M-x epa-encrypt-file}
 @end itemize
 
+EasyPG Assistant provides several cryptographic features which can be
+integrated into other Emacs functionalities.  For example, automatic
+encryption/decryption of @samp{*.gpg} files.
+
+To install these features, do @kbd{C-u 1 M-x epa-mode}.  It can also
+be turned on by customize.  Try @kbd{M-x customize-variable epa-mode}.
+
 @node Commands
 @chapter Commands
 
@@ -377,6 +374,13 @@ line on the first line of the text being encrypted.
 @end lisp
 @end cartouche
 
+The file name extension of encrypted files can be controlled by
+@var{epa-file-name-regexp}.
+
+@defvar epa-file-name-regexp
+Regexp which matches filenames treated as encrypted.
+@end defvar
+
 Other variables which control the automatic encryption/decryption
 behavior are below.