From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jambunathan K Subject: Re: [Patch] For the Manual: using org-crypt Date: Wed, 23 Mar 2011 21:33:05 +0530 Message-ID: <81d3lhhlja.fsf@gmail.com> References: <4D831E9A.9050808@manor-farm.org> <87hbatdf77.fsf@sbs.ch> Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from [140.186.70.92] (port=50656 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Q2QWw-0000Oc-HN for emacs-orgmode@gnu.org; Wed, 23 Mar 2011 12:03:32 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Q2QWp-0004nf-1g for emacs-orgmode@gnu.org; Wed, 23 Mar 2011 12:03:24 -0400 Received: from mail-gy0-f169.google.com ([209.85.160.169]:35913) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Q2QWo-0004nQ-UY for emacs-orgmode@gnu.org; Wed, 23 Mar 2011 12:03:23 -0400 Received: by gyg10 with SMTP id 10so3659823gyg.0 for ; Wed, 23 Mar 2011 09:03:22 -0700 (PDT) In-Reply-To: <87hbatdf77.fsf@sbs.ch> (Christian Egli's message of "Wed, 23 Mar 2011 16:33:32 +0100") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Christian Egli Cc: emacs-orgmode@gnu.org Thanks Christian. Some minor improvements. The intention is not to nitpick but to build on top of what you have provided and help the reviewer. > +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. --8<---------------cut here---------------start------------->8--- > EasyPG is part of recent Emacs releases (at least Emacs 23). It is > +available as a separate package for earlier versions of Emacs. If your > +version of Emacs already has EasyPG do not install the package manager's > +version. Doing so will lead to unpredictable results. --8<---------------cut here---------------end--------------->8--- This information could be captured elsewhere and be left out of the manual. (This parts reads like a tutorial entry) > + > +To use org-crypt you will need to have something like the following in your > +@file{.emacs}: `Recommendation', `suggestion' would be a better word. Word `something' is ambiguous. --8<---------------cut here---------------start------------->8--- > +If you want to use Public Key Encryption, you will need to generate a > +suitable pubic/private key pair using @command{gnupg}. --8<---------------cut here---------------end--------------->8--- This portion better be left out of the Org manual. --8<---------------cut here---------------start------------->8--- > +Now any text below a headline that has a @samp{:crypt:} tag will be > +automatically be encrypted when the file is saved. --8<---------------cut here---------------end--------------->8--- Above portion qualifies to be part of introductory text. --8<---------------cut here---------------start------------->8--- > +Preventing tag inheritance stops you having encrypted text inside encrypted > +text. --8<---------------cut here---------------end--------------->8--- Above segment seems a bit out of context ... May be some supplementary information has to go with it or is it just an implementation artefact that the user need not bother about. Or is this part of the user configuration? > +To decrypt the text just call @kbd{M-x org-decrypt-entry} and the encrypted > +text where the point is will be replaced with the plain text. The first part is complete in itself. The latter can be removed. --8<---------------cut here---------------start------------->8--- > If you use this +feature a lot, you will probably want to bind > @kbd{M-x org-decrypt-entry} to +a key. --8<---------------cut here---------------end--------------->8--- Shouldn't part of the manual? Jambunathan K. --