summaryrefslogtreecommitdiffstatshomepage
path: root/src/lib/netlist/build/man/nltool.1
blob: ac1e70067948a59e88ef6c13edc44b42a922dba0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
.TH NLTOOL "1" "May 2022" "nltool (netlist) 0.14" "User Commands"
.SH NAME
nltool \- manual page for nltool (netlist) 0.14
.SH SYNOPSIS
.B nltool
[\fI\,option\/\fR]... [\fI\,files\/\fR]...
.SH DESCRIPTION
nltool serves as the Swiss Army knife to run, test and convert netlists.
.PP
Commands may accept one or more files depending on the functionality.
If no file is provided, standard input is used.
.SH OPTIONS
.SS "General options:"
.IP
The following options apply to all commands.
.HP
\fB\-c\fR, \fB\-\-cmd\fR=\fI\,run\/\fR|validate|convert|listdevices|listmodels|static|header|docheader|tests
.IP
run|validate|convert|listdevices|listmodels|static|header|docheader|tests
.TP
\fB\-I\fR, \fB\-\-include\fR=\fI\,Value\/\fR
Add the directory to the list of directories to be
searched for header files. This option may be
specified repeatedly.
.TP
\fB\-D\fR, \fB\-\-define\fR=\fI\,Value\/\fR
predefine value as macro, e.g. \fB\-Dname\fR=\fI\,value\/\fR. If
\&'=value' is omitted predefine it as 1. This option
may be specified repeatedly.
.TP
\fB\-r\fR, \fB\-\-rom\fR=\fI\,Value\/\fR
where to look for data files
.TP
\fB\-v\fR, \fB\-\-verbose\fR
be verbose \- this produces lots of output
.TP
\fB\-q\fR, \fB\-\-quiet\fR
be quiet \- no warnings
.TP
\fB\-\-prepro\fR
output preprocessor output to stderr
.TP
\fB\-\-progress\fR
show progress bar on longer operations
.TP
\fB\-\-version\fR
display version and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
display help and exit
.SS "Options for run and static commands:"
.IP
These options apply to run and static commands.
.TP
\fB\-n\fR, \fB\-\-name\fR=\fI\,Value\/\fR
the netlist in file specified by \fB\-f\fR option to run;
default is first one
.SS "Options for static command:"
.IP
These options apply to static command.
.TP
\fB\-d\fR, \fB\-\-dir\fR=\fI\,Value\/\fR
output directory for the generated files.
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,Value\/\fR
single output file for the generated code.
Either \fB\-\-dir\fR or \fB\-\-output\fR can be specificied
.TP
\fB\-\-static_include\fR
write static solvers to individual files included by
file specified with \fB\-\-output\fR. \fB\-\-dir\fR must be path to
"generated/static" path in netlist folder.
.SS "Options for run command:"
.IP
These options are only used by the run command.
.TP
\fB\-t\fR, \fB\-\-time_to_run\fR=\fI\,Value\/\fR
time to run the emulation (seconds)
.TP
\fB\-\-boost_lib\fR=\fI\,Value\/\fR
generic: will use generic solvers.
builtin: Use optimized solvers compiled in.
somelib.so: Use library with precompiled solvers.
.TP
\fB\-s\fR, \fB\-\-statistics\fR
gather runtime statistics
.TP
\fB\-l\fR, \fB\-\-log\fR=\fI\,Value\/\fR
define terminal to log. This option may be specified
repeatedly.
.TP
\fB\-i\fR, \fB\-\-input\fR=\fI\,Value\/\fR
input file to process (default is none)
.TP
\fB\-\-loadstate\fR=\fI\,Value\/\fR
load state from file and continue from there
.TP
\fB\-\-savestate\fR=\fI\,Value\/\fR
save state to file at end of run
.TP
\fB\-\-fperr\fR
raise exception on floating point errors. This is
intended to be used during debugging.
.SS "Options for convert command:"
.IP
These options are only used by the convert command.
.TP
\fB\-y\fR, \fB\-\-type\fR=\fI\,spice\/\fR|eagle|rinf
type of file to be converted: spice,eagle,rinf
.SS "Options for validate command:"
.IP
These options are only used by the validate command.
.SS "Options for header command:"
.IP
These options are only used by the header command.
.TP
\fB\-\-tab\-width\fR=\fI\,Value\/\fR
Tab width for output.
.TP
\fB\-\-line\-width\fR=\fI\,Value\/\fR
Line width for output.
.TP
\fB\-\-pattern\fR=\fI\,Value\/\fR
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.
.SH EXAMPLES
nltool \-c run \-t 3.5 \-n cap_delay nl_examples/cdelay.c
.IP
Run netlist "cap_delay" from file nl_examples/cdelay.c for 3.5
seconds
.PP
nltool \-\-cmd=listdevices
.IP
List all known devices.
.PP
nltool \-\-cmd=header \-\-tab\-width=8 \-\-line\-width=80
.IP
Create the header file needed for including netlists as code.
.PP
nltool \-\-cmd static \-\-output
.IP
src/lib/netlist/generated/static_solvers.cpp
src/mame/audio/nl_*.cpp src/mame/machine/nl_*.cpp
.IP
Create static solvers for the MAME project using one single source
file.
.PP
nltool \-\-cmd static \-\-output
.IP
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
.IP
Create static solvers for the MAME project using a single source
file which includes generated solvers written to \-\-dir folder.
.PP
nltool \-\-cmd tests
.IP
Run unit tests. In case the unit tests are not linked in, this will
do nothing.
.SH AUTHOR
Written by Couriersud.
.SH COPYRIGHT
Copyright \(co 2021 Couriersud
License BSD\-3\-Clause
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
More documentation for the
.B nltool
program is available in doxygen format.