~cairo-dock-team/ubuntu/oneiric/cairo-dock/2.3.0-3

« back to all changes in this revision

Viewing changes to data/help.conf

  • Committer: Bazaar Package Importer
  • Author(s): Matthieu Baerts (matttbe)
  • Date: 2010-08-09 23:26:12 UTC
  • mto: This revision was merged to the branch mainline in revision 13.
  • Revision ID: james.westby@ubuntu.com-20100809232612-pocdxliaxjdetm37
Tags: upstream-2.2.0~0beta4
Import upstream version 2.2.0~0beta4

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!en;0.0.8
2
 
 
3
 
[Icons]
4
 
 
5
 
#> Note : many answers have an extra hint.
6
 
#To popup the hint, simply let the mouse over the sentence for 1 second, a tooltip will appear.
7
 
#{Yes, like that :-)}
8
 
hint=
9
 
 
10
 
#v
11
 
sep_intro=
12
 
 
13
 
#X [How can I re-order my icons ?]]
14
 
Xreorder=
15
 
#> Simply drag them with the mouse, and drop it where you want.
16
 
#{Hint : you can even re-order the icons of the current applications.}
17
 
reorder=
18
 
#X [How can I place the applets and taskbar icons at the beginning of the dock ?]
19
 
Xplace=
20
 
#> In the “icons” module, on the bottom, you can choose the order of icons according to their type (launcher/appli/applet).
21
 
#{Hint : you can also place applets amongst launchers, by ticking the box below.}
22
 
place=
23
 
#X [How can I change the image of an icon ?]
24
 
Xtheme=
25
 
#> In the “Icons” module, you can choose an <b>icon theme</b>. Just choose a theme, and apply.
26
 
#All the themes installed on your system are listed, plus the 'Custom icons' theme, which represent the icons provided by the Cairo-Dock's theme;
27
 
# they are located in ~/.config/cairo-dock/current_theme/icons, and you can add personnal icons there.
28
 
#If you choose nothing, the default icon theme of your system will be used.
29
 
#{Hint : you can also directly edit a launcher’s configuration, and set a path for an image. If you don’t write a path, but simply the name of an image, don’t put the extension (.svg, .png, etc), to let the dock choose the best.}
30
 
theme=
31
 
#X [How can I quickly remove many icons ?]
32
 
Xremove=
33
 
#> Just drag and drop them out of the dock, they will disappear in an explosion !
34
 
#{Hint : if you delete an icon pointing on a sub-dock, you will be asked to delete the sub-dock’s icons as well, or to move them in the main dock.}
35
 
remove=
36
 
#X [How can I resize my icons ?]
37
 
Xsize=
38
 
#> In the 'Icons' modules, you can setup the default size of your icons by type : launchers, applis, applets and separators.
39
 
#You can also setup the zoom factor.
40
 
#{Hint : You can define the size of each applet independantely, to any size smaller or equal than the default size. Set it to 0x0 to use the default size.}
41
 
size=
42
 
 
43
 
[Dock]
44
 
#X [How can I place my dock on the screen ?]
45
 
Xscreen=
46
 
#> All is in the “Position” module. You can choose to place it on the bottom, top, left or right side of your screen.
47
 
#Moreover, you can also place it on the beginning, center, or end of the screen border.
48
 
#{Hint : If you have a multi-screen managed by Xinerama, you can tick the option “Use Xinerama”, and choose the screen where you want your dock to be.}
49
 
screen=
50
 
#X [How can I adjust the position of the dock above the gnome-panel ?]
51
 
Xadjust=
52
 
#> In the “Position” module, you can add an offset to the screen border.
53
 
#{Hint : you can also just dragging your dock with the mouse, by pressing the ALT key at the same time.}
54
 
adjust=
55
 
#X [The dock is hidden by the gnome-panel]
56
 
Xhidden=
57
 
#> it’s normal, because they both are “docks”. You can either move the dock out of the panel, or launch it wih the command “cairo-dock -–keep-above”.
58
 
