annotate etc/gnus-tut.txt @ 94414:d86cb59eea9f

2008-04-27 Carsten Dominik <[e-mail]> * org/org.el (org-html-level-start): Always have id's in HTML (org-export-as-html): Use `org-link-protocols' to retrieve the export form of the link. (org-add-link-type): Final parameter renamed from PUBLISH. Better documentation of how it is to be used. Avoid double entries for the same link type. (org-add-link-props): New function. (org-modules-loaded): New variable. (org-load-modules-maybe, org-set-modules): New function. (org-modules): New option. (org-mode, org-cycle, orgstruct-mode, org-run-like-in-org-mode) (orgtbl-mode, org-store-link, org-insert-link-global) (org-open-at-point): Call `org-load-modules-maybe'. (org-search-view): Add more text properties. (org-agenda-schedule, org-agenda-deadline): Allow also in search-type agendas. (org-search-view): Order of arguments has been changed. Interpret prefix-arg as TODO-ONLY. (org-agenda, org-run-agenda-series, org-agenda-manipulate-query): Take new argument order of `org-search-view' into account. (org-todo-only): New variable. (org-search-syntax-table): New variable and function. (org-search-view): Do the search with the special syntax table. (define-obsolete-function-alias): Make work with XEmacs. (org-add-planning-info): Use old date as default when modifying an existing deadline or scheduled item. (org-agenda-compute-time-span): Make argument N optional. (org-agenda-format-date-aligned): Require `cal-iso'. (org-agenda-list): Include week into into agenda heading, don't list it at each date (only on Mondays). (org-read-date-analyze): Define local variable `iso-date'. (org-agenda-format-date-aligned): Remove dependency on `calendar-time-from-absolute'. (org-remember-apply-template, org-go-to-remember-target): Interpret filenames relative to `org-directory'. (org-complete): Silently fail when trying to complete keywords that don't have a default value. (org-get-current-options): Added a #+DATE: option. (org-additional-option-like-keywords): Removed "DATE:" from the list of additional keywords. (org-export-as-html): Removed (current-time) as unnecessary second argument of `format-time-string'. (org-clock-find-position): Handle special case at end of buffer. (org-agenda-day-view): New argument DAY-OF-YEAR, pass it on to `org-agenda-change-time-span'. (org-agenda-week-view): New argument ISO-WEEK, pass it on to `org-agenda-change-time-span'. (org-agenda-month-view): New argument MONTH, pass it on to `org-agenda-change-time-span'. (org-agenda-year-view): New argument YEAR, pass it on to `org-agenda-change-time-span'. (org-agenda-change-time-span): New optional argument N, pass it on to `org-agenda-compute-time-span'. (org-agenda-compute-time-span): New argument N, interpret it by changing the starting day. (org-small-year-to-year): New function. (org-scheduled-past-days): Respect `org-scheduled-past-days'. (org-auto-repeat-maybe): Make sure that repeating dates are pushed into the future, and that the shift is at least one interval, never 0. (org-update-checkbox-count): Fix bug with checkbox counting. (org-add-note): New command. (org-add-log-setup): Renamed from `org-add-log-maybe'. (org-log-note-headings): New entry for plain notes (i.e. notes not related to state changes or clocking). (org-get-org-file): Check for availability of `remember-data-file'. (org-cached-entry-get): Allow a regexp value for `org-use-property-inheritance'. (org-use-property-inheritance): Allow regexp value. Fix bug in customization type. (org-use-tag-inheritance): Allow a list and a regexp value for this variable. (org-scan-tags, org-get-tags-at): Implement selective tag inheritance. (org-entry-get): Respect value `selective' for the INHERIT argument. (org-tag-inherit-p, org-property-inherit-p): New functions. (org-agenda-format-date-aligned): Allow 10 characters for weekday, to acomodate German locale. (org-add-archive-files): New function. (org-agenda-files): New argument `ext', to get archive files as well. (org-tbl-menu): Protect the use of variables that are only available when org-table.el gets loaded. (org-read-agenda-file-list): Error if `org-agenda-files' is a single directory. (org-open-file): Allow a batch process to trigger waiting after executing a system command. (org-store-link): Link to headline when there is not target and no region in an org-mode buffer when creating a link. (org-link-types-re): New variable. (org-make-link-regexps): Compute `org-link-types-re'. (org-make-link-description-function): New option. (org-agenda-date, org-agenda-date-weekend): New faces. (org-archive-sibling-heading): New option. (org-archive-to-archive-sibling): New function. (org-iswitchb): New command. (org-buffer-list): New function. (org-agenda-columns): Also try the #+COLUMNS line in the buffer associated with the entry at point (or with the first entry in the agenda view). (org-modules): Add entry for org-bibtex.el. (org-completion-fallback-command): Moved into `org-completion' group. (org-clock-heading-function): Moved to `org-progress' group. (org-auto-repeat-maybe): Make sure that a note can be enforces if `org-log-repeat' is `note'. (org-modules): Allow additional symbols for external packages. (org-ctrl-c-ctrl-c): Allow for `org-clock-overlays' to be undefined. (org-clock-goto): Hide drawers after showing an entry with `org-clock-goto.' (org-shiftup, org-shiftdown, org-shiftright, org-shiftleft): Try also a clocktable block shift. (org-clocktable-try-shift): New function. (org-columns-hscoll-title): New function. (org-columns-previous-hscroll): New variable. (org-columns-full-header-line-format): New variable. (org-columns-display-here-title, org-columns-remove-overlays): Install `org-columns-hscoll-title' in post-command-hook. * org/org.el: Split into many small files. * org/org-agenda.el: New file, split off from org.el. * org/org-archive.el: New file, split off from org.el. * org/org-bbdb.el: New file. * org/org-bibtex.el: New file, split off from org.el. * org/org-clock.el: New file, split off from org.el. * org/org-colview.el: New file, split off from org.el. * org/org-compat.el: New file, split off from org.el. * org/org-exp.el: New file, split off from org.el. * org/org-faces.el: New file, split off from org.el. * org/org-gnus.el: New file, split off from org.el. * org/org-info.el: New file, split off from org.el. * org/org-infojs.el: New file. * org/org-irc.el: New file. * org/org-macs.el: New file, split off from org.el. * org/org-mew.el: New file. * org/org-mhe.el: New file, split off from org.el. * org/org-publish.el: New file, split off from org.el. * org/org-remember.el: New file, split off from org.el. * org/org-rmail.el: New file, split off from org.el. * org/org-table.el: New file, split off from org.el. * org/org-vm.el: New file, split off from org.el. * org/org-wl.el: New file, split off from org.el. 2008-04-27 Jason Riedy <[e-mail]> * lisp/org-table.el (orgtbl-to-generic): Add a :remove-nil-lines parameter that supresses lines that evaluate to NIL. (orgtbl-get-fmt): New inline function for picking apart formats that may be lists. (orgtbl-apply-fmt): New inline function for applying formats that may be functions. (orgtbl-eval-str): New inline function for strings that may be functions. (orgtbl-format-line, orgtbl-to-generic): Use and document. (orgtbl-to-latex, orgtbl-to-texinfo): Document. (*orgtbl-llfmt*, *orgtbl-llstart*) (*orgtbl-llend*): Dynamic variables for last-line formatting. (orgtbl-format-section): Shift formatting to support detecting the last line and formatting it specially. (orgtbl-to-generic): Document :ll* formats. Set to the non-ll formats unless overridden. (orgtbl-to-latex): Suggest using :llend to suppress the final \\. (*orgtbl-table*, *orgtbl-rtn*): Dynamically bound variables to hold the input collection of lines and output formatted text. (*orgtbl-hline*, *orgtbl-sep*, *orgtbl-fmt*, *orgtbl-efmt*, (*orgtbl-lfmt*, *orgtbl-lstart*, *orgtbl-lend*): Dynamically bound format parameters. (orgtbl-format-line): New function encapsulating formatting for a single line. (orgtbl-format-section): Similar for each section. Rebinding the dynamic vars customizes the formatting for each section. (orgtbl-to-generic): Use orgtbl-format-line and orgtbl-format-section. (org-get-param): Now unused, so delete. (orgtbl-gather-send-defs): New function to gather all the SEND definitions before a table. (orgtbl-send-replace-tbl): New function to find the RECEIVE corresponding to the current name. (orgtbl-send-table): Use the previous two functions and implement multiple destinations for each table. * doc/org.texi (A LaTeX example): Note that fmt may be a one-argument function, and efmt may be a two-argument function. (Radio tables): Document multiple destinations. 2008-04-27 Carsten Dominik <[e-mail]> * org/org-agenda.el (org-add-to-diary-list): New function. (org-prefix-has-effort): New variable. (org-sort-agenda-noeffort-is-high): New option. (org-agenda-columns-show-summaries) (org-agenda-columns-compute-summary-properties): New options. (org-format-agenda-item): Compute the duration of the item. (org-agenda-weekend-days): New variable. (org-agenda-list, org-timeline): Use the proper faces for dates in the agenda and timeline buffers. (org-agenda-archive-to-archive-sibling): New command. (org-agenda-start-with-clockreport-mode): New option. (org-agenda-clockreport-parameter-plist): New option. (org-agenda-clocktable-mode): New variable. (org-agenda-deadline-leaders): Allow a function value for the deadline leader. (org-agenda-get-deadlines): Deal with new function value. * lisp/org-clock.el (org-clock): New customization group. (org-clock-into-drawer, org-clock-out-when-done) (org-clock-in-switch-to-state, org-clock-heading-function): Moved into the new group. (org-clock-out-remove-zero-time-clocks): New option. (org-clock-out): Use `org-clock-out-remove-zero-time-clocks'. (org-dblock-write:clocktable): Allow a Lisp form for the scope parameter. (org-dblock-write:clocktable): Fixed bug with total time calculation. (org-dblock-write:clocktable): Request the unrestricted list of files. (org-get-clocktable): New function. (org-dblock-write:clocktable): Make sure :tstart and :tend can not only be strings but also integers (an absolute day number) and lists (m d y). * org/org-colview.el (org-columns-next-allowed-value) (org-columns-edit-value): Limit the effort for updatig in the agenda to recomputing a single file. (org-columns-compute): Only write property value if it has changed. This avoids raising the buffer-change-flag unnecessarily. (org-agenda-colview-summarize) (org-agenda-colview-compute): New functions. (org-agenda-columns): Call `org-agenda-colview-summarize'. * org/org-exp.el (org-export-run-in-background): New option. (org-export-icalendar): Allow a batch process to trigger waiting after executing a system command. (org-export-preprocess-string): Renamed-from `org-cleaned-string-for-export'. (org-export-html-style): Made target class look like normal text. (org-export-as-html): Make use of the better proprocessing in `org-cleaned-string-for-export'. (org-cleaned-string-for-export): Better treatment of heuristic targets, many more internal links will now work in HTML export. (org-get-current-options): Incorporate LINK_UP, LINK_HOME, and INFOJS. (org-export-inbuffer-options-extra): New variable. (org-export-options-filters): New hook. (org-infile-export-plist): Find also the settings keywords in `org-export-inbuffer-options-extra'. (org-infile-export-plist): Allow multiple #+OPTIONS lines and multiple #+INFOJS_OPT lines. (org-export-html-handle-js-options): New function. (org-export-html-infojs-setup): New option. (org-export-as-html): Call `org-export-html-handle-js-options'. Add autoload to all entry points. (org-skip-comments): Function removed. * org/org-table.el (org-table-make-reference): Extra parenthesis around single fields, to make sure that algebraic formulas get correctly interpreted by calc. (org-table-current-column): No longer interactive. * org/org-export-latex.el (org-export-latex-preprocess): Renamed from `org-export-latex-cleaned-string'. 2008-04-27 Bastien Guerry <[e-mail]> * org/org-publish.el (org-publish-get-base-files-1): New function. (org-publish-get-base-files): Use it. (org-publish-temp-files): New variable. Don't require 'dired-aux anymore. (org-publish-initial-buffer): New variable. (org-publish-org-to, org-publish): Use it. (org-publish-get-base-files-1): Bug fix: get the proper list of files when recursing thru a directory. (org-publish-get-base-files): Use the :exclude property to skip both files and directories.

