4.1 Commands

Command: burnish

Run the function that exports the Org file and views the result as specified by burnish-backend.

This function is governed by two variables:

  • burnish-backend — local file variable specifying which export backend to use.
  • burnish-export-functions — alist map whose pairs are (SYMBOL FUNCTION), where SYMBOL is a backend key and FUNCTION is its corresponding export function.
Command: burnish-select-backend CHOICE

Prompt the user for CHOICE and set it to the local file variable burnish-backend in an Org file.

The prompt supports completion where choices are taken from the keys defined in burnish-export-functions.

This command will either add or update burnish-backend as detailed in (emacs)Specifying File Variables.

Command: burnish-mode

Minor mode to enable automated Org file export and viewing of the result.

When burnish-mode is enabled:

  • Automated export and view is triggered by a file save (save-buffer).
  • The key sequence burnish-export-key is bound to the command burnish.

Disabling burnish-mode undoes the above.

burnish-mode is identified on the mode line with the glyph ‘≛’.