hidden=
59
 
#X [I don’t want other windows to hover the dock]
60
 
Xreserve=
61
 
#> Just choose the corresponding option in the “Visibility” module.
62
 
#This will reserve the space for the dock only.
63
 
#{Hint : you can even do that with desklets, making a desklet's panel !.}
64
 
reserve=
65
 
#X [I don’t want that the dock hovers windows]
66
 
Xkeep below=
67
 
#> Two choices are available in the “Visibility” module :
68
 
# - either choose to “keep the dock below other windows”. The dock will then pop-up when you place the mouse on its screen border.
69
 
# - or choose the auto-hide. The dock will then hide itself and reappear when you enter the trigger zone.
70
 
#{Hint : you can choose to pop-up the dock only when the mouse hits the screen corner instead of the whole screen border.
71
 
#You can also setup the size of the trigger zone, and even set an image to it.}
72
 
keep below=
73
 
#v
74
 
sep_apparence=
75
 
#X [How can I add a separator ?]
76
 
Xseparator=
77
 
#> Simply right-click on the dock where you want to add a separator, and select “add a separator”.
78
 
#You can place it wherever you want (except in amongst taskbar icons) by dragging it with the mouse.
79
 
#{Hint : if you choose to mix applets and launchers in the 'Icons' module, you can also place separators between applets then.}
80
 
separator=
81
 
#X [I don’t want to have a separator between launchers , applis and applets]
82
 
Xauto sep=
83
 
#> In the “Icons” module, under the “separator” part, untick the box that says to “add automatic separators”.
84
 
auto sep=
85
 
#X [How can I add a sub-dock ?]
86
 
Xsubdock=
87
 
#> Just right-click on the dock, then select “add a sub-dock”. Fill the config panel with some name and image, then validate.
88
 
#{Hint : to move an icon into another dock, right-click on it, go to 'Move to', and choose the one you want in the list. You can do the same with applets as well, allowing you to group many applets in a sub-dok. You can also create new main docks with this way.}
89
 
subdock=
90
 
#X [How can I have many main docks ?]
91
 
Xmaindock=
92
 
#> Right-click on a launcher or an applet, go to 'Move to', and choose 'a new main dock'. A new dock will be created, with this icon inside.
93
 
#{Hint : you can then move icons inside this new dock by following the previous method and selecting the dock you've just created.
94
 
#To place this new dock, right click on it, and in the Cairo-dock sub-menu choose “configure this dock”.}
95
 
maindock=
96
 
#X [How do I get a 3D dock ?]
97
 
Xview=
98
 
#> Any dock can be displayed with one view, and many views are available (3D, Curve, etc).
99
 
#Go to the “Views” module, and choose the view you want for main dock, and for sub-docks.
100
 
#{Hint : you can setup the view for each sub-dock; just edit the icon pointing on the sub-dock, and choose the view you want for it.}
101
 
view=
102
 
#X [How can I change the background of my docks ?]
103
 
Xbg=
104
 
#> In the 'Background' module, you can either choose an image, or a color gradation.
105
 
#If you set an image, it will be used as the background, if you don't, the gradatoin will be used.
106
 
#{Hint : the Parabolic view doe not have a background, and the Slide and Rainbow views have their own background parameters.}
107
 
bg=
108
 
#X [I find the dock too much flashy, can it be more sober ?]
109
 
Xflashy=
110
 
#> Who can do more can do less ! You can for instance deactivate the "Icon effects" plug-in,
111
 
# or deactivate the effect on mouse hovering in "Animated Icon" plug-in.
112
 
#You can also decrease the zoom effect or lower the icons' reflect in the "Icon" module,
113
 
# change the background colors in the "Background" module, or change the view to the "default" view in the "Views" module.
114
 
#In brief, you can easily have something as much sober as a gnome-panel, but this would be a shame ! ^_^
115
 
#{Hint : try different themes, some are already very sober, like Dust-Sand or Elementary.}
116
 
flashy=
117
 
 
118
 
 
119
 
 
120
 
