      fnch@users.sourceforge.net

Matteo Franchin 2003Matteo FranchinJuly 22, 2008;

NAME

box — A language to create figures and graphics.

SYNOPSIS

box [-l library ] {-st | source.box }

This is the typical minimal syntax; see below for a list and explanation of the other options.

DESCRIPTION

box compiles a box source file (to bytecode) and executes it. It can read the source from the standard input (with -st) or from the specified file.

OPTIONS

A summary of options is included below:

-h: Show summary of options.
-st | source.box: The user MUST provide either a source file or the option -st. In the latter case the source is read from the standard input.
-l library: Link against the provided C library, before trying to execute the compiled code. When specifying ``-l g'', the library ``libg.so'' (or ``libg.dylib'') is searched, instead.
-L path: Add an additional path to be considered when searching for the libraries specified with the -l option. The option can be used more than once to specify more than one path. The last occurrence has the precedence on the formers and has precedence on the paths specified in the environmental variable ``BOX_LIBRARY_PATH''.
-I path: Add an additional path to be considered when searching for the file included with ``include "file"''. This option can be used more than once to specity more than one path. The last occurrence has the precedence on the formers and on the paths specified with the ``BOX_INCLUDE_PATH'' environmental variable. When using ``include "file"'' in your programs, the files ``file.bxh`` and ``file`` are searched (in this precise order).
-o outfile, -w outfile: Write to outfile a human readable representation of the bytecode produced from the given box source (useful for debugging). Use -w if you want to overwrite existing files, otherwise use -o.
-se setupfile: Include automatically the file setupfile before processing any other line of source.
-t: Compile only. The compiled code will not be linked and executed.
-f: Force execution, even when warning messages were displayed.
-v: Verbose message reports.
-e: Only error messages are reported (no warnings).
-si: Make the Box compiler totally silent.

ENVIRONMENT

These are the environmental variables used by Box:

BOX_LIBRARY_PATH: Add additional search paths for Box libraries. The format is the same as the shell's $PATH: one or more directory pathnames separated by colons. See option -L.
BOX_INCLUDE_PATH: Add additional search paths for Box header files. The format is the same as the shell's $PATH: one or more directory pathnames separated by colons. See option -I.
BOX_DEFAULT_LIBS: A list of libraries which should be always used for linking. The format is the same as the shell's $PATH: one or more library names separated by colons.

AUTHOR

This manual page was written by Matteo Franchin fnch@users.sourceforge.net. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 any later version published by the Free Software Foundation.