boxenv User Commands (cmd)

quickify

Usage (Normal Mode)

quickify < input-file > output-file

Usage (Preference Mode)

quickify pref < input-file > embedded-prefs

Description:

quickify is a tool to enable you to make source codes (especially C source codes) that automatically customize based on preference files and other factors. It's output is that customized file you want, and it's input is a blueprint file that specifies, line by line, what should be on that output file.

Every line in the Blueprint File beginning with a dash ("-") is known as a Full Line. That means that everything on the line (following, but not including the initial dash) is to appear in the Output File, followed by a newline character ("\n").

Every line in the Blueprint File beginning with an asteriek ("*") is known as a Partial Line. That means that everything on the line (following, but not including the initial asteriek) is to appear in the Output File. However, unlike a Full Line, these contents will not be followed by a newline character.

Every line in the Blueprint File beginning with the character "e" is known as an Environment Line. That means that following the "e" is the name of an environment variable, who's contents will appear in the Output File.

Every line in the Blueprint File beginning with the character "s" is known as a Space Line. This means that following the initial "s" is a number. That number of blankspace characters (" ") are to appear in the Output File. This type of line is necessary because every line of the Blueprint File is only read in from the first printable character to the last. Therefore, sometimes, this is the only way to insert blank spaces where they need to be.

Every line in the Blueprint File beginning with the character "t" is known as a Tab Line. Tab Lines are just like Space Lines, only they output tab-spaces instead of regular blank-spaces. They were implemented on 2003-04-22 to make it easier to write Blueprint Files for Makefiles.

Every line in the Blueprint File beginning with a dollar sign ("$") is known as a Command Line. That means that following the initial dollar sign is a Shell Command who's output is to appear in the Output File.

Every line in the Blueprint File beginning with a slash ("/") is known as a Preference Line. The line is to be interpreted just the same way as it would be without the initial slash, with one difference, that being that this line is only used when quickify is run in Preference Mode. Without the slash, the line would be used only when quickify is run in Normal Mode. The output formed by quickify in Preference Mode is used by quicktrans to know what special variables must be set before running quickify in Normal Mode.

Every line in the Blueprint File beginning with a pound symbol ("#") is known as a Comment Line. The comment line is skipped over by quickify just like any other unsupported type of line. The only difference is that a Comment Line is guaranteed not to have meaning to future versions of quickify earlier, therefore allowing you to put comment lines into your quickify Blueprint Files without fear of them causing conflicts with later versions.