$MEINSTALLPATH(5)

NAME

$MEINSTALLPATH - MicroEmacs system macros search path
$MEPATH - MicroEmacs search path
$MEUSERPATH - MicroEmacs user directory

SYNOPSIS

[Microsoft Windows/MS-DOS]
$MEINSTALLPATH <path1>;<path2>;....;<pathn>
$MEPATH= <path1>;<path2>;....;<pathn>
$MEUSERPATH <path>

[UNIX]
$MEINSTALLPATH <path1>:<path2>:....:<pathn>
$MEPATH= <path1>:<path2>:....:<pathn>
$MEUSERPATH <path>

DESCRIPTION

These environment variables control the run-time search paths for MicroEmacs and affect the operation of $search-path(5) and $user-path(5), the macro search path and user macro directory respectively.

$MEINSTALLPATH is an environment variable that overrides any internally defined search path for MicroEmacs system macros and defines the root directory(s) of the MicroEmacs system macros. The presence of the environment variable affects $search-path(5).

The environment variable $MEINSTALLPATH is ignored if $MEPATH is defined. The search path is always included after any user path defined by $user-name(5).

$MEUSERPATH is an environment variable that defines the users private directory where user configuration files such as $user-name.emf, $user-name.erf and personal spelling dictionaries are stored. This is an absolute directory path. The environment variable sets the MicroEmacs variable $user-name(5).

$MEPATH is an environment variable that may be used to define the absolute search path for MicroEmacs macro files and affects the setting of $search-path. The path should include the system macros location(s) and should include the user directory location $user-path(5) as the first path when the environment variable $MEUSERPATH(5) is not defined. If $MEUSERPATH is defined then this path name appears before the $MEPATH variable to define the user directory location. $MEPATH is not searching, so ALL all directories to be searched must be included in the path specification.

$MEUSERPATH(5) is the preferred method used to defined the user directory.

Search Paths

MicroEmacs needs to know the installation directory location(s) of its macro files when it executes, this includes both user defined and system macros. MicroEmacs performs a searching operation of well-known directory locations where it may expect to find these macros at start up, the locations that it has found are saved in macro variables $user-path(5) and $search-path(5) and are used to subsequently locate files thereafter. The environment variables defined here allow that default search process to be modified by the user or system administrator.

Directories are specified as searching if a search operation is performed. The following sub-directories of a base directory are searched for the existence of subdirectories:

. - root directory.
$user-name - private user directory.
company - company files.
macros - JASSPA standard macros.
spelling - spelling dictionaries.

MicroEmacs performs a searching operation on some directories to locate information. Generally, if the directory exists then it is included in the search path, otherwise it is excluded. Any subdirectories that are found are added in the order presented above. The $search-path is ONLY evaluated at start-up therefore directories created after MicroEmacs is running are not detected until the editor is closed down and re-started.

UNIX

The defined search paths for UNIX are defined as follows:-

Default install directories:-

/opt/jasspa - searching (SunOS, HP-UX, AIX and IRIX only)
/usr/share/jasspa - searching
/usr/local/share/jasspa - searching (BSD systems only)
/usr/local/jasspa - searching

The default user location is defined as follows.

$(passwd-home)/.jasspa - searching

MicroEmacs searches for user defined configuration files in this directory and will write new user configuration files to this directory. The behaviour of the search may be over-ridden by setting some environment variables.

$MEUSERPATH - not searching


Specified as a single pathname and redefines the $user-path where user macros are placed, this overrides the $(passwd-home)/.jasspa directory location.

$MEINSTALLPATH - searching


Specified as multiple pathname components and overrides the default install directory location (i.e. /usr/local/jasspa, etc. Typically used when the system macro directory has been install in another location that is not included in the default search path. This does not affect the user directory location.

$MEPATH - not searching


Overrides the $(passwd-home)/.jasspa and default search paths (including $MEINSTALLPATH), MicroEmacs will use this directory as the search path. The user directory is assumed to be the FIRST directory path in the string unless the $MEUSERPATH environment variable is defined which specifies the user path.

Microsoft Windows

he defined search paths for WINDOWS are defined as follows:-

Default search locations:-

Executable directory location - searching

The default user location is defined as follows. MicroEmacs searches for user defined configuration files in this directory and will write new user configuration files to this directory.

$APPDATA\jasspa - not searching

If the system does not define a user application data location (Win95 and Win32s) then a directory $user-name or the executable location is used.

The behaviour may be over-ridden by setting the environment variables as follows:

$MEUSERPATH - not searching


Specified as a single pathname and redefines the users home directory, this overrides the $APPDATA\jasspa directory location.

$MEINSTALLPATH - searching


Specified as multiple pathname components and overrides the default install directory location. Typically used when the macro directory has been install in another location that is not in the same directory as the executable. This does not affect the user directory location.

$MEPATH - not searching


Overrides the $APPDATA\jasspa and default search paths. MicroEmacs will use the FIRST directory path as the $user-path unless $MEUSERPATH is defined.

MS-DOS

MS-DOS does not include a concept of a user name or user directory.

Default search locations:-

Executable directory location - searching

If a sub-directory exists at the executable location with name $user-name then this is used as $user-path, otherwise the execution directory location is used.

The behaviour may be over-ridden using the environment variables.

$MEUSERPATH - not searching


Specified as a single pathname and redefines the $user-path overriding the executable directory location.

$MEINSTALLPATH - searching


Specified as multiple pathname components and overrides the default executable directory location. Typically used when the macro directory has been installed at a different location that is not in the same directory as the executable. This does not affect the user directory location.

$MEPATH - not searching


Overrides the Executable... and default search paths (including $MEINSTALLPATH). MicroEmacs will use FIRST directory path as the $user-path unless $MEUSERPATH is defined.

SEE ALSO

me(1), $home(5), $progname(5) $search-path(5), $user-name(5), emf(8), erf(8).

Copyright (c) 1998-2006 JASSPA
Last Modified: 2004/02/01
Generated On: 2006/10/07