From lars Thu Feb 23 23:20:38 1995
From: [e-mail] (ding)
Date: Fri Feb 24 13:40:45 1995
Subject: So you want to use the new Gnus
Message-ID: <[e-mail]>

Actually, since you are reading this, chances are you are already
using the new Gnus.  Congratulations.

This entire newsgroup you are reading is, in fact, no real newsgroup
at all, in the traditional sense.  It is an example of one of the
"foreign" select methods that Gnus may use.

The text you are now reading is stored in the "etc" directory with the
rest of the Emacs sources.  You are using the "nndoc" backend for
accessing it.  Scary, isn't it?

This isn't the real documentation.  `M-x info', `m gnus <RET>' to read
that.  This "newsgroup" is intended as a kinder, gentler way of getting
people started.

Gnus is a rewrite of GNUS 4.1, written by Masanobu Umeda.  The rewrite
was done by moi, yours truly, your humble servant, Lars Magne
Ingebrigtsen.  If you have a WWW browser, you can investigate to your
heart's delight at <URL:http://www.ifi.uio.no/~larsi/larsi.html>.

;; Copyright (C) 1995, 2001, 2002, 2003, 2004, 2005,
;;   2006, 2007, 2008  Free Software Foundation, Inc.

;; Author: Lars Magne Ingebrigtsen <[e-mail]>
;; Keywords: news

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

From lars Thu Feb 23 23:20:38 1995
From: [e-mail] (ding)
Date: Fri Feb 24 13:40:45 1995
Subject: Starting up
Message-ID: <[e-mail]>

If you are having problems with Gnus not finding your server, you have
to set `gnus-select-method'.  A "method" is a way of specifying *how*
the news is to be found, and from *where*.

Say you want to read news from you local, friendly nntp server
"news.my.local.server".

(setq gnus-select-method '(nntp "news.my.local.server"))

Quite easy, huh?

From the news spool:

(setq gnus-select-method '(nnspool ""))

From your mh-e spool:

(setq gnus-select-method '(nnmh ""))

There's a whole bunch of other methods for reading mail and news, see
the "Foreign groups" article for that.


From lars Thu Feb 23 23:20:38 1995
From: [e-mail] (ding)
Date: Fri Feb 24 13:40:45 1995
Subject: Where are all the groups, then?
Message-ID: <[e-mail]>

If this is the first time you have used a newsreader, you won't have a
.newsrc file.  This means that Gnus will think that all the newsgroups
on the server are "new", and kill them all.

If you have a .newsrc file, the new groups will be processed with the
function in the `gnus-subscribe-newsgroup-method' variable, which is
`gnus-subscribe-zombies' by default.

This means that all the groups have been made into "zombies" - not
quite dead, but not exactly alive, either.

Jump back to the *Group* buffer, and type `A z' to list all the zombie
groups.  Look though the list, and subscribe to the groups you want to
read by pressing `u' on the one you think look interesting.

If all the groups have been killed, type `A k' to list all the killed
groups.  Subscribe to them the same way.

When you are satisfied, press `S z' to kill all the zombie groups.

Now you should have a nice list of all groups you are interested in.

(If you later want to subscribe to more groups, press `A k' to
list all the kill groups, and repeat.  You can also type `U' and be
prompted for groups to subscribe to.)


From lars Thu Feb 23 23:20:38 1995
From: [e-mail] (ding)
Date: Fri Feb 24 13:40:45 1995
Subject: I want to read my mail!
Message-ID: <[e-mail]>

Yes, Virginia, you can read mail with Gnus.

First you have to decide which mail backend you want to use.  You have
nnml, which is a one-file-one-mail backend, which is quite nice, but
apt to make your systems administrator go crazy and come after you
with a shotgun.

nnmbox uses a Unix mail box to store mail.  Nice, but slow.

nnmh uses mh-e folders, which is also a one-file-one-mail thingie, but
slower than nnml.  (It doesn't support NOV files.)

So if you want to go with nnmbox, you can simply say:

(setq gnus-secondary-select-methods '((nnmbox "")))

(The same for the other methods, kind of.)

You should also set `nnmail-split-methods' to something sensible:

(setq nnmail-split-methods
      '(("mail.junk" "From:.*Lars")
	("mail.misc "")))

This will put all mail from me in you junk mail group, and the rest in
"mail.misc".

These groups will be subscribe the same way as the normal groups, so
you will probably find them among the zombie groups after you set
these variables and re-start Gnus.


From lars Thu Feb 23 23:20:38 1995
From: [e-mail] (ding)
Date: Fri Feb 24 13:40:45 1995
Subject: Foreign newsgroups
Message-ID: <[e-mail]>

These are groups that do not come from `gnus-select-method'.

Say you want to read "alt.furniture.couches" from "news.funet.fi".  You
can then either type `B news.funet.fi <RET>' to browse that server and
subscribe to that group, or you can type
`G m alt.furniture.couches<RET>nntp<RET>news.funet.fi<RET>', if you
like to type a lot.

If you want to read a directory as a newsgroup, you can create an
nndir group, much the same way.  There's a shorthand for that,
though.  If, for instance, you want to read the (ding) list archives,
you could type `G d /ftp <RET>'.

There's lots more to know about foreign groups, but you have to read
the info pages to find out more.


From lars Thu Feb 23 23:20:38 1995
From: [e-mail] (ding)
Date: Fri Feb 24 13:40:45 1995
Subject: Low level changes in GNUS, or, Wrong type argument: stringp, nil
Message-ID: <[e-mail]>

Gnus really isn't GNUS, even though it looks like it.  If you scrape
the surface, you'll find that most things have changed.

This means that old code that relies on GNUS internals will fail.

In particular, `gnus-newsrc-hashtb', `gnus-newsrc-assoc',
`gnus-killed-list', the `nntp-header-' macros and the display formats
have all changed.  If you have some code lying around that depend on
these, or change these, you'll have to re-write your code.

Old hilit19 code does not work at all.  In fact, you should probably
remove all hilit code from all the Gnus hooks
(`gnus-group-prepare-hook', `gnus-summary-prepare-hook' and
`gnus-summary-article-hook').  (Well, at the very least the first
two.)  Gnus provides various integrated functions for highlighting,
which are both faster and more accurated.

There is absolutely no chance, whatsoever, of getting Gnus to work
with Emacs 18.  It won't even work on Emacsen older than Emacs
19.30/XEmacs 19.13.  Upgrade your Emacs or die.


From lars Thu Feb 23 23:20:38 1995
From: [e-mail] (ding)
Date: Fri Feb 24 13:40:45 1995
Subject: How do I re-scan my mail groups?
Message-ID: <[e-mail]>

Reading the active file from the nntp server is a drag.

Just press `M-g' on the mail groups, and they will be re-scanned.

You can also re-scan all the mail groups by putting them on level 1
(`S l 1'), and saying `1 g' to re-scan all level 1 groups.


From lars Thu Feb 23 23:20:38 1995
From: [e-mail] (ding)
Date: Fri Feb 24 13:40:45 1995
Subject: How do I set up virtual newsgroups?
Message-ID: <[e-mail]>

Virtual newsgroups are collections of other newsgroups.  Why people
want this is beyond me, but here goes:

Create the group by saying

`G m my.virtual.newsgroup<RET>nnvirtual<RET>^rec\.aquaria\.*<RET>'

This will create the group "nnvirtual:my.virtual.newsgroup", which
will collect all articles from all the groups in the "rec.aquaria"
hierarchy.

If you want to edit the regular expression, just type `M-e' on the
group line.

Note that all the groups that are part of the virtual group have to be
alive.  This means that the cannot, absolutely not, be zombie or
killed.  They can be unsubscribed; that's no problem.

You can combine groups from different servers in the same virtual
newsgroup, something that may actually be useful.  Say you have the
group "comp.headers" on the server "news.server.no" and the same group
on "news.server.edu".  If people have posted articles with Distribution
headers that stop propagation of their articles, combining these two
newsgroups into one virtual newsgroup should give you a better view of
what's going on.

One caveat, though: The virtual group article numbers from the first
source group (group A) will always be lower than the article numbers
from the second (group B).  This means that Gnus will believe that
articles from group A are older than articles from group B.  Threading
will lessen these problems, but it might be a good idea to sort the
threads over the date of the articles to get a correct feel for the
flow of the groups:

(setq gnus-thread-sort-functions '(gnus-thread-sort-by-date))

If you only want this in virtual groups, you could say something along
the lines of:

(setq gnus-select-group-hook
      (lambda ()
  	(if (eq 'nnvirtual (car (gnus-find-method-for-group
	                          gnus-newsgroup-name)))
	    (progn
	      (make-local-variable 'gnus-thread-sort-functions)
	      (setq gnus-thread-sort-functions '(gnus-thread-sort-by-date))))))


From lars Thu Feb 23 23:20:38 1995
From: [e-mail] (ding)
Date: Fri Feb 24 13:40:45 1995
Subject: Bugs & stuff
Message-ID: <[e-mail]>

If you want to report a bug, please type `M-x gnus-bug'.  This will
give me a precise overview of your Gnus and Emacs version numbers,
along with a look at all Gnus variables you have changed.

Du not expect a reply back, but your bug should be fixed in the next
version.  If the bug persists, please re-submit your bug report.

When a bug occurs, I need a recipe for how to trigger the bug.  You
have to tell me exactly what you do to uncover the bug, and you should
(setq debug-on-error t) and send me the backtrace along with the bug
report.

If I am not able to reproduce the bug, I won't be able to fix it.

I would, of course, prefer that you locate the bug, fix it, and mail
me the patches, but one can't have everything.

If you have any questions on usage, the "[e-mail]" mailing list
is where to post the questions.