Variable: org-agenda-window-setup

org-agenda-window-setup is a customizable variable defined in org-agenda.el.gz.

Value

reorganize-frame

Documentation

How the agenda buffer should be displayed.

Possible values for this option are:

current-window Show agenda in the current window, keeping all other windows.
other-window Use switch-to-buffer-other-window to display agenda.
only-window Show agenda, deleting all other windows.
reorganize-frame Show only two windows on the current frame, the current
                  window and the agenda.
other-frame Use switch-to-buffer-other-frame to display agenda.
                  Also, when exiting the agenda, kill that frame.
other-tab Use switch-to-buffer-other-tab to display the
                  agenda, making use of the tab-bar-mode(var)/tab-bar-mode(fun) introduced
                  in Emacs version 27.1. Also, kill that tab when
                  exiting the agenda view.

See also the variable org-agenda-restore-windows-after-quit.

This variable was added, or its default value changed, in Org version
9.4.

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-agenda.el.gz
(defcustom org-agenda-window-setup 'reorganize-frame
  "How the agenda buffer should be displayed.
Possible values for this option are:

current-window    Show agenda in the current window, keeping all other windows.
other-window      Use `switch-to-buffer-other-window' to display agenda.
only-window       Show agenda, deleting all other windows.
reorganize-frame  Show only two windows on the current frame, the current
                  window and the agenda.
other-frame       Use `switch-to-buffer-other-frame' to display agenda.
                  Also, when exiting the agenda, kill that frame.
other-tab         Use `switch-to-buffer-other-tab' to display the
                  agenda, making use of the `tab-bar-mode' introduced
                  in Emacs version 27.1.  Also, kill that tab when
                  exiting the agenda view.

See also the variable `org-agenda-restore-windows-after-quit'."
  :group 'org-agenda-windows
  :type '(choice
	  (const current-window)
	  (const other-frame)
	  (const other-tab)
	  (const other-window)
	  (const only-window)
	  (const reorganize-frame))
  :package-version '(Org . "9.4"))