# NLTOOL

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
EXAMPLES
AUTHOR
COPYRIGHT
SEE ALSO

## NAME

nltool − manual page for nltool (netlist) 0.14

## SYNOPSIS

nltool [option]... [files]...

## DESCRIPTION

nltool serves as the Swiss Army knife to run, test and convert netlists.

Commands may accept one or more files depending on the functionality. If no file is provided, standard input is used.

## OPTIONS

General options:

The following options apply to all commands.

| −c, −−cmd=run|validate|convert|listdevices|listmodels|static|header|docheader|tests

run|validate|convert|listdevices|listmodels|static|header|docheader|tests

−I, −−include=Value

Add the directory to the list of directories to be searched for header files. This option may be specified repeatedly.

−D, −−define=Value

predefine value as macro, e.g. −Dname=value. If ’=value’ is omitted predefine it as 1. This option may be specified repeatedly.

−r, −−rom=Value

where to look for data files

−v, −−verbose

be verbose − this produces lots of output

−q, −−quiet

be quiet − no warnings

−−prepro

output preprocessor output to stderr

−−progress

show progress bar on longer operations

−−version

display version and exit

−h, −−help

display help and exit

Options for run and static commands:

These options apply to run and static commands.

−n, −−name=Value

the netlist in file specified by −f option to run; default is first one

Options for static command:

These options apply to static command.

−d, −−dir=Value

output directory for the generated files.

−o, −−output=Value

single output file for the generated code. Either −−dir or −−output can be specificied

−−static_include

write static solvers to individual files included by file specified with −−output. −−dir must be path to "generated/static" path in netlist folder.

Options for run command:

These options are only used by the run command.

−t, −−time_to_run=Value

time to run the emulation (seconds)

−−boost_lib=Value

generic: will use generic solvers. builtin: Use optimized solvers compiled in. somelib.so: Use library with precompiled solvers.

−s, −−statistics

gather runtime statistics

−l, −−log=Value

define terminal to log. This option may be specified repeatedly.

−i, −−input=Value

input file to process (default is none)

−−loadstate=Value

load state from file and continue from there

−−savestate=Value

save state to file at end of run

−−fperr

raise exception on floating point errors. This is intended to be used during debugging.

Options for convert command:

These options are only used by the convert command.

−y, −−type=spice|eagle|rinf

type of file to be converted: spice,eagle,rinf

Options for validate command:

These options are only used by the validate command.

Options for header command:

These options are only used by the header command.

−−tab−width=Value

Tab width for output.

−−line−width=Value

Line width for output.

−−pattern=Value

Pattern to match against device names. If the device name contains pattern, the device will be included in the output. Multiple patterns can be specified, if none is given, all devices will be output.

## EXAMPLES

nltool −c run −t 3.5 −n cap_delay nl_examples/cdelay.c

Run netlist "cap_delay" from file nl_examples/cdelay.c for 3.5 seconds

nltool −−cmd=listdevices

List all known devices.

nltool −−cmd=header −−tab−width=8 −−line−width=80

Create the header file needed for including netlists as code.

nltool −−cmd static −−output

src/lib/netlist/generated/static_solvers.cpp src/mame/audio/nl_*.cpp src/mame/machine/nl_*.cpp

Create static solvers for the MAME project using one single source file.

nltool −−cmd static −−output

src/lib/netlist/generated/static_solvers.cpp −−dir src/lib/netlist/generated/static −−static_include src/mame/audio/nl_*.cpp src/mame/machine/nl_*.cpp

Create static solvers for the MAME project using a single source file which includes generated solvers written to −−dir folder.

nltool −−cmd tests

Run unit tests. In case the unit tests are not linked in, this will do nothing.

## AUTHOR

Written by Couriersud.

## COPYRIGHT

Copyright © 2021 Couriersud License BSD−3−Clause
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

## SEE ALSO

More documentation for the nltool program is available in doxygen format.