MAN page from RedHat Other xbmbrowser-5.1-1.i386.rpm

XBMBROWSER

Section: User Commands (1)
Updated: 26 May 1995
Index

NAME

xbmbrowser - view and manage X bitmap and X pixmap files.

SYNOPSIS

xbmbrowser[ -options... ][ directory ]

DESCRIPTION

xbmbrowser will show you all the bitmaps or pixmaps in the directoryif it is specified otherwise it will look in the current directory.Note that if the program can not change directory to the directoryin the command line it will exit and print an error message.

Once started the User can change the directory being displayed by either

•: Editing the displayed current directory string on the main applicationwindow.
•: Selecting a directory from a popup menu, by pressing a mouse buttonover the displayed current directory string. This is the recommendedmethod when you are moving around a directory tree that you know verywell.
•: Clicking with the first (left-most) mouse button on a directory file symbol.
•: Or even through one of the user configurable popup menu actions (See below).This is usfull to define a specific directory that you wish to change toregularly.

This latest version of xbmbrowserwill also display small symbols for all the other files and directoriespresent in the displayed directory. These symbols can be turned of ifdesired either through command line options, resources, or interactivlywithin the program.

You can perform a many different operations on bitmap (or pixmap) filethat is being displayed, or even any of the other files in the currentdirectory. These operations include, Rename, Copy, Delete, Edit and Set itas the background root window pattern.

These operations are initialized from a default library configuration file"/usr/lib/X11/xbmbrowser/xbmbrowser.menu", or from the users ownversion of this file ".xbmbrowserrc" in the user's home directory.

OPTIONS

Xbmbrowserwill take all the normal Xtoolkit options as well as the followingcommand line options. All but the -cf option can also be turnedon and off as and when required from an "Options" menu (middlebutton along the top of the main application window) or its default setvia X resource.

-cf "file"

-config "file"

Load the menu configuration from the given file instead of eitherthe users rc file ".xbmbrowserrc" or the library configuration file"/usr/lib/X11/xbmbrowser/xbmbrowser.menu".

-solid

This controls the two different styles in which xbmbrowser can displaythe icons. The first -solid option uses a solid background withthe icons displayed in shaped windows. This option is generally onlyusful on color displays and is by default enabled if this is the case.You can override this automatic setting with the X resource below.

Resource: XbmBrowser.solid_bgnd: True

-stipple

This other option is just the oppisite of the -solid option above.Display a stipple (checker board grey pattern) as the background and displaythe icon images in boxed (un-shaped) windows. This option is the originaldefault of xbmbrowser. It also produces a better display on monocromedisplays and as such is automatically selected as the defult for such displays.You can override this automatic setting with the X resource below.

Resource: XbmBrowser.solid_bgnd: False

-(no)label

Display (or not) the filenames under the icon or symbols shown.

Resource: XbmBrowser.label_all: False

-(no)iconsonly

Only display (or not) the actual icons (bitmaps and pixmaps) found in thecurrent directory. In other words do not display and file symbols fordirectories or other files found in the current directory. This option isprovided to allow the user to turn of the display of a large number offile symbols that can appear at times, and return xbmbrowser back to the`older' version style.

Resource: XbmBrowser.icons_only: False

-(no)dir

Display (or not) directory symbols for any sub-directories found. The".." directory symbol will also be removed.

Resource: XbmBrowser.show_dir: True

-(no)xpmbad

Display (or not) any pixmaps which failed to load properly. This Pixmapsusally couldn't be displayed as they were unable to allocate enough colorson the current display. To display these, try quiting some otherapplications, removing any root background image you may have on yourdisplay, or even delete or move other pixmaps in the current directoryelsewhere.

Resource: XbmBrowser.show_xpmbad: True

-(no)other

Display (or not) the other files found in the current directory. As partof the attempt to load these files as icons for display, xbmbrowserhas determined weather or not these files are either binary, plain text,or some other special file type. It will use an appropiate file symbol toshow the user its findings. NOTE: Picture Image formats such as gifand jpeg will appear as binary files.

Resource: XbmBrowser.show_other: False

-(no)hidden

Include in the display (or not) the UNIX hidden (or `dot') files foundin the directory. Note that this only allows these hidden files to beshown, other options (above) may or may not permit these files to bevisible. EG: hidden directories will not be visible in the display ifeither hidden files or directories are not visible.

Resource: XbmBrowser.show_hidden: False

-R or -recursive

This option can slow xbmbrowser enormously. When it is turned on,initially by this command line option, or interactively through the"Options" menu, xbmbrowser will recursively scan and displayall the files in the directories under the current directory. Thisdirectory search can take a very very long and could result in systemlimitations crashing the program. As such this option will beautomatically turned off any time xbmbrowser successfully changesthe current directory.

Resource: XbmBrowser.recursive: False

This option was provided at the request of Steve Kinzler to allowxbmbrowser to scan the directory tree structure of his ``picons''collection (See SEE ALSO below).

OTHER X RESOURCES

Other than those associated with command line others the followingresources are also available and usful in your .Xdefults or otherresource control files.

XbmBrowser.shape_syms: True

Controls if the non-icon file symbols are to be displayed in a shapedwindow or as a boxed symbol. Note that by default this is initially setequal to the value of the XbmBrowser.solid_bgnd: (see -solidcommandline option above) unless overridden by your own resource setting(IE: True on color displays False on monocrome).

XbmBrowser.label_syms: False

Label only the file symbols. The XbmBrowser.label_all: resource(see -(no)label commandline option above) can override this valueif it is True.

XbmBrowser.sym_foreground: black

XbmBrowser.sym_background: wheat

The colors to display file symbols and their labels on the display.

XbmBrowser.icon_foreground: black

XbmBrowser.icon_background: white

The colors to display bitmap icons and their labels with.

XbmBrowser.icon_transparent: linen

