MainMenu(3)

NAME

Main Menu - The top main menu

SYNOPSIS

n osd

DESCRIPTION

The main menu is provided to give an easier access to parts of MicroEmacs functionality, the menu is not burnt into MicroEmacs but defined on start-up in me.emf and osd.emf. The user-setup(3) command can be used to set whether the menu is always visible and if the Alt-Hotkeys are enabled (i.e. 'A-f' to open the File menu).

The main menu is osd(2) dialog number 0 so key bindings can be made which will open the main menu, an argument of 0 will simply open the main menu, an argument of 0x0n0000 will not only open the main menu but also the nth sub menu, e.g. to open the edit menu use:

    0x020000 osd 

Following is a brief description of the main menu items:

File Menu

New


Changes the current buffer to a new buffer.

Open


Opens a dialog enabling the user to select files for opening into MicroEmacs. By default the dialog opens the selected file using command find-file(2), but if the view option is selected the view-file(2) command is used. The binary or encrypt options configure whether the files are to be loaded with binary(2m) or crypt(2m) modes enabled.

Quick Open


Opens a sub-menu list all user file types (defined in user-setup(3)). Selecting one will open another sub-dialog list all files of that type in the current directory, selecting a file will open it using command find-file(2).

Favorites


Opens a sub-menu enabling the user to add new favorite files, edit the existing list of favorite files, or select an existing favorite file in which case the file is opened using command find-file(2). The favorite file using to store the list is "$MENAME.eff" and is saved in the first path given in the $search-path(5). Each favorite file takes 2 lines in the file, the first is the text displayed in the dialog (note that characters '\' and '&' must be protected with a '\' and the '&' can be used to set the Hot key) and the second line is the file name. A line with a single '-' character creates a separater line in the dialog.

Find Tag


Only visible when a tags file is found in the current directory, the command jumps to the current tag or if not on a tag or the tag is not found, opens a dialog enabling the user to select a tag. See command find-tag(2) for more information.

Find File


Executes command file-browser(3).

FTP


Executes command ftp(3).

Close


Executes a dialog form of the command delete-buffer(2).

Attributes


Opens a dialog enabling the user to set the current buffers file attributes. See command file-attrib(3) for more information.

Save


Executes a dialog form of the command save-buffer(2).

Save As


Executes a dialog form of the command write-buffer(2).

Save All


Executes a dialog form of the command save-all(3).

Printer Setup


Opens a dialog which enables the user to configure the printer driver, output location and page layout (executes command print-setup(3)).

Print


Executes command print-buffer(2).

Buffer


Opens a sub-menu listing all created buffers, selecting one will change the current buffer to the selected one.

Exit


Executes command save-buffers-exit-emacs(2).

Edit Menu

Undo


Undoes the last edit in the current buffer (executes command undo(2)).

Redo


Redo the last undo, only available immediately after an undo. This is also done via the undo(2) command.

Undo All


Undo all edits in the current buffer until the last save or no more undo history is available. Executes the command undo(2) with a 0 numerical argument.

Set Mark


Executes command set-mark(2).

Cut


Executes command kill-region(2).

Copy


Executes command copy-region(2).

Paste


Executes command yank(2).

Narrow Out


Executes command narrow-buffer(2) with a numeric argument of 4.

Narrow To


Executes command narrow-buffer(2) with a numeric argument of 3.

Remove Single Narrow


Executes command narrow-buffer(2) with a numeric argument of 2.

Remove All Narrows


Executes command narrow-buffer(2) with a numeric argument of 1.

Search Menu

Search


Executes a dialog form of the command isearch-forward(2).

Replace


Executes a dialog form of the command query-replace-string(2).

Hilight Search


Opens another dialog which can be used to add and remove hilighting of individual lines in the current buffer. Note that setting a line hilight is a temporary change, it will not effect any files etc and will be lost when the buffer is deleted.

Goto Line


Executes a dialog form of the command goto-line(2).

Goto Fence


Executes command goto-matching-fence(2).

Set Bookmark


Executes command set-alpha-mark(2).

Goto Bookmark


Executes command goto-alpha-mark(2).

Insert Menu

Symbol


Executes command symbol(3).

Date & Time


Opens a dialog with the current date and time in a selection of common formats; selecting one of these will insert the string into the current buffer at the current position. Note that the format text strings depend on the current language (Default and American languages use the order MM-DD-YY etc whereas the rest use DD-MM-YY). The names used for the day and month names can be defined using the Setup page of Organizer(3).

File


Executes command insert-file(2).

File Name


Executes command insert-file-name(2).

Macro...


Executes command insert-macro(2).

Format Menu

Restyle Buffer


Executes command restyle-buffer(3).

Restyle Region


Executes command restyle-region(3).

Clean Buffer


Executes command clean(3).

Change Buffer Char Set


Executes command charset-change(3).

IQ Fill Paragraph


Executes command ifill-paragraph(3).

Fill Paragraph


Executes command fill-paragraph(2).

Fill All Paragraphs


Executes command fill-paragraph(2) with a very large positive numerical argument. Note that this only effects paragraphs from the current position onwards.

Paragraph to Line


Executes command paragraph-to-line(3).

All Paragraphs to Line


Executes command paragraph-to-line(3) with a very large positive numerical argument. Note that this only effects paragraphs from the current position onwards.

Sort Lines


Executes command sort-lines(2).

Ignore Case Sort Lines


Executes command sort-lines-ignore-case(3).

Capitalize Word


Executes command capitalize-word(2).

Lower Case Word


Executes command lower-case-word(2).

Lower Case Region


Executes command lower-case-region(2).

Upper Case Word


Executes command upper-case-word(2).

Upper Case Region


Executes command upper-case-region(2).

Execute Menu

Execute Command


Executes command execute-named-command(2).

Execute Buffer


Executes command execute-buffer(2).

Execute File


Executes command execute-file(2).

Start Kbd Macro


Executes command start-kbd-macro(2).

Query Kbd Macro


Executes command kbd-macro-query(2).

End Kbd Macro


Executes command end-kbd-macro(2).

Execute Kbd Macro


Executes command execute-kbd-macro(2).

Name Kbd Macro


Executes command name-kbd-macro(2).

Ipipe command


Executes command ipipe-shell-command(2).

Shell


Executes command shell(2).

Tools Menu

Current Buffer Tools


For some file formats MicroEmacs provides a file format specific set of tools, see the file type help page for more specific information.

Count Words


Executes command count-words(2).

Spell Word


Executes command spell-word(3).

Spell Buffer


Executes command spell-buffer(3).

Word Complete


Takes the incomplete word to the left of the cursor and attempts to complete the word by using the users current language dictionary. Executes command spell-complete-word(3).

Compare Windows


Executes command compare-windows(2).

Compile


Executes command compile(3).

Grep


Executes command grep(3).

Graphical Diff


Executes command gdiff(3).

Diff


Executes command diff(3).

Diff Changes


Executes command diff-changes(3).

Organizer


Executes command organizer(3).

Mail


Executes command mail(3).

View Mail


Executes command vm(3).

More...


Opens a sub-menu with a collection of other useful miscellaneous tools.

Window Menu

Split Window V


Executes command split-window-vertically(2).

Grow Window V


Executes command grow-window-vertically(2).

Shrink Window V


Executes command shrink-window-vertically(2).

Split Window H


Executes command split-window-horizontally(2).

Grow Window H


Executes command grow-window-horizontally(2).

Shrink Window H


Executes command shrink-window-horizontally(2).

One Window


Executes command delete-other-windows(2).

Delete Window


Executes command delete-window(2).

Previous Window


Executes command previous-window(2).

Next Window


Executes command next-window(2).

Help Menu

Curr Buffer Help


For some file formats MicroEmacs provides a file format specific help page giving details of key-bindings and tools specific to the current buffers file type.

General Help


Executes command osd-help(3).

Help on Command


Executes command help-command(2).

Help on Variable


Executes command help-variable(2).

Describe Bindings


Executes command describe-bindings(2).

Describe key


Executes command describe-key(2).

Describe Variable


Executes command describe-variable(2).

Describe Word


Executes command describe-word(3).

List Buffers


Executes command list-buffers(2).

List Commands


Executes command list-commands(2).

List Registry


Executes command list-registry(2).

List Variables


Executes command list-variables(2).

Command Apropos


Executes command command-apropos(2).

Buffer Setup


Executes command buffer-setup(3).

User Setup


Executes command user-setup(3).

Scheme Editor


Executes command scheme-editor(3).

Games


Opens a sub-menu listing all available games, see Games for more information.

Product Support


Opens on-line Contact information.

About MicroEmacs


Executes command about(2).

NOTES

The main menu is defined using osd(2) in macro files me.emf and osd.emf.

General user extensions to the main menu can be added to the user file myosd.emf which is executed once when the main menu is first opened. The macro file can add new items to any of the main sub menus and can delete most existing items (some are dynamically added when appropriate, these should not be deleted). See osd.emf for examples of how to add items to the menu.

New sub-menus should be added in the company or user setup files as this must be done at start-up. The content on the menu is not required until the main menu is used so populating the new sub-menu can be done in myosd.emf.

SEE ALSO

user-setup(3).

(c) Copyright JASSPA 2002
Last Modified: 2001/12/18
Generated On: 2002/01/06