annotate doc/misc/remember.texi @ 98597:36ba1f7c4d10

*** empty log message ***
author Eli Zaretskii <eliz@gnu.org>
date Fri, 10 Oct 2008 08:54:08 +0000
parents 0080e1e64a78
children 6de181810d0f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
1 \input texinfo @c -*-texinfo-*-
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
2 @c %**start of header
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
3 @setfilename ../../info/remember
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
4 @settitle Remember Manual
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
5 @c %**end of header
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
6
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
7 @dircategory Emacs
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
8 @direntry
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
9 * Remember: (remember). Simple information manager for Emacs
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
10 @end direntry
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
11
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
12 @syncodeindex fn cp
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
13
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
14 @copying
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
15 This manual is for Remember Mode, version 1.9
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
16
87662
22a3b3069f85 Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 87054
diff changeset
17 Copyright @copyright{} 2001, 2004, 2005, 2007, 2008
22a3b3069f85 Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 87054
diff changeset
18 Free Software Foundation, Inc.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
19
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
20 @quotation
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
21 Permission is granted to copy, distribute and/or modify this document
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
22 under the terms of the GNU Free Documentation License, Version 1.2
95981
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 87662
diff changeset
23 or any later version published by the Free Software Foundation; with no
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 87662
diff changeset
24 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 87662
diff changeset
25 and with the Back-Cover Texts as in (a) below. A copy of the license
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 87662
diff changeset
26 is included in the section entitled ``GNU Free Documentation License''.
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 87662
diff changeset
27
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 87662
diff changeset
28 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 87662
diff changeset
29 modify this GNU manual. Buying copies from the FSF supports it in
0080e1e64a78 Add Cover-Texts.
Glenn Morris <rgm@gnu.org>
parents: 87662
diff changeset
30 developing GNU and promoting software freedom.''
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
31 @end quotation
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
32 @end copying
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
33
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
34 @titlepage
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
35 @title Guide to Remember Mode
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
36 @subtitle a simple information manager
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
37 @subtitle for Emacs and XEmacs
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
38
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
39 @c The following two commands
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
40 @c start the copyright page.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
41 @page
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
42 @vskip 0pt plus 1filll
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
43 @insertcopying
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
44 @end titlepage
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
45
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
46 @c So the toc is printed at the start
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
47 @contents
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
48
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
49 @ifnottex
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
50 @node Top, Preface, (dir), (dir)
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
51 @comment node-name, next, previous, up
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
52 @top Remember
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
53
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
54 @insertcopying
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
55 @end ifnottex
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
56
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
57 @menu
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
58 * Preface:: About the documentation.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
59 * Introduction:: What is Remember Mode?
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
60 * Installation:: How to install Remember.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
61 * Implementation:: How Remember came into existence.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
62 * Quick Start:: Get started using Remember.
85775
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
63 * Function Reference:: Interactive functions in remember.el.
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
64 * Keystrokes:: Keystrokes bound in Remember Mode.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
65 * Backends:: Backends for saving notes.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
66 * GNU Free Documentation License:: The license for this documentation.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
67 * Concept Index:: Search for terms.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
68
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
69 @detailmenu
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
70 --- The Detailed Node Listing ---
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
71
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
72 Backends
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
73
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
74 * Text File:: Saving to a text file.
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
75 * Diary:: Saving to a Diary file.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
76 * Mailbox:: Saving to a mailbox.
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
77 * Org:: Saving to an Org Mode file.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
78
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
79 @end detailmenu
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
80 @end menu
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
81
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
82 @node Preface, Introduction, Top, Top
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
83 @comment node-name, next, previous, up
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
84 @chapter Preface
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
85
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
86 This document describes remember-el, which was written by John Wiegley,
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
87 was once maintained by Sacha Chua, and is now maintained by the Emacs
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
88 developers.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
89
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
90 This document is a work in progress, and your contribution will be
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
91 greatly appreciated.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
92
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
93 @node Introduction, Installation, Preface, Top
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
94 @comment node-name, next, previous, up
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
95 @chapter Introduction
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
96
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
97 Todo lists, schedules, phone databases... everything we use databases
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
98 for is really just a way to extend the power of our memory, to be able
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
99 to remember what our conscious mind may not currently have access to.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
100
85793
b7bd71352e5d remember.texi (Introduction): Fix typographical issue with "---"
Michael Olson <mwolson@gnu.org>
parents: 85775
diff changeset
101 There are many different databases out there---and good ones---which
b7bd71352e5d remember.texi (Introduction): Fix typographical issue with "---"
Michael Olson <mwolson@gnu.org>
parents: 85775
diff changeset
102 this mode is not trying to replace. Rather, it's how that data gets
b7bd71352e5d remember.texi (Introduction): Fix typographical issue with "---"
Michael Olson <mwolson@gnu.org>
parents: 85775
diff changeset
103 there that's the question. Most of the time, we just want to say
b7bd71352e5d remember.texi (Introduction): Fix typographical issue with "---"
Michael Olson <mwolson@gnu.org>
parents: 85775
diff changeset
104 "Remember so-and-so's phone number, or that I have to buy dinner for the
b7bd71352e5d remember.texi (Introduction): Fix typographical issue with "---"
Michael Olson <mwolson@gnu.org>
parents: 85775
diff changeset
105 cats tonight." That's the FACT. How it's stored is really the
b7bd71352e5d remember.texi (Introduction): Fix typographical issue with "---"
Michael Olson <mwolson@gnu.org>
parents: 85775
diff changeset
106 computer's problem. But at this point in time, it's most definitely
b7bd71352e5d remember.texi (Introduction): Fix typographical issue with "---"
Michael Olson <mwolson@gnu.org>
parents: 85775
diff changeset
107 also the user's problem, and sometimes so laboriously so that people
b7bd71352e5d remember.texi (Introduction): Fix typographical issue with "---"
Michael Olson <mwolson@gnu.org>
parents: 85775
diff changeset
108 just let data slip, rather than expend the effort to record it.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
109
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
110 ``Remember'' is a mode for remembering data. It uses whatever
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
111 back-end is appropriate to record and correlate the data, but its main
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
112 intention is to allow you to express as @emph{little} structure as
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
113 possible up front. If you later want to express more powerful
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
114 relationships between your data, or state assumptions that were at
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
115 first too implicit to be recognized, you can ``study'' the data later
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
116 and rearrange it. But the initial ``just remember this'' impulse
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
117 should be as close to simply throwing the data at Emacs as possible.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
118
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
119 Have you ever noticed that having a laptop to write on doesn't
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
120 @emph{actually} increase the amount of quality material that you turn
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
121 out, in the long run? Perhaps it's because the time we save
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
122 electronically in one way, we're losing electronically in another; the
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
123 tool should never dominate one's focus. As the mystic Faridu'd-Din
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
124 `Attar wrote: ``Be occupied as little as possible with things of the
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
125 outer world but much with things of the inner world; then right action
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
126 will overcome inaction.''
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
127
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
128 If Emacs could become a more intelligent data store, where brainstorming
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
129 would focus on the @emph{ideas} involved---rather than the structuring
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
130 and format of those ideas, or having to stop your current flow of work
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
131 in order to record them---it would map much more closely to how the mind
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
132 (well, at least mine) works, and hence would eliminate that very
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
133 manual-ness which computers from the very beginning have been championed
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
134 as being able to reduce.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
135
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
136 @node Installation, Implementation, Introduction, Top
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
137 @comment node-name, next, previous, up
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
138 @chapter Installation
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
139
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
140 Installing Remember Mode is as simple as adding the following lines to
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
141 your Emacs configuration file (usually @file{~/.emacs.d/init.el} or
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
142 @file{~/.emacs}).
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
143
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
144 @lisp
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
145 (add-to-list 'load-path "/path/to/remember")
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
146 (require 'remember)
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
147 @end lisp
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
148
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
149 @node Implementation, Quick Start, Installation, Top
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
150 @comment node-name, next, previous, up
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
151 @chapter Implementation
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
152
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
153 Hyperbole, as a data presentation tool, always struck me as being very
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
154 powerful, but it seemed to require a lot of ``front-end'' work before
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
155 that data was really available. The problem with BBDB, or keeping up
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
156 a Bibl-mode file, is that you have to use different functions to
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
157 record the data, and it always takes time to stop what you're doing,
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
158 format the data in the manner expected by that particular data
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
159 interface, and then resume your work.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
160
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
161 With ``remember'', you just hit @kbd{M-x remember} (you'd probably
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
162 want to bind this to an easily accessible keystroke, like @kbd{C-x
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
163 M-r}), slam in your text however you like, and then hit @kbd{C-c C-c}.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
164 It will file the data away for later retrieval, and possibly indexing.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
165
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
166 Indexing is to data what ``studying'' is in the real world. What you do
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
167 when you study (or lucubrate, for some of us) is to realize certain
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
168 relationships implicit in the data, so that you can make use of those
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
169 relationships. Expressing that a certain quote you remembered was a
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
170 literary quote, and that you want the ability to pull up all quotes of a
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
171 literary nature, is what studying does. This is a more labor intensive
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
172 task than the original remembering of the data, and it's typical in real
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
173 life to set aside a special period of time for doing this work.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
174
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
175 ``Remember'' works in the same way. When you enter data, either by
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
176 typing it into a buffer, or using the contents of the selected region,
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
177 it will store that data---unindexed, uninterpreted---in a data pool.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
178 It will also try to remember as much context information as possible
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
179 (any text properties that were set, where you copied it from, when,
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
180 how, etc). Later, you can walk through your accumulated set of data
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
181 (both organized, and unorganized) and easily begin moving things
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
182 around, and making annotations that will express the full meaning of
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
183 that data, as far as you know it.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
184
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
185 Obviously this latter stage is more user-interface intensive, and it
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
186 would be nice if ``remember'' could do it as elegantly as possible,
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
187 rather than requiring a billion keystrokes to reorganize your
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
188 hierarchy. Well, as the future arrives, hopefully experience and user
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
189 feedback will help to make this as intuitive a tool as possible.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
190
85775
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
191 @node Quick Start, Function Reference, Implementation, Top
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
192 @comment node-name, next, previous, up
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
193 @chapter Quick Start
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
194
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
195 @itemize
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
196
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
197 @item
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
198 Load @file{remember.el}.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
199
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
200 @item
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
201 Type @kbd{M-x remember}. The @samp{*Remember*} buffer should be
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
202 displayed.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
203
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
204 @item
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
205 Type in what you want to remember. The first line will be treated as
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
206 the headline, and the rest of the buffer will contain the body of the
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
207 note.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
208
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
209 @item
85913
047b6a6087c2 Remember: Use define-obsolete-function-alias for `remember-buffer'.
Michael Olson <mwolson@gnu.org>
parents: 85806
diff changeset
210 Type @kbd{C-c C-c} (@code{remember-finalize}) to save the note and close
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
211 the @samp{*Remember*} buffer.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
212 @end itemize
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
213
85913
047b6a6087c2 Remember: Use define-obsolete-function-alias for `remember-buffer'.
Michael Olson <mwolson@gnu.org>
parents: 85806
diff changeset
214 By default, @code{remember-finalize} saves the note in @file{~/.notes}.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
215 You can edit it now to see the remembered and timestamped note. You
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
216 can edit this file however you want. New entries will always be added
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
217 to the end.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
218
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
219 To remember a region of text, use the universal prefix. @kbd{C-u M-x
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
220 remember} displays a @samp{*Remember*} buffer with the region as the
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
221 initial contents.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
222
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
223 As a simple beginning, you can start by using the Text File backend,
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
224 keeping your @file{~/.notes} file in outline-mode format, with a final
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
225 entry called @samp{* Raw data}. Remembered data will be added to the
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
226 end of the file. Every so often, you can move the data that gets
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
227 appended there into other files, or reorganize your document.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
228
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
229 You can also store remembered data in other backends.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
230 (@pxref{Backends})
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
231
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
232 Here is one way to map the remember functions in your @file{.emacs} to
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
233 very accessible keystrokes facilities using the mode:
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
234
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
235 @lisp
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
236 (autoload 'remember ``remember'' nil t)
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
237 (autoload 'remember-region ``remember'' nil t)
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
238
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
239 (define-key global-map (kbd "<f9> r") 'remember)
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
240 (define-key global-map (kbd "<f9> R") 'remember-region)
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
241 @end lisp
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
242
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
243 By default, remember uses the first annotation returned by
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
244 @code{remember-annotation-functions}. To include all of the annotations,
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
245 set @code{remember-run-all-annotation-functions-flag} to non-nil.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
246
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
247 @defopt remember-run-all-annotation-functions-flag
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
248 Non-nil means use all annotations returned by
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
249 @code{remember-annotation-functions}.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
250 @end defopt
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
251
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
252 You can write custom functions that use a different set of
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
253 remember-annotation-functions. For example:
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
254
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
255 @lisp
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
256 (defun my/remember-with-filename ()
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
257 "Always use the filename."
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
258 (interactive)
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
259 (let ((remember-annotation-functions '(buffer-file-name)))
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
260 (call-interactively 'remember)))
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
261 @end lisp
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
262
85775
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
263 @node Function Reference, Keystrokes, Quick Start, Top
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
264 @comment node-name, next, previous, up
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
265 @chapter Function Reference
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
266
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
267 @file{remember.el} defines the following interactive functions:
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
268
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
269 @defun remember initial
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
270 Remember an arbitrary piece of data. With a prefix, it will use the
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
271 region as @var{initial}.
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
272 @end defun
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
273
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
274 @defun remember-region beg end
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
275 If called from within the remember buffer, @var{beg} and @var{end} are
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
276 ignored, and the entire buffer will be remembered. If called from any
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
277 other buffer, that region, plus any context information specific to
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
278 that region, will be remembered.
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
279 @end defun
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
280
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
281 @defun remember-clipboard
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
282 Remember the contents of the current clipboard. This is most useful
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
283 for remembering things from Netscape or other X Windows applications.
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
284 @end defun
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
285
85913
047b6a6087c2 Remember: Use define-obsolete-function-alias for `remember-buffer'.
Michael Olson <mwolson@gnu.org>
parents: 85806
diff changeset
286 @defun remember-finalize
85775
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
287 Remember the contents of the current buffer.
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
288 @end defun
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
289
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
290 @defun remember-mode
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
291 This enters the major mode for output from @command{remember}. This
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
292 buffer is used to collect data that you want remember. Just hit
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
293 @kbd{C-c C-c} when you're done entering, and it will go ahead and file
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
294 the data for latter retrieval, and possible indexing.
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
295 @end defun
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
296
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
297 @node Keystrokes, Backends, Function Reference, Top
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
298 @comment node-name, next, previous, up
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
299 @chapter Keystroke Reference
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
300
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
301 @file{remember.el} defines the following keybindings by default:
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
302
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
303 @table @kbd
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
304
85913
047b6a6087c2 Remember: Use define-obsolete-function-alias for `remember-buffer'.
Michael Olson <mwolson@gnu.org>
parents: 85806
diff changeset
305 @item C-c C-c (`remember-finalize')
85775
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
306 Remember the contents of the current buffer.
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
307
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
308 @item C-c C-k (`remember-destroy')
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
309 Destroy the current *Remember* buffer.
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
310
85913
047b6a6087c2 Remember: Use define-obsolete-function-alias for `remember-buffer'.
Michael Olson <mwolson@gnu.org>
parents: 85806
diff changeset
311 @item C-x C-s (`remember-finalize')
85775
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
312 Remember the contents of the current buffer.
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
313
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
314 @end table
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
315
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
316 @node Backends, GNU Free Documentation License, Keystrokes, Top
85775
c00d89ba4e04 Reorganize chapters in Remember Manual
Michael Olson <mwolson@gnu.org>
parents: 85772
diff changeset
317 @comment node-name, next, previous, up
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
318 @chapter Backends
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
319
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
320 You can save remembered notes to a variety of backends.
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
321
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
322 @menu
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
323 * Text File:: Saving to a text file.
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
324 * Diary:: Saving to a Diary file.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
325 * Mailbox:: Saving to a mailbox.
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
326 * Org:: Saving to an Org Mode file.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
327 @end menu
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
328
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
329 @node Text File, Diary, Backends, Backends
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
330 @comment node-name, next, previous, up
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
331 @section Saving to a Text File
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
332 @cindex text file, saving to
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
333
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
334 @subheading Insinuation
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
335
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
336 @lisp
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
337 (setq remember-handler-functions '(remember-append-to-file))
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
338 @end lisp
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
339
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
340 @subheading Options
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
341
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
342 @defopt remember-data-file
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
343 The file in which to store unprocessed data.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
344 @end defopt
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
345
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
346 @defopt remember-leader-text
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
347 The text used to begin each remember item.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
348 @end defopt
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
349
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
350 @node Diary, Mailbox, Text File, Backends
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
351 @comment node-name, next, previous, up
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
352 @section Saving to a Diary file
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
353 @cindex diary, integration
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
354
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
355 @subheading Insinuation
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
356
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
357 @lisp
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
358 (add-to-list 'remember-handler-functions 'remember-diary-extract-entries)
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
359 @end lisp
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
360
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
361 @subheading Options
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
362
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
363 @defopt remember-diary-file
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
364 File for extracted diary entries.
87054
25de6f4a58d8 Merge remember-diary.el into remember.el
Michael Olson <mwolson@gnu.org>
parents: 85913
diff changeset
365 If this is nil, then @code{diary-file} will be used instead."
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
366 @end defopt
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
367
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
368 @node Mailbox, Org, Diary, Backends
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
369 @comment node-name, next, previous, up
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
370 @section Saving to a Mailbox
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
371 @cindex mailbox, saving to
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
372
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
373 @subheading Insinuation
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
374
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
375 @lisp
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
376 (add-to-list 'remember-handler-functions 'remember-store-in-mailbox)
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
377 @end lisp
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
378
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
379 @subheading Options
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
380
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
381 @defopt remember-mailbox
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
382 The file in which to store remember data as mail.
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
383 @end defopt
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
384
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
385 @defopt remember-default-priority
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
386 The default priority for remembered mail messages.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
387 @end defopt
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
388
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
389 @node Org, , Mailbox, Backends
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
390 @comment node-name, next, previous, up
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
391 @section Saving to an Org Mode file
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
392 @cindex org mode, integration
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
393
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
394 For instructions on how to integrate Remember with Org Mode,
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
395 consult @ref{Remember, , , org}.
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
396
85799
10f70d5f0ff3 remember.texi: Remove mentions of things outside of Emacs
Michael Olson <mwolson@gnu.org>
parents: 85793
diff changeset
397 @node GNU Free Documentation License, Concept Index, Backends, Top
85772
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
398 @appendix GNU Free Documentation License
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
399 @include doclicense.texi
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
400
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
401 @node Concept Index, , GNU Free Documentation License, Top
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
402 @comment node-name, next, previous, up
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
403 @unnumbered Index
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
404
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
405 @printindex cp
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
406
6b9c41aaadf8 Check in Remember Mode
Michael Olson <mwolson@gnu.org>
parents:
diff changeset
407 @bye
85806
2a9d361b3986 Add arch tagline
Miles Bader <miles@gnu.org>
parents: 85799
diff changeset
408
2a9d361b3986 Add arch tagline
Miles Bader <miles@gnu.org>
parents: 85799
diff changeset
409 @ignore
2a9d361b3986 Add arch tagline
Miles Bader <miles@gnu.org>
parents: 85799
diff changeset
410 arch-tag: 5b980db0-20cc-4167-b845-52dc11d53b9f
2a9d361b3986 Add arch tagline
Miles Bader <miles@gnu.org>
parents: 85799
diff changeset
411 @end ignore