[Desklet]
121
 
#X [What are these “desklets” ?]
122
 
Xdesklet=
123
 
#> they are widgets that’s are displayed on your desktop. Each applet can be detached from the dock to act as a desklet.
124
 
#{Hint : to detach an applet, you can drag and drop its icon from the dock to the desktop}
125
 
desklet=
126
 
#X [How do I setup their position ?]
127
 
Xposition=
128
 
#> Simply drag them with the mouse.
129
 
#{Hint : If you don’t want to move it anymore, you can lock its position. Simply right click on the desklet, and select “lock position”. To unlock it, de-select this option.}
130
 
position=
131
 
#X [How do I set up their attitude ?]
132
 
Xattitude=
133
 
#> There are small buttons on the top and left side of the desklet. They allow  you to rotate the desklet in 3D !
134
 
#{Hint : if you locked the desklet, the buttons won’t appear. You can reset a rotation by middle-clicking on the appropriate button.}
135
 
attitude=
136
 
#X [How can I change their decorations ?]
137
 
Xdecorations=
138
 
#> The default decoration is defined in the “Desklets” module.
139
 
#You can setup a different decoration for each desklet. To change a desklet’s decoration,
140
 
# go to the applet’s configuration, click on the “desklet” tab, and then choose the decoration you want.
141
 
#{Hint : you can add new decorations, by choosing the “personnal” decoration, and providing a background and/or foreground image. You can setup the offsets of these images to adjust the position of the drawings inside the decorations.}
142
 
decorations=
143
 
#X [How do I insert a desklet into the dock ?]
144
 
Xinsert=
145
 
#> Simply click on the top right button.
146
 
#{Hint :  if the desklet is locked, the button won’t appear.}
147
 
insert=
148
 
#X [How can I place a desklet on the <i>Compiz Widget Layer</i> ?]
149
 
Xwlayer=
150
 
#> In the Compiz-Fusion config, activate the 'Widget Layer' plug-in, and set the rule (name=cairo-dock &amp; type=utility).
151
 
#You can then switch an applet to the Widget Layer by left-clicking on its desklet and selecting 'Compiz-Fusion Widget'.
152
 
#{Hint : you may have to switch one time to the Widget Layer so that Compiz takes into account the modification.}
153
 
wlayer=
154
 
 
155
 
 
156
 
[Taskbar]
157
 
#X [How do I activate the Taskbar ?]
158
 
Xactivate=
159
 
#> go to the “Taskbar” module, then tick the first box, and apply.
160
 
#{Hint : All the Taskbar’s options are grouped together in this module.
161
 
activate=
162
 
#X [I don’t want to have many icons in the dock when I use Gimp/Pidgin/etc]
163
 
Xgroup=
164
 
#> Use the “group applis by class” option. Only a single icon will appear in the dock. and if there are several windows, they will be grouped together in a sub-dock above this icon.
165
 
#{Hint : You can then scroll on this icon to switch from a window to another, in an ALT+TAB way.
166
 
group=
167
 
#X [I have ugly icons for some applis]
168
 
Xoverwrite=
169
 
#> it’s because X provides small icons for applis, that don’t look nice when zoomed. Use the option “overwrite X icons”, to tell the dock to not use them.
170
 
#{Hint : This way, you can setup your personnal icon for any application. Just place an icon with the same name as the class of the application in a folder used by the dock (by default, ~/.config/cairo-dock/current_theme/icons)
171
 
#The class of an appli can be found by typing xprop in a terminal, then clicking on the window of the appli.}
172
 
overwrite=
173
 
#X [When I launch a program with its launcher, I don’t want an additional icon in the taskbar]
174
 
Xmix=
175
 
#> Use the “Mix applis and launchers” option.
176
 
#When a program is launched, if it has a launcher in the dock, this one will take an indicator to signal you that the corresponding application is running.
177
 
#You can then act on the window as if it was a taskbar icon.
178
 
#{Hint : to launch another instance of the program, shift+click on the launcher.}
179
 
