VUEACTION(1X)
NAME
vueaction — Allows non-HP-VUE applications to invoke HP-VUE actions.
SYNOPSIS
vueaction [-audio file] [-volume value] [-user
[-internal] [-external] [action [file-args]]
DESCRIPTION
Vueaction provides a mechanism by which applications or shell scripts, which are not connected to the Bradcase Message Server (BMS), can participate in the invocation of HP-VUE actions. By using the ‘audio‘ option, a sound snippet can also be played when the action is invoked.
Vueaction also allows a user name to be specified; if vueaction is not currently running as that user, then a prompt dialog will be used to collect either the password for the indicated user, or the root password. Once a valid password has been entered, the vueaction client will change so that it is running as that user, and will then initiate the requested action. Anytime the vueaction client changes to run as a different user, it will be logged in the file /usr/adm/sulog.
OPTIONS
Vueaction defines a number of command-line options, which allow the user to configure the behavior of the vueaction client. Command-line options will override any resource values specified within a resource file.
−audio file
This parameter is used to specify the audio snippet which is to be played. The filename parameter uses the ‘host:/path‘ format, with the ‘host‘ portion being optional. Only audio files of the linear-16 format are supported; this is the same format created by the vueannotator client.
−volume value
This parameter allows the user to specify the volume setting when the audio snippet is played; this value must be in the range [0 - 100], inclusive.
−user name
This parameter can be used to requet that the specified action be run as a different user; this is typically used to allow actions reserved for the super-user to be accessed by the non-super-user, who has access to the root password. If this parameter is specified, then the user will be prompted for a password; the requested action will not be initiated until either the correct password for the specified user has been entere, or the root password has been entered. All successfull or unsuccessful attempts at entering the password are logged in ’/usr/adm/sulog’. If an unknown user name is supplied, then an error dialog will be posted, and no action initiated. If this parameter is specified, and the vueaction client is already running as this user, then the user will not be prompted for a password. If a user name is specified which has no password, then the user will not be prompted for a password.
−timeout value
After the vueaction client invokes the specified action, it will remain alive until it no longer detects that any dialogs are posted for the user (i.e. error dialogs or prompt dialogs). By default, it will check every second to see if it is safe to exit. A user can use this parameter to control the frequency that this check occurs. The minimum value is 1 second.
−internal
Specifies that any audio snippets should be played on the internal speaker on the workstation.
−external
Specifies that any audio snippets should be played to the external jack, located on the back of the workstation.
action This optional parameter specifies the HP-VUE action to be performed; the action should be defined either in one of the system action database files, or in one of the user’s private action database files. If this parameter is not supplied, but the ‘audio‘ option is supplied, then only the audio snippet is played.
file-args This optional information can specify an optional set of filenames. The files can be specified in ‘host:/path‘ format, in ‘/path‘ format, or simply as a relative path; a relative path is assumed to be relative to the current working directory for the vueaction client. This list of files will be passed on to the specified action.
RESOURCES
Vueaction uses the following resources:
| Client Resource Set | |||
| Name | Class | Type | Default |
| volume | Volume | XmRInt | 70 |
| defaultDevice | DefaultDevice | XmRDevType | internalSpeaker |
Vueaction*volume
This resource allows the user to specify the volume setting when an audio snippet is played; this value must be in the range [0 - 100], inclusive. The default value is 70.
Vueaction*defaultDevice
This resource allows the user to specify whether the audio snippets are played on the built-in speaker on the workstation (internalSpeaker), or whether they are instead played to the external jack (externalJack). By default, all audio snippets are played on the internal speaker.
ENVIRONMENT VARIABLES
This client makes no direct use of environment variables. However, since it uses the audio facilities to play any user-specified sound snippets, it makes an indirect use of the environment variable used by the audio facilities for specifying the host upon which the audio snippet should be played.
AUDIO
This environment variable allows the user to specify the name of the host on which the audio snippet should be played. If not specified, then it defaults to the host upon which the vueaction client is running. If defined, the value associated with this environment variable is simply a host name, such as hpcvxff.
COPYRIGHT
Copyright 1992 Hewlett-Packard Company
ORIGIN
Hewlett-Packard Company
— February 15, 1994