Difference between revisions of "Cairo-Dock"

From ArchWiki
Jump to: navigation, search
m (typo)
(Installation)
(26 intermediate revisions by 11 users not shown)
Line 1: Line 1:
[[Category:Desktop environments (English)]]
+
[[Category:Application launchers]]
 +
[[Category:Eye candy]]
 
Cairo-dock is a highly customizable dock written in C.
 
Cairo-dock is a highly customizable dock written in C.
==Installation==
 
[https://aur.archlinux.org/packages.php?ID=15201 Cairo-dock] and [https://aur.archlinux.org/packages.php?ID=31144 Cairo-dock plugins] are available from the [[AUR]] and can be installed using [[yaourt]] or [[makepkg]].
 
  
===Yaourt installation===
+
== Installation ==
To install the core packages:
+
Install {{Pkg|cairo-dock}} from the [community] repository. The core package provides only the strict minimum to run cairo-dock - to use applets, animations, views, effects and dialogs you will also need {{Pkg|cairo-dock-plugins}}.
$ yaourt -S cairo-dock  
+
The core packages provides only the strict minimum to run cairo-dock. To use applets, animations, views, effects and dialogs with the dock you will also need the plugin packages:
+
$ yaourt -S cairo-dock-plug-ins
+
To install the latest BZR snapshot packages:
+
{{Warning|These packages are unstable and should be used at own risk}}
+
$ yaourt -S cairo-dock-bzr cairo-dock-plugins-bzr
+
  
==Configuration==
+
You can also try the latest BZR snapshot packages: {{AUR|cairo-dock-bzr}} and {{AUR|cairo-dock-plugins-bzr}}.
===Running the dock===
+
{{Warning|The BZR packages are unstable and should be used at own risk.}}
Run as default:
+
 
 +
=== Plugin dependencies ===
 +
The applets in {{Pkg|cairo-dock-plugins}} require quite a lot of dependencies, therefore all of them have been made optional not to bloat your system if you don't use a particular applet. Please refer to the optdepends list and install those you need.
 +
 
 +
{{Note|If for some reason an applet is not working, make sure you have GVFS installed, it is required for several applets as well as GNOME, XFCE and KDE integration.}}
 +
 
 +
== Configuration ==
 +
=== Running the dock ===
 +
Run the dock in the background:
 
  $ 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 the dock with OpenGL backend:
 
  $ cairo-dock -o &
 
  $ cairo-dock -o &
Run with Cairo backend
+
Run the dock with Cairo backend:
 
  $ cairo-dock -c &
 
  $ 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.}}
+
{{Tip|All using ATI graphics cards should use this option. Some cards/drivers do not support OpenGL, which may prevent cairo-dock from running correctly.}}
  
===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 cairo-dock should be run with. The following section 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 used the next time you login.
+
  
====Openbox====
+
==== Cairo-dock method ====
Add the following to {{Filename|~/.config/openbox/autostart.sh}}.
+
Run cairo-dock and right-click the dock and go to '''Cairo-Dock > Launch Cairo-Dock on startup'''. The settings will be stored in {{Ic|~/.config/autostart/}} and sourced the next time you login.
 +
 
 +
==== Openbox/Fluxbox ====
 +
Add the following to {{Ic|~/.config/openbox/autostart}} or {{Ic|~/.fluxbox/startup}} accordingly:
 
  cairo-dock &
 
  cairo-dock &
  
===Configuring the dock===
+
==== Xfce ====
To configure the dock, right-click the dock > Cairo-Dock > Configure
+
If you have {{Ic|xfce4-autostart-editor}} installed, simply run it and add an entry for cairo-dock. If you're not using a session manager you can add the following to {{Ic|~/.config/xfce4/xinitrc}} or {{Ic|~/Desktop/Autostart}}:
==Troubleshooting==
+
cairo-dock &
===Two instances of cairo-dock running===
+
 
This is most likely a result of sessions being saved and being runned at next login.
+
==== GNOME ====
====Openbox====
+
Add a cairo-dock entry to Startup Programs using
If you are starting the cairo-dock from {{Filename|~/.config/openbox/autostart.sh}} - remove autostart files generated by cario-dock:
+
$ gnome-session-properties
 +
 
 +
=== Configuring the dock ===
 +
To configure the dock, right-click the dock and go to '''Cairo-Dock > Configure'''.
 +
 
 +
== Troubleshooting ==
 +
=== Two cairo-docks are 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 cairo-dock startup by itself, you need to remove autostart files generated by cairo-dock:
 
  $ rm ~/.config/autostart/cairo-dock*
 
  $ rm ~/.config/autostart/cairo-dock*
==More resources==
+
 
 +
=== 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 '''Cairo-Dock > Configure > Advanced Mode > System > Composition'''. Then enable both '''Emulate composition with fake transparency''' and '''Make the config panel transparent'''.
 +
 
 +
== 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 08:40, 5 July 2013

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

Installation

Install cairo-dock from the [community] repository. The core package provides only the strict minimum to run cairo-dock - to use applets, animations, views, effects and dialogs you will also need cairo-dock-plugins.

You can also try the latest BZR snapshot packages: cairo-dock-bzrAUR and cairo-dock-plugins-bzrAUR.

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

Plugin dependencies

The applets in cairo-dock-plugins require quite a lot of dependencies, therefore all of them have been made optional not to bloat your system if you don't use a particular applet. Please refer to the optdepends list and install those you need.

Note: If for some reason an applet is not working, make sure you have GVFS installed, it is required for several applets as well as GNOME, XFCE and KDE integration.

Configuration

Running the dock

Run the dock in the background:

$ 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 the dock with OpenGL backend:

$ cairo-dock -o &

Run the dock with Cairo backend:

$ cairo-dock -c &
Tip: All using ATI graphics cards should use this option. Some cards/drivers do 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 cairo-dock should be run with. The following section 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 ~/.config/autostart/ and sourced the next time you login.

Openbox/Fluxbox

Add the following to ~/.config/openbox/autostart or ~/.fluxbox/startup accordingly:

cairo-dock &

Xfce

If you have xfce4-autostart-editor installed, simply run it and add an entry for cairo-dock. If you're not using a session manager you can add the following to ~/.config/xfce4/xinitrc or ~/Desktop/Autostart:

cairo-dock &

GNOME

Add a cairo-dock entry to Startup Programs using

$ gnome-session-properties

Configuring the dock

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

Troubleshooting

Two cairo-docks are 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 cairo-dock startup by itself, you need to remove autostart files generated by 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 Cairo-Dock > Configure > Advanced Mode > System > Composition. Then enable both Emulate composition with fake transparency and Make the config panel transparent.

More resources