3
#[@pkgdatadir@/icons/icon-help.svg]
8
#>Most icons in the dock have several actions: the primary action on left-click, a secondary action on middle-click, and additionnal actions on right-click (in the menu).
9
#Some applets let you bind a shortkey to an action, and decide which action sould be on middle-click.
14
#>Cairo-Dock has a lot of applets. Applets are small applications that live inside the dock, for instance a clock or a log-out button.
15
#To enable new applets, open the settings (right-click -> Cairo-Dock -> configure), go to "Add-ons", and tick the applet you want.
16
#More applets can be installed easily: in the configuration window, click on the "More applets" button (which will lead you to our applets web page) and then just drag-and-drop the link of an applet into your dock.
19
#[@pkgdatadir@/icons/icon-icons.svg]
24
#>You can add a launcher by drag-and-dropping it from the Applications Menu into the dock. An animated arrow will appear when you can drop.
25
#Alternatively, if an application is already opened, you can right-click on its icon and select "make it a launcher".
28
#X[Removing a launcher]
30
#>You can remove a launcher by drag-and-dropping it outside the dock. A "delete" emblem will appear on it when you can drop it.
31
_Removing a launcher =
33
#X[Grouping icons into a sub-dock]
34
Grouping icons into a sub-dock =
35
#>You can group icons into a "sub-dock".
36
#To add a sub-dock, right-click on the dock -> add -> a sub-dock.
37
#To move an icon into the sub-dock, right-click on an icon -> move to another dock -> select the sub-dock's name.
38
_Grouping icons into a sub-dock =
42
#> You can drag any icon to a new location inside its dock.
43
#You can move an icon into another dock by right-clicking on it -> move to another dock -> select the dock you want.
44
#If you select "a new main dock", a main dock will be created with this icon inside.
47
#X[Changing an icon's image]
48
Changing an icon's image =
49
#>- For a launcher or an applet:
50
#Open the settings of the icon, and set a path to an image.
51
#- For an aplication icon:
52
#Right-click on the icon -> "Other actions" -> "set a custom icon", and choose an image. To remove the custom image, right-click on the icon -> "Other actions" -> "remove the custom icon".
54
#If you have installed some icons themes on your PC, you can also select one of them to be used instead of the default icon theme, in the global config window.
55
_Changing an icon's image =
59
#>You can make the icons and the zoom effect smaller or bigger. Open the settings (right-click -> Cairo-Dock -> configure), and go to Appearance (or Icons in advanced mode).
60
#Note that if there are too many icons inside the dock, they will be zoomed out to fit in the screen.
61
#Also, you can define the size of each applet independently in their own settings.
66
#>You can add separators between icons by right-clicking on the dock -> add -> a separator.
67
#Also, if you enabled the option to separate icons of different types (launchers/applications/applets), a separator will be added automatically between each group.
68
#In the "panel" view, separators are represented as gap between icons.
72
#[@pkgdatadir@/icons/icon-taskbar.png]
75
#X[Using the dock as a taskbar]
76
Using the dock as a taskbar =
77
#>When an application is running, a corresponding icon will appear in the dock.
78
#If the application already has a launcher, the icon will not appear, instead its launcher will have a small indicator.
79
#Note that you can decide which applications should appear in the dock: only the windows of the current desktop, only the hidden windows, separated from the launcher, etc.
80
_Using the dock as a taskbar =
84
#>You can close a window by middle-clicking on its icon (or from the menu).
87
#X[Minimizing / restauring a window]
88
Minimizing / restauring a window =
89
#>Clicking on its icon will bring the window on top.
90
#When the window has the focus, clicking on its icon will minimize the window.
91
_Minimizing / restauring a window =
93
#X[Launching an application several times]
94
Launching an application several times =
95
#>You can launch an application several times by SHIFT+clicking on its icon (or from the menu).
96
_Launching an application several times =
98
#X[Switching between the windows of a same application]
99
Switching between the windows of a same application =
100
#>With your mouse, scroll up/down on one of the icons of the application. Each time you scroll, the next/previous window will be presented to you.
101
_Switching between the windows of a same application =
103
#X[Grouping windows of a given application]
104
Grouping windows of a given application =
105
#>When an application has several windows, one icon for each window will appear in the dock; they will be grouped togather into a sub-dock.
106
#Clicking on the main icon will display all the windows of the application side-by-side (if your Window Manager is able to do that).
107
_Grouping windows of a given application =
109
#X[Setting a custom icon for an application]
110
Setting a custom icon for an application =
111
#>See "Changing an icon's image" in the "Icons" category.
112
_Setting a custom icon for an application =
114
#X[Showing windows preview over the icons]
115
Showing windows preview =
116
#>You need to run Compiz, and enable the "Window Preview" plug-in in Compiz. Install "ccsm" to be able to configure Compiz.
117
_Showing windows preview =
119
#G [bash '@pkgdatadir@/scripts/help_scripts.sh' compiz_plugin thumbnail && dbus-send --session --dest=org.freedesktop.compiz /org/freedesktop/compiz/thumbnail/screen0/current_viewport org.freedesktop.compiz.set boolean:false;sh -c "ps aux | grep -v grep | grep -c 'compiz'"]If you're using Compiz, you can click on this button:
120
#{Tip: If this line is grayed, it's because this tip is not for you.)
121
preview_compiz_button=
124
#[@pkgdatadir@/icons/icon-background.svg]
127
#X[Positionning the dock on the screen]
128
Positionning the dock on the screen =
129
#>The dock can be placed anywhere on the screen.
130
#In the case of the main dock, right-click -> Cairo-Dock -> configure, and then select the position you want.
131
#In the case of a 2nd or 3rd dock, right-click -> Cairo-Dock -> set up this dock, and then select the position you want.
132
_Positionning the dock on the screen=
134
#X[Hiding the dock to use all the screen]
135
Hiding the dock to use all the screen=
136
#>The dock can hide itself to let all the screen for applications. But it can also be always visible like a panel.
137
#To change that, right-click -> Cairo-Dock -> configure, and then select the visibility you want.
138
#In the case of a 2nd or 3rd dock, right-click -> Cairo-Dock -> set up this dock, and then select the visibility you want.
139
_Hiding the dock to use all the screen=
141
##~ #X[Having more than one dock]
142
##~ Having more than one dock=
144
##~ _Having more than one dock=
146
##~ #X[Deleting a dock]
149
##~ _Deleting a dock=
151
##~ #X[Changing the look of a dock]
152
##~ Changing the look of a dock=
154
##~ _Changing the look of a dock=
158
#[@pkgdatadir@/icons/icon-desklets.png]
161
#X[Placing applets on your desktop]
162
Placing applets on your desktop =
163
#>Applets can live inside desklets, which are small windows that can be placed wherever on your desktop.
164
#To detach an applet from the dock, simply drag and drop it outside the dock.
165
_Placing applets on your desktop =
169
#>Desklets can be moved anywhere simply with the mouse.
170
#They can also be rotated by dragging the small arrows on the top and left sides.
171
#If you don't want to move it any more, you can lock its position by right-clicking on it -> "lock position". To unlock it, de-select this option.
176
#>From the menu (right-click -> visibility), you can also decide to keep it above other windows, or on the Widget Layer (if you use Compiz), or make a "desklet bar" by placing them on a side of the screen and selecting "reserve space".
177
#Desklets that don't need interaction (like the clock) can be set transparent to the mouse (means you can click on what is behind them), by clicking on the small bottom-right button.
180
#X[Changing the desklets decorations]
181
Changing the desklets decorations =
182
#>Desklets can have decorations. To change that, open the settings of the applet, go to Desklet, and select the decoration you want (you can provide your own one).
183
_Changing the desklets decorations =
186
#[@pkgdatadir@/icons/icon-system.svg]
189
#X[Having a calendar with tasks]
190
Having a calendar with tasks =
191
#>Activate the Clock applet.
192
#Clicking on it will display a calendar.
193
#Double-clicking on a day will pop-up a task-editor. Here you can add/remove taks.
194
#When a task has been or is going to be scheduled, the applet will warn you (15mn before the event, and also 1 day before in the case of an anniversary).
195
_Having a calendar with tasks =
197
#X[Having a list of all windows]
198
Having a list of all windows =
199
#>Activate the Switcher applet.
200
#Right-clicking on it will give you access to a list containing all the windows, sorted by desktops.
201
#You can also display the windows side-by-side if your Window-Manager is able to do that.
202
#You can bind this action to the middle-click.
203
_Having a list of all windows =
205
#X[Showing all the desktops]
206
Showing all the desktops =
207
#>Activate either the Switcher applet or the Show-Desktop applet.
208
#Right-click on it -> "show all the desktop".
209
#You can bind this action to the middle-click.
210
_Showing all the desktops =
212
#X[Changing the screen resolution]
213
Changing the screen resolution =
214
#>Activate the Show-Desktop applet.
215
#Right-click on it -> "change resolution" -> select the one you want.
216
_Changing the screen resolution =
218
#X[Locking your session]
219
Locking your session =
220
#>Activate the Log-out applet.
221
#Right-click on it -> "lock screen".
222
#You can bind this action to the middle-click.
223
_Locking your session =
225
#X[Quick-launching a program from keyboard (replacing ALT+F2)]
226
Quick-launching a program from keyboard (replacing ALT+F2) =
227
#>Activate the Applications Menu applet.
228
#Middle-click on it, or right-click -> "quick-launch".
229
#You can bin a shortkey for this action.
230
#The text is automatically completed (for instance, typing "fir" will be completed into "firefox").
231
_Quick-launching a program from keyboard (replacing ALT+F2) =
233
#X[Turning Composite OFF during games]
234
Turning Composite OFF during games =
235
#>Activate the Composite Manager applet.
236
#Clicking on it will disable the Composite, which often makes games more smooth.
237
#Clicking again on it will enable the Composite.
238
_Turning Composite OFF during games =
240
#X[Seeing the hourly weather forecast]
241
Seeing the hourly weather forecast =
242
#>Activate the Weather applet.
243
#Open its settings, go to Configure, and type the name of your city. Press Enter, and select your city from the list that will appear.
244
#Then validate to close the settings window.
245
#Now, double-clicking on a day will lead you to the web page of the hourly forecast for this day.
246
_Seeing the hourly weather forecast =
248
#X[Adding a file or a web page into the dock]
249
Adding a file or a web page into the dock =
250
#>Simply drag a file or an html link and drop it onto the dock (an animated arrow should appear when you can drop).
251
#It will be added into the Stack. The Stack is a sub-dock that can contain any file or link you want to access quickly.
252
#You can have several Stacks, and you can drop files/links onto a Stack directly.
253
_Adding a file or a web page into the dock =
255
#X[Importing a folder into the dock]
256
Importing a folder into the dock =
257
#>Simply drag a folder and drop it onto the dock (an animated arrow should appear when you can drop).
258
#You can choose to import the folder's files or not.
259
_Importing a folder into the dock =
261
#X[Accessing the recent events]
262
Accessing the recent events =
263
#>Activate the Recent-Events applet.
264
#You need to have the Zeitgeist daemon to be running. Install it if it's not present.
265
#The applet can then display all the files, folders, web pages, songs, videos and documents you have accessed recently, so that you can access them quickly.
266
_Accessing the recent events =
268
#X[Quickly opening a recent file with a launcher]
269
Quickly opening a recent file with a launcher =
270
#>Activate the Recent-Events applet.
271
#You need to have the Zeitgeist daemon to be running. Install it if it's not present.
272
#Now when you right-click on a launcher, all the recent files that can be opened with this launcher will appear in its menu.
273
_Quickly opening a recent file with a launcher =
277
#>Activate the Shortcuts applet.
278
#Then all the disks (including USB key or external hard drives) will be listed in a sub-dock.
279
#To unmount a disk before disconnecting it, middle-click on its icon.
282
#X[Accessing folder bookmarks]
283
Accessing folder bookmarks =
284
#>Activate the Shortcuts applet.
285
#Then all the folders bookmarks (the ones that appear in Nautilus) will be listed in a sub-dock.
286
#To add a bookmark, simply drag-and-drop a folder onto the applet's icon.
287
#To remove a bookmark, right-click on its icon -> remove
288
_Accessing folder bookmarks =
290
#X[Having multiple instances of an applet]
291
Having multiple instances of an applet =
292
#>Some applets can have several instances running at the same time: Clock, Stack, Weather, ...
293
#Right click on the applet's icon -> "launch another instance".
294
#You can configure each instance independantely. This allows you, for example, to have the current time for different countries in your dock or the weather in different cities.
295
_Having multiple instances of an applet =
297
#X[Adding / removing a desktop]
298
Adding / removing a desktop =
299
#>Activate the Switcher applet.
300
#Right-click on it -> "add a desktop" or "remove this desktop".
301
#You can even name each of them.
302
_Adding / removing a desktop =
304
#X[Controling the sound volume]
305
Controling the sound volume =
306
#>Activate the Sound Volume applet.
307
#Then scroll up/down to increase/decrease the sound.
308
#Alternatively, you can click on the icon and move the scroll bar.
309
#Middle-click will mute/unmute.
310
_Controling the sound volume =
312
#X[Controling the screen brightness]
313
Controling the screen brightness =
314
#>Activate the Screen Luminosity applet.
315
#Then scroll up/down to increase/decrease the brightness.
316
#Alternatively, you can click on the icon and move the scroll bar.
317
_Controling the screen brightness =
319
#X [Removing completely the gnome-panel]
321
#> Open gconf-editor, edit the key /desktop/gnome/session/required_components/panel, and replace its content with "cairo-dock".
322
#Then restart your session : the gnome-panel has not been started, and the dock has been started (if not, you can add it to the startup programs).
324
#G [sh -c "gconftool-2 --type string --set /desktop/gnome/session/required_components/panel '(cairo-dock'";sh -c "ps aux | grep -v grep | grep -c 'gnome-settings-daemon'"]If you are on Gnome, you can click on this button in order to automatically modify this key:
325
#{Tip: If this line is grayed, it's because this tip is not for you.)
329
#[@pkgdatadir@/icons/icon-behavior.svg]
331
#W[Forum] If you have any question, don't hesitate to ask on our forum.
332
forum=http://forum.glx-dock.org
333
#W[Wiki] Our wiki can also help you, it is more complete on some points.
334
wiki=http://wiki.glx-dock.org
336
#X [I have a black background around my dock.]
338
#> You need to turn on compositing. For instance, you can run Compiz or xcompmgr.
339
#If you're using XFCE or KDE, you can just enable compositing in the window manager options.
340
#If you're using Gnome, you can enable it in Metacity in this way :
341
# Open gconf-editor, edit the key '/apps/metacity/general/compositing_manager' and set it to 'true'.
342
#{Hint : If you have an ATI or an Intel card, you should try without OpenGL first, because their drivers are not yet perfect.}
344
#G [gconftool-2 --type bool --set /apps/metacity/general/compositing_manager true;sh -c "ps aux | grep -v grep | grep -c 'metacity'"]If you're on Gnome with Metacity (without Compiz), you can click on this button:
345
#{Tip: If this line is grayed, it's because this tip is not for you.)
347
#X [My machine is too old to run a composite manager.]
349
#> Don't panic, Cairo-Dock can emulate the transparency.
350
#To get rid of the black background, simply enable the corresponding option in the end of the «System» module
352
#X [The dock is horribly slow when I move the mouse into it.]
354
#> If you have an Nvidia GeForce8 graphics card, please install the latest drivers, as the first ones were really buggy.
355
#If the dock is running without OpenGL, try to reduce the number of icons in the main dock, or try to reduce its size.
356
#If the dock is running with OpenGL, try to disable it by launching the dock with «cairo-dock -c».
358
#X [I don't have these wonderful effects like fire, cube rotating, etc.]
360
#> You need a graphics card with drivers that support OpenGL2.0. Most Nvidia cards can do this, as can more and more Intel cards. Most ATI cards do not support OpenGL2.0.
361
#{Tip: You can force OpenGL by launching the dock with «cairo-dock -o».but you might get a lot of visual artifacts.}
363
#X [I don't have any themes in the Theme Manager, except the default one.]
365
#> Be sure that you are connected to the Net.
366
# If your connection is very slow, you can increase the connection timeout in the "System" module.
367
# If you're under a proxy, you'll have to configure "curl" to use it; search on the web how to do it (basically, you have to set up the "http_proxy" environment variable).
368
#{Hint : Up to version 2.1.1-2, wget was used.}
372
#X [The «netspeed» applet displays 0 even when I'm downloading something]
374
#> You must tell the applet which interface you're using to connect to the Net (by default, this is «eth0»).
375
#Just edit its configuration, and enter the interface name. To find it, type «ifconfig» in a terminal, and ignore the «loop» interface. It's probably something like «eth1», «ath0», or «wifi0»..
376
#{Tip: you can run several instances of this applet if you wish to monitor several interfaces.}
378
#X [The dustbin remains empty even when I delete a file.]
380
#> if you're using KDE, you may have to specify the path to the trash folder.
381
#Just edit the applet's configuration, and fill in the Trash path; it is probably «~/.locale/share/Trash/files». Be very careful when typing a path here!!! (do not insert spaces or some invisible caracters).
383
#X [There is no icon in the Applications Menu even though I enable the option.]
385
#> In Gnome, there is an option that override the dock's one. To enable icons in menus, open 'gconf-editor', go to Desktop / Gnome / Interface and enable the "menus have icons" and the "buttons have icons" options.
387
#G [sh -c "gconftool-2 --type bool --set /desktop/gnome/interface/menus_have_icons true && gconftool-2 --type bool --set /desktop/gnome/interface/buttons_have_icons true; gsettings set org.gnome.desktop.interface buttons-have-icons true && gsettings set org.gnome.desktop.interface menus-have-icons true";sh -c "ps aux | grep -v grep | grep -c 'gnome-settings-daemon'"]If you're on Gnome you can click on this button:
388
#{Tip: If this line is grayed, it's because this tip is not for you.)
392
#[@pkgdatadir@/cairo-dock.svg]
394
#F [Join the project!]
397
#> We value your help! If you see a bug, if you think something could be improved,
398
#or if you just made a dream about the dock, pay us a visit on glx-dock.org.
399
#English (and others!) speakers are welcome, so don’t be shy ! ;-)
401
#If you made a theme for the dock or one of the applet, and want to share it, we’ll be happy to integrate it on our server !
403
#W[Documentation] If you wish to develop an applet, a complete documentation is available here.
404
doc=http://doc.glx-dock.org
405
#W[DBus API] If you wish to develop an applet in Python, Perl or any other language,
406
#or to interact with the dock in any kind of way, a full DBus API is described here.
407
dbus=http://dbus.glx-dock.org
415
#W[Community site] Problems? Suggestions? Just want to talk to us? Come on over!
416
community_site=http://glx-dock.org
417
#W[Development site] Find the latest version of Cairo-Dock here !
418
dev_site=https://launchpad.net/cairo-dock
419
#W[Cairo-Dock-Plug-ins-Extras] More applets available online!
420
extras_site=http://extras.glx-dock.org
424
#W[Debian/Ubuntu] We maintain two repositories for Debian, Ubuntu and other Debian-forked:
425
# One for stable releases and another which is updated weekly (unstable version)
426
reposit_wiki_site=http://www.glx-dock.org/ww_page.php?p=From the repository&lang=en
428
#> If you on (x/k/l)Ubuntu, you can easily add our repositories with these buttons
429
# (if you're using a fork of Ubuntu like Linux Mint, please have a look at our wiki).
431
#G [gksu "sh '@pkgdatadir@/scripts/help_scripts.sh' repository no";sh -c "lsb_release -i | grep -c Ubuntu"]If you're on Ubuntu, you can add our 'stable' repository by clicking on this button:
432
# After that, you can launch your update manager in order to install the latest stable version.
433
#{Tip: If this line is grayed, it's because this tip is not for you.)
435
#G [gksu "sh '@pkgdatadir@/scripts/help_scripts.sh' weekly no";sh -c "lsb_release -i | grep -c Ubuntu"]If you're on Ubuntu, you can also add our 'weekly' ppa (can be unstable) by clicking on this button:
436
# After that, you can launch your update manager in order to install the latest weekly version.
437
#{Tip: If this line is grayed, it's because this tip is not for you.)
440
#> If you on Debian, you can easily add our repositories with these buttons
441
# (Please check if you're using the Stable or the Unstable version of Debian).
443
#G [gksu "sh '@pkgdatadir@/scripts/help_scripts.sh' debian_stable no";sh -c "grep -c ^Debian /etc/issue"]If you're on Debian Stable, you can add our 'stable' repository by clicking on this button:
444
# After that, you can purge all 'cairo-dock*' packages, update the your system and reinstall 'cairo-dock' package.
445
#{Tip: If this line is grayed, it's because this tip is not for you.)
447
#G [gksu "sh '@pkgdatadir@/scripts/help_scripts.sh' debian_unstable no";sh -c "grep -c ^Debian /etc/issue"]If you're on Debian Unstable, you can add our 'stable' repository by clicking on this button:
448
# After that, you can purge all 'cairo-dock*' packages, update the your system and reinstall 'cairo-dock' package.
449
#{Tip: If this line is grayed, it's because this tip is not for you.)
450
addDebianUnStableRepo=
459
#d Name of the dock it belongs to:
462
#s Name of the icon as it will appear in its caption in the dock:
468
#{Leave empty to use the default one.}
469
icon=preferences-desktop-accessibility
471
#j[0;128] Desired icon size for this applet
472
#{Set to 0 to use the default applet size}
488
#{If locked, the desklet cannot be moved by simply dragging it with the left mouse button. It can still be moved with ALT + left-click.}
491
#j+[24;512] Desklet dimensions (width x height):
492
#{Depending on your WindowManager, you may be able to resize this with ALT + middle-click or ALT + left-click.}
495
#i[-2048;2048] Desklet position (x, y):
496
#{Depending on your WindowManager, you may be able to move this with ALT + left-click.. Negative values are counted from the right/bottom of the screen}
501
#I[-180;180] Rotation:
502
#{You can quickly rotate the desklet with the mouse, by dragging the little buttons on its left and top sides.}
508
#b Is detached from the dock
509
initially detached=false
510
#l[Normal;Keep above;Keep below;Keep on widget layer;Reserve space] Visibility:
511
#{for CompizFusion's "widget layer", set behaviour in Compiz to: (class=Cairo-dock & type=Utility)}
513
#b Should be visible on all desktops?
517
#F[Decorations;gtk-orientation-portrait]
520
#o+ Choose a decoration theme for this desklet:
521
#{Choose 'Custom decorations' to define your own decorations below.}
522
decorations = default
527
#S+ Background image:
528
#{Image to be displayed below drawings, e.g. a frame. Leave empty for no image.}
530
#e+[0;1] Background transparency:
532
#i+[0;256] Left offset:
533
#{in pixels. Use this to adjust the left position of drawings.}
535
#i+[0;256] Top offset:
536
#{in pixels. Use this to adjust the top position of drawings.}
538
#i+[0;256] Right offset:
539
#{in pixels. Use this to adjust the right position of drawings.}
541
#i+[0;256] Bottom offset:
542
#{in pixels. Use this to adjust the bottom position of drawings.}
544
#S+ Foreground image:
545
#{Image to be displayed above the drawings, e.g. a reflection. Leave empty for no image.}
547
#e+[0;1] Foreground tansparency: