Synopsis

keepFile {file} { maxlines | option | } [option...]

Description

Called from within a computeMarks script, which would in turn have been called by rst. Used to request that a file generated by runTests or computeMarks** *be printed. For files submitted by the student, use *printFile instead.

Usage

The file parameter specifies the filename of the file to be printed. The filename may be relative to tmpdir , or it may be an absolute path. maxlines is the maximum number of lines to print; if the file is longer than the specified length, it is truncated. If maxlines is omitted, a copy of the indicated file is kept for later inspection after the testing run finishes, but the file is not printed. options are optional and may be used to specify certain behaviour. If more than one option is provided, the whole set of options may be enclosed in quotation marks for backwards compatibility with an older version of keepFile, but this is not required or recommended.

Tip: If you want a copy of the file in the same directory as output file, but not in the output file itself, set maxlines to 0.

The options are as follows:

-n

Don't show line numbers.

-f

Fold long lines (instead of truncating at the right margin). Using -f is important as having lines truncated can make marking very difficult.

-o

Keep the file as it is. Do not fold, truncate, or make any modifications.

-w

Not yet implemented! Wrap long lines; like fold, except it tries to break at a word boundary.

-h "name"

Override the output header for this file to something other than the default filename header.

-k "keystring"

Primarily for use with deProcessFile. Specify that the key for this file should be something other than what was provided in the file parameter.

-E

Specifies that the file is an EPS file and should be scaled to fit a full page as closely as possible.

-e "params"

Specifies that the file is an EPS file, and that it should be sized according to the LaTeX code params . An example would be:

 -e 'height=0.4\textheight,width=0.9\textwidth,keepaspectratio' 

-s

Disables keeping a copy of the file in the same directory as the output file.

As part of the process of preparing the file for printing, it is transformed into a LaTeXed version that must be saved for inclusion in the final LaTeX produced for the assignment. An attempt has been made to handle a handful of special characters in a way that makes LaTeX interpret them properly, but there is no guarantee of success for many non-alphanumeric characters.