@c %**start of header
@setfilename ../../info/remember
@settitle Remember Manual
-@c %**end of header
-
-@dircategory Emacs
-@direntry
-* Remember: (remember). Simple information manager for Emacs
-@end direntry
-
@syncodeindex fn cp
+@c %**end of header
@copying
This manual is for Remember Mode, version 1.9
-Copyright @copyright{} 2001, 2004, 2005, 2007 Free Software Foundation, Inc.
+Copyright @copyright{} 2001, 2004, 2005, 2007, 2008, 2009, 2010
+Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.2
-or any later version published by the Free Software Foundation;
-with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
-Texts. A copy of the license is included in the section entitled ``GNU
-Free Documentation License''.
+under the terms of the GNU Free Documentation License, Version 1.3 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
+and with the Back-Cover Texts as in (a) below. A copy of the license
+is included in the section entitled ``GNU Free Documentation License''.
+
+(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
+modify this GNU manual. Buying copies from the FSF supports it in
+developing GNU and promoting software freedom.''
@end quotation
@end copying
+@dircategory Emacs
+@direntry
+* Remember: (remember). Simple information manager for Emacs
+@end direntry
+
@titlepage
@title Guide to Remember Mode
@subtitle a simple information manager
@insertcopying
@end titlepage
-@c So the toc is printed at the start
@contents
@ifnottex
* Installation:: How to install Remember.
* Implementation:: How Remember came into existence.
* Quick Start:: Get started using Remember.
-* Backends:: Backends for saving notes.
* Function Reference:: Interactive functions in remember.el.
-* Copying:: The GNU General Public License gives you
- permission to redistribute Remember on
- certain terms; it also explains that
- there is no warranty.
+* Keystrokes:: Keystrokes bound in Remember Mode.
+* Backends:: Backends for saving notes.
* GNU Free Documentation License:: The license for this documentation.
* Concept Index:: Search for terms.
Backends
* Text File:: Saving to a text file.
+* Diary:: Saving to a Diary file.
* Mailbox:: Saving to a mailbox.
-* Bibliography:: Saving to a bibliography.
-* Planner Page:: Saving to a Planner page.
+* Org:: Saving to an Org Mode file.
@end detailmenu
@end menu
for is really just a way to extend the power of our memory, to be able
to remember what our conscious mind may not currently have access to.
-There are many different databases out there---and good ones---
-which this mode is not trying to replace. Rather, it's how that
-data gets there that's the question. Most of the time, we just
-want to say "Remember so-and-so's phone number, or that I have to
-buy dinner for the cats tonight." That's the FACT. How it's
-stored is really the computer's problem. But at this point in
-time, it's most definitely also the user's problem, and sometimes
-so laboriously so that people just let data slip, rather than
-expend the effort to record it.
+There are many different databases out there---and good ones---which
+this mode is not trying to replace. Rather, it's how that data gets
+there that's the question. Most of the time, we just want to say
+"Remember so-and-so's phone number, or that I have to buy dinner for the
+cats tonight." That's the FACT. How it's stored is really the
+computer's problem. But at this point in time, it's most definitely
+also the user's problem, and sometimes so laboriously so that people
+just let data slip, rather than expend the effort to record it.
``Remember'' is a mode for remembering data. It uses whatever
back-end is appropriate to record and correlate the data, but its main
M-r}), slam in your text however you like, and then hit @kbd{C-c C-c}.
It will file the data away for later retrieval, and possibly indexing.
-Indexing is to data what ``studying'' is in the real world. What you
-do when you study (or lucubrate, for some of us) is to realize certain
+Indexing is to data what ``studying'' is in the real world. What you do
+when you study (or lucubrate, for some of us) is to realize certain
relationships implicit in the data, so that you can make use of those
relationships. Expressing that a certain quote you remembered was a
-religious quote, and that you want the ability to pull up all quotes
-of a religious nature, is what studying does. This is a more labor
-intensive task than the original remembering of the data, and it's
-typical in real life to set aside a special period of time for doing
-this work.
+literary quote, and that you want the ability to pull up all quotes of a
+literary nature, is what studying does. This is a more labor intensive
+task than the original remembering of the data, and it's typical in real
+life to set aside a special period of time for doing this work.
``Remember'' works in the same way. When you enter data, either by
typing it into a buffer, or using the contents of the selected region,
hierarchy. Well, as the future arrives, hopefully experience and user
feedback will help to make this as intuitive a tool as possible.
-@node Quick Start, Backends, Implementation, Top
+@node Quick Start, Function Reference, Implementation, Top
@comment node-name, next, previous, up
@chapter Quick Start
note.
@item
-Type @kbd{C-c C-c} (@code{remember-buffer}) to save the note and close
+Type @kbd{C-c C-c} (@code{remember-finalize}) to save the note and close
the @samp{*Remember*} buffer.
@end itemize
-By default, @code{remember-buffer} saves the note in @file{~/.notes}.
+By default, @code{remember-finalize} saves the note in @file{~/.notes}.
You can edit it now to see the remembered and timestamped note. You
can edit this file however you want. New entries will always be added
to the end.
(define-key global-map (kbd "<f9> R") 'remember-region)
@end lisp
-Check out the Planner package
-(@uref{http://www.emacswiki.org/cgi-bin/wiki/PlannerMode}) for plenty
-of annotation functions you can use with Remember. If you use Planner,
-you can easily publish your remembered notes as HTML and RSS.
-(@pxref{Planner Page})
-
By default, remember uses the first annotation returned by
@code{remember-annotation-functions}. To include all of the annotations,
set @code{remember-run-all-annotation-functions-flag} to non-nil.
(call-interactively 'remember)))
@end lisp
-@node Backends, Function Reference, Quick Start, Top
-@chapter Backends
-
-You can save remembered notes to a variety of backends.
-
-@menu
-* Text File:: Saving to a text file.
-* Mailbox:: Saving to a mailbox.
-* Bibliography:: Saving to a bibliography.
-* Planner Page:: Saving to a Planner page.
-@end menu
-
-@node Text File, Mailbox, Backends, Backends
-@section Saving to a Text File
-@cindex text file
-@cindex outline
-
-This backend comes with Emacs.
-
-@lisp
-(setq remember-handler-functions '(remember-append-to-file))
-@end lisp
-
-@defopt remember-data-file
-@end defopt
-
-@defopt remember-leader-text
-@end defopt
-
-@node Mailbox, Bibliography, Text File, Backends
-@section Saving to a Mailbox
-@cindex mailbox, saving to a
-
-@lisp
-(setq remember-handler-functions '(remember-store-in-mailbox))
-@end lisp
-
-@defopt remember-mailbox
-Name of mailbox to save messages to.
-@end defopt
-
-This backend does not come with Emacs. To get it, download the latest
-version of Remember from @url{http://download.gna.org/remember-el/}.
-
-If you want to use BBDB to associate remembered snippets with entries
-in your contact database, use the following code snippet:
-
-@lisp
-(require 'remember-bbdb)
-(setq remember-handler-functions '(remember-bbdb-store-in-mailbox))
-@end lisp
-
-@node Bibliography, Planner Page, Mailbox, Backends
-@section Saving to a Bibliography
-
-This backend does not come with Emacs. To get it, download the latest
-version of Remember from @url{http://download.gna.org/remember-el/}.
-
-Bibl-mode is a major mode for maintaining bibliography files. You can
-get bibl-mode from:
-@uref{http://ftp.azc.uam.mx/mirrors/gnu/emacs-lisp/bosullivan-packages/bibl-mode/}.
-
-@lisp
-(require 'remember-bibl)
-@end lisp
-
-@defun remember-url
-Remember a URL in @code{bibl-mode} that is being visited with w3.
-@end defun
-
-@defun remember-location
-Remember a bookmark location in `bibl-mode'.
-@end defun
-
-You can use this in addition to your normal remember backend.
-
-@node Planner Page, , Bibliography, Backends
-@comment node-name, next, previous, up
-@section Saving to a Planner Page
-@cindex @file{remember-planner.el}, using
-@cindex remember-el, using with PlannerMode
-
-This backend does not come with Emacs. To get it, download the latest
-version of Remember from @url{http://download.gna.org/remember-el/}.
-
-If you are using PlannerMode, depending on your configuration, notes
-made using remember-el may actually be saved to a project and/or day
-plan page.
-
-@file{remember-planner.el} makes the notes you save with remember have
-more context information associated with them, in the way that
-PlannerMode tasks do.
-
-To use remember-planner, place this in your @file{.emacs}:
-
-@lisp
-(require 'remember-planner)
-(setq remember-handler-functions '(remember-planner-append))
-@end lisp
-
-To take advantage of PlannerMode's annotation functions, add the
-following code as well:
-
-@lisp
-(setq remember-annotation-functions planner-annotation-functions)
-@end lisp
-
-Then, type @kbd{M-x remember} to remember new text, @kbd{M-x
-remember-region} to remember the current region, or @kbd{C-u M-x
-remember} to remember the current region but have an opportunity to
-edit it before it is saved.
-
-@defopt remember-planner-xref-p
-Non-nil means cross-reference new entries with plan pages. Plan pages
-are useful for gathering related information. If you don't want a note
-associated with a plan page, you can press RET to accept the default
-(just today's page) or specify nil at the prompt.
-@end defopt
-
-@defopt remember-planner-copy-on-xref-flag
-Non-nil means copy note text instead of moving it to the plan page. If
-nil, move the note body to the plan page, leaving a cross-reference
-link on the day page. This results in shorter day pages but may be
-harder for people to read.
-@end defopt
-
-@defopt remember-planner-timestamp-format
-Format of timestamp for remember entries.
-@end defopt
-
-@file{remember-planner.el} does not define any interactive functions
-or keybindings.
-
-@node Function Reference, Copying, Backends, Top
+@node Function Reference, Keystrokes, Quick Start, Top
@comment node-name, next, previous, up
@chapter Function Reference
-@subheading Interactive functions
-
@file{remember.el} defines the following interactive functions:
@defun remember initial
for remembering things from Netscape or other X Windows applications.
@end defun
-@defun remember-buffer
+@defun remember-finalize
Remember the contents of the current buffer.
@end defun
the data for latter retrieval, and possible indexing.
@end defun
-@subheading Keystrokes
+@node Keystrokes, Backends, Function Reference, Top
+@comment node-name, next, previous, up
+@chapter Keystroke Reference
@file{remember.el} defines the following keybindings by default:
@table @kbd
-@item C-x C-s (`remember-buffer')
+@item C-c C-c (`remember-finalize')
+Remember the contents of the current buffer.
+
+@item C-c C-k (`remember-destroy')
+Destroy the current *Remember* buffer.
-@item C-c C-c (`remember-buffer')
+@item C-x C-s (`remember-finalize')
+Remember the contents of the current buffer.
@end table
-@node Copying, GNU Free Documentation License, Function Reference, Top
+@node Backends, GNU Free Documentation License, Keystrokes, Top
+@comment node-name, next, previous, up
+@chapter Backends
+
+You can save remembered notes to a variety of backends.
+
+@menu
+* Text File:: Saving to a text file.
+* Diary:: Saving to a Diary file.
+* Mailbox:: Saving to a mailbox.
+* Org:: Saving to an Org Mode file.
+@end menu
+
+@node Text File, Diary, Backends, Backends
+@comment node-name, next, previous, up
+@section Saving to a Text File
+@cindex text file, saving to
+
+@subheading Insinuation
+
+@lisp
+(setq remember-handler-functions '(remember-append-to-file))
+@end lisp
+
+@subheading Options
+
+@defopt remember-data-file
+The file in which to store unprocessed data.
+@end defopt
+
+@defopt remember-leader-text
+The text used to begin each remember item.
+@end defopt
+
+@node Diary, Mailbox, Text File, Backends
+@comment node-name, next, previous, up
+@section Saving to a Diary file
+@cindex diary, integration
+
+@subheading Insinuation
+
+@lisp
+(add-to-list 'remember-handler-functions 'remember-diary-extract-entries)
+@end lisp
+
+@subheading Options
+
+@defopt remember-diary-file
+File for extracted diary entries.
+If this is nil, then @code{diary-file} will be used instead."
+@end defopt
+
+@node Mailbox, Org, Diary, Backends
@comment node-name, next, previous, up
-@appendix GNU GENERAL PUBLIC LICENSE
-@include gpl.texi
+@section Saving to a Mailbox
+@cindex mailbox, saving to
-@node GNU Free Documentation License, Concept Index, Copying, Top
+@subheading Insinuation
+
+@lisp
+(add-to-list 'remember-handler-functions 'remember-store-in-mailbox)
+@end lisp
+
+@subheading Options
+
+@defopt remember-mailbox
+The file in which to store remember data as mail.
+@end defopt
+
+@defopt remember-default-priority
+The default priority for remembered mail messages.
+@end defopt
+
+@node Org, , Mailbox, Backends
+@comment node-name, next, previous, up
+@section Saving to an Org Mode file
+@cindex org mode, integration
+
+For instructions on how to integrate Remember with Org Mode,
+consult @ref{Remember, , , org}.
+
+@node GNU Free Documentation License, Concept Index, Backends, Top
@appendix GNU Free Documentation License
@include doclicense.texi
@printindex cp
@bye
+
+@ignore
+ arch-tag: 5b980db0-20cc-4167-b845-52dc11d53b9f
+@end ignore
HCoop / bpt / emacs.git / blobdiff