Function: org-batch-agenda

org-batch-agenda is an autoloaded macro defined in org-agenda.el.gz.

Signature

(org-batch-agenda CMD-KEY &rest PARAMETERS)

Documentation

Run an agenda command in batch mode and send the result to STDOUT.

If CMD-KEY is a string of length 1, it is used as a key in org-agenda-custom-commands and triggers this command. If it is a longer string it is used as a tags/todo match string. Parameters are alternating variable names and values that will be bound before running the agenda command.

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-agenda.el.gz
;;;###autoload
(defmacro org-batch-agenda (cmd-key &rest parameters)
  "Run an agenda command in batch mode and send the result to STDOUT.
If CMD-KEY is a string of length 1, it is used as a key in
`org-agenda-custom-commands' and triggers this command.  If it is a
longer string it is used as a tags/todo match string.
Parameters are alternating variable names and values that will be bound
before running the agenda command."
  (pcase-let ((`(,vars . ,exps) (org-agenda--split-plist parameters)))
    `(org--batch-agenda ,cmd-key ',vars (list ,@exps))))