Manpages

xv_init()

Establishes the connection to the server, initializes the Notifier and the Defaults/Resource-Manager database, loads the Server Resource-Manager database, reads any passed attributes, and installs a default X11 Errorhandler.

xv_create()

Creates an object.

xv_destroy()

Destroys an object.

xv_find()

Finds an object that meets certain criteria; or if the object doesn’t exist, creates it (default behavior which can be defeated using XV_AUTO_CREATE, FALSE).

xv_get()

Gets the value of a single attribute.

xv_set()

Sets the value of one or more attributes.

Argument(s):

-Wx, or -scale

Type:

string ("small", "medium", "large", "extra_large")

Resource:

Window.Scale

Default:

medium

Description:

Sets the initial scale of the application (larger or smaller). small is 10 pixels, medium is 12 pixels, large is 14 pixels and extra_Large is 19 pixels. The font.name resource will override the scale.

Example:

cmdtool -scale extra_large

Argument(s):

-Wt, -fn, or -font

Type:

string

Resource:

Font.Name

Default:

lucidasans-12

Description:

Sets the name of the font used for the application. Does not set the font for frame header and frame menu header. These are controlled by the window manager. To find out what fonts are available, use the xlsfonts(1) command. If the font you specify cannot be found, you will see an error message such as:

Example:

cmdtool -fn fixed

Argument(s):

-Ws, or -size

Type:

integer integer

Resource:

Window.Width and Window.Height

Default:

depends on application

Description:

Sets the width and height of the application’s base frame. The values are in pixels.

Example:

cmdtool -Ws 400 500

Argument(s):

-Ww, or -width

Type:

int (number of columns)

Resource:

window.columns

Default:

None

Description:

Specifies the width, in columns, of the application.

Example:

cmdtool -width 40

Argument(s):

-Wh, or -height

Type:

int (number of columns)

Resource:

window.rows

Default:

None

Description:

Specifies the height, in rows, of the application.

Example:

cmdtool -height 40

Argument(s):

-Wp, or -position

Type:

integer integer

Resource:

Window.X and Window.Y

Default:

depends on window manager

Description:

Sets the initial position of the application’s base frame in pixels. The upper left corner of the screen is at position (0,0), with the x-axis increasing to the left, and the y-axis increasing downward. These values will also be generated by the "Save Workspace" option on the root menu into the $HOME/.openwin-init file when using the Open Look Window Manager.

Example:

cmdtool -Wp 100 200

Argument(s):

-WG, or -geometry

Type:

string of the format <width>x<height>{+-}<xoffset>{+-}<yoffset>

Resource:

Window.Geometry

Default:

depends on application and window manager

Description:

This sets both the size and the placement of the application’s base frame. This option has priority over the -size and -position arguments. The size and placement parts of the value are optional. You can set just the size, just the position, or both. The size values are measured in pixels, and the position values use the same semantics as -position. However, if you use the ’-’ in front of an X value, it will be taken as relative to the right hand side of the screen, instead of the left. Likewise, if you use the ’-’ with the Y value, it will be taken relative to the bottom of the screen instead of the top.

Examples:

cmdtool -geometry 500x600

Argument(s):

-WP, -icon_position

Type:

integer integer

Resource:

Icon.X Icon.Y

Default:

depends on window manager

Description:

Sets the position of the application’s icon in pixels. Uses the same semantics as -position for base frames.

Example:

cmdtool -WP 400 20

Argument(s):

-Wl, -label, or -title

Type:

string

Resource:

Window.Header

Default:

N/A

Description:

Sets a default label for the base frame’s header. However, the application can overwrite this setting and display its own header.

Example:

cmdtool -Wl "Header Text"

Argument(s):

-Wi, and +Wi

Type:

boolean

Resource:

Window.Iconic

Default:

+Wi

Description:

Controls how an application will come up, open or closed (iconified).

Examples:

cmdtool +Wi (will make the cmdtool come up open)

Argument(s):

-depth

Type:

integer

Resource:

Window.Depth

Default:

Depth of server’s default visual

Description:

Specifies the depth of base frame. If this depth is not supported by the server, the default depth will be used instead. If this is specified in conjunction with -visual, then the exact visual will be used.

Example:

cmdtool -depth 4

Argument(s):

-visual

Type:

string (one of the values: StaticGray, GrayScale, StaticColor, PseudoColor, TrueColor, or DirectColor).

Resource:

Window.Visual

Default:

Server’s default visual

Description:

Specifies the visual class of the base frame. If this visual class is not supported by the server, the default visual class will be used instead. If this is specified in conjunction with -depth, then the exact visual will be used.

Example:

cmdtool -visual StaticGray

Argument(s):

-Wf, or -foreground_color

Type:

integer integer integer

Resource:

Window.Color.Foreground

Default:

0 0 0

Description

See Description in -Wb below.

Argument(s):

-Wb, or -background

Type:

integer integer integer

Resource:

Window.Color.Background

Default:

255 255 255

Description:

These options allow the user to specify the foreground color (e.g., the color of the text in a textsw), or the background color (e.g., the color that the text is painted on) of an application. The three values should be integers between 0 and 255. They specify the amount of red, green and blue that is in the color. See -fg and -bg below for information on similar functions.

Example:

cmdtool -Wf 0 0 255 -Wb 100 100 100

Argument(s):

-fg, or -foreground

Type:

string (color name, or hexadecimal color specification)

Resource:

Window.Color.Foreground

Default:

black

Description:

See Description in -bg below.

Argument(s):

-bg, or -background

Type:

string (color name, or hexadecimal color specification)

Resource:

Window.Color.Background

Default:

white

Description:

