Command line options and parameters by lindash


Command line options and parameters

More Info
									Command line options
and parameters

xwaves has a number of command line options that can be used when it is
started from a terminal window. The options influence the way xwaves
functions and the parameter files with which it is initialized. You can use the
following options and parameters:
    xwaves [ -w wave_pro ] [ -s ] [ -c ]
    [ -n alternate_name ] [ -p socket_port ]
    [ infile1 infile2 ... ]

The options (indicated by the minus sign) will be discussed soon. First a
word on the parameters.

Parameters to xwaves
The file(s), if any, specified on the command line will be interpreted by
xwaves either as data to be displayed or as commands to be executed,
depending on the file contents. If the first non-comment line (not starting
with #) in the file is a line beginning with waves, the file will be interpreted
as a command file. Up to 50 files may be specified on the command line.

Entropic, Inc.                                                               3
Command line options and parameters

It is usually a good idea to run xwaves as a background process. This will
permit interaction with the UNIX shell in which xwaves was started and
thus give access to exactly the execution environment that xwaves has.

There is a Glossary in waves+ Reference that explains some of our terminol-

Options to xwaves
The command-line options recognized by xwaves are:
    -w wave_pro Specifies the startup profile to be read. If this
       option is not used, xwaves attempts to read the file
       .wave_pro along the search path $HOME:$ESPS_BASE/
       lib/waves. That is, it first looks for a file named
       .wave_pro in the user’s home directory, and then it looks
       in the directory $ESPS_BASE/lib/waves. The search
       path used can be overridden by setting the UNIX environ-
       ment variable WAVES_PROFILE_PATH before starting
       xwaves. This search path is used for user supplied file
       names also.
    -c Specifies that xwaves creates its colormap segment as
       STATIC. The reason to make a colormap segment STAT-
       IC is that this makes it eligible for sharing with other appli-
       cations on the same X server. Since xwaves uses a rather
       large colormap, there might be interference, if another ap-
       plication on the same server tries to allocate a large color-
       map (such as another copy of xwaves). A side effect of
       making the colormap STATIC is that the colormap cannot
       be changed after the initial one is loaded. In addition, the
       variation of the color threshold and contour marking via the
       mouse in spectrogram display window do not work with
       STATIC colormaps.
        If you must run more than one copy of xwaves on the same
        X server and you have colormap problems (flashing as you
        move the mouse around and/or incorrect colors), start each

4                                                           Options to xwaves
                              Command line options and parameters

         xwaves with the -c option and have them all load the same
         colormap via the file .wave_pro. They will then share the
         colormap segment.
    -s     Specifies that xwaves starts up in server mode (now ob-
         solete). This is equivalent to executing the xwaves com-
         mand enable_server. When in server mode, xwaves
         listens on a socket for commands sent by external scripts or
         programs that use the send_xwaves() (3-ESPS) library
         functions. This server mode is no longer needed by any En-
         tropic supplied programs, and is only provided for compat-
         ibility with old user written programs.
         In pre-5.0 versions of xwaves it was necessary to be in the
         server mode for the send_xwaves (1-ESPS) command to
         function. This is no longer true, since send_xwaves (1-
         ESPS) now uses a different communications protocol, one
         that is done via the X server in a way that is compatible
         with Tcl/Tk. For new applications, see SendXwavesNoRe-
         ply() (3-ESPS) and SendXwavesReply() (3-ESPS) li-
         brary functions.
    -p socket_port Specifies the INET domain socket port
       number to listen on when in server mode (not necessary for
       version 5.0 and later). If this option is not used and if the
       UNIX environment variable WAVES_PORT is defined, the
       port will be set to the value of WAVES_PORT. If
       WAVES_PORT is not defined, a compiled in default is used.
       The port number can be changed at any time by setting the
       xwaves global socket_port (see the reference in
       “xwaves Symbols” in waves+ Reference ); the change will
       take effect the next time the enable_server command is
       executed. Note: See the comment above concerning the
       phase out of this server mode.

Entropic, Inc.                                                          5
Command line options and parameters

6                                     Options to xwaves

To top