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

NAME

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

AUTHOR

683       Written by Mark Hummel
684

REPORTING BUGS

686       Report bugs at <http://sourceforge.net/projects/vrq>
687
689       Copyright © 1997-2009 Mark Hummel
690
691       Vrq comes with ABSOLUTELY NO WARRANTY; This is free software,  and  you
692       are  welcome to redistribute it under the terms of the GNU General Pub‐
693       lic License as published by the Free Software Foundation;  either  ver‐
694       sion 2 of the License, or (at your option) any later version.
695
696
697
698Vrq 1.0.88,                        July 2011                            VRQ(1)
Impressum