VUEPAD(1X) UNIX Programmer's Manual VUEPAD(1X)
NAME
vuepad - The HP VUE Text Editor .
SYNOPSIS
vuepad [file ...]
DESCRIPTION
The Vuepad program is a text editor for use within the X
Window System environment. The Text Editor allows the use
of the mouse for moving the edit cursor and for selecting
portions of text for editing operations. The Text Editor
also supports the HP VUE drag and drop, allowing the user to
drag file icons from the HP VUE file manager onto the Text
Editor window for editing.
When started with the -server option, the Text Editor can
simultaneously display and edit many files. Subsequent
invocations of the Text Editor will cause the first running
"server" copy to open a new window editing the specified
file. If the "server" Text Editor cannot access the speci-
fied file directory, then the Text Editor process which sent
the request will continue to run and will open its own win-
dow. Only one Text Editor can be started with the -server
option to a single X Display.
The multi-window feature restricts the ability to change
resources for a particular window. Only those resources
listed below, with the exception of useMessaging and exitOn-
LastClose can be set (via command line options) for an indi-
vidual Text Editor window. If more control is required, the
use of the -standAlone command line option will allow access
to any and all normally exposed resources such as fontList
or colors.
OPTIONS
The following options are available from the command line
-session session file
This option takes the name of a session file as an
additional parameter. The text editor is run with the
specified session file name. The session file is a
file that was previously saved by the text editor
through a session shutdown. This option causes all
other command line options to be ignored, as all set-
tings are taken from the specified session file.
-noMessaging
This option forces the Text Editor to refrain from con-
necting to the BMS. This will result in the Text Edi-
tor only displaying and editing a single file. In
HP VUE 3.0 (11/92) 1
VUEPAD(1X) UNIX Programmer's Manual VUEPAD(1X)
addition, the Text Editor is unable to support the
dragging and dropping of files in this mode. This is
equivalent to setting the useMessaging resource to
False.
-standAlone
This option forces the Text Editor to ignore the pres-
ence of other running copies of the Text Editor but
still connect to the BMS. This can be useful if one
desires an instance of the Text Editor with an environ-
ment different from that of other Text Editor windows.
An example would be running an instance under a dif-
ferent locale, or with different color resources. The
Text Editor is able to support the dragging and drop-
ping of files in this mode. This is equivalent to set-
ting the standAlone resource to True.
-mainTitle String
Specifies the string to be used as the window title.
If this resource is non-NULL, then this string is com-
bined with the current file name to form the window's
title. The string is also used in the title of all
dialogs displayed by the Text Editor.
-wordWrapOn
Specifies that the Word Wrap option in the Edit menu be
enabled at start up.
-noBlocking
Specifies that the Text Editor process terminate as
soon as the server Editor signifies that it can edit a
file in the referenced directory. In the absence of
this option the Text Editor will block, waiting for
notification from the server Editor indicating that the
window has been closed.
-server
Specifies that the Text Editor should run with no ini-
tial window displayed. In this mode the Text Editor
waits for a message forwarded by the Broadcast Message
Server (BMS) telling it to open a window editing a par-
ticular file. The BMS is normally configured to use
this option to start the Text Editor.
-workspaceList String
Specifies a list of workspace names. The Text Editor
window created will appear in all the named workspaces.
-noNameInTitle
Tells the Text Editor to refrain from displaying the
name of the file being edited. This can be useful if
the file being edited is a temporary file with a
HP VUE 3.0 (11/92) 2
VUEPAD(1X) UNIX Programmer's Manual VUEPAD(1X)
meaningless name.
-insertOnDrop
Specifies that an unmodified drop action should result
in the file contents being inserted (aka included),
rather than invoking the Open file functionality. In
this case, the [CTRL] modifier will invoke the Open
functionality.
-noChange
Specifies that the name of the file currently being
edited should not change as the result of a Save As
operation. By default, the file specified in the Save
As operation is taken as the active file.
-useNewSaveAs
Specifies that the Text Editor should present the user
with a revised dialog for the Save As functionality.
This dialog closely matches those used by other com-
ponents in the MPower multimedia product.
-statusLine
Specifies that the Text Editor should display a status
line at the bottom of the editor window. This status
line contains two text fields which display the current
line number and the current character column position
of the insert cursor.
-noDrop
Specifies that the affected Text Editor window should
not allow files to be dropped upon it. This can be
used to limit the user's ability to open other files.
-directory String
Specifies the directory which should seed the contents
of the Open, Include, and Save As dialogs, regardless
of the location of any initial file.
RESOURCES.
The following table and descriptions define resources used
to specify data for the vuepad program.
Vuepad Resource Set
Name Class Type Default
___________________________________________________________
blocking Blocking Boolean True
confirmationString ConfirmationString String NULL
mainTitle MainTitle String NULL
session Session String NULL
useMessaging UseMessaging Boolean True
HP VUE 3.0 (11/92) 3
VUEPAD(1X) UNIX Programmer's Manual VUEPAD(1X)
standAlone StandAlone Boolean False
wordWrapOn WordWrapOn Boolean False
exitOnLastClose ExitOnLastClose Boolean False
workspaceList WorkSpaceList String NULL
nameInTitle NameInTitle Boolean False
insertOnDrop InsertOnDrop Boolean False
noChange NoChange Boolean False
iconFontList IconFontList String NULL
useNewSaveAs UseNewSaveAs Boolean False
statusLine StatusLine Boolean False
noDrop NoDrop Boolean False
directory Directory String NULL
blocking
Specifies that the editor should block waiting for the
user to Exit or Close the window associated with this
particular edit request. Setting this resource False
is equivalent to specifying the -noBlocking command
line option.
confirmationString
Specifies the string to be put in a dialog box to ask
the user a yes/no question immediately before exiting
the editor. This is typically used by an invoking pro-
gram. As an example, a mail program could use this
resource to ask the user if they wish to send the mes-
sage. The user's response determines the exit status
of the Text Editor, with a "Yes" response resulting in
an exit status of 0, and a no response resulting in an
exit status of 1.
mainTitle
Specifies the string to be used as the window title.
This is functionally equivalent to the -mainTitle com-
mand line option
session
Specifies the saved session file to use in restoring a
previously saved Editor session. This is functionally
equivalent to the -session command line argument.
useMessaging
Used by the HP VUE Lite configuration. Setting this
resource to False is equivalent to specifying the
-noMessaging command line option.
HP VUE 3.0 (11/92) 4
VUEPAD(1X) UNIX Programmer's Manual VUEPAD(1X)
standAlone
Specifies whether the Text Editor should attempt to
connect to an already running copy of the Editor. Set-
ting this resource to True is equivalent to specifying
the -standAlone command line option.
wordWrapOn
Specifies whether the Text Editor should have word wrap
enabled (True) or disabled (False) when the editor is
started. Setting this resource to True is equivalent
to specifying the -wordWrapOn command line option.
exitOnLastClose
Specifies whether the Text Editor process should ter-
minate when the last active edit window is closed. If
this resource is False, then the Text Editor will con-
tinue to run, ready to receive a message to edit a
file. If this resource it True, then the Text Editor
terminates when the last active edit window is closed.
workSpaceList
This is equivalent to the -workSpaceList command line
option.
nameInTitle
Setting this False is equivalent to specifying the
-noNameInTitle command line option.
insertOnDrop
Setting this True is equivalent to specifying the
-insertOnDrop command line option.
noChange
Setting this True is equivalent to specifying the
-noChange command line option.
iconFontList
Specifies the fontlist for use in displaying text asso-
ciated with the multimedia icons.
useNewSaveAs
Setting this resource True is equivalent to specifying
the -useNewSaveAs command line option.
statusLine
Setting this resource True is equivalent to specifying
the -statusLine command line option.
noDrop
Setting this resource True is equivalent to specifying
the -noDrop command line option.
HP VUE 3.0 (11/92) 5
VUEPAD(1X) UNIX Programmer's Manual VUEPAD(1X)
directory
This is equivalent to the -directory command line
option.
COPYRIGHT
Copyright 1991, 1992, 1993 Hewlett-Packard Company.
ORIGIN
Hewlett-Packard Company.
HP VUE 3.0 (11/92) 6