1GTKWAVERC(5)              GTKWave Configuration File              GTKWAVERC(5)
2
3
4

NAME

6       gtkwaverc - GTKWave Configuration File
7

SYNTAX

9       option <value>
10
11       The  configuration file is a series of option and value pairs.  Comment
12       lines marked with an initial  '#'  character  are  permissible.   Blank
13       lines are ignored.
14

DESCRIPTION

16       Configuration  file for gtkwave(1).  The search path for the configura‐
17       tion file (if unspecified) is the current working directory followed by
18       the user's home directory.
19

OPTIONS

21       accel <"pathvalue" accelerator>
22              This allows replacement of menu accelerator keys.  See the .gtk‐
23              waverc file in the source distribution for examples on pathvalue
24              and accelerator syntax.  The special accelerator value of (null)
25              means that no accelerator is bound to the menu item.
26
27       alt_hier_delimeter <value>
28              This allows another character in addition to the  hier_delimeter
29              to  be used to delimit levels in the hierarchy for VCD. Only the
30              first character in the value is significant. Note that  this  is
31              normally  off. The intended use is to resolve the hierarchies of
32              netlist based models that often contain slashes to delimit hier‐
33              archy inside of $var statements.
34
35       alt_wheel_mode <value>
36              Default is on.  Scrollwheel alone pans along a quarter at a time
37              rather than a full page, so  you  don't  get  lost.   Ctrl+wheel
38              zooms  in/out  around  the mouse cursor position, not the marker
39              position.  Alt+wheel edges left/right  based  on  the  currently
40              selected signal.  This makes measuring deltas easier.
41
42       analog_redraw_skip_count <value>
43              Specifies  how many overlapping analog segments can be drawn for
44              a given X position onscreen.  (Default: 20)  If there  are  gaps
45              in analog traces, this value is too low.
46
47       append_vcd_hier <value>
48              Allows  the  specification  of a prefix hierarchy for VCD files.
49              This can be done in "pieces," so that multiple layers of hierar‐
50              chy  are  prepended  to  symbol  names with the most significant
51              addition occurring first (see .gtkwaverc  in  the   examples/vcd
52              directory).  The  intended use of this is to have the ability to
53              add "project" prefixes which allow easier  selection  of  every‐
54              thing from the tree hierarchy.
55
56       atomic_vectors <value>
57              Speeds  up  vcd loading and takes up less memory. This option is
58              deprecated; it is currently the default.
59
60       autocoalesce <value>
61              A nonzero value  enables  autocoalescing  of  VCD  vectors  when
62              applicable.  This  may be toggled dynamically during wave viewer
63              usage.
64
65       autocoalesce_reversal <value>
66              causes split vectors to be reconstructed in reverse order  (only
67              if autocoalesce is also active).
68
69       autoname_bundles <value>
70              A  nonzero value indicates that GTKWave will create its own bun‐
71              dle names rather than prompting the user for them.
72
73       clipboard_mouseover <value>
74              A nonzero value indicates that when mouseover  is  enabled,  all
75              values  generated  for the tooltips will be automatically copied
76              into the clipboard so they may be  pasted  into  other  programs
77              such as text editors, etc.
78
79       color_0 <value>
80              trace color when 0.
81
82       color_1 <value>
83              trace color when 1.
84
85       color_1fill <value>
86              trace color (inside of box) when 1.
87
88       color_back <value>
89              background color.
90
91       color_baseline <value>
92              middle mouse button marker color.
93
94       color_black <value>
95              color value for "black" in signal window.
96
97       color_brkred <value>
98              brick red color for comments.
99
100       color_dash <value>
101              trace color when don't care ("-").
102
103       color_dashfill <value>
104              trace color (inside of box) when don't care ("-").
105
106       color_dkblue <value>
107              color value for "dark blue" in signal window.
108
109       color_dkgray <value>
110              color value for "dark gray" in signal window.
111
112       color_gmstrd <value>
113              color value for trace groupings.
114
115       color_grid <value>
116              grid  color  (use Alt-G/Shift-Alt-G to show/hide grid).  This is
117              also the color used for highlight_wavewindow when enabled.
118
119       color_grid2 <value>
120              grid color for secondary pattern search.
121
122       color_high <value>
123              trace color when high ("H").
124
125       color_highfill <value>
126              trace color (inside of box) when high ("H").
127
128       color_low <value>
129              trace color when low ("L").
130
131       color_ltblue <value>
132              color for shadowed traces.
133
134       color_ltgray <value>
135              color value for "light gray" in signal window.
136
137       color_mark <value>
138              color of the named markers.
139
140       color_mdgray <value>
141              color value for "medium gray" in signal window.
142
143       color_mid <value>
144              trace color when floating ("Z").
145
146       color_normal <value>
147              color value for "normal" GTK state in signal window.
148
149       color_time <value>
150              text color for timebar.
151
152       color_timeb <value>
153              text color for timebar's background.
154
155       color_trans <value>
156              trace color when transitioning.
157
158       color_u <value>
159              trace color when undefined ("U").
160
161       color_ufill <value>
162              trace color (inside of box) when undefined ("U").
163
164       color_umark <value>
165              color of the unnamed (primary) marker.
166
167       color_value <value>
168              text color for vector values.
169
170       color_vbox <value>
171              vector color (horizontal).
172
173       color_vtrans <value>
174              vector color (verticals/transitions).
175
176       color_w <value>
177              trace color when weak ("W").
178
179       color_wfill <value>
180              trace color (inside of box) when weak ("W").
181
182       color_white <value>
183              color value for "white" in signal window.
184
185       color_x <value>
186              trace color when undefined ("X") (collision for VHDL).
187
188       color_xfill <value>
189              trace color (inside of box) when undefined ("X") (collision  for
190              VHDL).
191
192       constant_marker_update <value>
193              A  nonzero  value indicates that the values for traces listed in
194              the signal window are to be updated  constantly  when  the  left
195              mouse  button  is  being  held  down rather than only when it is
196              first pressed then when released (which is the default).
197
198       context_tabposition <value>
199              Use zero for tabbed viewing with named tabs at the top.  Nonzero
200              places numerically indexed tabs at the left.
201
202       convert_to_reals <value>
203              Converts all integer and parameter VCD declarations to real-val‐
204              ued ones when set to a nonzero/yes value. The positive aspect of
205              this  is that integers and parameters will take up less space in
206              memory and will automatically display  in  decimal  format.  The
207              negative  aspect  of  this  is that integers and parameters will
208              only be displayable as  decimals  and  can't  be  bit  reversed,
209              inverted, etc.
210
211       cursor_snap <value>
212              A nonzero value indicates the number of pixels the marker should
213              snap to for the nearest signal transition.
214
215       disable_ae2_alias <value>
216              A nonzero value indicates that the AE2 loader is to  ignore  the
217              aliasdb keyword and is not to construct facility aliases.
218
219       disable_auto_comphier <value>
220              A  nonzero  value  indicates  that the loaders that support com‐
221              pressed hierarchies should not automatically turn on compression
222              if the threshold count of signals (500000) has been reached.
223
224       disable_empty_gui <value>
225              A  nonzero  value indicates that if gtkwave is invoked without a
226              dumpfile name, then an empty  gtkwave  session  is  to  be  sup‐
227              pressed.   Default is a zero value: to bring up an empty session
228              which needs a file loaded or dragged into it.
229
230       disable_mouseover <value>
231              A nonzero value indicates that signal/value tooltip pop up  bub‐
232              bles  on  mouse  button  presses should be disabled in the value
233              window. A zero value indicates that  value  tooltips  should  be
234              active (default is disabled).
235
236       disable_tooltips <value>
237              A  nonzero value indicates that tooltip pop up bubbles should be
238              disabled. A zero value indicates that tooltips should be  active
239              (default).
240
241       do_initial_zoom_fit <value>
242              A  nonzero  value  indicates  that the trace should initially be
243              crunched to fit the screen. A zero value indicates that the ini‐
244              tial zoom should be zero (default).
245
246       dragzoom_threshold <value>
247              A  nonzero  value indicates the number of pixels in the x direc‐
248              tion the marker must move in order for a dragzoom  to  be  trig‐
249              gered.  This is largely to handle noisy input devices.
250
251       dynamic_resizing <value>
252              A  nonzero  value indicates that dynamic resizing should be ini‐
253              tially enabled (default). A zero value  indicates  that  dynamic
254              resizing should be initially disabled.
255
256       editor <"value">
257              This  is  used  to  specify a string (quotes mandatory) for when
258              gtkwave invokes a text editor (e.g.,  Open  Source  Definition).
259              Examples  are:  editor  "vimx -g +%d %s", editor "gedit +%d %s",
260              editor "emacs +%d %s", and for OSX, editor "mate -l %d %s".  The
261              %d  may be combined with other characters in a string such as +,
262              etc.  The %s argument must stand by itself.  Note that  if  this
263              rc  variable  is  not  set,  then  the environment variable GTK‐
264              WAVE_EDITOR will be consulted next, then finally gedit  will  be
265              used (if found).
266
267       enable_fast_exit <value>
268              Allows  exit  without  bringing up a confirmation requester. The
269              default is nonzero/yes.
270
271       enable_ghost_marker <value>
272              lets the user turn on/off the ghost marker during primary marker
273              dragging. Default is enabled.
274
275       enable_horiz_grid <value>
276              A  nonzero  value  indicates  that when grid drawing is enabled,
277              horizontal lines are to be drawn. This is the default.
278
279       enable_vcd_autosave <value>
280              causes the vcd loader to  automatically  generate  a  .sav  file
281              (vcd_autosave.sav  )  in the cwd if a save file is not specified
282              on the command line. Note that this mirrors the  VCD  $var  defs
283              and  no  attempt  is  made  to  coalesce  split  bitvectors back
284              together.
285
286       enable_vert_grid <value>
287              A nonzero value indicates that when  grid  drawing  is  enabled,
288              vertical  lines  are to be drawn. This is the default. Note that
289              all   possible    combinations    of    enable_horiz_grid    and
290              enable_vert_grid values are acceptable.
291
292       fill_waveform <value>
293              A  zero  value  indicates that the waveform should not be filled
294              for 1/H values. This is the default.
295
296       fontname_logfile <value>
297              When followed by an argument, this indicates the name of the X11
298              font  that you wish to use for the logfile browser. You may gen‐
299              erate appropriate fontnames using the xfontsel program.
300
301       fontname_signals <value>
302              When followed by an argument, this indicates the name of the X11
303              font  that  you wish to use for signals. You may generate appro‐
304              priate fontnames using the xfontsel program.
305
306       fontname_waves <value>
307              When followed by an argument, this indicates the name of the X11
308              font  that you wish to use for waves. You may generate appropri‐
309              ate fontnames using the xfontsel program. Note that  the  signal
310              font  must  be taller than the wave font or the viewer will com‐
311              plain then terminate.
312
313       force_toolbars <value>
314              When enabled, this forces everything above the signal  and  wave
315              windows  to  be rendered as toolbars. This allows for them to be
316              detached which allows for more  usable  wave  viewer  space.  By
317              default this is off.
318
319       hide_sst <value>
320              Hides  the Signal Search Tree widget for GTK2.4 and greater such
321              that it is not embedded into the  main  viewer  window.   It  is
322              still reachable as an external widget through the menus.
323
324       hier_delimeter <value>
325              This allows characters other than '/' to be used to delimit lev‐
326              els in the hierarchy. Only the first character in the  value  is
327              significant.
328
329       hier_grouping <value>
330              For  the tree widgets, this allows the hierarchies to be grouped
331              in a single place rather than spread among the netnames.
332
333       hier_ignore_escapes <value>
334              A nonzero value indicates that the signal pane  ignores  escapes
335              in  identifiers  when  determining  the hierarchy maximum depth.
336              Default is disabled so that escapes are examined.
337
338       hier_max_level <value>
339              Sets the maximum hierarchy depth (from the right side)  to  dis‐
340              play  for  trace  names.  Note that a value of zero displays the
341              full hierarchy name.
342
343       highlight_wavewindow <value>
344              When enabled, this causes traces highlighted in the signal  win‐
345              dow also to be highlighted in the wave window.
346
347       hpane_pack <value>
348              A  nonzero  value  indicates  that the horizontal pane should be
349              constructed using the gtk_paned_pack functions (default and rec‐
350              ommended).  A  zero  value  indicates that gtk_paned_add will be
351              used instead.
352
353       ignore_savefile_pane_pos <value>
354              If nonzero, specifies that the pane position  attributes  (i.e.,
355              signal  window  width  size,  SST  is  expanded, etc.) are to be
356              ignored during savefile loading and is to be skipped during sav‐
357              ing.  Default is that the attribute is used.
358
359       ignore_savefile_pos <value>
360              If  nonzero,  specifies that the window position attribute is to
361              be ignored during savefile loading and is to be  skipped  during
362              saving.  Default is that the position attribute is used.
363
364
365       ignore_savefile_size <value>
366              If  nonzero,  specifies  that the window size attribute is to be
367              ignored during savefile loading and is to be skipped during sav‐
368              ing.  Default is that the size attribute is used.
369
370       initial_signal_window_width <value>
371              Sets  the  creation width for the signal pane on GUI initializa‐
372              tion.  Also sets another potential  minimum  value  for  dynamic
373              resizing.
374
375       initial_window_x <value>
376              Sets  the  size  of the initial width of the wave viewer window.
377              Values less than or equal to zero will  set  the  initial  width
378              equal to -1 which will let GTK determine the minimum size.
379
380       initial_window_xpos <value>
381              Sets  the  size  of  the initial x coordinate of the wave viewer
382              window. -1 will let the window manager determine the position.
383
384       initial_window_y <value>
385              Sets the size of the initial height of the wave  viewer  window.
386              Values  less  than  or  equal to zero will set the initial width
387              equal to -1 which will let GTK determine the minimum size.
388
389       initial_window_ypos <value>
390              Sets the size of the initial y coordinate  of  the  wave  viewer
391              window. -1 will let the window manager determine the position.
392
393       keep_xz_colors <value>
394              When  nonzero,  indicates that the original color scheme for non
395              0/1 signal values is to be used when Color Format overrides  are
396              in effect.  Default is off.
397
398       left_justify_sigs <value>
399              When  nonzero, indicates that the signal window signal name jus‐
400              tification should default to left, else the justification is  to
401              the right (default).
402
403       lxt_clock_compress_to_z <value>
404              For  LXT  (not LXT2) allows clocks to compress to a 'z' value so
405              that regular/periodic value changes may be noted.
406
407       max_fsdb_trees <value>
408              sets the maximum number of hierarchy and signal trees to process
409              for  an FSDB file.  Default = 0 = unlimited.  The intent of this
410              is to work around sim environments that accidentally call  fsdb‐
411              DumpVars multiple times.
412
413       page_divisor <value>
414              Sets  the scroll amount for page left and right operations. (The
415              buttons, not the hscrollbar.) Values over 1.0 are taken  as  1/x
416              and  values  equal  to  and  less  than 1.0 are taken literally.
417              (i.e., 2 gives a  half-page  scroll  and  .67  gives  2/3).  The
418              default is 1.0.
419
420       ps_maxveclen <value>
421              sets  the maximum number of characters that can be printed for a
422              value in the signal window portion of  a  postscript  file  (not
423              including  the  net  name itself). Legal values are 4 through 66
424              (default).
425
426       ruler_origin <value>
427              sets the zero origin for alternate time tick marks.
428
429       ruler_step <value>
430              sets the left/right step value for the alternate time tick marks
431              from  the  origin.  When this value is zero, alternate time tick
432              marks are disabled.
433
434       scale_to_time_dimension <value>
435              The value can be any of the characters m, u,  n,  f,  p,  or  s,
436              which  indicates which time dimension to convert the time values
437              to. The default for this is * which means  that  time  dimension
438              conversion is disabled.
439
440       show_base_symbols <value>
441              A  nonzero  value (default) indicates that the numeric base sym‐
442              bols for hexadecimal ('$'), binary ('%'), and octal ('#') should
443              be rendered. Otherwise they will be omitted.
444
445       show_grid <value>
446              A  nonzero value (default) indicates that a grid should be drawn
447              behind the traces. A zero  indicates  that  no  grid  should  be
448              drawn.
449
450       splash_disable <value>
451              Turning this off enables the splash screen with the GTKWave mas‐
452              cot when loading a trace. Default is on.
453
454       sst_dbl_action_type <value>
455              Allows double-clicking to be active in the SST signals pane with
456              the  following  actions  possible:  insert  (default),  replace,
457              append, prepend, none.  The value specified for  the  action  is
458              case insensitive and only the first letter is required.  Invalid
459              action types default to none.
460
461       sst_dynamic_filter <value>
462              When true (default) allows the SST dialog signal filter to  fil‐
463              ter  signals  while keys are being pressed, otherwise enter must
464              be pressed to cause the filter to go active.
465
466       sst_expanded <value>
467              When true allows the SST dialog (when not  hidden)  to  come  up
468              already expanded.
469
470       strace_repeat_count <value>
471              Determines  how  many  times that edge search and pattern search
472              will iterate on a search.  This allows,  for  example,  skipping
473              ahead 10 clock edges instead of 1.
474
475       use_big_fonts <value>
476              A  nonzero  value indicates that any text rendered into the wave
477              window will use fonts that are four points larger in  size  than
478              normal.  This  can  enhance  readability. A zero value indicates
479              that normal font sizes should be used.
480
481       use_fat_lines <value>
482              A nonzero value indicates that any lines rendered into the  wave
483              window  will  be  two  pixels  wide instead of a single pixel in
484              width. This can enhance readability. A zero value indicates that
485              normal line widths should be used.
486
487       use_frequency_delta <value>
488              allows  you  to switch between the delta time and frequency dis‐
489              play in the upper right corner of the main window when measuring
490              distances  between  markers.  Default behavior is that the delta
491              time is displayed (off).
492
493       use_gestures <value>
494              if supported by the GTK version will  enable  gestures  such  as
495              swipe  in  the  wave window. The default is that this feature is
496              enabled if a touch screen is available (value is "maybe").  Val‐
497              ues of on or off are also permissible.
498
499       use_full_precision <value>
500              does  not  round  time values when the number of ticks per pixel
501              onscreen is greater than 10 when active.  The  default  is  that
502              this feature is disabled.
503
504       use_maxtime_display <value>
505              A  nonzero  value  indicates  that the maximum time will be dis‐
506              played in the upper right corner of the screen.  Otherwise,  the
507              current  primary  (unnamed)  marker time will be displayed. This
508              can be toggled at any  time  with  the  Toggle  Max-Marker  menu
509              option.
510
511       use_nonprop_fonts <value>
512              Allows  accelerated redraws of the signalwindow that can be done
513              because the font width is constant. Default is off.
514
515       use_pango_fonts <value>
516              Uses anti-aliased pango fonts (GTK2) rather than  bitmapped  X11
517              ones. Default is on.
518
519       use_roundcaps <value>
520              A  nonzero  value  indicates  that vector traces should be drawn
521              with rounded caps rather than perpendicular  ones.  The  default
522              for this is zero.
523
524       use_scrollbar_only <value>
525              A  nonzero value indicates that the page, shift, fetch, and dis‐
526              card buttons should  not  be  drawn  (i.e.,  time  manipulations
527              should  be  through  the  scrollbar only rather than front panel
528              buttons). The default for this is zero.
529
530       use_scrollwheel_as_y <value>
531              A nonzero value indicates that the scroll  wheel  on  the  mouse
532              should  be  used  to  scroll the signals up and down rather than
533              scrolling the time value from left to right.
534
535       use_standard_clicking <value>
536              This option no longer has any  effect  in  gtkwave:  normal  GTK
537              click semantics are used in the signalwindow.
538
539       use_standard_trace_select <value>
540              A  nonzero  value keeps the currently selected traces from dese‐
541              lecting on mouse button press. This  allows  drag  and  drop  to
542              function  more  smoothly.   As this behavior is not how GTK nor‐
543              mally functions, it is by default disabled.
544
545       use_toolbutton_interface <value>
546              A nonzero value indicates that a toolbar with buttons should  be
547              at  the  top of the screen instead of the traditional style gtk‐
548              wave button groups.  Default is on.
549
550       vcd_explicit_zero_subscripts <value>
551              indicates that signal  names  should  be  stored  internally  as
552              name.bitnumber  when  enabled.  When  disabled,  a more "normal"
553              ordering of name[bitnumber] is used. Note  that  when  disabled,
554              the Bundle Up and Bundle Down options are disabled in the Signal
555              Search Regexp,  Signal Search Hierarchy, and Signal Search  Tree
556              options.  This  is necessary as the internal data structures for
557              signals are represented with one "less" level of hierarchy  than
558              when  enabled  and those functions would not work properly. This
559              should not be an issue if atomic_vectors  are  enabled.  Default
560              for vcd_explicit_zero_subscripts is disabled.
561
562       vcd_preserve_glitches <value>
563              indicates  that  any repeat equal values for a net spanning dif‐
564              ferent time values in the VCD/FST file are not to be  compressed
565              into  a  single value change but should remain in order to allow
566              glitches to be present  for  this  case.  Default  for  vcd_pre‐
567              serve_glitches is disabled.
568
569       vcd_preserve_glitches_real <value>
570              indicates  that  any repeat equal values for a real net spanning
571              different time values in the VCD/FST file are  not  to  be  com‐
572              pressed  into  a  single value change but should remain for this
573              case.  Default  for  vcd_preserve_glitches  is  disabled.    The
574              intended  use  is for when viewing analog interpolated data such
575              that removing duplicate  values  would  incorrectly  deform  the
576              interpolation.
577
578       vcd_warning_filesize <value>
579              produces  a  warning message if the VCD filesize is greater than
580              the argument's size in MB.  Set to zero to disable this.
581
582       vector_padding <value>
583              indicates the number of pixels of extra whitespace  that  should
584              be  added  to any strings for the purpose of calculating text in
585              vectors. Permissible values are 0 to 16 with the  default  being
586              4.
587
588
589       vlist_compression <value>
590              indicates  the  value  to  pass  to zlib during vlist processing
591              (which is used in the VCD recoder).   -1  disables  compression,
592              0-9 correspond to the value zlib expects.  4 is default.
593
594       vlist_prepack <value>
595              indicates  that  the  VCD recoder should pre-compress data going
596              into the value change vlists in order to  reduce  memory  usage.
597              This is done before potential zlib packing.  Default is off.
598
599       vlist_spill <value>
600              indicates that the VCD recoder should spill all generated vlists
601              to a tempfile on disk in order to reduce memory  usage.  Default
602              is off.
603
604       wave_scrolling <value>
605              a nonzero value enables scrolling by dragging the marker off the
606              left or right sides of the wave window. A  zero  value  disables
607              it.
608
609       zoom_base <value>
610              allows  setting  of  the  zoom base with a value between 1.5 and
611              10.0. Default is 2.0.
612
613       zoom_center <value>
614              a nonzero value enables center zooming, a  zero  value  disables
615              it.
616
617       zoom_dynamic <value>
618              a nonzero value enables dynamic full zooming when using the par‐
619              tial VCD (incremental) loader, a zero value disables it.
620
621       zoom_dynamic_end <value>
622              a nonzero value enables dynamic zoom to the end when  using  the
623              partial VCD (incremental) loader, a zero value disables it.
624
625       zoom_pow10_snap <value>
626              corresponds to the Zoom Pow10 Snap menu option. Default for this
627              is disabled (zero).
628

AUTHORS

630       Anthony Bybell <bybell@rocketmail.com>
631

SEE ALSO

633       gtkwave(1)
634
635
636
637Anthony Bybell                      3.3.81                        GTKWAVERC(5)
Impressum