.; .; FILE NAME: MCL.RNO .; .; DESCRIPTION: Document source for the VAX Multi-Column Lister .; .; BUILD INFO: $ RUNOFF/OUTPUT=MCL.DOC MCL .; .; REVISION HISTORY: .; 12-SEP-1988 Dale D. Lutes .; MCL version 3.0 .; .RIGHT MARGIN 70 .KEEP .AUTOPARAGRAPH .SET PARAGRAPH 0,1,, .FIGURE 3 .CENTER;Multi-Column Lister (MCL) .CENTER;Version 3.0 .SKIP .CENTER;Dale D.#Lutes .CENTER;Cessna Aircraft Company .CENTER;12-SEP-1988 .HEADER LEVEL 1 GENERAL DESCRIPTION MCL will reformat an ASCII file into a document with multiple columns on a page. To enable MCL, enter the following at the DCL prompt: .NO FILL _$ SET COMMAND CES__SHARE:MCL The format of an MCL command is: _$ MCL input__file [/qualifiers...] .FILL .HEADER LEVEL 2 Input Files For the best results, the lines in the input file should be no longer than the output column width. Using a text formatter such as RUNOFF is an easy way to to produce an input file with lines of uniform length. MCL uses the following formula to determine output column width: .NO FILL (page__width - right__shift - 3 * (num__of__columns - 1)) col__width = ----------------------------------------------------- num__of__columns .FILL MCL will properly handle input files created with FORTRAN carriage control. .PAGE .HEADER LEVEL 2 Qualifiers A number of command qualifiers allow the user to control the format of the output page. These are described in the following sections .HEADER LEVEL 3 /COLUMNS /COLUMNS=n This qualifier specifies the number of output columns per page. The number requested must be in the range 1 through 9. Lines which are too wide for the column will be wrapped or truncated according to the setting of the /WRAP qualifier. The default is /COLUMNS=2 .HEADER LEVEL 3 /FF /FF=COLUMN (default) .BREAK /FF=PAGE .BREAK /NOFF This qualifier specifies the type of action MCL takes when it encounters an embedded formfeed character. If the formfeed is the first character in the input line: .NO FILL /FF=COLUMN instructs MCL to start a new column /FF=PAGE instructs MCL to start a new page .FILL /NOFF indicates that all formfeeds should be ignored. Formfeeds that do not appear at the beginning of the line are ignored in any case. MCL recognizes files written with FORTRAN carriage control, and will process the '1', '0', and blank characters correctly. .HEADER LEVEL 3 /FOOTER /FOOTER="text" This qualifier allows the user to specify a text string that will appear on the bottom of every page. .HEADER LEVEL 3 /FTAB__EXPAND /[NO]FTAB__EXPAND If this qualifier is specified, tab characters in the input file will be expanded according to the manner in which the Fortran compiler would interpret them; otherwise, tab characters will be expanded to the standard 8-column tab step. The default is /NOFTAB__EXPAND. .HEADER LEVEL 3 /HEADER /HEADER="text" .BREAK /NOHEADER This qualifier allows the user to change the default MCL header line that appears on every output page. /NOHEADER eliminates the header line completely. .HEADER LEVEL 3 /LENGTH /LENGTH=n This qualifier specifies the number of output lines per page. By default, MCL uses the value returned by LIB_$LP__LINES minus 6. .HEADER LEVEL 3 /LOWER__CASE /[NO]LOWER__CASE If this qualifier is present, MCL converts all text to lower case before writing it to the output file, /NOLOWER__CASE is the default. .HEADER LEVEL 3 /OUTPUT /OUTPUT=output__file__spec The output file may be named explicitly by means of this qualifier. By default, MCL uses the input file name with the file extension .MCL. .HEADER LEVEL 3 /PAUSE /[NO]PAUSE If this qualifier is present, MCL will wait for the RETURN key to be pressed after writing each page of output. This qualifier is useful when the terminal is specified as the output file. .PAGE .HEADER LEVEL 3 /RIGHT /RIGHT=n This qualifier is used to shift the output text to the right by N columns. This can be used to allow space for punching holes in documents that will be stored in 3-ring binders. /RIGHT does not change the overall width of the output file, but will cause the width of the columns to shrink instead. The default is /RIGHT=0 .HEADER LEVEL 3 /SEPARATOR /SEPARATOR="char" This qualifier allows the user to change the column separator character. The default is /SEPARATOR="|". .HEADER LEVEL 3 /UPPER__CASE /[NO]UPPER__CASE If this qualifier is present, MCL converts all text to upper case before writing it to the output file, /NOUPPER__CASE is the default. .HEADER LEVEL 3 /WIDTH /WIDTH=width This qualifier specifies the width of the output page (default=132). .HEADER LEVEL 3 /WRAP /[NO]WRAP If this qualifier is specified, a line which exceeds the page width on the output files will be continued on the following line. The continuation line is flagged with the characters "-->". /NOWRAP causes a long line to be truncated on output. /WRAP is the default.