![[me]](../me/logo.gif)
user-setup(3)
[Home]
[Commands]
[Variables]
[Macro-Dev]
[Glossary]
NAME
SYNOPSIS
DESCRIPTION
user-setup provides a dialog interface to enable the user to configure the editor. user-setup may be invoked from the main Help menu or directly from the command line using
execute-named-command(2). user-setup configures the user's setup registry file, "<logname>.erf" which is used by MicroEmacs to initialize the environment to a user's preference.
Note, if your screen is too small to display the whole dialog, it may be moved using any key bound to the scroll commands such as scroll-up, e.g. A-up, C-z, A-down, C-v, A-left etc. For systems without mouse support, the tab key may be used to move between fields.
On all pages the following buttons are available at the bottom of the dialog and have the following effect:
Save
Saves the changes made to the users registry file, i.e. "<Log-Name>.erf" but does not re-initialize MicroEmacs. Some changes, such as color scheme changes, only take effect when the Current button is used or when MicroEmacs is restarted.
Current
Makes the current user and the changes made Current to this MicroEmacs session, dismissing the user-setup dialog and reinitializing MicroEmacs. This also saves the registry file out!
Exit
Quits user-setup, if changes where not Saved or made Current they will be lost.
The following pages, which appear in the dialog, are defined as follows:-
Start-up
Log Name
Sets the name of the current user to setup, this can be set to any valid file base name (no extension) which need not be the current user. The rest of the user-setup entries are then initialized to the settings defined for the given user (or standard defaults if not defined).
Default User
Creates a small macro file, "default.emf", setting
$MENAME(5) to the current setting of Log Name. This may be executed at start-up to determine the current user. See
$MENAME(5) for more information.
Setup Path
Sets the location of the user files, the files are searched for and created in this directory.
$MEPATH(5) should be defined to include this path.
Setup File
Sets the personal user setup macro file name which is executed at start-up. A user macro file should contain all personal settings such as preferred key bindings etc. See
Setting Up A User Profile for more information. The Edit check box can be used to enable/disable the automatic loading of the setup file ready for editing when the Current button is used.
Company File
Sets the company setup macro file name which is executed at start-up. A company macro file should contain all company wide standard settings such as %company-name, No .emf extension is supplied. See
Setting Up a Company Profile for more information.
Emulate
Sets an emulation mode which changes the behaviour on MicroEmacs to emulate another editor/program; this is done by executing a macro file at start-up. An emulation macro file should contain the macro code required to simulate the environment of the other editor. MicroEmacs '02 is released with two emulation modes, MicroEmacs v3.8 which executes macro file meme3_8.emf (See
Compatibility for more information) and NEdit v5 which is at best a demonstration of what can be achieved, this executes macro file menedit.emf.
MS Shift Region
Enables/disables cursor key manipulation with the shift key similar to the conventional Microsoft region selection. When enabled, pressing the shift key in conjunction with the cursor movement keys selects a region which is hilighted. Once the region is selected then the <DELETE> or <BACKSPACE> key erases the selected region. This also enables a similar behaviour with the Mouse Drag region driver, see below.
Locale Setup
Keyboard
Configures MicroEmacs to the user's keyboard. Accent character generation keys present on foreign keyboards cannot be automatically supported on Windows platforms. MicroEmacs must be informed of the keyboard being used to correctly interpret the keys. If a required keyboard is not supported please see
FAQ38 on how to setup the keyboard, also see
Locale Support.
Language
Sets the user language, this sets the word (or letter) characters and if available sets up
spell(2) with appropriate spelling rules and dictionaries. For more information on adding support for a language see
Locale Support.
NOTES
Earlier versions MicroEmacs had "(Ext)" languages which use extended language dictionaries, vastly increasing the word list. New versions automatically test for and use these dictionaries if available.
In earlier versions a personal dictionary name could be set in the next field, this option was removed on Oct 2001. Instead a personal dictionary for each language is automatically created for you, any words or auto-corrected words will be added to the current languages personal dictionary. The name of dictionary is "lsdp<lang-id>.edf" where "<lang-id>" is the 4 letter MicroEmacs language name (e.g. "enus" for American), simply rename any existing personal dictionary to this new name.
Auto Spell
Enables Auto Spell Checking in file types which support this feature (usually text based files such as
txt(9) or
nroff(9) files etc). Auto spell detects word breaks as you type and checks the spelling of every completed word hilighting any erroneous words in the error color scheme (usually red). The feature can be manually enabled and disabled by invoking the
auto-spell(3) command (usually bound to "f5").
Auto Save Dics
Enables auto-saving of any changed dictionaries on exit. If this is disabled the user is prompted to save for each changed dictionary.
General
Full Name
This should be set to the user's name and is used in a variety of places, e.g. by
etfinsrt(3) to set the "Created By" field in a template.
Organizer
Sets the organizer file base name, defaults to the Log Name. When notes and addresses are stored using
organizer(3) the file "<Organizer>.eof" is used.
Auto-Save Time
Sets the length of time in seconds between buffer auto-saves, a setting of 0 or an empty string disables auto-saving. The default setting is 300 seconds or 5 minutes. This indirectly sets the
auto-time(5) variable and the
autosv(2m) global mode.
Global Modes
Sets the initial state of the global
quiet(2m) mode. This indirectly executes
global-mode(2) to set the required modes.
Buffer Modes
Sets the initial state of the global modes
auto(2m),
backup(2m),
tab(2m) and
undo(2m), any buffers created will inherit the state of these modes. However, as changing these modes directly effects only the global modes, any existing buffers (including ones re-created using the -c command-line option, see
me(1)) will not be effect by the setting of these modes. For them to take effect, the buffers should be reloaded. These modes can be changed on a per file type basis using the command
buffer-setup(3), also some file hooks override these global settings, such as the
makefile(9) hook which overrides the tab mode. This indirectly executes
global-mode(2) to set the required modes.
Search Modes
Keep Undo History
If this is enabled the
undo history is kept after a save allowing the
undo(2) command to back-up changes beyond the last save. When clear the undo history is discarded after the buffer is saved. This indirectly sets bit 0x8000 of the
$system(5) variable.
Hide Backups
Enables hiding MicroEmacs generated backup files. On Windows and Dos platforms the Hidden file attribute is used to hide the file, whereas on UNIX the backup file name is prepended with a '.'. This indirectly sets bit 0x100000 of the
$system(5) variable.
Main Menu
Enables the top main menu bar.
Alt -> Main Menu
If enabled the main menu Alt hot-key bindings are enabled. These are dynamic bindings automatically generated from the main menu. Typically the first item in the main menu is "File" with a hot key of 'F', with this enabled 'A-f' will open this menu item. Note that global and local key bindings override these. This indirectly sets bit 0x2000 of the
$system(5) variable.
Alt -> Esc Prefx
If enabled the Alt key acts as a
prefix 1 modifier key. By default 'A-n' is not bound, with this bit set the key is inferred to 'esc n' which is bound to forward-paragraph. Note that global, local and menu hot-key bindings override these. This indirectly sets bit 0x4000 of the
$system(5) variable.
Tab To Indent
Show Modes
Selects which modes are to be displayed on the mode-line whenever a "%e" token is used in the
$mode-line(5) variable. This indirectly sets the
$show-modes(5) variable.
Platform - UNIX Setup
Only present on UNIX platforms using the X interface, see below for the Console setup.
Font
Sets the X font name to be used. This indirectly executes
change-font(2) with the given font name. e.g.
Display Char Set
Selects the display character set being used by the system to render the MicroEmacs window, dependent on the Font being used. The setting of this option effects the configuration of MicroEmacs's internal character maps (using command
set-char-mask(2)) enabling the character sets of foreign languages to be correctly supported. It also changes the definition of variables
$box-chars(5) and
$window-chars(5) to their best values for the given font.
Extend Char Set
When enabled MicroEmacs replaces the display of characters 0x00 to 0x1f with forms which are useful for variables
$box-chars(5) and
$window-chars(5) greatly improving the look of
osd(2) dialogs, the scroll bars etc.
Use Fonts
When enabled the bold, italic, light and underline characteristics of the font will be used depending on their availability and the Color Scheme being used. This indirectly sets bit 0x10 of the
$system(5) variable.
Draw White Spaces
Enables the drawing of visible white spaces, i.e. space, tab and new-line characters. This indirectly sets bit 0x80000 of the
$system(5) variable.
Client Server
The client/server enables the file based external macro command driver to be enabled - see
Client-Server. This by default is disabled, when enabled it is used by
command-line options -m and -o.
DOS File Names
DOS has a restricted 8.3 file naming system (i.e. "BBBBBBBB.XXX"), if this option is enabled the MicroEmacs '02 will adhere to this system for auto-save and backup file names whenever possible. See
$auto-time(5) for more information on the naming convention used. This indirectly sets bit 0x400 of the
$system(5) variable.
# Backups
This option only has an effect when DOS File Names is disabled. Setting this to a number greater than zero enables multiple backup files to be created, the number determined by this value. If set to zero (or less) then only a single backup file is created. This indirectly sets the
$kept-versions(5) variable.
Ignore Files
Sets a list extensions of files to be ignored in file completion, e.g. MicroEmacs backup files (~). This indirectly sets the
$file-ignore(5) variable.
Cursor Blink Rate
Sets the cursor blink period in millisecond. The first entry box sets the cursor visible time, a setting of zero disables blinking. The second box sets the hidden time. A visible time of 600 and hidden time of 200 gives a reasonable blink cycle. This indirectly sets the
$cursor-blink(5) variable.
Fence Display
Sets the preferred method of displaying a matching fence, a fence is one of the following brackets:
{...} (...) [...]
Jumping to the opening fence only occurs when the closing brace is typed, whereas the drawing of matching fences occurs whenever the cursor is on an open fence or one character past the close fence. When this option is set to "Never Display" the
buffer-setup(3) setting is ignored.
Scroll Bars
Selects the scroll bar support required. When Splitter is enabled, the first character of the scroll bar and mode-line is a split character used for splitting the window into two using the mouse. This indirectly sets the
$scroll-bar(5) variable.
Horizontal Scroll
Vertical Scroll
Color Scheme
Sets the color scheme setup macro file name which is executed at start-up. MicroEmacs by default comes with 4 color schemes. Color schemes can be created and altered using the
scheme-editor(3) dialog.
Platform - UNIX Console Setup
Only present on UNIX platforms when using the termcap interface, all the Console platform settings are kept independent of the X interface settings.
Termcap Color
This option determines whether Termcap based colors should be used. These are typically the standard eight colors and may not be supported on all terminals. If this option is disabled Termcap fonts (such as bold) are used instead to create a primitive hi-lighting. This indirectly sets bit 0x004 of the
$system(5) variable.
Use Fonts
See Platform UNIX Setup above.
Display Char Set
See Platform UNIX Setup above.
Draw White Spaces
See Platform UNIX Setup above.
Client Server
See Platform UNIX Setup above.
DOS File Names
See Platform UNIX Setup above.
# Backups
See Platform UNIX Setup above.
Ignore Files
See Platform UNIX Setup above.
Cursor Blink Rate
See Platform UNIX Setup above.
Scroll Bars
See Platform UNIX Setup above.
Horizontal Scroll
See Platform UNIX Setup above.
Vertical Scroll
See Platform UNIX Setup above.
Color Scheme
See Platform UNIX Setup above.
Platform - Win32 Setup
Platform - Win32 Console Setup
Only present on Windows NT and Win95+ platforms when using the console interface, all the Console platform settings are kept independent of the Window interface settings.
Display Char Set
See Platform UNIX Setup above.
Draw White Spaces
See Platform UNIX Setup above.
Client Server
See Platform Win32 Setup above.
DOS File Names
See Platform Win32 Setup above.
# Backups
See Platform UNIX Setup above.
Ignore Files
See Platform UNIX Setup above.
Cursor Blink Rate
See Platform UNIX Setup above.
Scroll Bars
See Platform UNIX Setup above.
Horizontal Scroll
See Platform UNIX Setup above.
Vertical Scroll
See Platform UNIX Setup above.
Color Scheme
See Platform UNIX Setup above.
Platform - DOS Setup
Only present on DOS machines.
Graphic Mode # and Double Lines
Sets the DOS graphics mode number and whether the number of text lines can be doubled. This indirectly executes
change-font(2) with the given font name.
Display Char Set
See Platform UNIX Setup above.
Draw White Spaces
See Platform UNIX Setup above.
Ignore Files
See Platform UNIX Setup above.
Cursor Blink Rate
See Platform UNIX Setup above.
Scroll Bars
See Platform UNIX Setup above.
Horizontal Scroll
See Platform UNIX Setup above.
Vertical Scroll
See Platform UNIX Setup above.
Color Scheme
See Platform UNIX Setup above.
Mouse
The mouse device creates keys in a similar way to regular keyboard keys and, like keyboard keysm they must be bound before they are used. MicroEmacs '02 does not have the mouse functionality hard coded into the editor, it provides a macro interface to the mouse for ultimate flexibility and a set of default functionality which can be bound to the mouse in a variety of ways.
All the mouse controlling macros are stored in mouse.emf and mouseosd.emf although some buffers have local functionality over-rides, such as
file-browser(3). The user can expand the range of mouse functionality but how this is achieved is beyond the scope of this documentation.
The user-setup dialog allows the user to configure the mouse to use the default functionality, as follows:-
Enable Mouse
Enables or disables the mouse, when disabled the mouse can not be used and will not generate any key events. This does not apply to UNIX Termcap systems as the mouse cut and paste operation is performed by the Xterm. This indirectly sets bit 0x010 of the
$mouse(5) variable.
Number Buttons
Sets the number of buttons on the mouse, may be 1, 2 or 3. MicroEmacs usually obtains the correct number for the system, but sometimes this can be wrong. This entry can be used to correct this problem. For one button mice, the button is considered to be the left mouse button, two button mice have an left and right button. This indirectly sets the
$mouse(5) variable.
Swap Buttons
If enabled then the left and right buttons are swapped, i.e. when the left button is pressed it executes the right button bindings. This indirectly sets bit 0x020 of the
$mouse(5) variable.
Simulate 3 Buttons
If enabled then pressing the left and right buttons together with generate a middle button press event, this feature is for people with a 2 button mouse who want more. The two buttons must be pressed or release within 10 millisecond of each other.
The following four fields determine which mouse button binding the user wishes to view and change:-
Button
The mouse button, Left, Right or Middle for the normal buttons and Whell Up or Whell Down for the pilot wheel events.
Shift Pressed
The action of the mouse can be different for every modifier key setting, if this is enabled then the binding being modified is for the Button being pressed with the Shift key held down.
Control Pressed
If enabled then modifying the action when the Button is pressed with the Control key held down.
Alt Pressed
If enabled then modifying the action when the Button is pressed with the Alt key held down.
The following two fields determine the functionality of the button defined by the previous four fields:-
Handle Scroll
When enabled, if the button is pressed with the mouse on the main menu, a scroll bar or mode-line the standard action is performed, such as opening the main menu or scrolling up or down the window etc. The bound To command is only called if the mouse is in a main window. If disabled, the Bound To command is always called.
Bound To
Defaults
Rests the mouse configuration to the default settings.
File Types
The file type list is used in two places, the main menu's File => Quick Open sub-menu list and the File => Open => File Type list. In each case the file type "All Files" is automatically added. The user can add, remove and change the list of file types by using this dialog. An entry can be selected for editing or deletion by simply selecting it with the left mouse button. A new entry may be added by simply filling in the 3 entry boxes and selecting Add. Items in the Dialog are as follows.
No.
The file type entry number. A new entry is always added to the end of the list, ignoring this value. The position of an existing entry can be changed by altering this field to the desired position and selecting the Change button to move it to its new position.
Name
The file type name, the string printed in the sub-menus.
File Mask List
A comma (',') separated list of file masks which match the file type, e.g. for C and C++ source files use "*.c,*.cc,*.cpp".
Add
Adds a new entry to the list, only the Name and FileMask List fields are used, the No. field is ignored as the new entry is always added to the end of the list. The position can be altered by using the Change button.
Change
Alters an existing file type entry, all 3 fields must be set.
Delete
Deletes the current entry number, only the No. entry is used.
Tools
The Tools dialog allows the user to configure up to 10 system commands, or tools, which can be executed via MicroEmacs Main Tools Menu. The dialog configures the user's registry for the command
execute-tool(3) to be used. The execution of a tool can also be bound to a key, see execute-tool for more information.
The top half of the dialog consists of the 10 Tools (0-9) configuration buttons. Selecting one of these selects the current tool to be configured, the current tool is shown by the title in the middle of the dialog.
The lower half of the dialog configures the currently selected tool, as follows:-
Tool Name
Sets the displayed name of the tool. The tool name is used in the buttons in the top half of this dialog and in the MicroEmacs Main Tools Menu.
Tool Command Line
Sets the system command-line to be launched whenever the tool is executed, the following special tokens may be used in the command-line which are substituted at execution:-
%ff
The current buffer's full file name, including the path.
%fp
The current buffer's file path.
%fn
The current buffer's file name without the path.
%fb
The current buffer's file base name, i.e. the file name without the path or the extension.
%fe
The current buffer's file extension with the '.' (e.g. ".emf"), set to the empty string if the file name does not have an extension.
Note that "%ff" is always the same as "%fp%fn" and "%fp%fb%fe". If any of these tokens are used, the tool will fail to execute if the current buffer does not have a file name.
Save Current Buffer and Prompt
If the current buffer has been edited, enabling Save Current Buffer will automatically save the current buffer before executing the tool. This is particularly useful when the tool operates on the current buffer's file (e.g. compiles the file). If Prompt is also enabled the user will be prompted before the file is saved.
Save All Buffers and Prompt
If Save All Buffers is enabled, all edited buffers will be automatically saved before executing the tool. This is particularly useful when the tool may operate on multiple files (e.g. compilation of a project). If Prompt is also enabled the user will be prompted before each file is saved.
Capture Output
If enabled any output produced from the execution of the tool will be captured and inserted into a new buffer. When enabled the following two items, Buffer and Hide, may be specified. When disabled the command used to execute the tool is
shell-command(2), otherwise the command used is either
pipe-shell-command(2) or
ipipe-shell-command(2) depending on the setting of Run Concurrently.
Buffer
Specifies the buffer name the captured output should be dumped to, this option is only visible when Capture Output is enabled. The following special tokens may be used in the buffer name which are substituted at execution:-
%fn
The current buffer's file name without the path, set to the buffer name if the current buffer does not have a file name.
%fb
The current buffer's file base name, i.e. the file name without the path or the extension. Set to the buffer name if the current buffer does not have a file name.
%fe
The current buffer's file extension with the '.' (e.g. ".emf"), set to the empty string if the current buffer does not have a file name or it does not have an extension.
Note that "%fn" is always the same as "%fb%fe". Default buffer name when this field is left empty is "*command*", or "*icommand*" if Run Concurrently is enabled.
Hide
When enabled the tool output capture buffer is hidden, this option is only visible when Capture Output is enabled.
Run Concurrently
If enabled, when the tool is executed the command is launched and run concurrently, allowing the user to continue working in MicroEmacs during the tools execution. This option is not available for all versions on MicroEmacs and forces the output to be captured. Enabling this option will force the use of command
ipipe-shell-command(2) to launch the tool.
E-Mail
MicroEmacs '02 provides a simple E-Mail manager, see
vm(3) for more information and example entries. It must be stressed that vm has only been tested in one environment, caution should be used as system differences may cause problems, such as loss of data, which the author does not except any responsibility for.
The E-Mail Setup dialog configures a user to use part or all of the vm E-Mail manager, as follows:-
Platform ALL Mail Setup
The following field is used for both sending and receiving mail:
User Mail Dir
Sets the user mail-box directory where all files are to be found and stored (except usually the Incoming Mail box). The value of this field is platform independent and must be setup for each one.
The following fields are used for sending mail:
Send Mail Signature
Sets the signature file name which is inserted at the bottom of every out-going email message, if empty the no signature is inserted. The value of this field is platform independent, is value use by all. The file must be located in the User Mail Dir and no path entered for it to work across platforms.
Carbon-Copy File
Sets the sent-mail carbon-copy file, creating the "Fcc:" line of the mail buffer. All out-going emails are appended to the end of this file if the "Fcc:" line is not altered. If this field is left empty then no "Fcc:" line is created. The value of this field is platform independent, the file must be located in the User Mail Dir.
Insert Data (^C^I)
Sets the first embedded data command line, bound to "C-c C-I". The value of this field is platform dependent.
Insert Data (^C^Z)
Sets the second embedded data command line, bound to "C-c C-z". The value of this field is platform dependent.
Send Mail Command
Sets the command-line used for sending email messages. The value of this field is platform dependent.
The following fields are used for receiving mail:
Check for mail
Sets the time interval between the automatic checking for incoming mail in seconds, when set to 0 the automatic checking is disabled. When enabled, the check is performed by
mail-check(3) which also sends any queued mail and gets any new mail if the Get Mail Command is used. The value of this field is platform dependent.
Get Mail Command
The command used to get new mail from the server, if empty it is assumed the Incoming Mail Box is automatically updated by the system. If used the command must append new mail to the end of the Incoming Mail Box specified below. The value of this field is platform dependent.
Incoming Mail Box
Sets the incoming mail box file which new incoming mail is appended to, either automatically by the system or by the Get Mail Command. The value of this field is platform dependent.
VM Main In Box
Sets the main current mail box, or inbox. The value of this field is platform independent, the file must be located in the User Mail Dir.
VM Gets Mail
When enabled, executing the command vm will not only create the mail box windows, it will also get and process any new mail. When disabled only the vm 'g' command can be used to get and process new mail.
Mime Data Extract
Sets the command-line used for extracting Mime encoded embedded data. The value of this field is platform dependent.
Uuencode Extract
Sets the command-line used for extracting Uuencoded embedded data. The value of this field is platform dependent.
Auto-Archive Setup
Sets up the auto-archive of messages in the current inbox to other mail boxes.
NOTES
user-setup is a macro using
osd(2), defined in userstp.emf.
SEE ALSO
(c) Copyright JASSPA 2002
Last Modified: 2001/12/18
Generated On: 2002/01/06