Org API

Dispatch agenda commands to collect entries to the agenda buffer. Prompts for a command to execute. Any prefix arg will be passed on to the selected command. The default selections are:

a Call org-agenda-list to display the agenda for current day or week. t Call org-todo-list to display the global todo list. T Call org-todo-list to display the global todo list, select only entries with a specific TODO keyword (the user gets a prompt). m Call org-tags-view to display headlines with tags matching a condition (the user is prompted for the condition). M Like m, but select only TODO entries, no ordinary headlines. L Create a timeline for the current buffer. e Export views to associated files. s Search entries for keywords. / Multi occur across all agenda files and also files listed in org-agenda-text-search-extra-files. < Restrict agenda commands to buffer, subtree, or region. Press several times to get the desired effect. > Remove a previous restriction. ! Configure what "stuck" means. C Configure custom agenda commands.

More commands can be added by configuring the variable org-agenda-custom-commands. In particular, specific tags and TODO keyword searches can be pre-defined in this way.

If the current buffer is in Org-mode and visiting a file, you can also first press < once to indicate that the agenda should be temporarily (until the next use of C-c a) restricted to the current file. Pressing < twice means to restrict to the current subtree or region (if active).

Exit agenda by removing the window or the buffer

Select entry for agenda action, or execute an agenda action. This command prompts for another letter. Valid inputs are:

m Mark the entry at point for an agenda action s Schedule the marked entry to the date at the cursor d Set the deadline of the marked entry to the date at the cursor r Call org-remember with cursor date as the default date c Call org-capture with cursor date as the default date SPC Show marked entry in other window TAB Visit marked entry in other window

The cursor may be at a date in the calendar, or in the Org agenda.

Add entry text to agenda lines. This will add a maximum of org-agenda-add-entry-text-maxlines lines of the entry text following headings shown in the agenda. Drawers will be excluded, also the line with scheduling/deadline info.

Add a diary entry with type to org-agenda-diary-file. If text is not empty, it will become the headline of the new entry, and the resulting entry will not be shown. When text is empty, switch to org-agenda-diary-file and let the user finish the entry there.

Add a time-stamped note to the entry at point.

Align all tags in agenda items to org-agenda-tags-column.

Append another agenda view to the current one. This function allows interactive building of block agendas. Agenda views are separated by org-agenda-block-separator.

Archive the entry or subtree belonging to the current agenda entry.

Archive the entry or subtree belonging to the current agenda entry.

Archive the entry or subtree belonging to the current agenda entry.

Move the entry to the archive sibling.

Move the entry to the archive sibling.

Toggle inclusion of items in trees marked with :ARCHIVE:. When called with a prefix argument, include all archive files as well.

Execute an remote-editing action on all marked entries. The prefix arg is passed through to the command if possible.

Mark the entry at point for future bulk action.

Mark all entries for future agenda bulk action.

Mark entries matching regexp for future agenda bulk action.

Remove the mark overlays between beg and end in the agenda buffer. beg and end default to the buffer limits.

This only removes the overlays, it does not remove the markers from the list in org-agenda-bulk-marked-entries.

Toggle marking the entry at point for bulk action.

Unmark the entry at point for future bulk action.

Remove all marks in the agenda buffer. This will remove the markers and the overlays.

Change all lines in the agenda buffer which match hdmarker. The new content of the line will be newhead (as modified by org-agenda-format-item). hdmarker is checked with equal against all org-hd-marker text properties in the file. If fixface is non-nil, the face of each item is modified according to the new TODO state. If just-this is non-nil, change just the current line, not all. If FORCE-TAGS is non nil, the car of it returns the new tags.

Change the agenda view to span. span may be day, week, month, year.

Check if gap t1 -> t2 contains one of the ok-list time-of-day values.

Do we have a reason to ignore this TODO entry because it has a time stamp?

Check if the entry is a diary link and abort if yes.

Check if agenda buffer is of allowed type. If error is non-nil, throw an error, otherwise just return nil.

Remove unwanted stuff in buffer created by fancy-diary-display. This gets rid of the date, the underline under the date, and the dummy entry installed by org-mode to ensure non-empty diary for each date. It also removes lines that contain only whitespace.

Cancel the currently running clock.

