script

Context: sl.sherpa

Synopsis

Save every command typed in a Sherpa session to a file.

Syntax

script([filename="sherpa.log"; clobber=0]);

The script function saves every command typed in a Sherpa session to the file specified in the 'filename' argument; by default, the file "sherpa.log" is used. If the file already exists in the current working directory, it can be clobbered by setting the 'clobber' argument to 1.

filename - the name of the file to write; default = sherpa.log
clobber - Boolean to specify if existing 'filename' should be overwritten; default = 0

Example 1

sherpa> script("sherpa_session1.log"; clobber=0) ;

This command will record *everything* typed at the command line in a Sherpa session to the file "sherpa_session1.log", unless this filename already exists in the current working directory.

Setting clobber=1 overwrites "sherpa_session1.log":

sherpa> script("sherpa_session1.log");
script file "sherpa_session1.log" exists and clobber is not set.

sherpa>  script("sherpa_session1.log"; 1);
Input saved to sherpa_session1.log

Example 2

sherpa> script();

When issued with no arguments, the 'script' command writes to "sherpa.log"; clobber is turned off by default.

sherpa> script();
Input saved to sherpa.log

sherpa> script();
script file "sherpa.log" exists and clobber is not set.

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.