Opaco-panel
								 ===========

NAME
		opaco is a lightweight panel for Linux desktops, written in GTK+

SYNOPSYS
		opaco [OPTION]...

DESCRIPTION
		opaco is a desktop panel which provides miscellaneous visual
		information by using "modules". The current supported modules are:

			o Battery	-	Shows information about the battery status
			o Clock		-	Shows the time and eventually, the date in a tooltip
			o Launcher	-	Shows an application launcher button
			o Pager		-	Implements a simple NET_WM-compliant desktop pager
			o Separator -	Shows a vertical separator
			o Showdesktop - Shows/Hides the desktop background
			o Space		-	Adds a horizontal space (defined by user)
			o Taskbar	-	Implements a simple NET_WM-compliant taskbar
			o Systray	-	Implements a simple NET_WM-compliant system tray
			o Volume	-	Simple applet to control ALSA volume on Linux
			o WLAN		-	Includes information about Wireless devices

		Opaco-panel requires a NETWM (http://www.freedesktop.org) compliant
		window manager. Opaco-panel can be run in many instances as wanted,
		with different own configurations for each panel.

		Most updated information about opaco can be found at:

			http://www.claudiocamacho.org/tech/opaco.phtml

OPTIONS
		-p, --profile <filename>
				Used the specified profile. Profiles are loaded from the
				XDG_CONFIG_HOME or from ~/.config/opaco/<filename>. No -p
				option is equivalent to -p default.

CONFIGURATION
		The default settings are located under the home directory, in the
		~/.config subdirectory (according to the freedesktop standard). This
		file uses a very simple XML format. First and foremost, create this
		file and edit it:

			mkdir -p ~/.config/opaco
			touch ~/.config/opaco/default
			vi ~/.config/opaco/default

		In this file there has to be, at least, one option, which is:

			<config>
			</config>

		Once this option is present, the panel will load but nothing will be
		displayed on it.

		Currently, there are only three configurable items. Consider the
		following example:

			<config>
				<panel>
					<height>26</height>
					<position>top</position>
					<spacing>5</spacing>
				</panel>
				<launcher>
					<name>Opera Web Browser</name>
					<command>opera</command>
					<icon>/usr/share/icons/opera.png</icon>
				</launcher>
				<taskbar>
					<expand>yes</expand>
				</taskbar>
				<separator/>
				<pager/>
				<systray/>
				<wlan/>
				<battery/>
				<clock>
					<format>%A, %d/%m/%Y</format>
				</clock>
			</config>

		In the example, <config> makes opaco to load a default configuration
		in memory. Afterwards, we configure every single module, step by step,
		in order of apparition, from right to left.

		The <panel> item allows to change the configuration of the panel itself
		by using <height> (for the panel height) and <position> (which ca be set
		at 'top' or 'bottom'). The 'spacing' is the spacing, in general, between
		modules attached to the panel.

		The <launcher> item allows to insert an application launcher button in
		the panel, which will show an icon and, eventually execute an external
		program when being clicked with the left mouse button. The optional
		<name> and <icon> tags define a tooltip and an image icon for the
		launcher button.

		The <space> with <expand>yes</expand>, includes a stretching space from
		the last module until the beginning of the next panel. This space must
		be empty by definition.

		The <taskbar/> statement indicates Opaco to load a taskbar, which uses
		the libwnck to draw the tasks list and their state.

		The <separator/> module shows a vertical line, indicating separation
		between modules in the panel.

		The <pager/> statement makes Opaco to load a desktop pager, which uses
		the libwnck to draw the windows and workspaces.

		The <systray/> statement indicates opaco to load a standard system tray.
		Unfortunately, this function is not yet very functional nor stable.

		The <wlan/> module includes information about the Wireless device(s) in
		the computer. THIS MODULE IS STILL UNDER HEAVY DEVELOPMENT.

		The <battery/> entry allows to configure the battery. However, no
		options are available at this point.

		The <clock> entry allows to configure the clock. The only option
		currently support is the format for the date in the tooltip, which is a
		strftime(3) compatible expression. See strftime(3).

		NOTE: If some entry for some module is missing, the module will not be
		displayed at all.

FILES
		/usr/bin/opaco
			Executable of opaco.

		/usr/share/opaco/
			Directory with necessary files for opaco.

		/usr/share/doc/opaco/
			Directory which contains basic documentation about the project.

		~/.config/opaco/
			Directory with user's configuration

		~/.config/opaco/default
			Default profile for opaco panel

ACKNOWLEDGEMENT
		Special thanks have to be given to the projects from where Opaco-panel
		was profited:

			- Gnome Project: Battery Icons and GTK+ documentation
			- Fbpanel:		 Source code, ideas and systray plugin.
			- PerlPanel:	 WLAN icons.
			- libwnck:		 Taskbar and pager are used in Opaco-panel.

AUTHORS
		This program was created by:
		Isaac Jurado <diptongo@gmail.com>
		Claudio M. Camacho <claudiomkd@gmail.com>

		Copyright 2006, 2007 Isaac Jurado, Claudio M. Camacho

BUGS
		Please report bugs to <diptongo@gmail.com> or <claudiomkd@gmail.com>.

COPYRIGHT
		This is free software. You may redistribute copies of it under the terms
		of the GNU General Public License <http://www.gnu.org/licenses/gpl.html>

		There is NO WARRANTY, to the extent permitted by law.

		For more information, please read LICENSE.