regfmt 0.9.1

A command line utility to generate SVG diagrams for control register-style data formats.

regfmt

regfmt is a command line utility to generate SVG diagrams for control register-style data formats. It is inspired by the dformat command from the troff family of tools, however re-imagined using contemporary (circa 2022) file formats.

Example output SVG:

Features

• SVG output
• Modern configuration input file formats
  • YAML for register configuration
  • CSS for styling SVG output

Usage

usage: regfmt [-h] [-v] [-o OUTPUT] [-s STYLE] [-t {yaml,css,yamlcss}] [input]

regfmt - generate SVG diagrams of control register-style data formats

positional arguments:
  input                 input register format YAML file (default: input.yaml)

options:
  -h, --help            show this help message and exit
  -v, --version         print version information and exit
  -o OUTPUT, --output OUTPUT
                        output file (default: '-' for stdout)
  -s STYLE, --style STYLE
                        CSS style file
  -t {yaml,css,yamlcss}, --template {yaml,css,yamlcss}
                        Generate template YAML and/or CSS files