These options are similar to the -Wf and -Wb options, except that they take a color argument in the form of a predefined color name (lavender, grey, goldenrod, etc.) from $OPENWINHOME/lib/rbg.txt, or a hexadecimal representation. The hexadecimal representation is of the form pound sign (#) followed by the hexadecimal representation of the red, green and blue aspects of the color.

Examples:

cmdtool -fg blue -bg gray

Argument(s):

-WI, or -icon_image

Type:

string

Resource:

Icon.Pixmap

Default:

depends on application

Description:

Sets the default filename for the icon’s image. However, the application can overwrite this setting and display its own icon image. The file must be in XView icon format. The program iconedit(1) will allow one to create an image in the icon format. Several icons have been provided in the directory $OPENWINHOME/include/images. By convention, icon format files end with the suffix .icon.

Example:

cmdtool -WI /usr/include/images/stop.icon

Argument(s):

-WL, or -icon_label

Type:

string

Resource:

Icon.Footer

Default:

depends on application

Description:

Sets a default label for the base frame’s icon. However, the application can overwrite this setting and display its own icon label.

Example:

cmdtool -WL "Icon Label"

Argument(s):

-WT, or -icon_font

Type:

string

Resource:

Icon.Font.Name

Default:

depends

Description:

Sets the name of the font used for the application’s icon.

Example:

cmdtool -WT ’*century schoolbook*’

Argument(s):

-Wd, or -default

Type:

string string

Resource:

given by the first string

Default:

none

Description:

This option allows the user to set resources that don’t have command line equivalents. The format is -default resource-name value . The XView resources without specific command line arguments are discussed in the following section.

Example:

cmdtool -default OpenWindows.ScrollbarPlacement left

Argument(s):

-xrm

Type:

string

Resource:

given in the string

Default:

none

Description:

This option allows the user to set resources that don’t have command line equivalents. This is similar to the -default option, but it takes only one argument, a string in the form of resource-name:value.

Example:

cmdtool -xrm OpenWindows.ScrollbarPlacement:right

Argument(s):

-WH, or -help

Type:

none

Resource:

none

Default:

none

Description:

Prints a description of the valid xview command line arguments for the application.

Argument(s):

-sync or -synchronous, and +sync or +synchronous

Type:

boolean

Resource:

Window.Synchronous

Default:

+synchronous

Description:

These options allow you to make the connection that the application has with the X11 server either synchronous (-sync) or asynchronous (+sync).

Argument(s):

-Wr, or -display

Type:

string (host:display{.screen})

Resource:

Server.Name

Default:

taken from the DISPLAY environment variable

Description:

Sets the name of the X11 server on which to connect. host is the name or address of the machine on whose server you have permission to display. display is a number corresponding to the server on which to display for that machine, and screen corresponds to which screen for the server. See reference manual page on xhost(1) for more details on adding to permissions list.

Examples:

cmdtool -display foobar:0

Argument(s):

-Wdxio, or -disable_xio_error_handler

Type:

boolean

Resource:

none

Default:

enable xio handler—this option disables it

Description:

This option is useful for debugging an application. Whenever there is a fatal XIO error, the server will print an error message before exiting. XView installs a error handler to keep those messages from appearing. If you would like to see these messages, use this option.

Argument(s)

-rv (or -reverse), and +rv (or +reverse)

Type:

boolean

Resource:

Window.ReverseVideo

Default:

False

Description:

These options control whether the foreground and background colors of the application will be reversed. If True, the foreground and background colors will be swapped. The -rv flag will set this to True, while the +rv will set it to False. This is really only useful on monochrome displays.

Argument(s):

-name

Type:

string

Resource:

None

Default:

argv[0]

Description:

Specifies the instance name of the application. This name is used to construct the resource name used to perform lookups in the X11 Resource Manager to look for the values of customizable attributes.

Argument(s):

-lc_basiclocale

Type:

string

Resource:

basicLocale

Default:

"C"

Description:

Specifies the basic locale category, which sets the country of the user interface.

Argument(s):

-lc_displaylang

Type:

string

Resource:

displayLang

Default:

"C"

Description:

Specifies the display language locale category, sets the language in which labels, messages, menu items, and help text are displayed.

Argument(s):

-lc_inputlang

Type:

string

Resource:

inputLang

Default:

"C"

Description:

Specifies the input language locale category, sets the language used for keyboard input.

Argument(s):

-lc_numeric

Type:

string

Resource:

numeric

Default:

"C"

Description:

Specifies the numeric locale category, which defines the language used to format numeric quantities.

Argument(s):

-lc_timeformat

Type:

string

Resource:

timeFormat

Default:

"C"

Description:

Specifies the time format locale category, which defines the language used to format time and date.

Argument(s):

-Wfsdb, or -fullscreendebug

Type:

boolean

Resource:

Fullscreen.Debug

Default:

FALSE

Description:

Enables/disables fullscreen debugging mode during which X grabs (XGrabServer(), XGrabKeyboard(), XGrabPointer()) are not done. When using the fullscreen pkg, the X11 server will be grabbed which prevents other windows on the server from responding until the grab has been released by the one window which initiated the grab. Refer to Appendix F in the XView Manual: Converting SunView Applications for further details.

Argument(s):

-Wfsdbs, or -fullscreendebugserver

Type:

boolean

Resource:

Fullscreen.Debugserver

Default:

FALSE

Description:

Enables/disables server grabbing (XGrabServer()) that is done via the fullscreen pkg. Refer to the Appendix F in the XView Manual: Converting SunView Applications for further details.

Argument(s):

-Wfsdbk, or -fullscreendebugkbd

Type:

boolean

Resource:

Fullscreen.Debugkbd

Default:

FALSE

Description:

Enables/disables keyboard grabbing (XGrabKeyboard()) that is done via the fullscreen pkg. Refer to the Appendix F in the XView Manual: Converting SunView Applications for further details.

Argument(s):

-Wfsdbp, or -fullscreendebugptr

Type:

boolean

Resource:

Fullscreen.Debugptr

Default:

FALSE

Description:

Enables/disables pointer grabbing (XGrabPointer()) that is done via the fullscreen pkg. Refer to the Appendix F in the XView Manual: Converting SunView Applications for further details.

Argument(s):

-Wdpgs, or -disable_pass_grab_select

Type:

boolean

Resource:

Window.PassiveGrab.Select

Default:

TRUE

Description:

Disables the passive grab that is done on the SELECT button. XView does a passive grab on the SELECT button to avoid input focus race conditions. When this passive grab is disabled, input focus race conditions may be seen.

Example:

% cmdtool -disable_pass_grab_select

Resource:

Resource Name ( If the resource can be modified by the OpenWindows Property Sheet, the word Props will be present.)

Values:

Possible Values, and/or Format of Values to be Assigned to Resource (Default Value)

Description

Description of Resource.

Resource:

window.synchronous, +sync -sync

Values:

True, False (False)

Description

Useful when debugging or tracking down a problem since the error codes emitted from Xlib will correspond to the immediate request made. Running in a synchronous mode will cause the application to run significantly slower.

Resource:

mouse.modifier.button2

Values:

Shift, Ctrl, any valid modifier keysym (Shift)

Description

When using a mouse with less than three buttons, this resource gets an equivalent mapping for the second button which is the ADJUST button on a three button mouse. For more information on keysyms, see the xmodmap(1) reference manual page, Xlib documentation, and the include file $OPENWINHOME/include/X11/Xkeymap.h.

Resource:

mouse.modifier.button3

Values:

Shift, Ctrl, any valid modifier keysym (Ctrl)

Description

When using a mouse with less than three buttons, this resource gets an equivalent mapping for the third button which is the MENU button on a three button mouse. For more information on keysyms, see the xmodmap reference manual page, Xlib documentation, and the include file $OPENWINHOME/include/X11/Xkeymap.h.

Resource:

OpenWindows.beep (Props)

Values:

never, notices, always (always)

Description

When the value is notices, the audible bell will ring only when a notice pops up. When the value is never, the audible bell will never ring. When the value is always, the audible bell will always ring when the bell function is called by a program.

Resource:

alarm.visible

Values:

True, False (True)

Description

When ringing the bell in an XView program, flash the window as well to alert the user.

Values:

any valid X11 color specification (#cccccc—80% grey)

Description

Specify the base color for control areas for 3-D look. Takes hexadecimal representation. Three other colors used for shading and highlighting are calculated based upon the value of the specified control color. The actual calculated values are done by the OLGX library to provide a consistent color calculation between XView and OLWM. The desktop properties program allows a full range of customization and previews what the chosen 3-D look will look like. Does not apply to monochrome displays.

Resource:

OpenWindows.workspaceColor (Props)

Values:

any valid X11 color specification (#cccccc—80% grey)

Description

Specifies the color for the root window and the background color for icons that blend into the desktop.

Resource:

xview.icccmcompliant

Values:

True, False (True)

Description

When False, tells XView to set window manager hints in a way that was used before the ICCCM was adopted. Useful for window managers that were released before X11R4. Not needed with the Open Look Window Manager provided with Open Windows.

Resource:

OpenWindows.3DLook.Color

Values:

True, False (True on all but monochrome screens)

Description

When False, do not use the 3-D look on a color or greyscale screen.

Resource:

OpenWindows.dragRightDistance (Props)

Values:

N (100)

Description

Used by menus to determine when a pullright submenu would display when dragging over the menu item near a submenu. N is an integer greater than 0. A reasonable value might start at 20 and go to 200 or so. May need to try different values to see what feels best to each person.

Resource:

Selection.Timeout

Values:

N (3)

Description:

Selection timeout value. N indicates the number of seconds that a requestor or a selection owner waits for a response.

Resource:

OpenWindows.GotoMenu.RecentCount

Values:

integer between 0 and 15 (8)

Description:

Specifies the number of recently visited directories shown in the Go To Menu of a File Chooser.

Resource:

OpenWindows.GotoMenu.UserDirs

Values:

string-list (NULL)

Description:

new-line (0 separated list of full-path names to directories that is added to the top of the Go To Menu of a File Chooser.

Resource:

OpenWindows.KeyboardCommand.*

Description:

These resources determine mouseless semantic action and its corresponding key binding. Refer to the XView Reference Manual for a complete listing and explanation of the OpenWindows.KeyboardCommand.* resources. Refer to the XView Programming Manual for information on the mouseless model.

Resource:

OpenWindows.KeyboardCommands

Values:

SunView1, Basic, or Full

Description:

Controls the level of mouseless operation. All of the OpenWindows.KeyboardCommand resource mappings may be modified by users, or by specifying one the the three values for OpenWindows.KeyboardCommands. For detailed information see the XView Programming Manual

Resource:

OpenWindows.MenuAccelerators

Values:

True or False (True)

Description:

Specifies whether or not to activate all keyboard menu acceleration defined by applications. Menu accelerators are keystrokes that can be used to invoke menu commands directly. They can be seen on the right side of frequently used menu items as a set of keyboard qualifiers (with a graphical diamond mark representing the meta key) and an accelerator key.

Resource:

OpenWindows.MouseChordMenu

Values:

True, False (False)

Description:

Turns on the mouse chording mechanism. Mouse chording was implemented to allow XView to work with two-button mice. Pressing the SELECT and the ADJUST buttons at the same time will act as MENU button.

Resource:

OpenWindows.MouseChordTimeout

Values:

N (100)

Description:

Mouse chording time-out value. N is in micro-seconds.

Resource:

OpenWindows.SelectDisplaysMenu (Props)

Values:

True, False (False)

Description

When True, the SELECT button (usually left mouse) will display the menu as well as the MENU button (usually right mouse).

Resource:

OpenWindows.popupJumpCursor (Props)

Values:

True, False (False)

Description

When False, do not warp the mouse to the notice when it appears.

Resource:

notice.beepCount

Values:

N (1)

Description

Where N is an integer to specify how many times to ring the bell when a notice appears.

Resource:

OpenWindows.scrollbarPlacement (Props)

Values:

Left, Right (Right)

Description

When set to Left, put all scrollbars on the lefthand side of the window or object.

Resource:

OpenWindows.multiClickTimeout (Props)

Values:

N (4)

Description

Where N is an integer greater than 2. Set the number of tenths of a second between clicks for a multi-click. A click is button-down, button-up pair.

Resource:

text.delimiterChars

Values:

string (’ \011!\"#$%&\’()*+,-./:;<=>?@[\\]^_’{|}~’)

Description

This resource allows the user to select the delimiter characters that are used when doing word level selections in the XView package. It was added because of the needs of the international marketplace, and it allows the user to define the local delimiters for the character set that is being used with the current keyboard and Sun workstation.

Resource:

scrollbar.jumpCursor (Props)

Values:

True, False (True)

Description

When False, the scrollbar will not move the mouse pointer when scrolling.

Resource:

scrollbar.repeatDelay

Values:

N (100)

Description

Where N is some integer greater than 2. Specifies the time in milliseconds when a click becomes a repeated action.

Resource:

scrollbar.pageInterval

Values:

N (100)

Description

Where N is some integer greater than 2. Specifies the time in milliseconds between repeats of a single page scroll.

Resource:

scrollbar.lineInterval

Values:

N (1)

Description

Where N is some integer greater than 0. Specifies the time in milliseconds between repeats of a single line scroll. How long to pause scrolling when holding down the SELECT button on the scrollbar elevator. Scrollbar sets up a timer routine for repeats.

Resource:

text.maxDocumentSize

Values:

N (2000)

Description

Where N specifies the bytes used in memory before a text file is saved to a file on disk. Once this limit is exceeded, the text package will send a notice to the user to tell them that no more insertions are possible. If the file being edited is saved to a file, or it is a disk file being edited, then the limit does not apply.

Resource:

text.retained

Values:

True, False (False)

Description

If True, retain text windows with server backing store.

Resource:

text.extrasMenuFilename

Values:

filename (/usr/lib/.text_extras_menu)

Description

Where filename is an absolute location to a file. Can also be set via environment variable EXTRASMENU. This file is used for the text package’s Extras menu. The commands specified in the extras menu are applied to the contents of the current selection in the textsw window and then it inserts the results at the current insertion point.

Resource:

text.enableScrollbar

Values:

True, False (True)

Description

When False, do not put a scrollbar on textsw objects.

Resource:

text.againLimit

Values:

N (1)

Description

Where N is an integer between 0 and 500. Number of operations the "again history" remembers for a textsw.

Resource:

text.autoIndent

Values:

True, False (False)

Description

When True, begin the next line at the same indentation as the previous line as typing in text.

Resource:

text.autoScrollBy

Values:

N (1)

Description

Where N is an integer between 0 and 100. Specifies the number of lines to scroll when type-in moves insertion point below the view.

Resource:

text.confirmOverwrite

Values:

True, False (True)

Description

When False, do not give user confirmation if a save will overwrite an existing file.

Resource:

text.displayControlChars

Values:

True, False (True)

Description

When False, use an up arrow plus a letter to display the control character instead of the character that is available for the current font.

Resource:

Text.DeleteReplacesClipboard

Values:

True, False (False)

Description

This resource controls whether text that has been selected and then deleted by the delete key or replaced by any other keystroke will be copied to the clipboard. If the value is True, then the selected text will be copied to the clipboard. If the value is False, then the text selected does not replace the clipboard.

Resource:

text.undoLimit

Values:

N (50 maximum of 500)

Description

Where N is an integer between 0 and 500. How many operations to save in the undo history log. These operations will be undone when you press the "Undo" key in the text window.

Resource:

text.insertMakesCaretVisible

Values:

If_auto_scroll (Always)

Description

Controls whether insertion causes repositioning to make inserted text visible.

Resource:

text.lineBreak

Values:

Clip, Wrap_char, Wrap_word (Wrap_word)

Description

Determines how the textsw treats file lines when they are too big to fit on one display line.

Resource:

text.margin.bottom

Values:

N (0)

Description

Where N is an integer between -1 and 50. Specifies the minimum number of lines to maintain between insertion point and bottom of view. A value of -1 turns auto scrolling off.

Resource:

mouse.multiclick.space

Values:

N (4)

Description

Where N is an integer between 2 and 500. Specifies the maximum number of pixels between successive mouse clicks to still have the clicks considered as a multi-click event.

Resource:

text.storeChangesFile

Values:

True, False (True)

Description

When False, do not change the name of the current file being edited to the name of the file that is stored. The name of the current file is reflected in the titlebar of the textedit frame.

Resource:

text.margin.top

Values:

N (2)

Description

Where N is an integer between -1 and 50. Specifies the minimum number of lines to maintain between the start of the selection and the top of the view. A value of -1 means defeat normal actions.

Resource:

text.margin.left

Values:

N (8)

Description

Where N is an integer between 0 and 2000. Specifies the margin in pixels that the text should maintain between the left hand border of the window and the first character on each line.

Resource:

text.margin.right

Values:

N (0)

Description

Where N is an integer between 0 and 2000. Specifies the margin in pixels that the text should maintain between the right hand border of the window and the last character on each line.

Resource:

text.tabWidth

Values:

N (8)

Description

Where N is an integer between 0 and 50. Specifies the width in characters of the tab character.

Resource:

Text.LineSpacing

Values:

N (0)

Description

Where N is an integer which is the percentage of the maximum height of a character in the Textsw window font to use as interline spacing. Setting Text.LineSpacing to a nonzero positive number will increase the size of a Textsw proportionally. xv_set() of WIN_ROWS will still yield the correct number of rows. However, the window will be taller as compared to a Textsw with Text.LineSpacing set to 0. This resource allows XView to conform to TUV requirements. To meet TUV requirements, set Text.LineSpacing to 15 or greater.

Resource:

term.boldStyle

Values:

None, Offset_X, Offset_Y, Offset_X_and_Y, Offset_XY, Offset_X_and_XY, Offset_Y_and_XY, Offset_X_and_Y_and_XY, Invert (Invert)

Description

Specify the text bolding style for a terminal based window.

Resource:

term.inverseStyle

Values:

Enable, Disable, Same_as_bold (Enable)

Description

Specify the text inverting style for a terminal based window.

Resource:

term.underlineStyle

Values:

Enable, Disable, Same_as_bold (Enable)

Description

Specify the text underlining style for a terminal based window.

Resource:

term.useAlternateTtyswrc

Values:

True, False (True)

Description

When True, and a $HOME/.ttyswrc is not found, look for an alternate ttyswrc file. When False, do not look for an alternate file is one is not found in the home directory, $HOME/.ttyswrc.

Resource:

term.alternateTtyswrc

Values:

filename ($XVIEWHOME/lib/.ttyswrc)

Description

Where filename specifies a complete filename and absolute path of an alternate ttyswrc file. This is only used if a .ttyswrc file is not found in $HOME/.ttyswrc and term.useAlternateTtyswrc is True.

Resource:

term.enableEdit

Values:

True, False (True)

Description

When False, do not keep an editlog of what has been typed into the term window. This is set to false automatically when switching from a scrollable term to one that is not scrollable.

Resource:

ttysw.eightBitOutput

Values:

True, False (True)

Description

This resource controls whether characters modified by the meta modifier are encoded as eight-bit characters when passed to the ttysw’s pty or are delivered as seven-bit characters.

Resource:

ttysw.yieldModifiers

Values:

Meta, Alt (The default is to not remove any semantic meaning from any modifiers)

Description

This resource takes as a value a list of modifier keys. Any semantic meaning (mouseless command or keyboard accelerator) that would normally be associated with the listed modifiers when the keyboard focus is in a ttysw or termsw would be removed.

$OPENWINHOME/lib

XView Libraries

$OPENWINHOME/bin

Binaries