Jump to the currently clocked in task within the agenda. If the currently clocked in task is not listed in the agenda buffer, display it in another window.

Start the clock on the currently selected item.

Stop the currently running clock.

Toggle clocktable mode in an agenda buffer. With prefix arg with-filter, make the clocktable respect the current agenda filter.

Collect the markers pointing to entries in the agenda buffer.

Turn on or update column view in the agenda.

Compute the relevant columns in the contributing source buffers.

Summarize the summarizable columns in column view in the agenda. This will add overlays to the date lines, to show the summary for each day.

Compare the effort of the current line with value, using op. If the line does not have an effort defined, return nil.

Compute starting date for agenda. span may be day, week, month, year. The return value is a cons cell with the starting date and the number of days, so that the date sd will be in that range.

Get a variable from a referenced buffer and install it here.

Show the current entry in another window, with default settings. Default settings are taken from org-show-hierarchy-above and siblings. When use repeatedly in immediate succession, the remote entry will cycle through visibility

children -> subtree -> folded

When called with a numeric prefix arg, that arg will be passed through to org-agenda-show-1. For the interpretation of that argument, see the docstring of org-agenda-show-1.

Change the date of this item to arg day(s) earlier.

Change the time of this item, in hour steps.

Change the time of this item, in units of org-time-stamp-rounding-minutes.

Change the date of this item to arg day(s) later.

Change the time of this item, in hour steps.

Change the time of this item, in units of org-time-stamp-rounding-minutes.

Change the date of this item. Date is prompted for, with default today. The prefix arg is passed to the org-time-stamp command and can therefore be used to request time specification in the time stamp.

Switch to daily view for agenda. With argument day-of-year, switch to that day of the year.

Schedule the item at point. arg is passed through to org-deadline.

Return the face to displaying a deadline item. fraction is what fraction of the head-warning time has passed.

Make a diary entry, like the i command from the calendar. All the standard commands work: block, weekly etc. When org-agenda-diary-file points to a file, org-agenda-diary-entry-in-org-file is called instead to create entries in that Org-mode file.

Make a diary entry in the file org-agenda-diary-file.

Dim currently blocked TODO's in the agenda display.

Evaluate form at the entry pointed to by org-agenda-action-marker.

Show outline path and, maybe, follow mode window.

Same as org-agenda-tree-to-indirect-buffer without saving window.

Go backward in time by the current span. With prefix arg, go backward that many times the current span.

Remove any shown entry context.

Toggle entry text mode in an agenda buffer.

Add entry context for all agenda lines.

Add some text from the entry as context to the current line.

Execute another agenda command, keeping same window. So this is just a shortcut for C-c C-a, available in the agenda.

Execute a calendar command from the agenda, with the date associated to the cursor position.

Exit agenda by removing the window or the buffer. Also kill all Org-mode buffers which have been loaded by org-agenda. Org-mode buffers visited directly by the user will not be touched.

Return non-nil, if file is an agenda file. If file is omitted, use the file associated with the current buffer.

Move/add the current file to the top of the agenda file list. If the file is not present in the list, it is added to the front. If it is present, it is moved there. With optional argument to-end, add/move to the end of the list.

Get the list of agenda files. Optional unrestricted means return the full list even if a restriction is currently in place. When archives is t, include all archive files that are really being used by the agenda files. If ARCHIVE is ifmode, do this only if org-agenda-archives-mode is t.

Set filter as the new agenda filter and apply it.

Keep only those lines in the agenda buffer that have a specific category. The category is that of the current line.

Keep only those lines in the agenda buffer that have a specific tag. The tag is selected with its fast selection letter, as configured. With prefix argument strip, remove all lines that do have the tag. A lisp caller can specify char. narrow means that the new tag should be used to narrow the search - the interactive user can also press - or + to switch to narrowing.

Refine the current filter. See org-agenda-filter-by-tag.

Keep only those lines in the agenda buffer that have a specific category. The category is that of the current line.

Return the form to compare the effort of the current line with what e says. e looks like "+<2:25".

Create the form that tests a line for agenda filter.

Set FILTER as the new agenda filter and apply it.

Remove tags string from txt, and add a modified list of tags. The modified list may contain inherited tags, and tags matched by org-agenda-hide-tags-regexp will be removed.

