🚀 go-pugleaf

RetroBBS NetNews Server

Inspired by RockSolid Light RIP Retro Guy

Article View: comp.graphics.avs
Article #39

Re: Anyone have an unformatted man page for AVS?

#39
From: Linda B. Merims
Date: Fri, 07 Aug 1992 14:59
977 lines
43446 bytes
OK, second try.  The mailer ate the leading "."s in the last
posting.  This is a "shar" version of the man page.  Follow
the instructions in the header to get rid of the "@"s.
------------------CUT HERE-------------------------------
# This is a shell archive.  Remove anything before this line,
# then unpack it by saving it in a file and typing "sh file".
#
# Wrapped by  <lbm@putty> on Fri Aug  7 10:44:06 1992
#
# This archive contains:
#	avs.6	
#

LANG=""; export LANG
PATH=/bin:/usr/bin:$PATH; export PATH

echo x - avs.6
sed 's/^@//' >avs.6 <<'@EOF'
@.\"	@(#)avs.6	7.6 Advanced Visual Systems 92/03/05
@.\"			Copyright (c) 1989 by
@.\"			Stardent Computer Inc.
@.\"			All Rights Reserved
@.\"	
@.\"	This software comprises unpublished confidential information of
@.\"	Advanced Visual Systems Inc. and may not be used, copied or made
@.\"	available to anyone, except in accordance with the license
@.\"	under which it is furnished.
@.\"	
@.\"	This file is under sccs control at Advanced Visual Systems in:
@.\"	
@.\"	
@.ds BU \s-2\(bu\s0
@.\"
@.TH avs 1 "Application Visualization System" "\&"
@.SH NAME
avs \- \c
Application Visualization System
@.SH SYNOPSIS
\f3avs\fP  \f2option(s)\fP
@.SH DESCRIPTION
The Application Visualization System (AVS) is an interactive
tool for scientific visualization. It includes the following
subsystems:
@.TP 18p
\*(BU
\f3Image Viewer.\fP
A high-level tool for manipulating and viewing images.
@.TP 18p
\*(BU
\f3Graph Viewer.\fP
A high-level tool for graphing data.
@.TP 18p
\*(BU
\f3Geometry Viewer.\fP
Allows you to compose "scenes"
that contain geometrically-defined objects. The objects must have
been created by programs or AVS modules that use AVS's GEOM
programming library. You can transform the objects themselves
(move, rotate, scale); you can change the viewing parameters
(e.g. move the eye point, perspective view, etc.); and you can
control the way in which the graphical images are rendered
(lighting and shading, Z-buffering, etc.).
@.TP 18p
\*(BU
\f3Network Editor.\fP
A visual programming interface for
connecting computational modules together into networks
that perform visualization functions.
@.PP
AVS also includes a sample application, the \f3AVS Data Viewer\f1.
The Data Viewer provides a simplified, pulldown menu interface
for building visualization networks.  It is a useful tool for
the novice user learning basic scientific visualization techniques.
@.PP
The command to start AVS is simple:
@.pS K
avs
@.pE
Use the \f2avs\f1 command to start AVS when your terminal or
workstation is directly-connected to the system that will run
AVS.  You should use the \f2avs\f1 command together with
the \f3-nohw\f1 option or \f3NoHW 1\f1 startup file
keyword when running
AVS as a remote X client on a different hardware platform, or
when you are displaying on an "X terminal."
AVS runs as an X Window System client, and thus requires that the
DISPLAY environment variable be set correctly.  These are usually
the only options necessary to start an AVS session.  However,
see the AVS release notes for your platform for additional
platform-specific information on which options, such as
\f3VisualType\f1, may be required
to start AVS correctly on your workstation.
@.SH CONTROLLING AVS STARTUP
Three entities can affect how AVS starts.  They are listed in
their order of precedence:
@.TP 1.5P
1.
Command line options.
@.TP 1.5P
2.
The \f2.avsrc\f1 startup file.  The startup file contains
keyword-value pairs.  AVS always reads the system default startup
file in \f2/usr/avs/runtime/avsrc\f1 first.  Users may override or
supplement these system default options with a personal \f2.avsrc\f1
file.  AVS will look for a personal startup file in \f2./.avsrc\f1
(in the current directory), then \f2$HOME/.avsrc\f1 (in your HOME directory).
It uses the first \f2.avsrc\f1 that it finds.
@.TP 1.5P
3.
Environment variables.
@.SH OPTIONS
All option keywords begin with a hyphen
(e.g. \f3\-data\fP). In many cases, the keyword is followed
by an additional word (e.g. a directory name). You must separate the
keyword and the additional word with whitespace (SPACE and/or TAB
characters).
@.PP
All options keywords can be abbreviated, as long as there is no ambiguity.
For example, \f3\-data\fP can be abbreviated to \f3\-da\fP. But you cannot
abbreviate it to \f3\-d\fP, since this might indicate either \f3\-data\fP or
\f3\-display\fP.
@.PP
In several cases, you can use an entry in the \f2AVS startup file\fP
as an alternative to a command line option. For example, a \f3DataDirectory\fP
entry in the startup file is equivalent to a \f3\-data\fP option.
See the next section for details on the startup file.
@.TP  4.5P
\f3\-class \f2string\f1
(startup file equivalent:  none)
This is the command line option equivalent of
the DISPLAYCLASS environment variable.  You can use
it to make AVS behave in different ways when it is started from
different types of display hardware.
\f3-class\f1 has two effects:
@.RS
@.TP 1.5P
1.  
An \f2Xdefaults\f1 file
specifies the "look" of the AVS interface; what shades of grey are
used for command buttons, what fonts to use, whether the background is
"stippled" or a flat color, etc.
When \f3-class \f2string\f1 is given, AVS does not use the default
\f2/usr/avs/runtime/avs.Xdefaults\f1 file.  Instead, it looks for
an Xdefaults.\f2string\f1
file in the \f2/usr/avs/runtime\f1 directory and uses it.
At present, the only
alternate X defaults file supplied is \f2Xdefaults.X\f1.
@.TP 1.5P
2.
If such a file is present, it will use an alternate startup file,
\f2/usr/avs/runtime/avsrc.string\f1.  Otherwise, it uses
\f2/usr/avs/runtime/avsrc\f1.
It will also look for a .avsrc.\f2string\f1 file in the current,
then HOME directory
and use it instead of your usual \f2.avsrc\f1 file.
@.eS
\f3-class\f1 is used
when running AVS from an "X terminal."  See the full discussion
in the "AVS on Color X Servers" appendix to the \f2AVS User's Guide\f1.
@.RE
@.PP
@.TP 4.5P
\f3\-cli\fP
(startup file equivalent:  none)
Run AVS with the Command Language Interpreter functioning in the
terminal emulator window from which AVS was invoked. This takes an optional
argument, which is a CLI command string, to be executed after
AVS starts up.  See the chapter on the "Command Language Interpreter" 
in the \f2AVS User's Guide\fP for details.
@.TP 4.5P
\f3-compile_library\f2 source_filespec compiled_filespec\f1
(startup file equivalent:  none)
This is a utility for maintaining module libraries whose component
modules are changing.  It follows a "source module library"
vs "compiled module library" paradigm.  Specifically, \f3-compile_library\f1
takes the \f2source_filespec\f1 to be an AVS module library file
containing a list of \f3file\f1 commands followed by the
name of a module binary file.  It executes each module listed in order
to extract the module description information.  From this, it generates
\f2compiled_filespec\f1 as an AVS module library file containing
the description information necessary to load the module into
the Network Editor's Palette quickly without actually executing
the module binary.  This option does not start a full AVS session.
@.eS
See the "Constructing a Module Library" discussion in the "Advanced Network
Editor" chapter for more information.
@.TP 4.5P
\f3\-data \f2directory\f1
(startup file equivalent: \f3DataDirectory\fP)
Specifies the directory in which all subsystem data input
file browsers, including the Image Viewer, the Graph Viewer,
the Geometry Viewer, and the data input modules in the
Network Editor, will
initially look for data files (files used an input to computational
modules).  This is the major tool for redirecting AVS's default
data input
focus off the sample data files provided in \f2/usr/avs/data\fP
and onto your own data files.
@.eS
The default data directory is \f2/usr/avs/data\fP.
@.TP 4.5P
\f3\-dials \f2devicefilespec\f1
(startup file equivalent: \f3DialDevice\fP)
Specifies the serial communications port to which a 
dialbox device is attached (e.g. \f2/dev/tty2\fP).  If
\f3-dials\fP is present, AVS automatically connects
the dialbox dials to the Geometry Viewer's rotation,
translation, and scaling transformations.  You must know
which serial communications port your dialbox is connected to.
This argument also corresponds to the environment variable DIALS.
Dialboxes are not supported on all platforms.
@.TP 4.5P
\f3\-display \f2display-name\f1
(startup file equivalent:  none)
Specifies the X Window System display on which AVS is to display.
This overrides the current setting of the DISPLAY environment variable.
@.TP 4.5P
\f3\-gamma \f2number\f1
(startup file equivalent: \f3Gamma\f1)
Controls the brightness of the display for all AVS windows except Geometry
Viewer output windows produced with a hardware renderer.  The default
varies from platform to platform.  Values between 1.7 to 2.2 are good
starting points for experimentation.  Higher real values produce
a lighter display.
@.TP 4.5P
\f3\-geometry \f2[ geom-option(s) ]\f1
(startup file equivalent:  none)
Automatically invokes the Geometry Viewer subsystem at startup.
There will be no \f3Data Viewers\f1 button to access other subsystems.
If you use this option, it must be the \f2last\f1 option on the
command line, followed only by the options listed below
that are specific to this subsystem.  All other options that
follow \f2-geometry\f1 will be ignored.
@.RS
@.TP 4.5P
\f3\-scene \f2scene-file.scene\f1 or \f2geomcli-file.scr\f1
(startup file equivalent:  none)
This option
executes the Geometry Viewer's \f3Read Scene\f1 function,
using the file \f2scene-file.scene\f1 or \f2geomcli-file.scr\f1,
depending upon the setting of the \f3AVS_GEOM_WRITE_V30\f1
environment variable.
@.TP 4.5P
\f3\-filter \f2pathname\f1
Specifies \f2pathname\f1 as the directory to search
for geometry conversion utilities, named \f2\&..._to_geom\f1.
See the "Importing Data Into AVS" chapter of the \f2User's Guide\f1.
@.eS
The default directory for these programs is \f2/usr/avs/bin\f1.
@.TP 4.5P
\f3\-defaults \f2filename\f1
Specifies a Geometry Viewer defaults file. The format of this file
is described in the "Geometry Viewer Script Language" appendix.
@.TP 4.5P
\f3\-geometry \f2Xgeometry\f1
Specifies an X Window System geometry (e.g. \f3500x500-5-5\fP)
for the initial window created by the Geometry Viewer.
@.TP 4.5P
\f3-noroll\f1
Turns off track rolling.  Track rolling occurs when you perform
a transformation and release the mouse button while the mouse is
still moving.  This "flings" the transformable, causing it to
continue in motion.
@.TP 4.5P
\f3\-usage\f1
Displays a list of Geometry Viewer startup options.
@.RE
@.TP 4.5P
\f3\-graph\fP
Automatically invokes the AVS Graph Viewer at system startup.  There
will be no \f3Data Viewers\f1 button to access other subsystems.
@.TP 4.5P
\f3\-image\fP
Automatically invokes the AVS Image Viewer at system startup.  There
will be no \f3Data Viewers\f1 button to access other subsystems.
@.TP 4.5P
\f3\-library \f2filespec\f1
(startup file equivalent: \f3ModuleLibraries\fP)
Specifies which AVS module library file to load into the Network
Editor at system startup.  Module library files are ASCII
files describing sets of modules.  \f2/usr/avs/avs_library/Supported\fP
is an example.  This is the major tool that allows
you to load your own sets of modules\(emeither modules you've
written yourself or subsets of the supplied modules that you
have customized to your needs\(eminstead of always relying
on the system default Supported and Unsupported module libraries
specified in the \f2/usr/avs/runtime/avsrc\fP file.
@.eS
To load more than one module library, use multiple pairs
of \f3-library \f2filespec\f1 options.
@.eS
It is equivalent to using the Network Editor's \f3Read Module Library\fP
function.
@.TP 4.5P
\f3\-modules \f2directory\f1 or \f2filename\f1
(startup file equivalent: none)
Specifies the directory or file in which the AVS Network Editor subsystem
initially will look for executable modules.  All executable
files in a directory are examined to determine whether they contain
one or more modules.
@.eS
\f3-modules\fP differs from \f3-library\fP above in that it
loads \f2binary\fP module files, not ASCII module \f2library\fP files.
It is slower to load modules as binary files rather than libraries.
@.\" For each module located in this search, an icon
@.\" is placed in one of the four columns of the \*(lqModule Palette\*(rq menu.
@.eS
You can use more than one \f3\-modules\fP options to specify
multiple individual module binaries, or to have AVS search
through multiple directories for modules.  This is the main tool
for loading individual modules (perhaps modules that you are debugging)
that you have not yet formalized into a module library.  It is
equivalent to the Network Editor's \f3Read Module(s)\fP
function.  It cannot be used to read remote modules.
@.eS
The default modules directory is \f2/usr/avs/avs_library\fP.
@.TP 4.5P
\f3\-netdir \f2directory\f1
(startup file equivalent: \f3NetworkDirectory\fP)
Specifies the directory in which the AVS Network Editor subsystem
initially will look for network files (\f3Read Network\fP and \f3Write Network\fP
functions).  This is the tool to use to redirect AVS's default network
focus away from the samples provided in \f2/usr/avs/networks\fP and
onto your own network files.
@.eS
The default network directory is \f2/usr/avs/networks\fP.
@.TP 4.5P
\f3\-network \f2network-file\f1
(startup file equivalent:  none)
Starts AVS and brings up the Network Editor's module control panel
with the controls for the network displayed.  The full Network Editor
subsystem is not displayed or accessible.  This is one way to make
an individual production network available to a user.
@.TP 4.5P
\f3-nodmc\f1
(startup file equivalent:  \f3DirectModuleCommunication 0\f1)
Turns off the default direct module-to-module communication.  This
is useful if you want to perform timing tests to compare network
execution speed with/without direct module-to-module communication.
@.TP 4.5P
\f3-nohw\f1
(startup file equivalent:  \f3NoHW 1\f1)
Tells the AVS Geometry Viewer to not initialize any hardware renderers.
Without a hardware renderer, the AVS Geometry Viewer will use a
software renderer to
create its 3D scenes instead of the platform's native graphics
facilities.  \f3-nohw\fP is used when you are running
AVS as a remote X client on a different hardware platform
or when you are using an "X terminal."
The software renderer creates an X image rendering of the
3D scene and ships only the image to the local X server
for display rather than a stream
rendering commands that may not be understood by the local system.
@.eS
\f2-nohw\f1 is equivalent to the obsolete \f2-swrender\f1.
@.TP 4.5P
\f3-parallel \f2n\f1
(startup file equivalent: none)
Sets the maximum number of module processes that will attempt to execute in
parallel at any one time.  The default is 1 (no parallelization.)
You should set this figure intelligently for the system(s) that
you are running on.  If two processors are available (a two-processor
system, or a local and a remote system) then this figure can reasonably
be set to 2.  If you give a value that exceeds the number of processors
available, the underlying operating systems will serialize the processes.
There is no inherent upper limit to the \f2n\f1 parameter.
@.eS
Modules
must be in separate processes to execute in parallel.  Most modules
supplied with AVS are combined into a single executable
that runs as a single process.  Thus, they will not run in
parallel unless they are divided into separate processes.  This may be
done wholesale with the \f3-separate\f1 option, or precisely using the
Network Editor's module group editing facility.  See the discussion
on parallel module execution in the "Advanced Network Editor"
chapter of the AVS \f2User's Guide\f1 for more information.
@.TP 4.5P
\f3\-path \f2directory\f1
(startup file equivalent: \f3Path\fP)
Specifies the directory tree in which AVS itself is installed.
@.eS
The default path is \f2/usr/avs\fP. If you specify another path, then
the default data directory and network directory are modified
accordingly. For example:
@.pS R
@.ta 4.5P 12P
\f3If:\fP	path	= \f2/usr/local/avs\fP
\f3Then:\fP	data directory	= \f2/usr/local/avs/data\fP
	network directory	= \f2/usr/local/avs/networks\fP
@.pE
@.sp .5
This option is also useful to switch between multiple
versions of AVS (for example, a test release
and a production release).
@.TP 4.5P
\f3\-reindex\f1
(startup file equivalent:  none)
This option creates AVS help system \f2.topics\fP files.  It does
not start an AVS session.  It is useful
if you are creating help files for applications that you want to
be accessible through the AVS help system.  See the appendix
on creating help files in the \f2AVS Developer's Guide\fP for
more information.
@.TP 4.5P
\f3-renderer \f2"string"\f1
(startup file equivalent:  \f3Renderer\f1)
Specifies which renderer will be the default selected in the
Geometry Viewer when a camera window is first created.  \f2"string"\f1 is
the literal name found on
the renderer buttons under the Geometry Viewer's \f3Cameras\f1
menu, usually either "Software Renderer" or "Hardware Renderer",
though other strings are possible.
It must match exactly, in spelling, case, and spacing.  The double
quote marks must be present.  Where
there is a hardware renderer available, \f3-renderer\f1
defaults to "Hardware Renderer".  If the user specified \f3-nohw\f1,
then only one renderer is available, the software renderer, and
this option is ignored.
@.TP 4.5P
\f3\-separate \fP
(startup file equivalent:  none)
This option disables AVS's multiple modules in one process feature.
It forces each module to execute as a separate process, whether
or not it is combined in an executable with other modules.  The option
is primarily useful for debugging, or when parallel module execution
is desired.  (In this last case, it is better to not use \f3-separate\f1,
since it usually increases memory utilization.  Instead, individually
divide modules into different executables using the Network Editor's
module process group editing facility.)
See the section on 
"Multiple Modules in a Single Process" in the \f2AVS Developer's Guide\fP.
@.TP 4.5P
\f3\-server \fP
(startup file equivalent: none)
This option opens a connection that an external process
can use to connect to AVS and exchange with it a
stream of Command Language Interpreter (CLI) commands
and their output.  See the chapter on the CLI in
the \f2AVS User's Guide\fP for details.
@.TP 4.5P
\f3\-shm/noshm \fP
(startup file equivalent:  \f3SharedMemory \f2on/off\f1)
This turns the AVS shared memory option on and off.  When shared memory
is on, AVS keeps only one copy of AVS field and UCD data that all
modules in a network share.  (GEOM-format data and pixmaps do not use
shared memory.)  This improves performance by
saving memory and processor time.  \f3-noshm\fP can disable shared memory
if, for example,
AVS's use of the finite shared memory area is interfering with other
applications.  On most systems shared memory is on by default.
@.TP 4.5P
\f3\-size \f2XDIM\f1x\f2YDIM\f1
(startup file equivalent: \f3ScreenSize\fP)
Specifies size, in pixels, to use for AVS's virtual display screen
size.  AVS will
automatically resize its interface to fit into the virtual screen.
You could use this to confine AVS to run within one section
of your screen instead of across the whole screen.
@.TP 4.5P
\f3\-spaceball \f2devicefilespec\f1
(startup file equivalent:  \f3SpaceballDevice\fP)
Specifies the serial communications port to which a 
Spaceball device is attached (e.g. \f2/dev/tty2\fP).  If
\f3-spaceball\fP is present, AVS automatically connects
the Spaceball device to the Geometry Viewer's rotation,
translation, and scaling transformations.  You must know
which serial communications port your spaceball is connected to.
This entry also corresponds to the environment variable SPACEBALL.
Spaceballs may not be supported on all platforms.
@.TP 4.5P
\f3\-timer\f1
(startup file equivalent: none)
Writes Geometry Viewer performance data to \f2stderr\f1.  This should be
used in conjunction with the \f3Object Info\f1 panel to display the
number of polygons being rendered.  To get the measurement, use
track rolling to set the object in continuous motion (middle mouse
button to rotate, release mouse button while mouse is still moving,
thereby "flinging" the object into continuous motion).  Wait several
seconds (the longer, the more accurate), then press any mouse button
in the window to stop the object.  Minimize mouse movements while the
measurement is being taken.  The measurement looks like:
@.eS
73 frames in 6.632989 seconds for 11.005596 FPS
@.eS
FPS stands for "frames per second."  By convention, the "standard unit"
is \f2/usr/avs/data/geometry/teapot.geom\f1, in the default-sized window, with
no additional rendering options (color, shading, etc.).  In this case,
FPS can be referred to as TPS ("teapots per second").
@.TP 4.5P
\f3\-version\fP
Displays the AVS version number. (Does not start an AVS session.)
@.TP 4.5P
\f3\-usage\fP
Displays a usage message for AVS.  No AVS session
is started.
@.SH AVS STARTUP FILE
When it begins execution, AVS uses a \f2startup file\fP, which
specifies such things as which module libraries to load,
the locations of various directories, where to
look for Help files, how big to make the AVS interface, etc.
@.PP
AVS always first reads the system default startup file in
\f2/usr/avs/runtime/avsrc\f1.  Users may override or supplement the
options in the system startup file with a personal \f2.avsrc\f1 file.
AVS looks user \f2.avsrc\f1 files in the order listed, using the first
that it finds:
@.pS 
\&./.avsrc                    \f1(current directory)\fP
\&$HOME/.avsrc                \f1(home directory)\fP
@.pE
@.PP
You can copy the system default
\f2/usr/avs/runtime/avsrc\fP file
to your HOME or other directory,
modify it according to your needs and preferences, and rename
it with the "." prefix.
@.PP
If you give the \f3-class X\fP command option, or set the
DISPLAYCLASS X environment variable, AVS will use a different startup
file:  \f2/usr/avs/runtime/avsrc.X\f1.  In the same manner as the
regular startup file, AVS will look for personal \f2.avsrc.X\f1 file
in the current directory, then your HOME directory.
This file
is used to customize AVS when you are running it from
an "X terminal."
@.SS .avsrc Startup File Format
Each line of the AVS startup file consists of keyword-value pair,
with whitespace separating the keyword and the value. For example:
@.pS
\s-1
ModuleLibraries       /usr/avs/avs_library/Supported  /usr/johnp/avs/modules/Modlib
NetworkWindow        867x567+407+2
NetworkDirectory     /usr/johnp/avs/nets
@.\" ModulesDirectory  /usr/johnp/avs/modules
DataDirectory        /usr/johnp/avs/data
DialDevice           /dev/tty02
@.\" Pat                 /usr/avs
\s+1
@.pE
@.PP
Often, the keyword corresponds to one of the command line options
described in the preceding section. If you use a command line option,
it overrides the specification, if any, in the startup file.
@.SS Startup File Keywords
The AVS startup file keywords are listed below.  
@.PP
\f3NOTE\f1:
Where
startup file keywords have command line equivalents, see the
command line description above for the most complete discussion of
the feature.
@.PP
@.TP 4.5P
\f3Applications  \f2filespec\f1
(command line equivalent:  none)
Causes AVS to use a file other than \f2/usr/avs/runtime/AVS.applns\f1
to build the large Applications menu.  This is how a user would
create their own set of application networks and have them
accessible from AVS's Applications menu without modifying the
central system file.  If a simple filename is given rather than
an absolute file and pathname, AVS will
look for the file in the directory defined by Path (by default,
\f2/usr/avs\f1).
@.TP 4.5P
\f3BoundingBox \f2switch\f1
(command line equivalent:  none)
If \f3BoundingBox on\fP is set, then the AVS Image Viewer and
Geometry Viewer will come up with their \f3Bounding Box\fP control
already turned on.  A "bounding box" is a less compute-intensive
style of moving geometric objects and Image Viewer subimages.
Instead of moving the object "real time," it only moves a
wirebox representation of the object.  Only when you release
the mouse button is the object/subimage rendered at its new
location.  \f3BoundingBox\f1 is most useful when you are using
AVS on lower performance graphics systems, with the software
renderer, or from an "X terminal."  \f3Bounding Box\f1 is usually
off by default.
@.TP 4.5P
\f3Colors \f2r g b gray\f1
(command line equivalent:  none)
This option controls how many cells of a \f2system\fP colormap
AVS will attempt to allocate to itself when it starts.  \f2r g b g\fP
represent numbers for red, green, blue, and gray.  This is primarily
intended for people who are using AVS from an "X terminal" or PseudoColor
workstation that objects to the number of colormap cells that
AVS tries to allocate for itself.  See the discussion on
"AVS on Color X Servers" in the AVS \f2User's Guide\f1.
@.TP 4.5P
\f3DataDirectory \f2directory\fP
(command line equivalent: \f3\-data\fP)
Specifies the directory in which the various AVS data
input file browsers used in the subsystems
(Image Viewer, Graph Viewer, and Geometry Viewer) and
Network Editor modules \*(lqread data\*(rq modules
(\f3read field\fP, \f3read geometry\fP, etc.)
initially will look for data files.  This is the
main tool to refocus AVS's data input attention off
the sample data files in \f2/usr/avs/data\fP and onto
your own data files.
@.TP 4.5P
\f3DialDevice \f2devicefilespec\f1
(command line equivalent:  \f3-dials\fP)
Specifies \f2devicefilespec\f1 as the serial communications
port to which a dialbox device
is attached (e.g. \f2/dev/tty1\fP).  If \f3DialDevice\fP is specified, AVS automatically
connects the dialbox dials to the Geometry Viewer's rotate, translate,
and scale transformations.
@.eS
This entry also corresponds to the environment variable DIALS. 
Dialboxes may not be supported on
all platforms.
@.TP 4.5P
\f3DirectModuleCommunication  \f2switch\f1
(command line equivalent:  \f3-nodmc\f1)
Turns direct module-to-module communication on and off.  This
is useful if you want to perform timing tests to compare network
execution speed with/without direct module-to-module communication.
Direct module-to-module communication is on by default.
@.TP 4.5P
\f3DisplayPixmapWindow \f2Xgeometry\f1
(command line equivalent:  none)
Controls the default X Window System geometry of
the \f3display pixmap\f1 module's window.
@.TP 4.5P
\f3Gamma \f2number\f1
(command line equivalent: \f3-gamma\f1)
Controls the brightness of the display for all AVS windows except Geometry
Viewer output windows produced with a hardware renderer.  The default
varies from platform to platform.  Values between 1.7 to 2.2 are good
starting points for experimentation.  Higher real values produce
a lighter display.
@.TP 4.5P
\f3GridSize \f2n\f1
(command line equivalent:  none)
Controls the size in pixels of the Layout Editor's alignment squares
when \f3Snap to Grid\f1 is switched on.  The
default is 10.
@.TP 4.5P
\f3HelpPath \f2directory ...\f1
(command line equivalent:  none)
Expands the list of directories that AVS will search to find a
module's documentation when you click \f3Show Module Documentation\fP
in the module's Module Editor window.  This is useful when you
are using modules other than the set provided with AVS. For the format
of the "Help" path, see Appendix D of the \f2AVS Developer's Guide\fP,
concerning "On-Line Help".
@.TP 4.5P
\f3Hosts \f2fullfilespec\f1
(command line equivalent: none)
Gives the name of a "Hosts" file that lists machines, access methods,
and directories of remote modules.  It provides a
personal override to the
system default \f2/usr/avs/runtime/hosts\fP file when you click on
the Network Editor's \f3Read Remote Module(s)\fP button under
\f3Module Tools\fP.  See the "Running Remote Modules" section
in the \f2AVS User's Guide\fP Network Editor chapter for details.
@.TP 4.5P
\f3ImageAutomagnify \f2switch\f1
(command line equivalent: none)
In AVS 3 and later releases, the display image window will not
rescale an image when the window is resized.  Turning this option
"on" will restore the AVS2 behavior of automatically magnifying the image.
@.TP 4.5P
\f3ImageScrollbars \f2switch\f1
(command line equivalent: none)
If set to the value \f3off\fP, suppresses the adding of scrollbars
to display windows that are too small for the image they are
currently displaying. (You can always see more of the image simply
by dragging it with the mouse.)
@.TP 4.5P
\f3ModuleLibraries\f2 filespec filespec ...\f1
(command line equivalent:  \f3-library\fP)
Specifies which libraries of modules will be loaded into the
Network Editor's module palette.  The \f2last\fP module library
listed will be the "default" library showing in the module
Palette when you enter
the Network Editor.  The other module libraries listed can
be called up by clicking on their iconic representation at the
top of the Network Editor's main panel.
There is no way to continue
the list of module libraries to a new line; the list must be on
one (perhaps very long) line.
@.TP 4.5P
\f3ModulePanelHeight \f2integer\f1
(command line equivalent:  none)
Controls the proportion of the Network Construction  window devoted to
the module Palette as opposed to the Workspace.
@.TP 4.5P
\f3NetworkDirectory \f2directory\f1
(command line equivalent: \f3\-netdir\f1)
Specifies the directory in which the AVS Network Editor subsystem
initially will look for network files (\f3Read Network\fP and 
\f3Write Network\fP functions).
@.TP 4.5P
\f3NetworkWindow \f2Xgeometry\f1
(command line equivalent: none)
Specifies the X Window system geometry of the Network Construction Window,
which includes the Network Editor menu, the Module Palette, and the Workspace
in which you construct networks of modules.  You may need this if
your display is substantially smaller than the usual 1280x1024 pixels.
@.TP 4.5P
\f3NoHW \f2switch\f1
(command line equivalent:  \f3-nohw\f1)
\f3NoHW 1\f1 tells the AVS Geometry Viewer to not initialize
any hardware renderer.
Without a hardware renderer, the AVS Geometry Viewer will use a
software renderer to
create its 3D scenes instead of the platform's native graphics
facilities.  \f3NoHW 1\fP is used when you are running
AVS as a remote X client on a different hardware platform
or when you are using an "X terminal."
The software renderer creates an X image rendering of the
3D scene and ships only the image to the local X server
for display rather than a stream of
rendering commands that the local display may not understand.
The default is \f3NoHW 0\f1 (do initialize
hardware renderers) on systems that support a hardware renderer.
@.eS
\f3NoHW 1\f1 is equivalent to the obsolete \f3SWRender 1\f1.
@.TP 4.5P
\f3NetWriteAllParams \f2switch\f1
(command line equivalent: none)
AVS saves only parameters that have been modified out to a network file.
Setting this option to \f3on\f1, will enable saving all parameters, as was the
default in AVS 2.  The default is \f3off\f1.
@.TP 4.5P
\f3Path\fP
(command line equivalent: \f3\-path\fP)
Specifies the directory tree in which AVS itself is installed.
@.TP 4.5P
\f3PrintNetwork \f2command\f1
(command line equivalent:  none)
The Network Editor's \f3Print Network\fP button normally sends
output to your default printer.  This lets you specify
an alternate print command to execute. The command should be a regular
shell command, such as:
@.pS
lpr -Plw2
@.pE
@.TP 4.5P
\f3ReadOnlySharedMemory \f2switch\f1
(command line equivalent:  none)
Shared memory is normally "read only."  Occasionally, the system
developer might wish to keep shared memory turned on, but allow
it to be written into.  Setting \f3ReadOnlySharedMemory 0\f1
accomplishes this.  The default is \f31\f1.
@.TP 4.5P
\f3Renderer "\f2string\f1"
(command line equivalent:  \f3-renderer "\f2string\f3"\f1)
Specifies which renderer will be the default selected in the
Geometry Viewer when the first camera window is created.  \f2"string"\f1 is
the literal name found on
the renderer buttons under the Geometry Viewer's \f3Cameras\f1
menu, usually either "Software Renderer" or "Hardware Renderer",
though other strings are possible.
It must match exactly, in spelling, case, and spacing.  The double
quote marks must be present.  Where
there is a hardware renderer available, \f3Renderer\f1
defaults to "Hardware Renderer".  If the user specified \f3NoHW 1\f1,
then only one renderer is available, the software renderer, and
this option is ignored.
@.TP 4.5P
\f3SaveMessageLog \f2switch\f1
(command line equivalent: none)
If set to the value \f3on\fP, causes the AVS message log
to be preserved when the AVS session ends normally.
By default, the message log (\f2/tmp/avs_message.log_\f(BIXXX\f1,
where \f(BIXXX\fP is the AVS process number) is deleted
automatically.
The log file is always preserved if AVS exits abnormally (e.g.
\f3Ctrl-C\fP interrupt, system crash).
@.TP 4.5P
\f3ScreenSize \f2XDIM\f1x\f2YDIM\f1
(command line equivalent: \f3size\f1)
Specifies the size of AVS's virtual display in pixels, confining
AVS to run within this area.  AVS scales its interface to fit
the virtual screen.
@.TP 4.5P
\f3SharedMemory \f2switch\f1
(command line equivalent:  \f3shm/noshm\fP)
Specifying \f3SharedMemory off\fP turns off AVS's shared memory
feature.
@.TP 4.5P
\f3SpaceballDevice \f2devicefilespec\f1
(command line equivalent:  \f3-spaceball\fP)
Indicates the serial communications port to which a Spaceball device
is attached (e.g. \f2/dev/tty1\fP).  If \f3Spaceball\fP is specified, AVS automatically
connects the Spaceball to the Geometry Viewer's rotate, translate,
and scale transformations.
@.eS
This entry also corresponds to the environment variable SPACEBALL.
Spaceballs may not be supported
on all platforms.
@.TP 4.5P
\f3StackSelector \f2option\f1
(command line equivalent:  none)
People who build very large networks sometimes find that the Network
Editor's control panel "overflows," making some of the module
buttons difficult to access, because the radio buttons take up too much
of the control panel.  Setting \f3StackSelector choice_browser\fP
displays the module names as a scrolling list similar to the
file browsers instead of as the default \f3radio_buttons\fP.
@.TP 4.5P
\f3VisualType \f2visualtype\f1
(command line equivalent:  none)
This command may be necessary when you are seeing less color rendition
than you know your display is capable of.
@.eS
AVS normally uses the X server's default visual.  Occasionally,
this is the wrong visual to use.  For example, the default may be set to
PseudoColor when there actually is a TrueColor visual available.
(The standard X Window System
command to list which
X visuals are available and which is being used as the default is
\f2xdpyinfo\f1.  This command may not be available on all platforms.)
@.eS
\f3VisualType\f1 lets you specify a \f2visualtype\f1, either
\f3PseudoColor\fP, \f3TrueColor\fP, or \f3DirectColor\f1.    AVS
will then search the X server's visual
list until it finds the first visual with the given visual type and
use it.
@.eS
You
can also specify an explicit visual using the string
\f3VisualID\f1 followed by a number \f2n\f1 that is the
decimal equivalent of the X server's hexadecimal visual id for the
visual you want to use.  For example:
@.pS K
VisualType  VisualID  41
@.pE
@.eS
This option may also be useful to people
using AVS from "X terminals."
@.eS
\f3Note:\f1  Poor color rendition may also be caused because your display is
using double buffering.  It may be using its 24 planes as two double-buffered
12 planes (or 12/6, or 8/4).  Turning off
double buffering on the Geometry Viewer's \f3Cameras\f1 submenu will
fix this, but you will see the object being drawn.
@.TP 4.5P
\f3WindowMgr \f2mgr\f1
(command line equivalent:  none)
This option ensures that the Network Editor's Layout Editor and
the X Window System window manager that you are using work
correctly together.  The default for this parameter is
specified in the \f2/usr/avs/runtime/avs.Xdefaults\f1 file.
The currently recognized values are:  \f3awm\f1, \f3mwm\f1 (Motif-style
window managers),
\f3twm\f1, \f3uwm\f1, \f3olwm\f1(Open Look), and \f3dxwm\f1(Dec XVI).  
@.TP 4.5P
\f3XWarpPtr \f2on\f1
(command line equivalent: none)
Causes the mouse cursor to be automatically moved ("warped") into
typein panels when they appear.  \f3XWarpPtr\f1 is off by
default.
@.SH AVS ENVIRONMENT VARIABLES
AVS uses the following environment variables.  Only DISPLAY
must be set correctly before AVS will work.
@.TP 6P
\f3AVS_ADAPT_TABLE \f2switch\f1
A block table is a data structure that maps field points' I, J, K
indicies
in an irregular field within a "block" of
X, Y, Z world space.  Modules such as \f3arbitrary slicer\f1 and
\f3probe\f1 use the block table to interpolate values at points
"on" their sampling surface, determining which  need to be mapped
as colored polygons.
@.eS
AVS normally builds a regular, evenly-dimensioned block table.  Where
data points are fairly uniformly spaced within the field, such a block
table provides efficient access to the I, J, K values in each block
of the grid\(emeach block has approximately the same number of points.
However, where data values are concentrated in some areas of the
field, but sparse elsewhere (e.g., the wing surface of the \f2bluntfin.fld\f1
dataset) search times in the dense blocks become much longer.
@.eS
An adaptive block table creates the block table as an octree.  Where
data values are dense, the block grid is divided and subdivided
again until each block contains only a short list of I, J, K values
to search through, improving performance.
@.eS
Adaptive block tables are slower to construct, but execute more rapidly
in the areas with dense grids.
People with irregular datasets where the distribution of data points
is uneven should try setting AVS_ADAPT_TABLE 1 to see if it improves
the performance of the \f3arbitrary slicer\f1, \f3threshold slicer\f1,
\f3streamline\f1, \f3particle advector\f1, \f3hedgehog\f1, \f3probe\f1, and 
\f3color geom\f1 modules.  AVS_ADAPT_TABLE is 0 (off) by default.
@.TP 6P
\f3AVS_GEOM_WRITE_V30 \f2switch\f1
A 1 value causes the Geometry Viewer's \f3Save Scene\f1 and
\f3Save Object\f1 functions
to save scenes and objects as Geometry Viewer Script Language \f2.scene\f1
and \f2.obj\f1 files, as occurred in AVS Release 3.0 and earlier,
rather than in a single CLI \f2.scr\f1 file.  It is provided for backward
compatibility.  It is 0 (off) by default.
@.TP 6P
\f3AVS_HELP_PATH\fP
Specifies one or more locations in the file system for AVS to use
when searching for on-line help files.
See Appendix D of the \f2AVS Developer's Guide\fP for more on this
variable.
@.TP 6P
\f3AVS_MEM_CHECK \f2switch\f1
@.sp 0
@.TP 6P
\f3AVS_MEM_HISTORY \f2switch\f1
@.sp 0
@.TP 6P
\f3AVS_MEM_VERBOSE \f2integer\f1
These three environment variables are all used by the alternate
memory allocation routines invoked with the include file
\f2/usr/avs/include/mem_defs.h\f1.  These routines replace the UNIX
standard memory allocation utilities such as \f2malloc\f1 with AVS
utilities that perform extensive dynamic memory allocation/deallocation
bug checking.  See the "Memory Allocation Debugging" section in the
"Advanced Topics" chapter of the AVS \f2Developer's Guide\f1 for
more information on these utilities.
@.TP 6P
\f3AVS_MG_TROFF \f2switch\f1
Causes the AVS Module Generator to generate its module man page
documentation templates in \f2troff\f1 format rather than the
default preformatted text man page using tabs and blanks.  This
option is 0 (off) by default.
@.TP 6P
\f3DIALS \f2devicefilespec\f1
Indicates the serial communications port to which a dialbox device
is attached.  Dialboxes may not be supported on all platforms.
@.TP 6P
\f3DISPLAY \f2host:server.screen\f1
(required)
Used by the X Window System to
indicate the display screen at which you're working.
@.TP 6P
\f3DISPLAYCLASS \f2string\f1
\f2string\f1 is used to specify an alternate
\f2/usr/avs/runtime/Xdefaults\f1 file, such as the supplied
\f2/usr/avs/runtime/Xdefaults.X\f1.  Also causes AVS to use
alternate \f2.avsrc.string\f1 startup files, both the default
in the \f2/usr/avs/runtime\f1 directory (no such alternative
is supplied with the release), and user \f2.avsrc\f1
files.  Both may be customized to make AVS behave differently
on different types of display hardware, such as an X terminal.
\f3-class\f1 is the command line equivalent.
@.TP 6P
\f3EDITOR\f1
The AVS Module Generator will use this common UNIX environment
variable's value as the default text editor that it will start
when you press the Module Generator's \f3Edit\f1 function.
@.TP 6P
\f3SPACEBALL \f2devicefilespec\fP
Indicates the serial communications port to which a Spaceball device
is attached.
Spaceballs may not be supported on all platforms.
\".TP 6P
@.\"\f3AVS_NUM_PROCS\f1
@.\"This environment variable only has meaning on Stardent ST3000VS
@.\"systems.  It controls how many of the system's parallel processors the
@.\"Dore graphics library will execute on.  (AVS uses Dore as its
@.\"underlying rendering package on Stardent "Titan" series
@.\"systems.)  The default is 1.
@.\".TP 6P
@.\"\f3DORE_ARGS\f1
@.\"(optional)
@.\"This environment variable only has meaning on Stardent "Titan" series
@.\"systems.  It controls some aspects of the Dore' graphics library
@.\"execution.  Specifically, it is the equivalent of the Dore' \f3DoDevice\f1
@.\"function call.  Its arguments are described in the "Device Driver"
@.\"appendix of the Stardent \f2Dore' Programmer's Guide\f1.  The
@.\"argument string should be enclosed in quotes with individual
@.\"arguments separated by semi-colons.
@.if n .Ee
@EOF

chmod 770 avs.6

exit 0
Technical Details
Message-ID: <1992Aug7.145937.10078@ctr.columbia.edu>
Path: arc1-ca.pugleaf.net!sparky!uunet!cs.utexas.edu!qt.cs.utexas.edu!yale.edu!yale!gumby!destroyer!sol.ctr.columbia.edu!phobos!lbm
References: <BsJx6t.1sx@cs.psu.edu>

Show Full Headers
Complete Article Headers
Newsgroups: comp.graphics.avs
Path: arc1-ca.pugleaf.net!sparky!uunet!cs.utexas.edu!qt.cs.utexas.edu!yale.edu!yale!gumby!destroyer!sol.ctr.columbia.edu!phobos!lbm
From: lbm@avs.com (Linda B. Merims)
Subject: Re: Anyone have an unformatted man page for AVS?
Organization: Advanced Visual Systems Inc.
References: <BsJx6t.1sx@cs.psu.edu>
Message-ID: <1992Aug7.145937.10078@ctr.columbia.edu>
Sender: news@ctr.columbia.edu (The Daily Lose)
X-Newsreader: Tin 1.1 PL4
Date: Fri, 7 Aug 1992 14:59:37 GMT
X-Posted-From: phobos.avs.com
X-Posted-Through: sol.ctr.columbia.edu
Lines: 978