mix=
180
 
#X [I’m using Pidgin, and I want to see my friends’ avatar]
181
 
Xnot overwrite=
182
 
#> If you choosed to overwrite X icons, you can add an exception for Pidgin just before this option.
183
 
#If you choosed to mix applis and launchers, you can edit the Pidgin launcher,
184
 
# and in the “Extra parameters”, tick the box that says to not steal the icon for this appli.
185
 
not overwrite=
186
 
#X [How can I quickly navigate between many windows of the same application ?]
187
 
Xalt-tab=
188
 
#> Scroll on the icon of one of the windows of this appli, or even on the icon pointing on the sub-dock if you group windows in a sub-dock.
189
 
#{Hint : you can also close all the windows of this appli by middle-clicking on the icon pointing on the sub-dock.}
190
 
alt-tab=
191
 
 
192
 
 
193
 
 
194
 
[Replacing the gnome-panel]
195
 
#X [How can I have the main menu ?]
196
 
Xmain menu=
197
 
#> activate the Gmenu applet.
198
 
#{Hint : if you removed your gnome-panel, then the “alt+F1” shortkey does not work anymore. This applet let you setup a shortcut to pop up the menu at the mouse’s location.}
199
 
main menu=
200
 
#X [How can I have a simple “quick launch” window ?]
201
 
Xquick launch=
202
 
#> activate the Gmenu applet, then you can have it by middle-clicking on its icon.
203
 
#{Hint : if you removed your gnome-panel, then the “alt+F2” shortkey does not work anymore. This applet let you setup a shortcut to pop up the quick-launch dialog.}
204
 
quick launch=
205
 
#X [How can I have a logout icon ?]
206
 
Xlogout=
207
 
#> Simply activate the “logout” applet.
208
 
#{Hint : In the last Gnome version, there are 2 panel : one to logout, and one to turn off computer. The first one is raised by a click on the icon, the second by a middle-click, but the applet let you invert this order, and even let you enter your own commands.}
209
 
logout=
210
 
#X [How can I access the dustbin ?]
211
 
Xdustbin=
212
 
#> Simply activate the “dustbin” applet.
213
 
#{Hint : you can delete a file by dragging it into the dustbin. You can even unmount a mount-point this way !}
214
 
dustbin=
215
 
#X [How can I access to my mount points ?]
216
 
Xmount=
217
 
#> Simply activate the “shortcuts” applet.
218
 
#{Hint : you can mount a volume by clicking on its icon. To unmount it, middle-click on its icon, or right-click -> unmount.}
219
 
mount=
220
 
#X [How can I access to my Nautilus bookmarks ?]
221
 
Xbookmarks=
222
 
#> Simply activate the “shortcuts” applet.
223
 
#{Hint : you can add a bookmark by dragging the folder onto the applet or into its sub-dock. You can also rename and remove them. This will also take effect in Nautilus immediately, and vice versa.}
224
 
bookmarks=
225
 
#X [How can I access to my desktop ?]
226
 
Xshow desktop=
227
 
#> Simply activate the “show desktop” applet.
228
 
#{Hint : middle-clicking on it will hide all the windows, but not the desklets.}
229
 
show desktop=
230
 
#X [How can I have an easy-to-acces calendar ?]
231
 
Xcalendar=
232
 
#> activate the “clock” applet; clicking on it will display a calendar, clicking again will hide it.
233
 
calendar=
234
 
#X [How can I have the notification area (also called systray) ?]
235
 
Xsystray=
236
 
#> activate the “systray” applet. For the moment it can’t be displayed directly into the dock,
237
 
#so clicking on the icon will pop-up a dialog containing the systray, middle-click will hide it.
238
 
#I recommend to detach this applet to make it a desklet, place it in a corner of your screen, and keep it above other windows.
239
 
systray=
240
 
#X [How can I have an easy-to-access terminal with real transparence, like Tilda ?]
241
 
Xterminal=
242
 
