X-Git-Url: http://cgit.sxemacs.org/?a=blobdiff_plain;f=texi%2Fepa.texi;h=0150d5478958bdc83e6ea29691e799a6cbb41f4f;hb=a2bbdbe2298142a1b9c843707efde0f7e858172a;hp=c729333ac5f022e9931a2d78d5686925311c0c9d;hpb=cbbae3be0807cdca91fd3c56409288fd7af59ba3;p=gnus diff --git a/texi/epa.texi b/texi/epa.texi index c729333ac..0150d5478 100644 --- a/texi/epa.texi +++ b/texi/epa.texi @@ -1,7 +1,8 @@ \input texinfo @c -*- mode: texinfo -*- @c %**start of header -@setfilename epa +@setfilename epa.info @settitle EasyPG Assistant User's Manual +@include docstyle.texi @c %**end of header @set VERSION 1.0.0 @@ -9,25 +10,18 @@ @copying This file describes EasyPG Assistant @value{VERSION}. -Copyright @copyright{} 2007-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2007--2015 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.3 or any later version published by the Free Software Foundation; with no -Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' +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. +is included in the section entitled ``GNU Free Documentation License''. (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. +modify this GNU manual.'' @end quotation @end copying @@ -63,11 +57,15 @@ called EasyPG Library. @end ifnottex @menu -* Overview:: -* Quick start:: -* Commands:: -* Caching Passphrases:: -* Bug Reports:: +* Overview:: +* Quick start:: +* Commands:: +* Caching Passphrases:: +* Bug Reports:: +* GNU Free Documentation License:: The license for this documentation. +* Key Index:: +* Function Index:: +* Variable Index:: @end menu @node Overview @@ -99,7 +97,7 @@ EasyPG Assistant commands are prefixed by @samp{epa-}. For example, EasyPG Assistant provides several cryptographic features which can be integrated into other Emacs functionalities. For example, automatic -encryption/decryption of @samp{*.gpg} files. +encryption/decryption of @file{*.gpg} files. @node Commands @chapter Commands @@ -107,12 +105,12 @@ encryption/decryption of @samp{*.gpg} files. This chapter introduces various commands for typical use cases. @menu -* Key management:: -* Cryptographic operations on regions:: -* Cryptographic operations on files:: -* Dired integration:: -* Mail-mode integration:: -* Encrypting/decrypting *.gpg files:: +* Key management:: +* Cryptographic operations on regions:: +* Cryptographic operations on files:: +* Dired integration:: +* Mail-mode integration:: +* Encrypting/decrypting gpg files:: @end menu @node Key management @@ -163,7 +161,7 @@ Show all keys matched with @var{name} from the private keyring. @end deffn @noindent -In @samp{*Keys*} buffer, several commands are available. The common +In @file{*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. @@ -246,8 +244,9 @@ you answered yes, it will let you select the signing keys. @node Cryptographic operations on files @section Cryptographic operations on files -@deffn Command epa-decrypt-file file -Decrypt @var{file}. +@deffn Command epa-decrypt-file file &optional output +Decrypt @var{file}. If you do not specify the name @var{output} to +use for the decrypted file, this function prompts for the value to use. @end deffn @deffn Command epa-verify-file file @@ -311,7 +310,7 @@ style of sending signed/encrypted emails by embedding raw OpenPGP blobs inside a message body, not using modern MIME format. NOTE: Inline OpenPGP is not recommended and you should consider to use -PGP/MIME. See +PGP/MIME@. See @uref{http://josefsson.org/inline-openpgp-considered-harmful.html, Inline OpenPGP in E-mail is bad@comma{} Mm'kay?}. @@ -343,20 +342,23 @@ Compose a signed message from the current buffer. @kindex @kbd{C-c C-e C-e} @kindex @kbd{C-c C-e e} @findex epa-mail-encrypt +@vindex epa-mail-aliases Compose an encrypted message from the current buffer. By default it tries to build the recipient list from @samp{to}, @samp{cc}, and @samp{bcc} fields of the mail header. To include your key in the recipient list, use @samp{encrypt-to} option in -@file{~/.gnupg/gpg.conf}. +@file{~/.gnupg/gpg.conf}. This function translates recipient +addresses using the @code{epa-mail-aliases} list. You can also +use that option to ignore specific recipients for encryption purposes. @end table -@node Encrypting/decrypting *.gpg files -@section Encrypting/decrypting *.gpg files -By default, every file whose name ends with @samp{.gpg} will be +@node Encrypting/decrypting gpg files +@section Encrypting/decrypting gpg files +By default, every file whose name ends with @file{.gpg} will be treated as encrypted. That is, when you open such a file, the decrypted text is inserted in the buffer rather than encrypted one. -Similarly, when you save the buffer to a @samp{foo.gpg} file, +Similarly, when you save the buffer to a @file{foo.gpg} file, encrypted data is written. The file name pattern for encrypted files can be controlled by @@ -401,7 +403,7 @@ which encryption method should be used through @xref{File Variables, , variable for this. @vindex epa-file-encrypt-to -For example, if you want an Elisp file should be encrypted with a +For example, if you want an Elisp file to be encrypted with a public key associated with an email address @samp{ueno@@unixuser.org}, add the following line to the beginning of the file. @@ -445,9 +447,12 @@ GnuPG version 2), encryption method (symmetric or public key), and whether or not you want to use gpg-agent. Here are some questions: @enumerate -@item Do you use GnuPG version 2 instead of GnuPG version 1? -@item Do you use symmetric encryption rather than public key encryption? -@item Do you want to use gpg-agent? +@item +Do you use GnuPG version 2 instead of GnuPG version 1? +@item +Do you use symmetric encryption rather than public key encryption? +@item +Do you want to use gpg-agent? @end enumerate Here are configurations depending on your answers: @@ -469,7 +474,7 @@ To set up gpg-agent, follow the instruction in GnuPG manual. To set up elisp passphrase cache, set @code{epa-file-cache-passphrase-for-symmetric-encryption}. -@xref{Encrypting/decrypting *.gpg files}. +@xref{Encrypting/decrypting gpg files}. @node Bug Reports @chapter Bug Reports @@ -490,9 +495,25 @@ collect necessary information to fix the bug, such as: Before reporting the bug, you should set @code{epg-debug} in the @file{~/.emacs} file and repeat the bug. Then, include the contents -of the @samp{ *epg-debug*} buffer. Note that the first letter of the +of the @file{ *epg-debug*} buffer. Note that the first letter of the buffer name is a whitespace. +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + +@node Key Index +@unnumbered Key Index +@printindex ky + +@node Function Index +@unnumbered Function Index +@printindex fn + +@node Variable Index +@unnumbered Variable Index +@printindex vr + @bye @c End: