1VRQ(1)                           User Commands                          VRQ(1)
2
3
4

NAME

6       Vrq - manual page for Vrq 1.0.134,
7

SYNOPSIS

9       vrq [options] <file1> [<file2>...]
10

DESCRIPTION

12       'Vrq' is a framework for creating verilog based tools.
13

OPTIONS

15       --version
16              Print version
17
18       --help This message
19
20       --bindir
21              Binary install path
22
23       --libdir
24              Library install path
25
26       --pkglibdir
27              Plugin install path
28
29       --includedir
30              Include install path
31
32       --cflags
33              Compiler flags used
34
35       --ldflags
36              Linker flags used
37
38       --libs Libraries used
39
40       --randomizeheap
41              Randomize heap
42
43       -V     Verbose
44
45       -y <directory>
46              Search directory for module definitions
47
48       -f <filename>
49              Read options from <filename>
50
51       -v <lib_filename>
52              Search file for module definitions
53
54       -l <filename>
55              Set log file to <filename>
56
57       -w <message>=<policy>
58              Set  policy  for warning <message> to <policy>; ignore, warning,
59              error, info
60
61       -w all=<policy>
62              Set policy for all warnings to <policy>; ignore, warning, error,
63              info
64
65       -wl    List all warning messages
66
67       +libext+<extension>
68              Specify library suffix to <extension>
69
70       -sv    Enable System Verilog support
71
72       -dump  Dump internal tree
73
74       -debug Print debug/statistics info
75
76       -quiet Print minimal runtime info
77
78       -lexbuffersize <bufferSize> Set lexer buffer size (default=1048576)
79
80       -infervectors
81              Infer reg and wire vectors
82
83       -keeptickdefines
84              Best effort attempt to keep tick defines and `include statements
85              in code (EXPERIMENTAL)
86
87       -macrocheck
88              Do not allow undefined macros
89
90       -o <filename>
91              Specify output file
92
93       -dir <directory>
94              Specify output directory
95
96       -pragma <regexp>
97              Extended regular expression template for pragma comments
98
99       -passthru <name>
100              Pass through ifdef blocks with label
101
102       +incdir+<directory>
103              Specify include search path
104
105       +define+<name>=<value>
106              Define `define
107
108       +<name>+<value>
109              Define plusargs
110
111       -tool builder
112              Auto route hierarchy
113
114       -tool coverage
115              Add line coverage instrumentation
116
117       -tool dump
118              Print verilog output
119
120       -tool filter
121              Extract elements of hierarchy
122
123       -tool flatten
124              Reduce to single level hiearchy
125
126       -tool rectify
127              Replace all X constants with 0 or 1
128
129       -tool sim
130              Verilog simulator
131
132       -tool stats
133              Print summary of hiearchy
134
135       -tool xprop
136              Add X propagation instrumentation
137
138       * 'builder' Options
139
140       +tree_ext=<ext>
141              File extension for files to be expanded
142
143       +depend=<filename>
144              Generate dependency info
145
146       +builder-verbose
147              Dump vebose log of actions
148
149       * 'coverage' Options
150
151       +coverage_output_file=<filename> Filename  for  coverage  line  mapping
152              info
153
154       * 'dump' Options
155
156       +dump-alt-rxnor
157              Use alternate rxnor op ^~
158
159       +dump-fps
160              Force part selects on all vectors
161
162       +dump-fvl
163              Convert all logical ops to vector ops
164
165       +dump-fcc
166              Convert all comments to c++ style
167
168       +dump-swda
169              Split wire declaration assignments
170
171       +dump-fbae
172              Force begin/end block after event statement
173
174       +dump-nns
175              Replace null statements with begin/end pairs
176
177       +dump-sabo
178              Add spaces around binary operators
179
180       +dump-ced
181              Create explicit declarations for implicitly declared variables
182
183       +dump-strip-attr
184              strip out all attributes
185
186       +dump-timescale=<timescale>  emit `timescale <timescale> statements for
187              all modules missing `timescale declarations
188
189       +dump-simplify
190              Simplify constant expressions (EXPERIMENTAL)
191
192       * 'filter' Options
193
194       +filter-default-policy-keep keep all element by default
195
196       +filter-default-policy-delete  delete  all  element  by  default  (tool
197              default behavior)
198
199       +filter-comment-keep
200              keep comment
201
202       +filter-comment-delete
203              delete comment
204
205       +filter-vrq-keep
206              keep vrq comment
207
208       +filter-vrq-delete
209              delete vrq comment
210
211       +filter-pragma-keep
212              keep program pragma
213
214       +filter-pragma-delete
215              delete program pragma
216
217       +filter-instance-ref-keep
218              keep instance reference
219
220       +filter-instance-ref-delete delete instance reference
221
222       +filter-gate-ref-keep
223              keep gate instance
224
225       +filter-gate-ref-delete
226              delete gate instance
227
228       +filter-task-enable-keep
229              keep call to a task
230
231       +filter-task-enable-delete delete call to a task
232
233       +filter-systask-call-keep
234              keep call to enable a systask
235
236       +filter-systask-call-delete delete call to enable a systask
237
238       +filter-timing-call-keep
239              keep call to a timing task
240
241       +filter-timing-call-delete delete call to a timing task
242
243       +filter-function-call-keep keep call to a function
244
245       +filter-function-call-delete delete call to a function
246
247       +filter-enum-ref-keep
248              keep reference to a enum
249
250       +filter-enum-ref-delete
251              delete reference to a enum
252
253       +filter-type-ref-keep
254              keep reference to a type
255
256       +filter-type-ref-delete
257              delete reference to a type
258
259       +filter-net-decl-keep
260              keep net declaration
261
262       +filter-net-decl-delete
263              delete net declaration
264
265       +filter-var-decl-keep
266              keep variable declaration
267
268       +filter-var-decl-delete
269              delete variable declaration
270
271       +filter-param-decl-keep
272              keep parameter declaration
273
274       +filter-param-decl-delete
275              delete parameter declaration
276
277       +filter-specparam-decl-keep keep specify parameter declaration
278
279       +filter-specparam-decl-delete delete specify parameter declaration
280
281       +filter-port-decl-keep
282              keep port declaration
283
284       +filter-port-decl-delete
285              delete port declaration
286
287       +filter-genvar-decl-keep
288              keep genvar declaration
289
290       +filter-genvar-decl-delete delete genvar declaration
291
292       +filter-typedef-decl-keep
293              keep type declaration
294
295       +filter-typedef-decl-delete delete type declaration
296
297       +filter-init-keep
298              keep initial block
299
300       +filter-init-delete
301              delete initial block
302
303       +filter-always-keep
304              keep always block
305
306       +filter-always-delete
307              delete always block
308
309       +filter-always-latch-keep
310              keep always latch block
311
312       +filter-always-latch-delete delete always latch block
313
314       +filter-always-ff-keep
315              keep always flip-flop block
316
317       +filter-always-ff-delete
318              delete always flip-flop block
319
320       +filter-always-comb-keep
321              keep always combinational logic block
322
323       +filter-always-comb-delete delete always combinational logic block
324
325       +filter-specify-ref-keep
326              keep specify block
327
328       +filter-specify-ref-delete delete specify block
329
330       +filter-assign-keep
331              keep procedural assignment
332
333       +filter-assign-delete
334              delete procedural assignment
335
336       +filter-gassign-keep
337              keep generate intialize assignment
338
339       +filter-gassign-delete
340              delete generate intialize assignment
341
342       +filter-add-assign-keep
343              keep procedural assignment with add
344
345       +filter-add-assign-delete
346              delete procedural assignment with add
347
348       +filter-sub-assign-keep
349              keep procedural assignment with subtract
350
351       +filter-sub-assign-delete
352              delete procedural assignment with subtract
353
354       +filter-mul-assign-keep
355              keep procedural assignment with mul
356
357       +filter-mul-assign-delete
358              delete procedural assignment with mul
359
360       +filter-div-assign-keep
361              keep procedural assignment with div
362
363       +filter-div-assign-delete
364              delete procedural assignment with div
365
366       +filter-mod-assign-keep
367              keep procedural assignment with mod
368
369       +filter-mod-assign-delete
370              delete procedural assignment with mod
371
372       +filter-and-assign-keep
373              keep procedural assignment with bitwise and
374
375       +filter-and-assign-delete
376              delete procedural assignment with bitwise and
377
378       +filter-or-assign-keep
379              keep procedural assignment with bitwise or
380
381       +filter-or-assign-delete
382              delete procedural assignment with bitwise or
383
384       +filter-xor-assign-keep
385              keep procedural assignment with bitwise xor
386
387       +filter-xor-assign-delete
388              delete procedural assignment with bitwise xor
389
390       +filter-lsh-assign-keep
391              keep procedural assignment with left shift
392
393       +filter-lsh-assign-delete
394              delete procedural assignment with left shift
395
396       +filter-rsh-assign-keep
397              keep procedural assignment with right shift
398
399       +filter-rsh-assign-delete
400              delete procedural assignment with right shift
401
402       +filter-lsha-assign-keep
403              keep procedural assignment with left arithmetic shift
404
405       +filter-lsha-assign-delete   delete  procedural  assignment  with  left
406              arithmetic shift
407
408       +filter-rsha-assign-keep
409              keep procedural assignment with right arithmetic shift
410
411       +filter-rsha-assign-delete  delete  procedural  assignment  with  right
412              arithmetic shift
413
414       +filter-force-keep
415              keep force statement
416
417       +filter-force-delete
418              delete force statement
419
420       +filter-release-keep
421              keep release statement
422
423       +filter-release-delete
424              delete release statement
425
426       +filter-nbassign-keep
427              keep nonblocking assignment
428
429       +filter-nbassign-delete
430              delete nonblocking assignment
431
432       +filter-if-keep
433              keep if statement
434
435       +filter-if-delete
436              delete if statement
437
438       +filter-forever-keep
439              keep forever statement
440
441       +filter-forever-delete
442              delete forever statement
443
444       +filter-repeat-keep
445              keep repeat statement
446
447       +filter-repeat-delete
448              delete repeat statement
449
450       +filter-while-keep
451              keep while statement
452
453       +filter-while-delete
454              delete while statement
455
456       +filter-wait-keep
457              keep wait statement
458
459       +filter-wait-delete
460              delete wait statement
461
462       +filter-for-keep
463              keep for statement
464
465       +filter-for-delete
466              delete for statement
467
468       +filter-case-keep
469              keep case statement
470
471       +filter-case-delete
472              delete case statement
473
474       +filter-casex-keep
475              keep casex statement
476
477       +filter-casex-delete
478              delete casex statement
479
480       +filter-casez-keep
481              keep casez statement
482
483       +filter-casez-delete
484              delete casez statement
485
486       +filter-cassign-keep
487              keep continious assignment
488
489       +filter-cassign-delete
490              delete continious assignment
491
492       +filter-import-keep
493              keep import item
494
495       +filter-import-delete
496              delete import item
497
498       +filter-function-def-keep
499              keep function definition
500
501       +filter-function-def-delete delete function definition
502
503       +filter-module-def-keep
504              keep module definition
505
506       +filter-module-def-delete
507              delete module definition
508
509       +filter-package-def-keep
510              keep package definition
511
512       +filter-package-def-delete delete package definition
513
514       +filter-port-def-keep
515              keep port definition
516
517       +filter-port-def-delete
518              delete port definition
519
520       +filter-defparam-keep
521              keep defparam statement
522
523       +filter-defparam-delete
524              delete defparam statement
525
526       +filter-path-keep
527              keep path statement
528
529       +filter-path-delete
530              delete path statement
531
532       +filter-trigger-keep
533              keep event trigger
534
535       +filter-trigger-delete
536              delete event trigger
537
538       +filter-passign-keep
539              keep procedural assignment
540
541       +filter-passign-delete
542              delete procedural assignment
543
544       +filter-deassign-keep
545              keep deassign statement
546
547       +filter-deassign-delete
548              delete deassign statement
549
550       +filter-disable-keep
551              keep disable statement
552
553       +filter-disable-delete
554              delete disable statement
555
556       +filter-attribute-keep
557              keep attribute specification
558
559       +filter-attribute-delete
560              delete attribute specification
561
562       +filter-gif-keep
563              keep structural if statement
564
565       +filter-gif-delete
566              delete structural if statement
567
568       +filter-gfor-keep
569              keep structural for statement
570
571       +filter-gfor-delete
572              delete structural for statement
573
574       +filter-gcase-keep
575              keep structural case statement
576
577       +filter-gcase-delete
578              delete structural case statement
579
580       +filter-table-keep
581              keep udp table
582
583       +filter-table-delete
584              delete udp table
585
586       +filter-enum-spec-keep
587              keep enum specification
588
589       +filter-enum-spec-delete
590              delete enum specification
591
592       +filter-member-keep
593              keep member reference (structure, class or external
594
595       +filter-member-delete
596              delete member reference (structure, class or external
597
598       +filter-return-keep
599              keep return
600
601       +filter-return-delete
602              delete return
603
604       +filter-preinc-keep
605              keep preincrement
606
607       +filter-preinc-delete
608              delete preincrement
609
610       +filter-postinc-keep
611              keep postincrement
612
613       +filter-postinc-delete
614              delete postincrement
615
616       +filter-predec-keep
617              keep predecrement
618
619       +filter-predec-delete
620              delete predecrement
621
622       +filter-postdec-keep
623              keep postdecrement
624
625       +filter-postdec-delete
626              delete postdecrement
627
628       +filter-cast-keep
629              keep data type change
630
631       +filter-cast-delete
632              delete data type change
633
634       +filter-assignment-pattern-keep keep assignment_pattern
635
636       +filter-assignment-pattern-delete delete assignment_pattern
637
638       +filter-dollar-keep
639              keep queue dimension
640
641       +filter-dollar-delete
642              delete queue dimension
643
644       * 'rectify' Options
645
646       +rectify-default-value={0|1} change default replacement value
647
648       +rectify-attribute-name=<attrName>  attribute  name  used  to  override
649              default replacement value
650
651       +rectify-delete-decl-pragmas delete pragmas attached to declarations
652
653       * 'sim' Options
654
655       +sim-interactive
656              start simulation in interactive mode only
657
658       +sim-compile-only
659              do not simulate, compile only
660
661       +sim-trace
662              enable execution tracing
663
664       +sim-mindelays
665              use minimum delays
666
667       +sim-typdelays
668              use typical delays
669
670       +sim-maxdelays
671              use maximum delays
672
673       +sim-pli=pliLib1+pliLib2+... load pli librarys
674
675       +sim-log=file
676              use file for logging
677
678       +sim-key=file
679              use file for key stroke log
680
681       * 'xprop' Options
682
683       +xprop-begin=<pragma>
684              insertion begin pragma
685
686       +xprop-end=<pragma>
687              insertion end pragma
688
689       +xprop-clk-begin=<pragma>
690              insertion clock begin pragma
691
692       +xprop-clk-end=<pragma>
693              insertion clock end pragma
694
695       +xprop-disable-task
696              disable task output instrumentation
697
698       +xprop-disable-if
699              disable if instrumentation
700
701       +xprop-disable-case
702              disable case instrumentation
703
704       +xprop-disable-index
705              disable reference instrumentation
706
707       +xprop-disable-ternary
708              disable '?' instrumentation
709
710       +xprop-nox-attr=<name>
711              attribute specifing variable will never be x
712
713       +xprop-int-nox
714              declare integers will never be x
715
716       +xprop-enable-clock
717              instrument register clocks
718
719       +xprop-clk-edge-control=[!]<tickdefine>  Supply  a  preprocessor   tick
720              define  to  enable instrumentation on both edges of the clock. !
721              indicates tickdefine disables both edges. If switch  isn't  sup‐
722              plied  the  behavior  is  single edge unless XPROP_BOTH_EDGES is
723              defined
724

AUTHOR

726       Written by Mark Hummel
727

REPORTING BUGS

729       Report bugs at <http://sourceforge.net/projects/vrq>
730
732       Copyright © 1997-2009 Mark Hummel
733
734       Vrq comes with ABSOLUTELY NO WARRANTY; This is free software,  and  you
735       are  welcome to redistribute it under the terms of the GNU General Pub‐
736       lic License as published by the Free Software Foundation;  either  ver‐
737       sion 2 of the License, or (at your option) any later version.
738
739
740
741Vrq 1.0.134,                    September 2019                          VRQ(1)
Impressum