#> activate the “terminal” applet. You can detach it and place it on the Widget Layer for instance, or setup a shorkey to make it pop-up instantly.
243
 
#{Hint : clicking next to the last tab will create a new tab. Double-clicking on a tab allows you to rename it. You can even change the color of a tab !}
244
 
terminal=
245
 
#X [So then, how can I remove completely the gnome-panel ?]
246
 
Xremove=
247
 
#> Open gconf-editor, edit the key /desktop/gnome/session/required_components_list/panel, and replace its content with "cairo-dock". This will not launch the dock on start-up, but just prevent the gnome-panel from launching, so don't forget to add Cairo-Dock on startup.
248
 
#Then restart your session : the gnome-panel has not been started.
249
 
remove=
250
 
 
251
 
 
252
 
[Other applets]
253
 
#X [How can I have a same applet many times ?]
254
 
Xmany=
255
 
#> Some applets can run several times at the same time : Clock, Cairo-Penguin, Weather, Netspeed, …
256
 
#Right click on the applet’s icon, and select “launch another instance”. A new instance of this applet appears in the main dock.
257
 
#You can configure this new one like any other applet.
258
 
#{Hint : This allows you, for example, to have the time of different countries in your dock, or to have many animated caracters in your dock, or the weather of different cities.}
259
 
many=
260
 
#X [I have a personal gauge that I want to use in the dock (for System-Monitor or others)] 
261
 
Xgauge=
262
 
#> move the folder containing your gauge in ~/.config/cairo-dock/extras/gauges, you’re done !
263
 
gauge=
264
 
#X [I have a personal Cairo-Clock theme that I want to use in the “clock” applet.]
265
 
Xclock=
266
 
#> move the folder containing your theme in ~/.config/cairo-dock/extras/clock, now it will appear in the list of themes !
267
 
#{Hint : the same goes on for all the applets that propose a theme : dustbin, Cairo-Penguin, weather, etc.}
268
 
clock=
269
 
#X [How can I change quickly the luminosity of my screen ?]
270
 
Xgamma=
271
 
#> Activate the Xgamma applet, then you can scroll up/down on the icon with the mouse.
272
 
gamma=
273
 
#X [How can I change quickly the speakers volume ?]
274
 
Xalsa=
275
 
#> Activate the AlsaMixer applet, then you can scroll up/down on the icon with the mouse.
276
 
alsa=
277
 
#X [How can I quickly switch to another desktop ?]
278
 
Xswitcher=
279
 
#> Activate the Switcher applet, then you can scroll up/down on the icon with the mouse to go to the previous/next desktop,
280
 
# or click on the icon to select a desktop.
281
 
#{Hint : this applet even lets you add/remove quickly a desktop !}
282
 
switcher=
283
 
#X [How can I control my dock with the keyboard ?]
284
 
Xkeyboard=
285
 
#> Many applets have events that can be triggered by a keyboard shortcut :
286
 
# - the <i>AlsaMixer</i> applet allows you to pop-up a <b>volume button</b> that can be controlled with the left/right arrows.
287
 
# - the <i>Terminal</i> applet allows you to pop-up the <b>terminal window</b> and directly write inside it.
288
 
# - the <i>Systray</i> applet allows you to pop-up the <b>notification area</b>.
289
 
# - the <i>Quick Browser</i> applet allows you to pop-up the <b>menu browser</b>, you can then navigate inside it with the arrows.
290
 
# - the <i>GMenu</i> applet allows you to pop-up the <b>Applications</b> menu, and also a <b>quick-launcher</b> dialog box.
291
 
# - the <i>Clipper</i> applet allows you to pop-up the <b>clipboard history</b> menu.
292
 
# - and of course, the <i>Scooby-Do</i> plug-in let you <b>navigate inside your docks</b> and quickly <b>find and launch</b> applications and files !
293
 
#{Hint : when you define a shorkey, try it before to be sure it's not already used by another application.}
294
 
keyboard=
295
 
 
296
 
 
297
 
[Troubleshooting]
298
 
