Go back to grave quoting in source-code docstrings etc.

[gnus] / texi / epa.texi

diff --git a/texi/epa.texi b/texi/epa.texi
index 17bbba6..b6825f7 100644 (file)
--- a/texi/epa.texi
+++ b/texi/epa.texi
@@ -1,7 +1,8 @@
 \input texinfo                  @c -*- mode: texinfo -*-
 @c %**start of header
 \input texinfo                  @c -*- mode: texinfo -*-
 @c %**start of header

-@setfilename epa
+@setfilename epa.info

 @settitle EasyPG Assistant User's Manual
 @settitle EasyPG Assistant User's Manual

+@include docstyle.texi

 @c %**end of header
 
 @set VERSION 1.0.0
 @c %**end of header
 
 @set VERSION 1.0.0


@@ -9,13 +10,13 @@
 @copying
 This file describes EasyPG Assistant @value{VERSION}.
 
 @copying
 This file describes EasyPG Assistant @value{VERSION}.
 

-Copyright @copyright{} 2007--2013 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
 
 @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''.
 
 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''.
 


@@ -62,6 +63,9 @@ called EasyPG Library.
 * Caching Passphrases::
 * Bug Reports::
 * GNU Free Documentation License::  The license for this documentation.
 * Caching Passphrases::
 * Bug Reports::
 * GNU Free Documentation License::  The license for this documentation.

+* Key Index::
+* Function Index::
+* Variable Index::

 @end menu
 
 @node  Overview
 @end menu
 
 @node  Overview


@@ -93,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
 
 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
 
 @node Commands
 @chapter Commands


@@ -106,7 +110,7 @@ This chapter introduces various commands for typical use cases.
 * Cryptographic operations on files::
 * Dired integration::
 * Mail-mode integration::
 * Cryptographic operations on files::
 * Dired integration::
 * Mail-mode integration::

-* Encrypting/decrypting *.gpg files::
+* Encrypting/decrypting gpg files::

 @end menu
 
 @node Key management
 @end menu
 
 @node Key management


@@ -157,7 +161,7 @@ Show all keys matched with @var{name} from the private keyring.
 @end deffn
 
 @noindent
 @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.
 
 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.
 


@@ -240,8 +244,9 @@ you answered yes, it will let you select the signing keys.
 @node Cryptographic operations on files
 @section Cryptographic operations on files
 
 @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
 @end deffn
 
 @deffn Command epa-verify-file file


@@ -337,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
 @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
 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
 
 
 @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.
 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
 encrypted data is written.
 
 The file name pattern for encrypted files can be controlled by


@@ -374,7 +382,7 @@ Enable automatic encryption/decryption of *.gpg files.
 @noindent
 By default, @code{epa-file} will try to use symmetric encryption, aka
 password-based encryption.  If you want to use public key encryption
 @noindent
 By default, @code{epa-file} will try to use symmetric encryption, aka
 password-based encryption.  If you want to use public key encryption

-instead, do @kbd{M-x epa-file-select-keys}, which will pops up the key
+instead, do @kbd{M-x epa-file-select-keys}, which pops up the key

 selection dialog.
 
 @deffn Command epa-file-select-keys
 selection dialog.
 
 @deffn Command epa-file-select-keys


@@ -395,7 +403,7 @@ which encryption method should be used through @xref{File Variables, ,
 variable for this.
 @vindex epa-file-encrypt-to
 
 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.
 
 public key associated with an email address @samp{ueno@@unixuser.org},
 add the following line to the beginning of the file.
 


@@ -439,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
 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:
 @end enumerate
 
 Here are configurations depending on your answers:


@@ -463,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}.
 
 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
 
 @node Bug Reports
 @chapter Bug Reports


@@ -484,13 +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
 
 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
 
 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:
 @bye
 
 @c End: