pkg://xbmbrowser-5.1p0.tgz:42076/
man/
cat1/xbmbrowser.0
downloads
XBMBROWSER(1) XBMBROWSER(1)
NNAAMMEE
xbmbrowser - view and manage X bitmap and X pixmap files.
SSYYNNOOPPSSIISS
xxbbmmbbrroowwsseerr [ -_o_p_t_i_o_n_s... ] [ _d_i_r_e_c_t_o_r_y ]
DDEESSCCRRIIPPTTIIOONN
xxbbmmbbrroowwsseerr will show you all the bitmaps or pixmaps in the
_d_i_r_e_c_t_o_r_y if it is specified otherwise it will look in the
current directory. Note that if the program can not
change directory to the _d_i_r_e_c_t_o_r_y in the command line it
will exit and print an error message.
Once started the User can change the directory being dis
played by either
· Editing the displayed current directory
string on the main application window.
· Selecting a directory from a popup menu, by
pressing a mouse button over the displayed
current directory string. This is the recom
mended method when you are moving around a
directory tree that you know very well.
· 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 to regularly.
This latest version of xxbbmmbbrroowwsseerr will also display small
symbols for all the other files and directories present in
the displayed directory. These symbols can be turned of if
desired either through command line options, resources, or
interactivly within the program.
You can perform a many different operations on bitmap (or
pixmap) file that is being displayed, or even any of the
other files in the current directory. These operations
include, Rename, Copy, Delete, Edit and Set it as the
background root window pattern.
These operations are initialized from a default library
configuration file "_/_u_s_r_/_l_i_b_/_X_1_1_/_x_b_m_b_r_o_w_s_e_r_/_x_b_m_
_b_r_o_w_s_e_r_._m_e_n_u", or from the users own version of this file
"_._x_b_m_b_r_o_w_s_e_r_r_c" in the user's home directory.
26 May 1995 1
XBMBROWSER(1) XBMBROWSER(1)
OOPPTTIIOONNSS
XXbbmmbbrroowwsseerr will take all the normal _X_t_o_o_l_k_i_t options as
well as the following command line options. All but the
--ccff option can also be turned on and off as and when
required from an "_O_p_t_i_o_n_s" menu (middle button along the
top of the main application window) or its default set via
X resource.
--ccff "_f_i_l_e"
--ccoonnffiigg "_f_i_l_e"
Load the menu configuration from the given
_f_i_l_e instead of either the users rc file
"_._x_b_m_b_r_o_w_s_e_r_r_c" or the library configuration
file "_/_u_s_r_/_l_i_b_/_X_1_1_/_x_b_m_b_r_o_w_s_e_r_/_x_b_m_
_b_r_o_w_s_e_r_._m_e_n_u".
--ssoolliidd This controls the two different styles in
which xbmbrowser can display the icons. The
first --ssoolliidd option uses a solid background
with the icons displayed in shaped windows.
This option is generally only usful on color
displays and is by default enabled if this
is the case. You can override this auto
matic setting with the X resource below.
Resource: XXbbmmBBrroowwsseerr..ssoolliidd__bbggnndd:: _T_r_u_e
--ssttiippppllee
This other option is just the oppisite of
the --ssoolliidd option above. Display a stipple
(checker board grey pattern) as the back
ground and display the icon images in boxed
(un-shaped) windows. This option is the
original default of xxbbmmbbrroowwsseerr. It also pro
duces a better display on monocrome displays
and as such is automatically selected as the
defult for such displays. You can override
this automatic setting with the X resource
below.
Resource: XXbbmmBBrroowwsseerr..ssoolliidd__bbggnndd:: _F_a_l_s_e
--((nnoo))llaabbeell
Display (or not) the filenames under the
icon or symbols shown.
Resource: XXbbmmBBrroowwsseerr..llaabbeell__aallll:: _F_a_l_s_e
26 May 1995 2
XBMBROWSER(1) XBMBROWSER(1)
--((nnoo))iiccoonnssoonnllyy
Only display (or not) the actual icons
(bitmaps and pixmaps) found in the current
directory. In other words do not display
and file symbols for directories or other
files found in the current directory. This
option is provided to allow the user to turn
of the display of a large number of file
symbols that can appear at times, and return
xbmbrowser back to the `older' version
style.
Resource: XXbbmmBBrroowwsseerr..iiccoonnss__oonnllyy:: _F_a_l_s_e
--((nnoo))ddiirr
Display (or not) directory symbols for any
sub-directories found. The ".." directory
symbol will also be removed.
Resource: XXbbmmBBrroowwsseerr..sshhooww__ddiirr:: _T_r_u_e
--((nnoo))xxppmmbbaadd
Display (or not) any pixmaps which failed to
load properly. This Pixmaps usally couldn't
be displayed as they were unable to allocate
enough colors on the current display. To
display these, try quiting some other appli
cations, removing any root background image
you may have on your display, or even delete
or move other pixmaps in the current direc
tory elsewhere.
Resource: XXbbmmBBrroowwsseerr..sshhooww__xxppmmbbaadd:: _T_r_u_e
--((nnoo))ootthheerr
Display (or not) the other files found in
the current directory. As part of the
attempt to load these files as icons for
display, xxbbmmbbrroowwsseerr has determined weather
or not these files are either binary, plain
text, or some other special file type. It
will use an appropiate file symbol to show
the user its findings. _N_O_T_E_: Picture Image
formats such as gif and jpeg will appear as
binary files.
Resource: XXbbmmBBrroowwsseerr..sshhooww__ootthheerr:: _F_a_l_s_e
--((nnoo))hhiiddddeenn
Include in the display (or not) the UNIX
26 May 1995 3
XBMBROWSER(1) XBMBROWSER(1)
hidden (or `dot') files found in the direc
tory. Note that this only allows these hid
den files to be shown, other options (above)
may or may not permit these files to be vis
ible. EG: hidden directories will not be
visible in the display if either hidden
files or directories are not visible.
Resource: XXbbmmBBrroowwsseerr..sshhooww__hhiiddddeenn:: _F_a_l_s_e
--RR or --rreeccuurrssiivvee
This option can slow xbmbrowser enormously.
When it is turned on, initially by this com
mand line option, or interactively through
the "_O_p_t_i_o_n_s" menu, xxbbmmbbrroowwsseerr will recur
sively scan and display all the files in the
directories under the current directory.
This directory search can take a very very
long and could result in system limitations
crashing the program. As such this option
will be automatically turned off any time
xxbbmmbbrroowwsseerr successfully changes the current
directory.
Resource: XXbbmmBBrroowwsseerr..rreeccuurrssiivvee:: _F_a_l_s_e
This option was provided at the request of
Steve Kinzler to allow xxbbmmbbrroowwsseerr to scan
the directory tree structure of his
``picons'' collection (See SEE ALSO
below).
OOTTHHEERR XX RREESSOOUURRCCEESS
Other than those associated with command line others the
following resources are also available and usful in your
.Xdefults or other resource control files.
XXbbmmBBrroowwsseerr..sshhaappee__ssyymmss:: _T_r_u_e
Controls if the non-icon file symbols are to
be displayed in a shaped window or as a
boxed symbol. Note that by default this is
initially set equal to the value of the XXbbmm
BBrroowwsseerr..ssoolliidd__bbggnndd:: (see --ssoolliidd commandline
option above) unless overridden by your own
resource setting (IE: True on color displays
False on monocrome).
XXbbmmBBrroowwsseerr..llaabbeell__ssyymmss:: _F_a_l_s_e
Label only the file symbols. The
26 May 1995 4
XBMBROWSER(1) XBMBROWSER(1)
XXbbmmBBrroowwsseerr..llaabbeell__aallll:: resource (see
--((nnoo))llaabbeell commandline option above) can
override this value if it is True.
XXbbmmBBrroowwsseerr..ssyymm__ffoorreeggrroouunndd:: _b_l_a_c_k
XXbbmmBBrroowwsseerr..ssyymm__bbaacckkggrroouunndd:: _w_h_e_a_t
The colors to display file symbols and their
labels on the display.
XXbbmmBBrroowwsseerr..iiccoonn__ffoorreeggrroouunndd:: _b_l_a_c_k
XXbbmmBBrroowwsseerr..iiccoonn__bbaacckkggrroouunndd:: _w_h_i_t_e
The colors to display bitmap icons and their
labels with.
XXbbmmBBrroowwsseerr..iiccoonn__ttrraannssppaarreenntt:: _l_i_n_e_n
This is the color used for the transparent
(or `None') pixmap color when not using a
solid background color (and shaped windows).
It is also the color of the pixmaps label.
XXbbmmBBrroowwsseerr..ssoolliidd__bbaacckkggrroouunndd:: _g_r_e_y
The the solid background color to use.
XXbbmmBBrroowwsseerr..ssttiippppllee__bbaacckkggrroouunndd:: _p_a_l_e _g_r_e_e_n
This is a very light color to use with the
foreground color (usally black) when creat
ing the background stipple pattern. This
color is usally not used as the stipple pat
tern is normall used on monocrome display
only.
ASIDE: The forground color of the stipple
pattern currently is set to whatever the
border color of the iconbox widget is set
to. If you don't want it to be black you
can change it with the resource XXbbmmBBrroowwsseerr
ccoonnbbooxx..bboorrddeerrCCoolloorr. In a future release you
may be able to set this color and maybe the
stripple pattern used, just like the other
resources above.
Suggestion. Try setting the iiccoonn__bbaacckkggrroouunndd, iiccoonn__ttrraannss
ppaarreenntt, and ssoolliidd__bbaacckkggrroouunndd all to the same color such as
grey. This will make the background color of the bitmaps
and pixmap labels the same as the solid background color,
thus removing the square boxes around these items. This
26 May 1995 5
XBMBROWSER(1) XBMBROWSER(1)
is more like a typical WWW client display.
Unfortunately if you do this, you will loose the visual
information on the true bitmap sizes being used. You can
temporarally regain this information however by switching
to stripple (non-solid_background) mode which turns off
shaped windows.
XXbbmmBBrroowwsseerr**IIccoonnLLaabbeell..llaabbeellTToopp:: _T_r_u_e
This resource will cause xbmbrowser to place
any and all Labels above the images dis
played instead of below as is normal. This
is not strictly a xbmbrowser resource but
one for the unusal Widget it uses to handle
the display of the Bitmaps and Pixmaps.
UUSSEERR CCOONNFFIIGGUURRAABBLLEE MMEENNUUSS
This version of xxbbmmbbrroowwsseerr has a user definable menu of
commands that can be executed for displayed bitmaps
pixmaps and other files. There is a default library con
figuration file, usally located in "_/_u_s_r_/_l_i_b_/_X_1_1_/_x_b_m_
_b_r_o_w_s_e_r_/_x_b_m_b_r_o_w_s_e_r_._m_e_n_u" (check with your system program
mers) or you can have your own config file called "_._x_b_m_
_b_r_o_w_s_e_r_r_c" in your home directory. I suggest that you copy
the library file "_/_u_s_r_/_l_i_b_/_X_1_1_/_x_b_m_b_r_o_w_s_e_r_/_x_b_m_
_b_r_o_w_s_e_r_._m_e_n_u_._t_u_t", which is a heavily commented version of
the default library file, to your home directory as "_._x_b_m_
_b_r_o_w_s_e_r_r_c" and then edit it to suit your needs.
Each line of this file consists of either :-
## _c_o_m_m_e_n_t _l_i_n_e
A _c_o_m_m_e_n_t _l_i_n_e which is completely ignored.
Comments can appear at the end of any (non-
continued) line.
mmeennuu "_m_a_i_n"
mmeennuu "_m_a_i_n" "_M_a_i_n _M_e_n_u"
Add any new menu elements (see below) to
this menu. Only specific menus are allowed
and will be titled using the optional second
argument. The menus, if defined, will be
poped up when the appropriate mouse button
is pressed on a displayed icon ot file sym
bol. If the menu is not defined the program
will `beep' the user. The following are the
menus which the user may define:-
26 May 1995 6
XBMBROWSER(1) XBMBROWSER(1)
"_m_a_i_n" The menu which pops up when
the "Main Menu" button when
pressed. Generally this is
used a menu of directories the
user likes to visit. Warning
no file is selected by the
user when using this menu so
some substitutions may be
empty strings. (See Substi
tions below)
Note: this menu must be
defined. If it isn't a warning
message is printed and a
default menu containing only a
QUIT button is created.
"_g_l_o_b_a_l" A menu of global actions which
will popup when either the
first two mouse buttons are
are pressed on a displayed
icon or file symbol or any
mouse button on the background
of the icon area. If the
pointer was not over a dis
played icon or symbol, no
filename, basename, or suffix
will be defined. (See function
`selected()' below)
_N_O_T_E: If button 1 (leftmost or
select mouse button) is
pressed on a directory symbol,
the browser will automaticaly
decend into that directory,
instead of poping up the
global menu.
"_b_i_t_m_a_p" Display this menu on any dis
played X bitmap with the right
most (menu) mouse button.
"_p_i_x_m_a_p" As "bitmap", but for any X
pixmap (or pixmap which failed
to load).
"_d_i_r_e_c_t_o_r_y" Same again, but for directory
symbols.
26 May 1995 7
XBMBROWSER(1) XBMBROWSER(1)
"_o_t_h_e_r" Again, for any other file sym
bol (text, binary..).
lliinnee
Just insert a line into the menu at this
point.
iitteemm "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
long sequences to be required for some menu
items, the menu lines can be continued onto
the next line by `backslashing' (\) the
return character at 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
other quote to be used freely with the argu
ment.
Each argument can contain any number of
macro substitutions which consist of a %%
character followed by a single letter. A
percent character can be substituted with
%%%%.
The following builtin functions can be called (in
sequence) from a menu item :-
qquuiitt() Exit xxbbmmbbrroowwsseerr. Need I say more?
ssccaann() Completely scan the current directory
(Again). (See rreessccaann() below)
rreessccaann()
Do a fast rescan of the current directory.
Note that X pixmaps which failed to load
will NOT be loaded by this command, to avoid
slowing the rreessccaann() in a directory of
unloadable X pixmaps. This occurance is
actually common on a directory of pixmaps
which do not follow a standard color table.
To attempt to load these Pixmaps use either
a full ssccaann(), touch the failed pixmap when
more colors are available, or convert that
pixmap to a common color table.
26 May 1995 8
XBMBROWSER(1) XBMBROWSER(1)
Alturnatively, display the pixmap in a sec
ondary image viewer (converting it if nes
sary).
cchhddiirr("_d_i_r")
Change directory to the given directory. If
the directory change succeeds xbmbrowser
will automatically do a full ssccaann() of the
new directory. If this fails, no ssccaann()
will be performed.
eexxeecc("_c_o_m_m_a_n_d")
Execute the given bourne shell _c_o_m_m_a_n_d. Any
output by the command executed will be to
the standard output (or error) of xbm
browser, usally the users terminal.
ccoonnffiirrmm("_p_r_o_m_p_t")
Ask the user to confirm action before con
tinuing the next function. If the user
presses ``cancal'' the current function
sequence will be aborted.
iinnppuutt("_p_r_o_m_p_t","_i_n_i_t_i_a_l")
Ask the user for some input, giving the user
the "_i_n_i_t_i_a_l" string to start with. The
result entered by the user will be returned
in the substitution marco %%ii (see below).
The ``cancal'' button will abort the current
function sequence.
sseelleecctteedd()
If the user pointer was NOT over an icon or
symbol then abort the current sequence with
a popup error. This function is not usful
in anything but the "global" menu, as in the
other menus an icon is either always or
never selected.
The following are substition macros can be used within
function arguments :-
%%dd The current directory of the browser. Note
that a the directory seperator '/' have been
pre-added to this substition macro.
%%ff The filename of the icon (or file) selected
by the user.
%%bb The basename (suffix removed) of the current
filename.
%%ss The suffix of the current filename EG:
26 May 1995 9
XBMBROWSER(1) XBMBROWSER(1)
".xbm"
%%ii The users input of the last iinnppuutt() function
(see above).
%%hh The Users Home directory (do NOT use ~ in an
argument for this). Note that a the direc
tory seperator '/' have been pre-added to
this substition macro.
%%DD The Initial Startup Directory. This is
either the directory XXbbmmBBrroowwsseerr was started
in or was given to it as an command line
argument.
%%%% 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 same as the %f substition.
WARNING: the substitution macros %f, %b and %s will be an
empty string if the users pointer was not over a display
icon or file symbol. See the function selected() above.
FFIILLEESS
_~_/_._x_b_m_b_r_o_w_s_e_r_r_c
User's own menu configuration file.
_/_u_s_r_/_l_i_b_/_X_1_1_/_x_b_m_b_r_o_w_s_e_r_/_x_b_m_b_r_o_w_s_e_r_._m_e_n_u
Default library menu configuration file.
_/_u_s_r_/_l_i_b_/_X_1_1_/_x_b_m_b_r_o_w_s_e_r_/_x_b_m_b_r_o_w_s_e_r_._m_e_n_u_._t_u_t
Verbose menu configuration file (with extra exam
ples).
Note: Some of these files may be installed in different
directories on your system, for example
_/_u_s_r_/_X_1_1_R_6_/_l_i_b_/_X_1_1. If you are not sure, please contact
your local system programmers.
SSEEEE AALLSSOO
````AAnntthhoonnyy''ss IIccoonn LLiibbrraarryy''''
This is a HUGE library of bitmaps and pixmaps of
`icon' size. The library is sorted into sections
based of size and intended usage of the icons. All
the pixmaps in the library follow a standard color
table of 30 colors so you can use and view as many
pixmaps as you require. It is for the coordination
of this library that xbmbrowser was originally
developed.
26 May 1995 10
XBMBROWSER(1) XBMBROWSER(1)
The coordinator is AAnntthhoonnyy TThhyysssseenn, and the last
release is downloadable from
_f_t_p_:_/_/_f_t_p_._c_i_t_._g_u_._e_d_u_._a_u_/_p_u_b_/_A_I_c_o_n_s_/ or directly
accessable (between releases) via the World Wide
Web on _h_t_t_p_:_/_/_w_w_w_._c_i_t_._g_u_._e_d_u_._a_u_/_~_a_n_t_h_o_n_y_/_i_c_o_n_s.
Also in this library (under support) is a collec
tion of scripts and a xbmbrowser config (rc) file
to provided a much expanded set of menus for icon
handling and conversion.
````PPIIccoonnss'''' bbiittmmaapp ccoolllleeccttiioonn
A collection of bitmaps and pixmaps all 48 by 48
pixels in size. This collection is designed for
use by mail and news readers, and as such is sorted
into: news groups, logos, and people sorted by
email address. The icons is stored in a large
directory structure making the recursive scan fea
ture a must for viewing this collection.
The coordinator is SStteevvee KKiinnzzlleerr _k_i_n_z_l_e_r_@_c_s_._i_n_d_i_
_a_n_a_._e_d_u and the collection is downloadable from
_f_t_p_:_/_/_f_t_p_._c_s_._i_n_d_i_a_n_a_._e_d_u_/_p_u_b_/_f_a_c_e_s_/_p_i_c_o_n_s_/ or on
the WWW from _h_t_t_p_:_/_/_w_w_w_._c_s_._i_n_d_i_
_a_n_a_._e_d_u_/_p_i_c_o_n_s_/_f_t_p_/_i_n_d_e_x_._h_t_m_l .
AAUUTTHHOORRSS
Original Programmer
AAsshhlleeyy RRoollll -- ash@cit.gu.edu.au ( upto version 3.4
)
Current Programmer & Original Idea for Program
AAnntthhoonnyy TThhyysssseenn -- anthony@cit.gu.edu.au ( version
4.0 and later )
26 May 1995 11