Toggle follow mode in an agenda buffer.

Make highest priority lines bold, and lowest italic.

Format a date string for display in the daily/weekly agenda, or timeline. This function makes sure that dates are aligned for easy reading.

Format txt to be inserted into the agenda buffer. In particular, it adds the prefix and corresponding text properties. extra must be a string and replaces the %s specifier in the prefix format. category (string, symbol or nil) may be used to overrule the default category taken from local variable or file name. It will replace the %c specifier in the format. dotime, when non-nil, indicates that a time-of-day should be extracted from txt for sorting of this entry, and for the %t specifier in the format. When dotime is a string, this string is searched for a time before txt is. tags can be the tags of the headline. Any match of remove-re will be removed from txt.

Return the date-range information for agenda display.

Return an image for category according to org-agenda-category-icon-alist.

Does the work for org-diary and org-agenda. file is the path to a file to be checked for entries. date is date like the one returned by calendar-current-date. args are symbols indicating which kind of entries should be extracted. For details about these, see the documentation of org-diary.

Return the face date should be displayed with.

Return the deadline information for agenda display.

Return the logged TODO entries for agenda display.

Get a list of all tags currently represented in the agenda.

The user interface for selecting an agenda command.

Return the scheduled information for agenda display.

Return the sexp information for agenda display.

Extract entry text from marker, at most n-lines lines. This will ignore drawers etc, just get the text. If indent is given, prefix every line with this string. If keep is given, it is a list of symbols, defining stuff that should not be removed from the entry content. Currently only planning is allowed here.

Return the date stamp information for agenda display.

Return the TODO information for agenda display.

Go to the Org-mode file which contains the item at point.

Open the Emacs calendar with the date at the cursor.

Jump to date in agenda.

Go to the Org-mode file which contains the item at the mouse click.

Go to today.

Display the holidays for the 3 months around the cursor date.

Make new entry as a top-level entry at the end of the file. Add text as headline, and position the cursor in the second line so that a timestamp can be added there.

Make new entry as last child of current entry. Add text as headline, and position the cursor in the second line so that a timestamp can be added there.

Kill the entry or subtree belonging to the current agenda entry.

Kill all buffers in org-agena-mode. This is used when toggling sticky agendas. You can also explicitly invoke it with C-c a C-k.

Go forward in time by thee current span. With prefix arg, go forward that many times the current span.

Produce a daily/weekly view from all files in variable org-agenda-files. The view will be for the current day or week, but from the overview buffer you will be able to go to other days/weeks.

With a numeric prefix argument in an interactive call, the agenda will span arg days. Lisp programs should instead specify span to change the number of days. span defaults to org-agenda-span.

start-day defaults to TODAY, or to the most recent match for the weekday given in org-agenda-start-on-weekday.

Create agenda view for projects that are stuck. Stuck projects are project that have no next actions. For the definitions of what a project is and how to check if it stuck, customize the variable org-stuck-projects.

Toggle log mode in an agenda buffer. With argument special, show all possible log items, not only the ones configured in org-agenda-log-mode-items. With a double C-u prefix arg, show only log items, nothing else.

Manipulate the query by adding a search term with positive selection. Positive selection means the term must be matched for selection of an entry.

Manipulate the query by adding a search regexp with positive selection. Positive selection means the regexp must match for selection of an entry.

Manipulate the query by adding a search term with negative selection. Negative selection means term must not be matched for selection of an entry.

Manipulate the query by adding a search regexp with negative selection. Negative selection means regexp must not match for selection of an entry.

Mark the current clock entry in the agenda if it is present.

Mark all text hidden by filtering with a text property.

Mark the line at pos as an agenda structure header.

If there is any window showing the agenda view, update it.

Agenda menu

Mode for time-sorted view on action items in Org-mode files.

The following commands are available:

key binding — -------

C-c Prefix Command TAB org-agenda-goto C-k org-agenda-kill RET org-agenda-switch-to C-n org-agenda-next-line C-p org-agenda-previous-line C-x Prefix Command C-_ org-agenda-undo SPC org-agenda-show-and-scroll-up ! org-agenda-toggle-deadlines $ org-agenda-archive % org-agenda-bulk-mark-regexp