This is the color used for the transparent (or `None') pixmap colorwhen not using a solid background color (and shaped windows). It is alsothe color of the pixmaps label.

XbmBrowser.solid_background: grey

The the solid background color to use.

XbmBrowser.stipple_background: pale green

This is a very light color to use with the foreground color (usally black)when creating the background stipple pattern. This color is usallynot used as the stipple pattern is normall used on monocrome display only.

ASIDE: The forground color of the stipple pattern currently is set towhatever the border color of the iconbox widget is set to. If you don'twant it to be black you can change it with the resourceXbmBrowserconbox.borderColor.In a future release you may be able to set this color and maybe thestripple pattern used, just like the other resources above.

Suggestion. Try setting the icon_background, icon_transparent,and solid_background all to the same color such as grey. This willmake the background color of the bitmaps and pixmap labels the same as thesolid background color, thus removing the square boxes around theseitems. This is more like a typical WWW client display.

Unfortunately if you do this, you will loose the visual information on thetrue bitmap sizes being used. You can temporarally regain this informationhowever by switching to stripple (non-solid_background) mode which turnsoff shaped windows.

XbmBrowser*IconLabel.labelTop: True

This resource will cause xbmbrowser to place any and all Labels above theimages displayed instead of below as is normal. This is not strictly axbmbrowser resource but one for the unusal Widget it uses to handle thedisplay of the Bitmaps and Pixmaps.

USER CONFIGURABLE MENUS

This version of xbmbrowser has a user definable menu of commandsthat can be executed for displayed bitmaps pixmaps and other files. Thereis a default library configuration file, usally located in"/usr/lib/X11/xbmbrowser/xbmbrowser.menu" (check with your systemprogrammers) or you can have your own config file called".xbmbrowserrc" in your home directory. I suggest that you copy thelibrary file "/usr/lib/X11/xbmbrowser/xbmbrowser.menu.tut", which isa heavily commented version of the default library file, to your homedirectory as ".xbmbrowserrc" and then edit it to suit your needs.

Each line of this file consists of either :-

# comment line

A comment line which is completely ignored. Comments can appearat the end of any (non-continued) line.

menu "main"

menu "main" "Main Menu"

Add any new menu elements (see below) to this menu. Only specific menusare allowed and will be titled using the optional second argument. Themenus, if defined, will be poped up when the appropriate mouse button ispressed on a displayed icon ot file symbol. If the menu is not definedthe program will `beep' the user. The following are the menus which theuser may define:-

"main"

The menu which pops up when the "Main Menu" button when pressed. Generallythis is used a menu of directories the user likes to visit. Warning nofile is selected by the user when using this menu so some substitutionsmay be empty strings. (See Substitions below)

Note: this menu must be defined. If it isn't a warning message is printedand a default menu containing only a QUIT button is created.

"global"

A menu of global actions which will popup when either the first two mousebuttons are are pressed on a displayed icon or file symbol or any mousebutton on the background of the icon area. If the pointer was not over adisplayed icon or symbol, no filename, basename, or suffix will bedefined. (See function `selected()' below)

NOTE: If button 1 (leftmost or select mouse button) is pressedon a directory symbol, the browser will automaticaly decend into thatdirectory, instead of poping up the global menu.

"bitmap"

Display this menu on any displayed X bitmap with the right most (menu)mouse button.

"pixmap"

As "bitmap", but for any X pixmap (or pixmap which failed to load).

"directory"

Same again, but for directory symbols.

"other"

Again, for any other file symbol (text, binary..).

line

Just insert a line into the menu at this point.

item "Delete" confirm("Really delete %f?") \

exec("rm '%f'") rescan()

Insert a item into the current menu which will execute the sequence
builtin functions (see below). As it is posible for a very longsequences to be required for some menu items, the menu lines can becontinued onto the next line by `backslashing' (\) the return characterat the end of the line.

Each function may or may-not require some quoted string arguments,with the quote being either single or double, allowing the otherquote to be used freely with the argument.

Each argument can contain any number of macro substitutions whichconsist of a % character followed by a single letter. A percentcharacter can be substituted with %%.

The following builtin functions can be called (in sequence) from amenu item :-

quit(): Exit xbmbrowser. Need I say more?
scan(): Completely scan the current directory (Again). (See rescan() below)
rescan(): Do a fast rescan of the current directory. Note that X pixmaps whichfailed to load will NOT be loaded by this command, to avoid slowing therescan() in a directory of unloadable X pixmaps. This occuranceis actually common on a directory of pixmaps which do not follow astandard color table.
: To attempt to load these Pixmaps use either a full scan(), touch thefailed pixmap when more colors are available, or convert that pixmap to acommon color table. Alturnatively, display the pixmap in a secondaryimage viewer (converting it if nessary).
chdir("dir"): Change directory to the given directory. If the directory change succeedsxbmbrowser will automatically do a full scan() of the new directory.If this fails, no scan() will be performed.
exec("command"): Execute the given bourne shell command. Any output by the commandexecuted will be to the standard output (or error) of xbmbrowser, usallythe users terminal.
confirm("prompt"): Ask the user to confirm action before continuing the next function.If the user presses ``cancal'' the current function sequence will beaborted.
input("prompt","initial"): Ask the user for some input, giving the user the "initial"string to start with. The result entered by the user will be returnedin the substitution marco %i (see below). The ``cancal'' buttonwill abort the current function sequence.
selected(): If the user pointer was NOT over an icon or symbol then abort the currentsequence with a popup error. This function is not usful in anything butthe "global" menu, as in the other menus an icon is either always or neverselected.

The following are substition macros can be used within functionarguments :-

%d: The current directory of the browser.Note that a the directory seperator '/' have been pre-added to thissubstition macro.
%f: The filename of the icon (or file) selected by the user.
%b: The basename (suffix removed) of the current filename.
%s: The suffix of the current filename EG: ".xbm"
%i: The users input of the last input() function (see above).
%h: The Users Home directory (do NOT use ~ in an argument for this).Note that a the directory seperator '/' have been pre-added to thissubstition macro.
%D: The Initial Startup Directory. This is either the directoryXbmBrowser was started in or was given to it as an command lineargument.
%%: Substitutes a percent character, just in case you really do need it.

NOTE: The full path of a selected file is %d%f. Also %b%s exactly the sameas the %f substition.

WARNING: the substitution macros %f, %b and %s will be an empty string ifthe users pointer was not over a display icon or file symbol. See thefunction selected() above.

FILES

~/.xbmbrowserrc: User's own menu configuration file.
/usr/lib/X11/xbmbrowser/xbmbrowser.menu: Default library menu configuration file.
/usr/lib/X11/xbmbrowser/xbmbrowser.menu.tut: Verbose menu configuration file (with extra examples).

Note: Some of these files may be installed in different directories onyour system, for example /usr/X11R6/lib/X11.If you are not sure, please contact your local system programmers.

AUTHORS

Original Programmer

Ashley Roll -- ashAATTcit.gu.edu.au ( upto version 3.4 )

Current Programmer & Original Idea for Program

Anthony Thyssen -- anthonyAATTcit.gu.edu.au ( version 4.0 and later )

This document was created byman2html,using the manual pages.