read-session(3)

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

NAME

read-session - Read in session information

SYNOPSIS

n read-session [ "session-file" ]

DESCRIPTION

read-session reads in a MicroEmacs session file, setting the current session information. If argument n is not given then the given "session-file" is simply read in. If a non-zero argument is specified then default session is set to the given file-name and the file is read. If an argument of zero is given then the default session is re-read. Information read in (and saved) from the history file includes:

Searching and replacing history.
Buffer name history.
Command name history.
File name history.
General (all the rest) history.
Buffer and file list with line numbers.

MicroEmacs's environment may be retained almost intact by the use of the default session and using the -c (continue) command-line option to re-load all files that were being edited in a previous session.

On loading a new session then the user is prompted to save the current session. If the numeric argument is zero (bit 0 is 0) then the user is not prompted and the session-file is effectively loaded and merged into the current session.

NOTES

When running multiple MicroEmacs sessions on the same work-station (or different workstations sharing the same home directory), the default history is saved when MicroEmacs exits. As a result the last MicroEmacs sessions that terminates writes the history information used next time.

The session information is saved in a registry format file (see esf(8)). Reference should be made to the notes included in erf(8) as to how the history file may be edited and effected in the same MicroEmacs session.

The user may have multiple sessions, this is useful when one is working on different projects, the sessions are created using save-session(3) using a new session name or by using the -c command line option. Starting the editor with a different session means that the hilighting scheme may be different between different sessions i.e. "Midnight X" and "Sherwood Forest". Note that the color scheme should be changed with session-setup(3) or change-scheme(3) and not with user-setup(3) if different sessions are to use different color schemes.

Command Line

Reading a session is generally performed when a MicroEmacs session is started using the "-c" command line option rather than from the emacs mode line or main menu, see me(1). Invoking

me -c<mySessionName>

where <mySessionName> is the name of the session (the $MENAME(5) or system login name) will restore all of of the buffers, windows layout, point and mark positions, main window size etc. at the point of the last shut down. e.g. given a system login name of jasspa then

me -cjasspa

restores the session to the state when jasspa last exited MicroEmacs. When the session name is specified then no other files should be specified, so the command line

me -cjasspa morefiles.txt