Previous topic

2. Download and Install Instructions

Next topic

4. Quick Start Guide

Glossary
Index

3. Command Line InterfaceΒΆ

The following command line is supported by the BCT:

bct [-v] [-h] [-d LEVEL] [-b BSF] [-i BIN] [-a [ABSF]] [-r [ADDR]]
[-o BOUT] [-g] [-n]

where all arguments are optional and have the following meaning:

 -v, --version         Emits version number and exits.

 -h, --help            Show this help message and exits.

 -d LEVEL, --debug LEVEL
                       Turn on LOGFILE messages at a specific log LEVEL which
                       can be one of the following DEBUG, INFO, WARNING,
                       ERROR, or CRITICAL. The default LEVEL is INFO.

 -b BSF, --bsf BSF
                       Specifies the Boot Settings File, BSF. If BSF is used on
                       the command line without specifying BIN or ABSF then BCT
                       opens BSF in the GUI.

 -i BIN, --bin BIN     Specifies the Binary input file, BIN, to be configured.

 -a [ABSF], --absf [ABSF]
                       Specifies the 'As Built' Boot Settings File, ABSF, to
                       create. If ABSF is omitted, then an ABSF will be
                       generated in CLI Mode and named after the BSF except with
                       a .absf file name extension. See CLI Mode below.

 -r [ADDR], --reloc [ADDR]
                       Specifies the relocation load address, ADDR, of BIN
                       which must also be specified via ``--bin`` or ``-i``. The
                       ADDR value must be hexadecimal, with or without the 0x
                       prefix. If ADDR is omitted, then the binary's current load
                       address will be emitted.

 -o BOUT, --bout BOUT  Specifies the binary output file name, BOUT.
 -g, --gui             Forces the graphical user interface to run.
 -n, --info            Displays the description table in the binary, if it has one.

The argument values [ABSF] and [ADDR] are optional.

CLI Mode
The following argument signatures will cause BCT to execute in command line mode
without a GUI, unless the --gui option is also specified:

  (--bin|-i) BIN (--bsf|-b) BSF [(--reloc|-r) ADDR] [(--bout|-o) BOUT]
       Patch binary BIN using setting in BSF, optionally rebase with load
       address ADDR and specify output file BOUT. An ABSF will be created with the same
       filename as BSF except with a .absf extension. If BOUT is omitted then BCT
       creates a new binary with the same filename as BIN except with a .rom extension.
       Please not that if you want to rebase the load address, a valid address must be
       specified. It is not optional in this case.

  (--bin|-i) BIN (--absf|-a) [ABSF] [(--reloc|-r) ADDR] [(--bout|-o) BOUT]
       Patch binary BIN using the settings in ABSF, optionally rebase with load
       address ADDR and specify output file BOUT. If ABSF is omitted, BCT will
       attempt to use an ABSF file with a path generated from BIN's filename with a
       .absf extension. If BOUT is omitted then BCT creates a new binary with the same
       filename as BIN except with a .rom extension. Please not that if you want to
       rebase the load address, a valid address must be specified. It is not optional
       in this case.

  (--bin|-i) BIN (--reloc|-r) [ADDR] [(--bout|-o) BOUT]
       Relocate the base address of the binary specified by BIN and save it as BOUT.
       If ADDR is omitted, then the current base address of BIN is printed. If BOUT
       is omitted then BIN will be over-written with the new base address.

  (--bsf|-b) BSF (--absf|-a) [ABSF]
       Create an ABSF file from a BSF file, using the defaults specified in BSF.
       If ABSF is omitted, then an ABSF file is created with the name of the BSF with
       a .absf extension, otherwise BCT saves to ABSF.

   (--bin|-i) BIN (--info|-n)
       Print the description table that's in BIN, if it has any.