epa.texi

   1 \input texinfo                  @c -*- mode: texinfo -*-
   2 @c %**start of header
   3 @setfilename epa.info
   4 @settitle EasyPG Assistant
   5 @c %**end of header
   6 @include version.texi
   7 @c @documentlanguage en
   8
   9 @dircategory GNU Emacs Lisp
  10 @direntry
  11 * EasyPG Assistant: (epa).   EasyPG Assistant
  12 @end direntry
  13
  14 @ifinfo
  15 This file describes EasyPG Assistant.
  16
  17 Copyright (C) 2007 Daiki Ueno.
  18
  19 Permission is granted to copy, distribute and/or modify this document
  20 under the terms of the GNU Free Documentation License, Version 1.1 or
  21 any later version published by the Free Software Foundation; with no
  22 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
  23 Texts.  A copy of the license is included in the section entitled "GNU
  24 Free Documentation License".
  25 @end ifinfo
  26
  27 @tex
  28
  29 @titlepage
  30 @title EasyPG Assistant
  31
  32 @author by Daiki Ueno
  33 @page
  34
  35 @vskip 0pt plus 1filll
  36 Copyright @copyright{} 2007 Daiki Ueno.
  37
  38 Permission is granted to copy, distribute and/or modify this document
  39 under the terms of the GNU Free Documentation License, Version 1.1 or
  40 any later version published by the Free Software Foundation; with no
  41 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
  42 Texts.  A copy of the license is included in the section entitled "GNU
  43 Free Documentation License".
  44 @end titlepage
  45 @page
  46
  47 @end tex
  48
  49 @node Top
  50 @top EasyPG Assistant user's manual
  51
  52 This manual covers EasyPG version @value{VERSION}.
  53
  54 @menu
  55 * Overview::
  56 * Quick start::
  57 * Commands::
  58 @end menu
  59
  60 @node  Overview
  61 @chapter Overview
  62
  63 EasyPG is an all-in-one GnuPG (@pxref{Top, , Top, gnupg, Using the GNU
  64 Privacy Guard}) interface for Emacs.  It has two aspects: convenient
  65 tools which allow to use GnuPG from Emacs (EasyPG Assistant), and a
  66 fully functional interface library to GnuPG (EasyPG Library).  This
  67 manual describes EasyPG Assistant specifically.
  68
  69 The EasyPG Assistant provides the following features.
  70
  71 @table @bullet
  72 @item Keyring browser.
  73 @item Cryptographic operations on regions.
  74 @item Cryptographic operations on files.
  75 @item Dired integration.
  76 @item Encryption/decryption of *.gpg files.
  77 @end table
  78
  79 @node  Quick start
  80 @chapter Quick start
  81
  82 To install, just follow the standard CMMI installation instructions.
  83
  84 @example
  85 $ ./configure
  86 $ sudo make install
  87 @end example
  88
  89 Then, add the following line to your @file{~/.emacs}
  90
  91 @lisp
  92 (require 'epa-setup)
  93 @end lisp
  94
  95 That's all.  Restart emacs and type @kbd{M-x epa- TAB}, and you will see a
  96 lot of commands available.  For example,
  97
  98 @table @bullet
  99 @item To browse your keyring, type @kbd{M-x epa-list-keys}
 100
 101 @item To create a cleartext signature of the region, type @kbd{M-x epa-sign-region}
 102 @end table
 103
 104 You can also do some cryptographic operations from dired.
 105
 106 @example
 107 M-x dired
 108 (mark some files)
 109 : e (or M-x epa-dired-do-encrypt)
 110 (select recipients by 'm' and click [OK])
 111 @end example
 112
 113 @node Commands
 114 @chapter Commands
 115
 116 @menu
 117 * Keyring browser::
 118 * Cryptographic operations on regions::
 119 * Cryptographic operations on files::
 120 * Dired integration::
 121 * Encrypting/decrypting *.gpg files::
 122 @end menu
 123
 124 @node Keyring browser
 125 @section Keyring browser
 126
 127 @deffn Command epa-list-keys &optional name mode
 128 Show all keys matched with NAME from the keyring.
 129 If MODE is non-nil, it reads the private keyring.  Otherwise, it
 130 reads the public keyring.
 131 @end deffn
 132
 133 The output looks as follows.
 134
 135 @example
 136   u A5B6B2D4B15813FE Daiki Ueno <ueno@@unixuser.org>
 137 @end example
 138
 139 You can move over entries by @kbd{TAB}.  If you type @kbd{RET} or
 140 clicked an entry, you will see more detailed information about the key
 141 you selected.
 142
 143 @example
 144  u Daiki Ueno <ueno@@unixuser.org>
 145  u A5B6B2D4B15813FE 1024bits DSA
 146         Created: 2001-10-09
 147         Expires: 2007-09-04
 148         Capabilities: sign certify
 149         Fingerprint: 8003 7CD0 0F1A 9400 03CA  50AA A5B6 B2D4 B158 13FE
 150  u 4447461B2A9BEA2D 2048bits ELGAMAL_E
 151         Created: 2001-10-09
 152         Expires: 2007-09-04
 153         Capabilities: encrypt
 154         Fingerprint: 9003 D76B 73B7 4A8A E588  10AF 4447 461B 2A9B EA2D
 155 @end example
 156
 157 @node Cryptographic operations on regions
 158 @section Cryptographic operations on regions
 159 (not yet written.)
 160
 161 @node Cryptographic operations on files
 162 @section Cryptographic operations on files
 163 (not yet written.)
 164
 165 @node Dired integration
 166 @section Dired integration
 167 (not yet written.)
 168
 169 @node Encrypting/decrypting *.gpg files
 170 @section Encrypting/decrypting *.gpg files
 171 (not yet written.)
 172
 173 @summarycontents
 174 @contents
 175 @bye
 176
 177 @c End: