Difference between revisions of "Cairo-Dock"

From ArchWiki
Jump to: navigation, search
(better categorizing, please do not suggest an aur helper over the others)
(fixed some syntax, added troubleshooting + startup howto's)
Line 4: Line 4:
 
Cairo-dock is a highly customizable dock written in C.
 
Cairo-dock is a highly customizable dock written in C.
 
==Installation==
 
==Installation==
[https://aur.archlinux.org/packages.php?ID=15201 cairo-dock] is available from the [[AUR]].
+
Install {{Package AUR|cairo-dock}} from the [[AUR]]. The core package provides only the strict minimum to run cairo-dock - to use applets, animations, views, effects and dialogs you will also need {{Package AUR|cairo-dock-plug-ins}}.
 
+
The core package provides only the strict minimum to run cairo-dock: to use applets, animations, views, effects and dialogs you will also need [https://aur.archlinux.org/packages.php?ID=31144 cairo-dock plugins].
+
  
 
You can also try the latest BZR snapshot packages: {{Package AUR|cairo-dock-bzr}} and {{Package AUR|cairo-dock-plugins-bzr }}.
 
You can also try the latest BZR snapshot packages: {{Package AUR|cairo-dock-bzr}} and {{Package AUR|cairo-dock-plugins-bzr }}.
Line 15: Line 13:
 
Run as default:
 
Run as default:
 
  $ cairo-dock &
 
  $ cairo-dock &
This will generate a startup message that will ask you to choose a backend for the current session (OpenGL or Cairo). There is an option to remember the choice and if not choosing to remember the choice, a startup message will be generated each time cairo-dock is run without backend options. To supress the startup message, you can specify which backend to use when running cairo-dock by specifying it as an option.<br>
+
This will generate a startup message that will ask you to choose a backend for the current session (OpenGL or Cairo). There is an option to remember the choice and if not choosing to remember the choice, a startup message will be generated each time cairo-dock is run without backend options. To supress the startup message, you can specify which backend to use when running cairo-dock by specifying it as an option.
  
 
Run with OpenGL backend
 
Run with OpenGL backend
Line 24: Line 22:
  
 
===Running the dock at startup===
 
===Running the dock at startup===
This depends on which [[DE]] or [[Window Manager|WM]] that is being used.
+
This depends on which desktop environment or window manager that is being used and which backend cario-dock should be run with. The following shows how to run cairo-dock at startup without forcing a backend.
====Cario-dock====
+
 
Run cairo-dock and right-click the dock > Cairo-Dock > Launch Cairo-Dock on startup. The settings will be stored in {{Filename|~/.config/autostart/}} and sourced the next time you login.
+
====Cairo-dock method====
 +
Run cairo-dock and right-click the dock and go to '''Cairo-Dock > Launch Cairo-Dock on startup'''. The settings will be stored in {{Filename|~/.config/autostart/}} and sourced the next time you login.
  
 
====Openbox====
 
====Openbox====
Add the following to {{Filename|~/.config/openbox/autostart.sh}}.
+
Add the following to {{Filename|~/.config/openbox/autostart.sh}}
 +
cario-dock &
 +
 
 +
====GNOME====
 +
Add a cario-dock entry to Startup Programs using
 +
$ gnome-session-properties
 +
 
 +
====Xfce====
 +
Get the required startup file if you don't have it already.
 +
$ cp -i /etc/xdg/xfce4/xinitrc ~/.config/xfce4/
 +
Add the following to it
 
  cairo-dock &
 
  cairo-dock &
  
 
===Configuring the dock===
 
===Configuring the dock===
To configure the dock, right-click the dock > Cairo-Dock > Configure
+
To configure the dock, right-click the dock and go to '''Cairo-Dock > Configure'''.
 
==Troubleshooting==
 
==Troubleshooting==
===Two cairo-dock instances running===
+
===Two cairo-docks is running===
This is most likely a result of sessions being saved and being runned at next login.
+
This is most likely a result of saved sessions being runned at login. If you are using a desktop environment like [[GNOME]], [[KDE]] or [[Xfce]] you need to disable automatic startup of sessions in your session manager settings. You may also need to delete the sessions cache:
====Openbox====
+
$ rm ~/.cache/sessions/x*
If you are starting the cairo-dock from {{Filename|~/.config/openbox/autostart.sh}} - remove autostart files generated by cario-dock:
+
 
 +
If you are not using a desktop environment with a session manager or choose to have cario-dock startup by itself, you need to remove autostart files generated by cario-dock:
 
  $ rm ~/.config/autostart/cairo-dock*
 
  $ rm ~/.config/autostart/cairo-dock*
 +
 +
===The background is black===
 +
This is most likely caused by not running a composite manager, like [[Xcompmgr]] or [[Cairo Compmgr]]. Cairo-dock uses the transparency feature of the composite manager to display the dock, and without it the dock will be displayed with a black background. If you are using a desktop environment, simply enable the composite manager or desktop effects in the settings.
 +
 +
An alternative solution that does not require a composite manager is to enable fake transparency in cairo-dock. To do this, right-click the dock and go to '''Cario-Dock > Configure > Advanced Mode > System > Composition'''. Then enable both '''Emulate composition with fake transparency''' and '''Make the config panel transparent'''.
 
==More resources==
 
==More resources==
 
* [http://www.glx-dock.org/index.php glx.org]
 
* [http://www.glx-dock.org/index.php glx.org]
 
* [https://launchpad.net/cairo-dock launchpad]
 
* [https://launchpad.net/cairo-dock launchpad]

Revision as of 14:58, 14 June 2011

Cairo-dock is a highly customizable dock written in C.

Installation

Install Template:Package AUR from the AUR. The core package provides only the strict minimum to run cairo-dock - to use applets, animations, views, effects and dialogs you will also need Template:Package AUR.

You can also try the latest BZR snapshot packages: Template:Package AUR and Template:Package AUR.

Warning: The BZR packages are unstable and should be used at own risk.

Configuration

Running the dock

Run as default:

$ cairo-dock &

This will generate a startup message that will ask you to choose a backend for the current session (OpenGL or Cairo). There is an option to remember the choice and if not choosing to remember the choice, a startup message will be generated each time cairo-dock is run without backend options. To supress the startup message, you can specify which backend to use when running cairo-dock by specifying it as an option.

Run with OpenGL backend

$ cairo-dock -o &

Run with Cairo backend

$ cairo-dock -c &
Tip: All using ATI graphics cards should use this option. Some cards/drivers does not support OpenGL, which may prevent cairo-dock from running correctly.

Running the dock at startup

This depends on which desktop environment or window manager that is being used and which backend cario-dock should be run with. The following shows how to run cairo-dock at startup without forcing a backend.

Cairo-dock method

Run cairo-dock and right-click the dock and go to Cairo-Dock > Launch Cairo-Dock on startup. The settings will be stored in Template:Filename and sourced the next time you login.

Openbox

Add the following to Template:Filename

cario-dock &

GNOME

Add a cario-dock entry to Startup Programs using

$ gnome-session-properties

Xfce

Get the required startup file if you don't have it already.

$ cp -i /etc/xdg/xfce4/xinitrc ~/.config/xfce4/

Add the following to it

cairo-dock &

Configuring the dock

To configure the dock, right-click the dock and go to Cairo-Dock > Configure.

Troubleshooting

Two cairo-docks is running

This is most likely a result of saved sessions being runned at login. If you are using a desktop environment like GNOME, KDE or Xfce you need to disable automatic startup of sessions in your session manager settings. You may also need to delete the sessions cache:

$ rm ~/.cache/sessions/x*

If you are not using a desktop environment with a session manager or choose to have cario-dock startup by itself, you need to remove autostart files generated by cario-dock:

$ rm ~/.config/autostart/cairo-dock*

The background is black

This is most likely caused by not running a composite manager, like Xcompmgr or Cairo Compmgr. Cairo-dock uses the transparency feature of the composite manager to display the dock, and without it the dock will be displayed with a black background. If you are using a desktop environment, simply enable the composite manager or desktop effects in the settings.

An alternative solution that does not require a composite manager is to enable fake transparency in cairo-dock. To do this, right-click the dock and go to Cario-Dock > Configure > Advanced Mode > System > Composition. Then enable both Emulate composition with fake transparency and Make the config panel transparent.

More resources