Commands
| :Org {action} [args] | Run any action by name (the names are those in org-keymaps). Without arguments, shows a picker. |
Additional subcommands:
:Org agenda [key|view],:Org capture [key]:Org export [format] [subtree] [body] [visible] [buffer] [open]:Org publish [project|file|current|all] [force]:Org tangle,:Org detangle [file],:Org tangle_jump,:Org tangle_clean,:Org babel_load_file [file]:Org search {text},:Org tags_search {match},:Org todo_list [KEYWORD]:Org clock_in_last,:Org refile_goto:Org show_all,overview,content,show_everything,set_startup_visibility,force_cycle_archived:Org delete_property_globally,:Org tags_sparse_tree [match],:Org occur [regexp],:Org align_tags,:Org id_update_locations:Org table_formula [formula](org-table-formulas),:Org agenda_filter_regexp [-]regexp(org-agenda-filter):Org timer_start,timer_stop,timer_pause,timer_insert,timer_countdown [min],timer_remaining:Org toggle_timestamp_type:Org notifications_start,notifications_stop:Org lint [checker ...](org-lint):Org tutor [lesson] [reset](without a lesson: the lesson list),:Org tutor_hint(org-tutor):Org feed_update [name],feed_update_all,feed_goto_inbox [name],feed_show_raw [name](org-feed):Org mobile_push,mobile_pull,mobile_apply,mobile_goto_inbox,mobile_flagged(org-mobile):Org migrate_config [file]: an nvim-orgmode setup as org.nvim's (org-migrate-config)
Live previews
Some subcommands show what they will do while you type them, before <CR>, like :substitute does with 'inccommand' (:command-preview):
:Org table_formula {formula} | the table recalculated with the formula; the fields it changes and the formula in #+TBLFM are highlighted |
:Org occur {regexp} | the matches highlighted |
:Org tags_sparse_tree {match} | the matching headlines highlighted |
:Org agenda_filter_regexp {re} | in the agenda, the entries the filter would hide dimmed |
The preview follows 'inccommand': nothing is shown when it is empty; "nosplit" (Neovim's default) shows it in the buffer, "split" also lists the changed table or the matching lines in the preview window. A formula or match that is not complete yet (or has an error) shows nothing, and tables of more than 20,000 fields get no preview. Nothing is folded or written until you press <CR>; <Esc> leaves the buffer as it was (the preview is no change, and leaves no undo step). The highlight is OrgCommandPreview (linked to hl-Substitute); sparse-tree matches use OrgSparseMatch, as after <CR>.
Menus
Emacs's Org menus are Neovim menus (:menu): "Org" and "Table" in org buffers (org-org-menu, org-tbl-menu), "Agenda" in the agenda (org-agenda-menu), "Column" in column view (org-columns-menu), "Edit-Formulas" in the formula editor (org-table-fedit-menu) and "OrgTbl" where orgtbl-mode is on (orgtbl-mode-menu), with Emacs's entries in Emacs's order, each running the action that does the same (its key is shown next to it, unless mappings.disable_all leaves it unbound; the agenda buffer's keys stay bound). Neovim menus are global, so they are added when a buffer they belong to is entered and removed when another one is. GUIs show them in the menu bar; anywhere, run an entry with :emenu (:emenu Org.<Tab> completes) or pop a menu up with :popup (:popup Org). Entries Emacs greys out at point are disabled before a popup and refuse to run otherwise. The menus are built the first time they can be used: when a GUI is attached, or when a menu command (:emenu, :popup, :menu, ...) is typed or run from the command line. A mapping that runs <Cmd>popup Org<CR> (no command line) should call require("org.menu").popup("Org") instead, which builds them first. "File List for Agenda" and "Agenda Files" list the agenda files. ui.menus = false turns the menus off (Emacs has no option for them).
Key menus and choice lists
Commands that ask for one key (the export dispatcher, the agenda dispatcher, capture templates, sorting, …) show a floating menu: each row is a key, then what it does; a toggle's value is shown on the right ("on" in green, "off" dimmed) and › marks a submenu. Press a key to choose, <BS> to go back from a submenu, <Esc> to quit. q quits too, unless an entry of the menu uses it as its key: a TODO keyword, tag, capture template, agenda command or export backend you gave the key q is chosen with it, and only <Esc> quits that menu. The same holds for the expert export prompt, the agenda's tag filter, the attachment prompt and the date prompt's calendar keys.
A menu taller than the screen (the export dispatcher on a 24-line screen) drops its blank lines first, then scrolls: the footer shows ↓ when more entries are below and ↑ when more are above, with the key that scrolls each way. Every entry's key works whether it is shown or not. A scroll key that an entry of the menu uses chooses the entry instead (the footer then names another key).
| <Space> <PageDown> | a screen down |
| <BS> <PageUp> | a screen up; at the top of a submenu, back |
| <C-d> <C-u> | half a screen down / up |
| <C-n> <C-p> <Down> <Up> | a line down / up |
| mouse wheel | three lines |
These are the export dispatcher's scroll keys in Emacs (org-export-dispatch: SPC, DEL, C-n, C-p and the arrows), in every menu. A choice list closes with q or <Esc>.
Commands that ask for one of a fixed set of values (Emacs's completing-read) show a floating list instead: the table export format (:Org table_export), the export template category, the publishing project, the ODT conversion format, a column's summary type, the dynamic block type, the BibTeX entry type and the state to switch to on clock out.
| j k <Down> <Up> <C-n> <C-p> | move |
| g G | first / last |
| <CR> | choose |
| 1-9 a-z | choose that row |
| e | edit the value at the cursor in the command line first (where the value can take arguments, like a table export format: orgtbl-to-latex :splice t) |
| <Esc> q | cancel |
With ui.choice_prompt = "input" these prompts are the command line with <Tab> completion, as in Emacs.
| :Org clock_menu | Pop up the clock menu: clock out, change the effort estimate, go to the clocked task, switch task (org-clock-menu). Emacs shows it on a click on the clock in the mode line; for the same in a statusline use the click handler: |
set statusline+=%@v:lua.require'org.menu'.clock_click@%{v:lua.require'org'.statusline()}%X
A left click pops the menu up, a middle click goes to the clocked task.
| :Org customize | A buffer listing every option with its value, in the order and sections of lua/org/config/ (org-customize); "[changed]" marks values that differ from the default. <CR> or K shows the option's documentation with its default and value, c sets it for this session (a Lua expression), R resets it to its default, q closes the buffer. Put changes in setup() to keep them. |
| :Org customize_menu | Put every option into the Org menu's Customize submenu (org-create-customize-menu); an entry opens the options buffer on it. |
| :Org bug_report | Report a bug (org-submit-bug-report): after a notice about privacy, asks whether to include your options (those that differ from the defaults) and for a subject, puts the report (Neovim, org.nvim and OS versions, the options) in a buffer and opens a new GitHub issue titled "[BUG] <subject> [<version>]" prefilled with it (vim.ui.open()). A report too long for a URL is left for you to paste (it is also in the + register). |
org-mouse
mouse.org_mouse = true loads org-mouse (Emacs: (require 'org-mouse)); it is off by default. mouse.features (org-mouse-features) picks its parts, by default all but "move-tree":
| "context-menu" | <RightMouse> pops up a menu for what is under the mouse (org-mouse-show-context-menu, also :Org mouse_context_menu at the cursor): a TODO keyword (switch it, TODO trees and lists), SCHEDULED:/DEADLINE: (switch or remove it), a priority cookie (set or remove it), a link (open, copy, cut), a tag (agenda, sparse tree, toggle tags), a timestamp (show the day, change, delete, set for today/tomorrow/in a week..., shift by a day/week/month), a checkbox (toggle, remove, all clear/set/toggle/remove), a table (and its special first-column marks), a #+STARTUP: line (toggle each option), a headline (priority, tags, TODO state, new heading, deadline, schedule, timestamp, archive, cut, copy, paste, sort children), the Visual selection (sparse tree, find, grep, convert to link, insert the last yank as a link), elsewhere a general menu (overview, headlines, deadlines, TODOs, tags, agenda views, custom agenda commands, blank lines, checkboxes, list to outline). Items that are radio buttons or toggles in Emacs show "(*)" / "[X]" when selected. In the agenda the menu of an entry is its headline's menu, run in the entry's buffer (the agenda is rebuilt), elsewhere an agenda menu; <C-ScrollWheelUp/Down> and a horizontal right drag go to earlier / later dates. <C-LeftMouse> dragged moves a subtree (see below). |
| "move-tree" | A right drag moves a subtree. |
| "yank-link" | <S-MiddleMouse>, or a right drag, inserts the last yank as " [[...]] " where the mouse is (org-mouse-yank-link). |
| "activate-stars", "activate-bullets", "activate-checkboxes" | A click on headline stars cycles the subtree, on a bullet cycles the item, on a checkbox toggles it (<MiddleMouse>, and <LeftMouse> with links.mouse_1_follows_link). With org-mouse, <C-c><C-o> on them does the same. |
With org-mouse a click inside the Visual selection keeps it (org-mouse-down-mouse), so that a right click there shows its menu. Dragging a subtree (org-mouse-move-tree): drop it on its own headline to demote it (drag right) or promote it (drag left), on another headline's stars to put it before that headline, at its level, further right or on the text below a headline to make it that headline's last child. Commands of org-mouse, also as actions: mouse_insert_heading (a heading before the line when at its start, else before the next heading), mouse_insert_checkbox, mouse_end_headline, mouse_show_headlines, mouse_show_overview, mouse_timestamp_today, mouse_transform_to_outline (the list items of the entry become subheadings), mouse_move_tree_start.