Command Line Options

Command Line Options#

PeakRDL-rawheader registers a raw-header subcommand with the PeakRDL command line tool:

peakrdl raw-header <input.rdl> -o <output> [options]

In addition to the standard PeakRDL arguments (such as -o/--output for the output path), the following exporter-specific options are available.

--format {c,svh,svpkg,ldh}#

Select the built-in output format. Defaults to c. See Output Formats for a description of each. Ignored when --template is given.

--template <path>#

Path to a custom Mako template file to render instead of the built-in formats. See Custom Templates.

--base-name <name>#

Custom prefix for the generated symbols and the include guard. Defaults to the name of the top-level addrmap. Mutually exclusive with --no-prefix.

--no-prefix#

Omit the top-level addrmap name from the generated symbol names. Mutually exclusive with --base-name.

--license-str <string>#

License string to embed at the top of the generated file. Literal \n sequences are converted to newlines, so multi-line license headers can be passed on the command line.

--ldh-no-memory#

Only meaningful with --format ldh. Suppresses emission of the MEMORY { ... } regions.

--ldh-no-symbols#

Only meaningful with --format ldh. Suppresses emission of the PROVIDE(...) symbols.

Note

The deprecated aliases --base_name and --license_str (with underscores) are still accepted for backward compatibility, but --base-name and --license-str should be used instead.