Cairo-Dock

Cairo-Dock is a pretty, light and convenient interface to your desktop, able to replace advantageously your system panel! It features multi-docks, taskbar, launchers and a lot of useful applets. Applets can be detached from the dock to act as desktop widgets. Numerous ready-to-use themes are available in 1 click, and can be easily customized at your convenience. It can use hardware acceleration to be very fast and low on CPU.

Other screenshots are available at Glx-Dock.org.

This project is split in 3 parts:

• Cairo-Dock-Core (the minimal - https://github.com/Cairo-Dock/cairo-dock-core)
• Cairo-Dock-Plug-ins (a collection of views, applets, animations, effects, etc. - https://github.com/Cairo-Dock/cairo-dock-plug-ins)
• Cairo-Dock-Plug-ins-Extras (a collection of third-party applets written in any language - https://github.com/Cairo-Dock/cairo-dock-plug-ins-extras)

The Cairo-Dock-Session project aims to provide an easy way to install a session that is desktop agnostic and uses Cairo-Dock as a Shell (the main interface).

Installation

Please see the Wiki for general information about installing Cairo-Dock.

To install the plugins in this repository, simply download them and copy the plugins you'd like to use under the third-party subdirectory of you Cairo-Dock configuration:

1. Download this repository: click the green "Code" button on top and then select "Download zip", then extract the contents of the zip file in some convenient location. Alternatively, you can use git from the command line: git clone https://github.com/Cairo-Dock/cairo-dock-plug-ins-extras.git
2. Navigate to the folder where you extracted / cloned the contents of this repository.
3. Select the plugins you'd like to use.
4. Copy them to ~/.config/cairo-dock/third-party (note: ~ here means your home directory)

Note:

• If using a file manager, the .config folder will likely by hidden, you will have to set it to show hidden files. E.g. on Nautilus / GNOME, the Ctrl+H keyboard shortcut works)
• If you use a custom location for your XDG_CONFIG_HOME or just for Cairo-Dock's config, you need to use that instead of ~/.config

Need some help?

See our the updated wiki for the most important information: https://github.com/Cairo-Dock/cairo-dock-core/wiki

See also the original wiki for a lot of additional useful info: http://www.glx-dock.org/ww_page.php

You can find: how to launch the dock at startup, how to customise it, how to resolve some recurrent problems (black background, messages at startup, etc.), how to help us, who we are, etc. A useful tutorial is also available to help you customize your dock on the old wiki: http://www.glx-dock.org/ww_page.php?p=Tutorial-Customisation&lang=en

If you have other questions not solved on our wiki you can post them on our Github discussions page.

Join the project

• Want to HACK into the dock or write an APPLET? see the complete C API here (or just run the script doc/generate-doc.sh)
• You don't like C and still want to write an APPLET for the dock or CONTROL it from a script or the terminal? see its powerful DBus API for plugins and for scripts
• You have some IDEAS / PROPOSITIONS? You need some help to develop an applet? Feel free to use the Github issues or discussions, or post a topic on our forum! We'll be happy to answer you!
• You want to TRANSLATE Cairo-Dock in your language? Use the 'Translations' tab in Launchpad, it's very simple to use it and helpful for us!

Bug reports

You can report bugs using Github issues. If possible:

• Read our wiki specially the 'Troubleshooting' section which can help you to resolve some bugs like a black background, messages at startup, etc.
• Please include also some information like your distribution, your achitecture (32/64bits), your Desktop Manager (Gnome, KDE, XFCE,...) your Window Manager (Compiz, Metacity, Kwin, etc.) or Wayland compositor (Wayfire, Kwin, Labwc, etc.), if you use Cairo-Dock with or without OpenGL, with which theme, etc. On a recent version (>= 3.5.99), you can just copy the "Technical info" page from the About dialog (right click on the dock -> Cairo-Dock -> About) which covers the most important details.
• Include the method to reproduce the bug (which actions, which options activated)
• Run the dock with the command cairo-dock -l debug > debug.txt reproduce the bug and join the content of debug.txt.
• If it's a crash, please give us a backtrace of it with GDB. It's easy thanks to this wiki page.

Thank you for your help!