summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarsten Dominik <carsten.dominik@gmail.com>2011-05-31 13:40:00 +0200
committerCarsten Dominik <carsten.dominik@gmail.com>2011-05-31 13:40:00 +0200
commit35baef01b0239315dbcf423a655d281d69f2b4c0 (patch)
tree00a4241b601819d636151472608998ea3960559d
parent257ce858e7526ec6174e6b28fa9cf7422b457705 (diff)
downloadorg-mode-35baef01b0239315dbcf423a655d281d69f2b4c0.tar.gz
Add documentation for org-crypt.el
Patch by Ian Barton.
-rw-r--r--doc/org.texi30
1 files changed, 29 insertions, 1 deletions
diff --git a/doc/org.texi b/doc/org.texi
index bf1fc2d..fea9146 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -12911,6 +12911,7 @@ emacs -Q --batch -l $ORGINSTALL \
* Clean view:: Getting rid of leading stars in the outline
* TTY keys:: Using Org on a tty
* Interaction:: Other Emacs packages
+* org-crypt.el:: Encrypting Org files
@end menu
@@ -13588,7 +13589,7 @@ tty you would rather use @kbd{C-c .} to re-insert the timestamp.
@end multitable
-@node Interaction, , TTY keys, Miscellaneous
+@node Interaction, org-crypt.el, TTY keys, Miscellaneous
@section Interaction with other packages
@cindex packages, interaction with other
Org lives in the world of GNU Emacs and interacts in various ways
@@ -13797,6 +13798,33 @@ another key for this command, or override the key in
@end table
++@node org-crypt.el, , Interaction, Miscellaneous
++@section org-crypt.el
++@cindex @file{org-crypt.el}
++@cindex @code{org-decrypt-entry}
+
+Org-crypt will encrypt the text of an entry, but not the headline, or
+properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
+files.
+
+Any text below a headline that has a @samp{:crypt:} tag will be
+automatically be encrypted when the file is saved. If you want to use a
+different tag just customize the @code{org-crypt-tag-matcher} setting.
+
+To use org-crypt it is suggested that you have the following in your
+@file{.emacs}:
+
+@example
+(require 'org-crypt)
+(org-crypt-use-before-save-magic)
+(setq org-tags-exclude-from-inheritance (quote ("crypt")))
+;; GPG key to use for encryption
+;; Either the Key ID or set to nil to use symmetric encryption.
+(setq org-crypt-key nil)
+@end example
+
+Excluding the crypt tag from inheritance prevents already encrypted text
+being encrypted again.
@node Hacking, MobileOrg, Miscellaneous, Top
@appendix Hacking