Macro Development Commands

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

MACRO DEVELOPMENT COMMANDS

MicroEmacs is based on a macro language which may be extended, refer to Writing MicroEmacs Macros to get started with the language.

Commands used in macro development, and more specialized commands which are only invoked from macros. Refer to Macro Commands for keyboard macros etc.

An additional set of commands for use with macros is outlined in the Introduction to Variable Functions section. The Macro Language Glossary contains a full list of macro related commands and special variables.

Commands

add-file-hook(2) DEPRICATED: Declare file name context dependent configuration
ascii-time(3) Return the current time as a string
buffer-info(2) (C-x =) Status information on current buffer position
buffer-init(3) Initialize a buffer language template
buffer-init-fhook(3) Initialize the buffer file hooks
buffer-init-hooks(3) Initialize the buffer language template hooks
command-wait(2) Conditional wait command
copy-file(3) Copy or move files and directories
copy-registry(3) Recursive copy of registry subtree
create-callback(2) Create a timer callback
create-frame(2) (C-x 5 1, C-x 5 2) Create a new frame
define-macro-file(2) Define macro file location
delete-file(3) Delete files and directories
delete-file-delayed(3) Delete file after a specified delay
delete-frame(2) (C-x 5 0) Delete the current frame
directory-tree(2) Draw the file directory tree
execute-string(2) Execute a string as a command
file-list(3) Generate list of matching file names
file-op(2) File system operations command
fileHooks(2) File Hooks
filemask-to-regex(3) Convert a file mask to a regex
goto-position(2) Restore a stored position
goto-window(2) Restore a saved window to the current window (historic)
hilight(2) Manage the buffer hilighting schemes
insert-space(2) Insert space(s) into current buffer
insert-string(2) Insert character string into current buffer
languageTemplates(2) File Language Templates
localeSupport(2) Locale Support
major-mode(2) Declare or set a buffer major mode
newline(2) (return) Insert a new line
next-frame(2) (C-x 5 o) Change the focus to the next frame
osd-dialog(3) OSD dialog box
osd-entry(3) OSD entry dialog box
osd-xdialog(3) OSD Extended dialog box
page-bfile(3) Load a large binary file as binary data
page-file(3) Load a large file in page mode
page-file-backward-line(3) (C-p) Move backwards one line in paged buffer
page-file-beginning-of-buffer(3) Move to the start of the paged file
page-file-end-of-buffer(3) Move to the end of the paged file
page-file-forward-line(3) (C-n) Move forwards one line in paged buffer
page-file-goto-byte(3) Page to the buffer byte offset
page-file-goto-page(3) Move to page
page-file-isearch-backward(3) (C-r) Page search backwards incrementally (interactive)
page-file-isearch-forward(3) (C-s) Page search forward incrementally (interactive)
page-file-save-buffer(3) (C-x C-s) Save contents of a page mode buffer to file
page-file-scroll-down(3) (C-n) Scroll paged buffer down
page-file-scroll-up(3) (C-p) Scroll paged buffer up
page-file-search-backward(3) (C-x r) Page search for a string in the backward direction
page-file-search-buffer(3) Search the page file buffer
page-file-search-forward(3) (C-x s) Page search for a string in the forward direction
popup-window(2) Pop-up a window on the screen
screen-poke(2) Immediate write string to the screen
screen-update(2) (redraw) Force screen update
search-buffer(2) Search the current buffer for a string
set-cursor-to-mouse(2) Move the cursor to the current mouse position
set-position(2) Store the current position
set-scroll-with-mouse(2) Scroll the window with the mouse
set-variable(2) (C-x v) Assign a new value to a variable
set-window(2) Save the current window for restore (historic)
show-cursor(2) Change the visibility of the cursor
shut-down(3) Editor exit callback command
spell(2) Spell checker service provider
start-up(3) Editor startup callback command
str-to-regex(3) Generate regex safe variant of a string
toolbar-refresh(3) Update the tool bar
unset-variable(2) Delete a variable
void(2) Null command

Variables

$MEBACKUPPATH(5) Backup file location
$MEBACKUPSUB(5) Backup file name modifier
$buffer-backup(5) Buffer backup file name
$buffer-bhook(5) Buffer macro hook command name (buffer current)
$buffer-dhook(5) Buffer macro hook command name (buffer deletion)
$buffer-ehook(5) Buffer macro hook command name (buffer swapped)
$buffer-fhook(5) Buffer macro hook command name (buffer creation)
$buffer-fmod(5) Buffer file modes (or attributes)
$buffer-indent(5) Current buffer indentation scheme
$buffer-input(5) Divert buffer input through macro
$buffer-ipipe(5) Divert buffer incremental pipe input through macro
$buffer-major-mode(5) Define buffer major-modem
$buffer-names(5) Filtered buffer name list
$buffer-xlate(5) Buffer on-save translation configuration
$build(5) MicroEmacs build information
$command-names(5) Filtered command name list
$cursor-x(5) Mouse X (horizontal) position
$cursor-y(5) Mouse Y (vertical) position
$debug(5) Macro debugging flag
$file-names(5) Filtered file name list
$find-words(5) Filtered word list
$global-fmod(5) Global file modes (or attributes)
$line-flags(5) Current buffer line flags
$major-mode-ids(5) Filtered major-mode ID list
$mode-names(5) Filtered mode name list
$mouse(5) Mouse configuration variable
$mouse-x(5) Mouse X (horizontal) position
$mouse-y(5) Mouse Y (vertical) position
$platform(5) MicroEmacs host platform identifier
$progname(5) Program file name
$random(5) Generate a random number
$result(5) Various command return values
$status(5) Macro command execution status
$system(5) System configuration variable
$temp-name(5) Temporary file name
$variable-names(5) Filtered variable name list
$version(5) MicroEmacs version date-code
$window-flags(5) Current window setup flags
$window-mode-line(5) Window mode line position
$window-scroll-bar(5) Window scroll bar (or separator) position
%ascii-time(5) Set the default format of the date string
.about.arg0(5) First command line option
.about.arg1(5) Second command line option
.about.arg2(5) Third command line option
.about.argc(5) Command line argument count
.calc.answer(5) Last successful calc answer
.calc.result(5) Last calc calculation result

Ref: Macro Development Commands File: me.0 Date: 2026/03/05