--  README for bbsmount 0.3.1 - a tool for mounting & umounting drives

--  Copyright (c) 2002-2004 by Miroslav Jezbera
--  parts Copyright (c) 1998 by John Kennis
--  parts Copyright (c) 1997,1998 by Brad Hughes.

--  This program is free software; you can redistribute it and/or modify
--  it under the terms of the GNU General Public License as published by
--  the Free Software Foundation; either version 2 of the License, or
--  (at your option) any later version.
--
--  This program is distributed in the hope that it will be useful,
--  but WITHOUT ANY WARRANTY; without even the implied warranty of
--  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
--  GNU General Public License for more details.
--
--  You should have received a copy of the GNU General Public License
--  along with this program; if not, write to the Free Software
--  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
--
-- (See the included file COPYING / GPL-2.0)
--

This tool displays drives that are mounted and umounted and allows
you to mount and umount them, but you must configure them in bbsmount
config file. This tool simulate look of the Blackbox toolbar (Blackbox
is a Windowmanager for X11). This tool was created by rewritting code of
bbdate to new purpose. To copy this look a great deal of the code is
taken from Blackbox.

This file gives a short description of the configuration possibilities of
bbsmount.

** Configuring bbsmount **
--------------------------

Blackbox users:

By default bbsmount reads the Blackbox style-file as defined in .blackboxrc 
and copies as much of the style as possible. The result is a application 
which looks a lot like the toolbar. Further configuration options can be 
found in bbsmount.style. Most likely you want to change these options, 
copy this file to somewhere in your homedir (eg blackbox/bbsmount.config) 
and edit it. Edit the file .blackboxrc and add or edit the line: 
bbsmount.configFile: <your config file>

WARNING: You have to define the entire PATH.

All style options set be reading the Blackbox-style file can be overridden by
placing them in bbsmount.config (and changing them). See bbsmount.style for all
possible options.

Make sure the file .bbtoolsrc does not exist, else the configuration style
for other Window Managers will be used.

Users other Window managers:

By default bbsmount reads the bbtoolsrc and bbsmount.nobb config files.
If you want to define your personal config-file copy bbtoolsrc to your
homedir as ./.bbtoolsrc Copy bbsmount.nobb somewhere in your homedir. 
Edit .bbtoolsrc so
bbsmount.configFile: <your config file>.

WARNING: You have to define the entire PATH.

** Copying the look of the Blackbox toolbar **
----------------------------------------------
bbsmount automaticly copes the style of the blackbox toolbar.
It copies:
toolbar                	 	-> bbsmount.frame
toolbar.label           	-> bbsmount.label
toolbar.color           	-> bbsmount.frame.color
toolbar.colorTo         	-> bbsmount.frame.colorTo
toolbar.label.color     	-> bbsmount.label.color
toolbar.label.colorTo   	-> bbsmount.label.colorTo
toolbar.textColor       	-> bbsmount.textColor
bevelWidth              	-> bbsmount.bevelWidth
window.label.focus		-> bbsmount.tooltip

WARNING: if .bbtoolsrc is defined it won't copy the blackbox style.

For the meaning of the different resources see the comments in the
config-files.

** General options **
---------------------
bbsmount.columns:			<columns count>
bbsmount.rows:				<rows count>
bbsmount.row.height:			<row height>
bbsmount.column.width:			<column width>
bbsmount.mount:				<blackbox style for button>
bbsmount.mount.pressed:			<blackbox style for pressed button>
bbsmount.checkdelay:			<check interval in seconds>
bbsmount.debuglevel:			<higher number = verbose>

** Image definitions **
-----------------------
bbsmount.ImagePrefix:		search_here_for_images
bbsmount.image1:		<path_to_first_image>
...				THERE MUST BE DEFINITION OF IMAGES 2,..,N-1 !!!
bbsmount.imageN:		<path_to_last_image>

** Command definitions **
-------------------------
Same as in image definitions.
bbsmount.command1:		<first_command>
...
bbsmount.commandN:		<last_command>
Command can be any shell construct (I use system for executing). You can use %s for mount point (if you want to use char '%' in command you have to write %%).

** Tooltip texts definition **
------------------------------
Same as in image definitions.
bbsmount.infotext1:		<tooltip_text>
...
bbsmount.infotextN:		<tooltip_text>
You can use \n for new-line and printf-like options described bellow.

** Tooltip format-like options (new feature in 0.3.1) **
--------------------------------------------------------
%[N][.N][B|k|M|G]X (%% is rewriten to %).
  |   |     `- show filesystem values in (kilo|mega|giga)-bytes
  |   `- number of digits after decimal point (see printf manual)
  `- maximum number of characters (see printf manual)

'X' can be:
u	used space
f	available space
t	total space on fs
v	display used unit (G/M/k)
F	available space %
U	used space %
d	description of this mount point (taken from bbsmount resource file)
s	mount point
e	last error when running command (from stderr)

----------------------------------------------------------------------------

** Tooltips **
--------------
bbsmount.tooltip.borderColor:		<color>
bbsmount.tooltip:			<blackbox style for pressed button>
bbsmount.tooltip.borderWidth:		<border width in pixels>
bbsmount.tooltip.timeout:		<wait this number of seconds before showing tooltip>
bbsmount.tooltip.textColor:		<color for tooltip text>

** Mount points **
------------------
bbsmount.mount1:			<STRING: mount point - %s in command definition>
bbsmount.mount1.mountedimage:		<NUMBER: image for mounted state>
bbsmount.mount1.notmountedimage:	<NUMBER: image for not mounted state>
bbsmount.mount1.action1.command:	<NUMBER: first action - see bellow>
bbsmount.mount1.action1.button:		<NUMBER: first action - see bellow>
bbsmount.mount1.mountedtext:		<NUMBER: tooltip text if mounted>
bbsmount.mount1.notmountedtext:		<NUMBER: tooltip text if not mounted>
bbsmount.mount1.errortext:		<NUMBER: tooltip text if error occured>
bbsmount.mount1.description:		<STRING: description>

** Actions **
-------------
bbsmount.mountM.actionN.command:
 - which command use when actionN occurs. If there are two numbers delimited by comma,
 the first command will be executed if not mounted, the second otherwise. Command is mandatory.
bbsmount.mountM.actionN.button:
 - mouse button which is generating this action
bbsmount.mountM.actionN.modifiers:
 - modifiers (Ctrl, Alt, ...) which must be (or can't be) to do this action.
 Valid modifiers: Shift, Lock (Caps Lock), Control, Mod1 (Alt on my system), Mod2 (Win key on my system), Mod3, Mod4, Mod5.
 NOTE: Modifiers are case sensitive!

Other:
======

The files Image.cc (.hh) are taken from the Blackbox,
only one class-name was changed.

The files LinkedListed.cc (.hh) are taken from Blackbox without any change.

and more ...

Thanks to:
==========

John Kennis <j.m.b.m.kennis@ele.tue.nl>
	For writting the bbdate (this was shape for my program).

Brad Hughes  <bhughes@tcac.net>
	For writing the Blackbox Windowmanager (and with this a great deal 
	of the code for this application).