#W[Forum] If you have any question, don't hesitate to ask it on our forum.
299
 
forum=http://forum.glx-dock.org
300
 
#W[Wiki] Our wiki can also help you, it is more complete on some points.
301
 
wiki=http://wiki.glx-dock.org
302
 
 
303
 
#X [I have a black background around my dock] 
304
 
Xblack=
305
 
#> You have to turn on the compositing. For instance, you can run Compiz or xcompmgr. 
306
 
#If you’re under XFCE or KDE, you can just activate the compositing in the window manager’s options.
307
 
#If you're under Gnome, you can activate it in Metacity in this way :
308
 
# Open gconf-editor, edit the key '/apps/metacity/general/compositing_manager' and set it to 'true'.
309
 
#{Hint : If yo have an ATI or an Intel, you should try without OpenGL first, because their drivers are not yet perfect.}
310
 
black=
311
 
#X [My machine is too old to run a composite manager] 
312
 
Xfake=
313
 
#> Don’t panic, Cairo-Dock can emulate the transparency.
314
 
#So to get rid of the black background, just activate the corresponding option, in the end of the “System” module
315
 
fake=
316
 
#X [The dock is horribly slow when I move the mouse into it] 
317
 
Xslow=
318
 
#> If you have a GeForce8, you have to install the latest drivers, because the first ones were really buggy.
319
 
#If the dock is running without openGL, try to reduce the number of icons in the main dock, or try to reduce its size.
320
 
#If the dock is running with openGL, try to deactivate it by launching the dock with “cairo-dock –c”.
321
 
slow=
322
 
#X [I don’t have these wonderful effects like fire, cube rotating, etc] 
323
 
Xeff=
324
 
#> You need a graphic card with drivers that support openGL2.0. Most of Nvidia cards can do that, more and more Intel cards can do too. Most of ATI cards can’t do that.
325
 
#{Hint : You can force the openGL by launching the dock with “cairo-dock –o”.but you might get a lot of visual artifacts.}
326
 
eff=
327
 
#X [I don't have any themes in the Theme Manager, except the default one.]
328
 
Xconn=
329
 
#> Be sure that you are connected to the Net.
330
 
# If your connection is very slow, you can increase the connection timeout in the "System" module.
331
 
# 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).
332
 
#{Hint : Until the version 2.1.1-2, wget was used.}
333
 
conn=
334
 
#v
335
 
sep_applet=
336
 
#X [The “netspeed” applet displays 0 even when I’m downloading something]
337
 
Xnetspeed=
338
 
#> You have to tell it which interface you’re using to connect to the Net (by default, it’s “eth0”).
339
 
#Just edit its configuration, and enter the interface’s name. To find it, type “ifconfig” in a terminal, and ignore the “loop” interface. It’s probably something like “eth1”, “ath0”, or “wifi0”.
340
 
#{Hint : you can instantiate this applet many times if you want to monitor many interfaces.}
341
 
netspeed=
342
 
#X [The dustbin remains empty even when I delete a file]
343
 
Xdustbin=
344
 
#> if you’re under KDE, you may have to tell it the path of the trash folder.
345
 
#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).
346
 
dustbin=
347
 
 
348
 
 
349
 
[Join the project !]
350
 
#> We value your help ! If you see a bug, or if you think something could be improved,
351
 
#or if you just made a dream about the dock, pay us a visit on glx-dock.org.
352
 
#English speakers are welcome, so don’t be shy ! ;-)
353
 
#
354
 
#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 !
355
 
help=
356
 
#W[documentation] If you wish to develop an applet, a complete documentation is available here.
357
 
doc=http://doc.glx-dock.org
358
 
#W[DBus API] If you wish to develop an applet in Python, Perl or any other language,
359
 
#or to interact with the dock in any kind of way, a full DBus API is described here.
360
 
dbus=http://www.glx-dock.org/ww_page.php?p=Control_your_dock_with_DBus&lang=en
361
 
#>
362
 
#
363
 
#The Cairo-Dock Team
364
 
team=