Function: org-agenda-archives-mode

org-agenda-archives-mode is an interactive and byte-compiled function defined in org-agenda.el.gz.

Signature

(org-agenda-archives-mode &optional WITH-FILES)

Documentation

Toggle inclusion of items in trees marked with :ARCHIVE:.

When called with a prefix argument, include all archive files as well.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-agenda.el.gz
(defun org-agenda-archives-mode (&optional with-files)
  "Toggle inclusion of items in trees marked with :ARCHIVE:.
When called with a prefix argument, include all archive files as well."
  (interactive "P")
  (setq org-agenda-archives-mode
	(cond ((and with-files (eq org-agenda-archives-mode t)) nil)
	      (with-files t)
	      (org-agenda-archives-mode nil)
	      (t 'trees)))
  (org-agenda-set-mode-name)
  (org-agenda-redo)
  (message
   "%s"
   (cond
    ((eq org-agenda-archives-mode nil)
     "No archives are included")
    ((eq org-agenda-archives-mode 'trees)
     (format "Trees with :%s: tag are included" org-archive-tag))
    ((eq org-agenda-archives-mode t)
     (format "Trees with :%s: tag and all active archive files are included"
	     org-archive-tag)))))