From 7b26e29c09ec312968e28014de711a90ec77f6bb Mon Sep 17 00:00:00 2001 From: ueno Date: Tue, 20 Mar 2007 07:32:57 +0000 Subject: [PATCH] * Makefile.am (info_TEXINFOS): Added epa.texi. * epa.texi: New file. --- ChangeLog | 5 ++ Makefile.am | 3 + epa.texi | 177 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 185 insertions(+) create mode 100644 epa.texi diff --git a/ChangeLog b/ChangeLog index 18129c7..e5681b0 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2007-03-20 Daiki Ueno + + * Makefile.am (info_TEXINFOS): Added epa.texi. + * epa.texi: New file. + 2007-03-19 Daiki Ueno * epg.el (epg--decode-percent-escape): New function. diff --git a/Makefile.am b/Makefile.am index a5cb7bc..9bcbfb8 100644 --- a/Makefile.am +++ b/Makefile.am @@ -5,6 +5,9 @@ epa-file.el epa-mail.el epa-setup.el CLEANFILES = auto-autoloads.el* custom-load.el *.elc DISTCLEANFILES = epg-package-info.el + +info_TEXINFOS = epa.texi + FLAGS ?= -batch -q -no-site-file all: elc diff --git a/epa.texi b/epa.texi new file mode 100644 index 0000000..25b5315 --- /dev/null +++ b/epa.texi @@ -0,0 +1,177 @@ +\input texinfo @c -*- mode: texinfo -*- +@c %**start of header +@setfilename epa.info +@settitle EasyPG Assistant +@c %**end of header +@include version.texi +@c @documentlanguage en + +@dircategory GNU Emacs Lisp +@direntry +* EasyPG Assistant: (epa). EasyPG Assistant +@end direntry + +@ifinfo +This file describes EasyPG Assistant. + +Copyright (C) 2007 Daiki Ueno. + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 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". +@end ifinfo + +@tex + +@titlepage +@title EasyPG Assistant + +@author by Daiki Ueno +@page + +@vskip 0pt plus 1filll +Copyright @copyright{} 2007 Daiki Ueno. + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.1 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". +@end titlepage +@page + +@end tex + +@node Top +@top EasyPG Assistant user's manual + +This manual covers EasyPG version @value{VERSION}. + +@menu +* Overview:: +* Quick start:: +* Commands:: +@end menu + +@node Overview +@chapter Overview + +EasyPG is an all-in-one GnuPG (@pxref{Top, , Top, gnupg, Using the GNU +Privacy Guard}) interface for Emacs. It has two aspects: convenient +tools which allow to use GnuPG from Emacs (EasyPG Assistant), and a +fully functional interface library to GnuPG (EasyPG Library). This +manual describes EasyPG Assistant specifically. + +The EasyPG Assistant provides the following features. + +@table @bullet +@item Keyring browser. +@item Cryptographic operations on regions. +@item Cryptographic operations on files. +@item Dired integration. +@item Encryption/decryption of *.gpg files. +@end table + +@node Quick start +@chapter Quick start + +To install, just follow the standard CMMI installation instructions. + +@example +$ ./configure +$ sudo make install +@end example + +Then, add the following line to your @file{~/.emacs} + +@lisp +(require 'epa-setup) +@end lisp + +That's all. Restart emacs and type @kbd{M-x epa- TAB}, and you will see a +lot of commands available. For example, + +@table @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} +@end table + +You can also do some cryptographic operations from dired. + +@example +M-x dired +(mark some files) +: e (or M-x epa-dired-do-encrypt) +(select recipients by 'm' and click [OK]) +@end example + +@node Commands +@chapter Commands + +@menu +* Keyring browser:: +* Cryptographic operations on regions:: +* Cryptographic operations on files:: +* Dired integration:: +* Encrypting/decrypting *.gpg files:: +@end menu + +@node Keyring browser +@section Keyring browser + +@deffn Command epa-list-keys &optional name mode +Show all keys matched with NAME from the keyring. +If MODE is non-nil, it reads the private keyring. Otherwise, it +reads the public keyring. +@end deffn + +The output looks as follows. + +@example + u A5B6B2D4B15813FE Daiki Ueno +@end example + +You can move over entries by @kbd{TAB}. If you type @kbd{RET} or +clicked an entry, you will see more detailed information about the key +you selected. + +@example + u Daiki Ueno + u A5B6B2D4B15813FE 1024bits DSA + Created: 2001-10-09 + Expires: 2007-09-04 + Capabilities: sign certify + Fingerprint: 8003 7CD0 0F1A 9400 03CA 50AA A5B6 B2D4 B158 13FE + u 4447461B2A9BEA2D 2048bits ELGAMAL_E + Created: 2001-10-09 + Expires: 2007-09-04 + Capabilities: encrypt + Fingerprint: 9003 D76B 73B7 4A8A E588 10AF 4447 461B 2A9B EA2D +@end example + +@node Cryptographic operations on regions +@section Cryptographic operations on regions +(not yet written.) + +@node Cryptographic operations on files +@section Cryptographic operations on files +(not yet written.) + +@node Dired integration +@section Dired integration +(not yet written.) + +@node Encrypting/decrypting *.gpg files +@section Encrypting/decrypting *.gpg files +(not yet written.) + +@summarycontents +@contents +@bye + +@c End: -- 1.7.10.4