3. VSD Template and configuration files

VSD Templates File

The default templates are in the file .vsdtemplate, which is written to your home directory the first time you start up VSD.

If you delete the .vsdconfig file, then the next time VSD is started, the file will be recreated with default values.

Template Syntax

The template files are written in a formatted form that is understood by the TCL code that supports VSD.

Templates in the .vsdtemplate have the following form:

set vsdtemplates(TemplateName) {

        {Type {ProcessName} StatName  scale  filter  axis}

	  {Type {ProcessName} StatName  scale  filter  axis}

        ...

    }

for example:

set vsdtemplates(Garbage) {

        {Stn {*} PagesNeedReclaimSize 1 none y2}

        {Stn {*} ReclaimedPagesCount 1 none y2}

        {Stn {*} EpochGcCount 1 persecond y}

        {Stn {*} ReclaimCount 1 persecond y}

        {Gem+ {*Gc*} CommitCount 1 persecond y}

    }

set vsdtemplates(CacheTooSmall) {

        {Shrpc ShrPcMonitor FreeFrameCount 1 none y2}

        {+ {*} FramesFromFreeList 1 persecond y}

        {+ {*} FramesFromFindFree 1 persecond y}

}

The data for each line in each template includes:

type — One of the following:

StnShrpcGemPgsvr

‘+’ can also be used, which means that all processes that match this line spec will be combined into a single line. + can be used either standalone, meaning all process types, or added to a type name. For details on types, see the process Type..

name — Identifies the specific process by process name. You m.ay use * to match multiple process names. For more on process names, see the process Name..

stat — The name of a specific existing statistic.

scale — The number of the scale for this particular statistic. It will usually be 1. For more details on scales, seeScaling.

filter — The name of the filter, which will be one of the following:

none

persecond

persample

aggregate

For details on these filters, see Filters

axis — Either y, the left axis, or y2, the right access. Units for this statistic line are labeled on the specified side y-axis.

Once you have created or edited your template file, save the .vsdtemplates file, and use the menu item Chart > Reload Template File to load this file. If you have made syntax errors, this file will not load.

For more about VSD templates and the syntax and options available, see the VSD help under the topic “Template Syntax”.

.vsdrc

This file is used by VSD to record its current configuration. VSD reads the file when it starts and writes the file when it exits.

If you delete the .vsdrc file, VSD will start with defaults from .vsdconfig or from the VSD executable. When it subsequently exists, the file will be recreated with the current settings.

You should not modify this file manually. To make changes in the way that VSD is always started, no matter how it was configured at the previous shutdown, edit the .vsdconfig file.

.vsdconfig

You can configure VSD by setting default values in this file. Any value set in .vsdconfig will override the same definition in .vsdrc.

If you delete the .vsdconfig file, then the next time VSD is started, the file will be recreated with default values.

Configuration file format

In most cases, you can configure your default display using by taking advantage of the natural way VSD saves your settings to .vsdrc and reads them on restart. By doing this, you get a consistent display without any extra work.

However, if you want to set a configuration that is always used, regardless of what you do during any particular VSD session, you will need to edit the VSD configuration file .vsdconfig. The configuration file format is the same in .vsdconfig and .vsdrc, so you may copy lines between files.

The following sections document many of the relevant configuration parameter names and meanings.

Configuration options are specified in a format that is specific to VSD/TCL, and are not intended for general use by customers.

To include a comment line, prefix the line with #.

Incorrect configuration names and settings encountered in reading the files are ignored; default values will be used in this case.

Configuration options have the format:

set vsd (configurationOption) value

for example:

set vsd(confirmonexit) 1

Acceptable value arguments depend on the parameter. Many are Integers, but some parameters are strings. Lists are indicated by {}. Boolean statistics are specified as 0 or 1.

Chart Window Display Options

The following parameters describe the defaults for including and omitting information from chart windows.

Fonts

Window title, menu, and other fonts are based on operating system default fonts, and are not controllable. However, you may set the font for text panes and for charts.

textfont {-family fixed -size 10 -weight normal -slant roman 

	-underline 0 -overstrike 0}

smallfont {-family fixed -size 12 -weight normal -slant roman 

	-underline 0 -overstrike 0}