Boxenator documentation
Boxenator generates Portage configuration files based on Python specification scripts which use Boxenator functions to provide output. Boxenator specifications, whether in files or from standard input, are Python scripts. Before they are executed, a global boxenator.Context instance, box, is defined. All specifications are made through its attributes and methods, as described in its class reference.
Command line options
Usage: boxenator [options] [FILE [...]]
If no spec FILEs are named on the command line, or if "-" is encountered, the standard input is read interactively. When reading standard input, no errors are fatal and only box.abort () causes an exit without output.
Output is divided into various target configuration files. Desired targets may be specified by their base file names using --target. If no targets are named, all targets are output. By default, target files are sent to standard output.
- -h, --help
- Displays a help message and exits.
- -D PARAM[=VALUE]
- Predefines a parameter PARAM to VALUE. If no VALUE is provided, the PARAM is set to
True. All predefines are done before any specifications are processed. - -t TARGET, --target=TARGET
- Includes a target TARGET in output. The targets are output in named order.
- -F, --files
- Outputs targets to files in appropriate subdirectories of the destination PATH.
- -S, --shallow
- Outputs targets to files in the destination PATH directory.
- -d PATH, --destination=PATH
- If applicable, outputs targets in the specified PATH. By default, output to the current directory.
- -v, --verbose
- Lists spec files and targets as they are processed.
- -f, --force
- Prints only a warning when referenced packages, categories, etc. do not actually exist. By default, the program is terminated.
- -w, --world
- Following any target output, install any packages in the world set that are not currently installed. Root access is required. Applies to the live configuration at / regardless of any specified destination PATH. If specified without any TARGETs or spec FILEs, this is the only action performed.