banvax {cgwtools}

Function print a text banner in the style of the original DEC VAX "banner" function.

Description

This function takes a character string and writes the same characters as large block-letters into a text file.

Usage

 
banvax(msg, file = 'banner.txt',  linewid = 80, bandat = cgwtools::ascarr)

Arguments

msg

A character string. See the Details section for the behavior for nonmatching characters.

file

A character string identifying an output file, or a connection as described in the help page for cat .

linewid

Defines the max number of characters per line. Change from the default value of 80 depending on the display or paper size in use.

bandat

The data array to use for the banner elements. In general, must be a 3-dimensional array with dimensions [x,y,N] where each n-th layer contains the banner form of one character. See the Details section.

Details

The supplied data file ascarr contains all letters and numerals and a bunch of punctuation marks such as " ;" , "," "\" , etc. If a character in the input is not found in the file, a "box" is used in its place. If a user-supplied file is specified, note that each layer of the [x,y,N] array must have a name equal to the character to be invoked. Here x specifies the number of columns and y the number of rows in each banner-element.

The function cat generates the output, so setting the argument file to "" will direct the output to the console. Quoting from the help page for cat, ' If "" (the default), cat prints to the standard output connection, the console unless redirected by sink. If it is "|cmd", the output is piped to the command given by cmd , by opening a pipe connection. '

Value

Nothing is returned from the function. The output is a file or whatever connection is specified by the file argument.

Author(s)

Author and Maintainer:Carl Witthoft [e-mail]

References

https://www0.mi.infn.it/~calcolo/OpenVMS/ssb71/6015/6017p041.htm#index_x_2757