-
Notifications
You must be signed in to change notification settings - Fork 3
/
doc.go
191 lines (128 loc) · 5.67 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/*
cdc starts a custom version of cairo-dock with a new config GUI.
Usage:
cdc command [arguments]
The commands are:
appinfo appinfo edits applets information
build build cairo-dock sources
external external applets management
remote remote controls the active dock
upload upload files or text to one-click hosting services
version print cdc version
Use "cdc help [command]" for more information about a command.
Without command, the dock will be started with those arguments:
Display Backend:
-c Use Cairo backend.
-o Use OpenGL backend.
-O Use OpenGL backend with indirect rendering.
There are very few case where this option should be used.
-A Ask again on startup which backend to use.
-W Work around some bugs in Metacity Window-Manager
(invisible dialogs or sub-docks)
Desktop:
-k Lock the dock so that any modification is impossible for users.
-e env Force the dock to consider this environnement - use it with care.
-a Keep the dock above other windows.
-s Don't make the dock appear on all desktops.
Paths override:
-d path Use a custom config directory. Default: ~/.config/cairo-dock
-S url Address of a server with additional themes (overrides default).
-M path Ask the dock to load additionnal modules from this directory.
(though it is unsafe for your dock to load unnofficial modules).
Debug:
-w time Wait for N seconds before starting; this is useful if you notice
some problems when the dock starts with the session.
-x appname Exclude applets from activating (still loaded). Separator=;
-f Safe mode: don't load any plug-ins.
-l level Log verbosity: debug,message,warning,critical,error (def=warning).
-F Force to display some output messages with colors.
-D Debug mode for the go part of the code (including applets).
-N Don't start the internal Dbus service (used by remote command).
-pf pprof file output: go tool pprof $(which cdc) /pathToFile
-pw pprof web service: http://localhost:port/debug/pprof
Versions:
-v Print gldi version.
-vv Print all versions.
This version still lacks some options and may not be considered usable for
everybody at the moment. But it also needs to be tested now.
Appinfo edits applets information
Usage:
cdc appinfo [-d path] appletname...
AppInfo edits applets registration information.
Common flags:
-d path Use a custom config directory. Default: ~/.config/cairo-dock
Build cairo-dock sources
Usage:
cdc build [-k] [-r] [-h] target
Build builds and install Cairo-Dock sources.
Targets:
c or core Build the dock core.
p or plug-ins Build all plug-ins.
applet name Use the name of the applet directory in cairo-dock-plug-ins.
Plug-ins must have been installed first.
Flags:
-k Keep build dir unchanged before build (no make clean).
-r Reload your target after build.
-h Hide the make install flood if any.
-g Graphical mode. Use gksudo to request password.
Options:
-s Sources directory. Default is current dir.
-j Specifies the number of jobs (commands) to run simultaneously.
Default = all availables processors.
External applets management
Usage:
cdc external [-d path] [-r] [appletname...]
External lists, installs or removes Cairo-Dock external applets.
The action depends if applet names are provided, and on the -r flag:
no applet name Display the list of external applets.
one or more Install applet(s).
one or more and -r Remove applet(s).
Common flags:
-d path Use a custom config directory. Default: ~/.config/cairo-dock
Remove flag:
-r Remove applets instead of install.
List matching flags:
-s Only match applets found on the applet server.
-l Only match applets found locally.
List display flags:
-json Print applet package data in JSON format.
-f template Set a specific format for the list, with the go template syntax.
You can use a template to format the result the way you want.
For example, to have just the applet name: -f '{{.DisplayedName}}'.
Everything is possible like '{{.DisplayedName}} by {{.Author}}'.
For the full list of fields, see AppletPackage:
http://godoc.org/github.com/sqp/godock/libs/packages#AppletPackage
Remote controls the active dock
Usage:
cdc remote command [args...]
Remote sends a remote command to the active dock.
d Debug appletName [state]
Set the debug state of a go applet.
To disable the debug, use state: false, no or 0.
All other state value will enable the debug for the applet.
sb SourceCodeBuildTarget
Build the current source code target.
sg SourceCodeGrepTarget grepString
Grep text in the current source code target dir.
so SourceCodeOpenFile filePath
Open a file in the current source code target dir (if relative).
ul UpToShareLastLink
Print the link of the last uploaded item.
Upload files or text to one-click hosting services
Usage:
cdc upload path/to/file
Upload send data (file or pipe) to a one-click hosting service.
Flags:
-m Multiple files enabled.
Examples:
cdc upload /path/to/file
cdc upload < path/to/file
cat /path/to/file | cdc upload
echo "test online text" | cdc upload # send raw text
Note: you must have an active instance of the NetActivity applet.
Print cdc version
Usage:
cdc version
Version prints the cdc version.
*/
package main