-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathcommand-reference-short.golden
454 lines (276 loc) · 10.1 KB
/
command-reference-short.golden
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
The Ringboard (clipboard history) CLI
Usage: clipboard-history <COMMAND>
Commands:
get Get an entry from the database
search Searches the Ringboard database for entries matching a query
add Add an entry to the database
favorite Favorite an entry
unfavorite Unfavorite an entry
move-to-front Move an entry to the front, making it the most recent entry
swap Swap the positions of two entries
remove Delete an entry from the database
wipe Wipe the entire database
import Migrate from other clipboard managers to Ringboard
garbage-collect Run garbage collection on the database
configure Modify app settings
debug Debugging tools for developers
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help (use `--help` for more detail)
-V, --version Print version
---
Get an entry from the database
Usage: clipboard-history get <ID>
Arguments:
<ID> The entry ID
Options:
-h, --help Print help (use `--help` for more detail)
---
Searches the Ringboard database for entries matching a query
Usage: clipboard-history search [OPTIONS] <QUERY>
Arguments:
<QUERY> The query string to search for
Options:
-r, --regex Interpret the query string as regex instead of a plain-text match
-i, --ignore-case Ignore ASCII casing when searching
-h, --help Print help (use `--help` for more detail)
---
Add an entry to the database
Usage: clipboard-history add [OPTIONS] [DATA_FILE]
Arguments:
[DATA_FILE] A file containing the data to be added to the entry [default: -]
Options:
-f, --favorite Whether to add the entry to the favorites ring
-m, --mime-type <MIME_TYPE> The entry mime type
-c, --copy Whether to overwrite the system clipboard with this entry
-h, --help Print help (use `--help` for more detail)
---
Favorite an entry
Usage: clipboard-history favorite <ID>
Arguments:
<ID> The entry ID
Options:
-h, --help Print help (use `--help` for more detail)
---
Unfavorite an entry
Usage: clipboard-history unfavorite <ID>
Arguments:
<ID> The entry ID
Options:
-h, --help Print help (use `--help` for more detail)
---
Move an entry to the front, making it the most recent entry
Usage: clipboard-history move-to-front <ID>
Arguments:
<ID> The entry ID
Options:
-h, --help Print help (use `--help` for more detail)
---
Swap the positions of two entries
Usage: clipboard-history swap <ID1> <ID2>
Arguments:
<ID1> The first entry ID
<ID2> The second entry ID
Options:
-h, --help Print help (use `--help` for more detail)
---
Delete an entry from the database
Usage: clipboard-history remove <ID>
Arguments:
<ID> The entry ID
Options:
-h, --help Print help (use `--help` for more detail)
---
Wipe the entire database
Usage: clipboard-history wipe
Options:
-h, --help Print help (use `--help` for more detail)
---
Migrate from other clipboard managers to Ringboard
Usage: clipboard-history import <FROM> [DATABASE]
Arguments:
<FROM> The existing clipboard to import [possible values: gnome-clipboard-history,
clipboard-indicator, g-paste, json]
[DATABASE] The existing clipboard's database location
Options:
-h, --help Print help (use `--help` for more detail)
---
Run garbage collection on the database
Usage: clipboard-history garbage-collect [OPTIONS]
Options:
-m, --max-wasted-bytes <MAX_WASTED_BYTES>
The maximum amount of garbage (in bytes) that is tolerable [default: 0]
-h, --help
Print help (use `--help` for more detail)
---
Modify app settings
Usage: clipboard-history configure <COMMAND>
Commands:
x11 Edit the X11 watcher settings
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help (use `--help` for more detail)
---
Edit the X11 watcher settings
Usage: clipboard-history configure x11 [OPTIONS]
Options:
--auto-paste <AUTO_PASTE> Instead of simply placing selected items in the clipboard, attempt
to automatically paste the selected item into the previously
focused application [default: true] [possible values: true, false]
-h, --help Print help (use `--help` for more detail)
---
Print this message or the help of the given subcommand(s)
Usage: clipboard-history configure help [COMMAND]
Commands:
x11 Edit the X11 watcher settings
help Print this message or the help of the given subcommand(s)
---
Edit the X11 watcher settings
Usage: clipboard-history configure help x11
---
Print this message or the help of the given subcommand(s)
Usage: clipboard-history configure help help
---
Debugging tools for developers
Usage: clipboard-history debug <COMMAND>
Commands:
stats Print statistics about the Ringboard database
dump Dump the database contents for analysis
generate Generate a pseudo-random database for testing and performance tuning purposes
fuzz Spam the server with random commands
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help (use `--help` for more detail)
---
Print statistics about the Ringboard database
Usage: clipboard-history debug stats
Options:
-h, --help Print help (use `--help` for more detail)
---
Dump the database contents for analysis
Usage: clipboard-history debug dump
Options:
-h, --help Print help (use `--help` for more detail)
---
Generate a pseudo-random database for testing and performance tuning purposes
Usage: clipboard-history debug generate [OPTIONS]
Options:
-n, --entries <NUM_ENTRIES> The number of random entries to generate [default: 100_000]
-m, --mean-size <MEAN_SIZE> The mean entry size [default: 512]
-c, --cv-size <CV_SIZE> The coefficient of variation of the entry size [default: 10]
-h, --help Print help (use `--help` for more detail)
---
Spam the server with random commands
Usage: clipboard-history debug fuzz [OPTIONS]
Options:
-s, --seed <SEED> The RNG seed [default: 42]
-m, --mean-size <MEAN_SIZE> The mean entry size [default: 512]
-c, --cv-size <CV_SIZE> The coefficient of variation of the entry size [default: 10]
-v, --verbose Print extra debugging output
-h, --help Print help (use `--help` for more detail)
---
Print this message or the help of the given subcommand(s)
Usage: clipboard-history debug help [COMMAND]
Commands:
stats Print statistics about the Ringboard database
dump Dump the database contents for analysis
generate Generate a pseudo-random database for testing and performance tuning purposes
fuzz Spam the server with random commands
help Print this message or the help of the given subcommand(s)
---
Print statistics about the Ringboard database
Usage: clipboard-history debug help stats
---
Dump the database contents for analysis
Usage: clipboard-history debug help dump
---
Generate a pseudo-random database for testing and performance tuning purposes
Usage: clipboard-history debug help generate
---
Spam the server with random commands
Usage: clipboard-history debug help fuzz
---
Print this message or the help of the given subcommand(s)
Usage: clipboard-history debug help help
---
Print this message or the help of the given subcommand(s)
Usage: clipboard-history help [COMMAND]
Commands:
get Get an entry from the database
search Searches the Ringboard database for entries matching a query
add Add an entry to the database
favorite Favorite an entry
unfavorite Unfavorite an entry
move-to-front Move an entry to the front, making it the most recent entry
swap Swap the positions of two entries
remove Delete an entry from the database
wipe Wipe the entire database
import Migrate from other clipboard managers to Ringboard
garbage-collect Run garbage collection on the database
configure Modify app settings
debug Debugging tools for developers
help Print this message or the help of the given subcommand(s)
---
Get an entry from the database
Usage: clipboard-history help get
---
Searches the Ringboard database for entries matching a query
Usage: clipboard-history help search
---
Add an entry to the database
Usage: clipboard-history help add
---
Favorite an entry
Usage: clipboard-history help favorite
---
Unfavorite an entry
Usage: clipboard-history help unfavorite
---
Move an entry to the front, making it the most recent entry
Usage: clipboard-history help move-to-front
---
Swap the positions of two entries
Usage: clipboard-history help swap
---
Delete an entry from the database
Usage: clipboard-history help remove
---
Wipe the entire database
Usage: clipboard-history help wipe
---
Migrate from other clipboard managers to Ringboard
Usage: clipboard-history help import
---
Run garbage collection on the database
Usage: clipboard-history help garbage-collect
---
Modify app settings
Usage: clipboard-history help configure [COMMAND]
Commands:
x11 Edit the X11 watcher settings
---
Edit the X11 watcher settings
Usage: clipboard-history help configure x11
---
Debugging tools for developers
Usage: clipboard-history help debug [COMMAND]
Commands:
stats Print statistics about the Ringboard database
dump Dump the database contents for analysis
generate Generate a pseudo-random database for testing and performance tuning purposes
fuzz Spam the server with random commands
---
Print statistics about the Ringboard database
Usage: clipboard-history help debug stats
---
Dump the database contents for analysis
Usage: clipboard-history help debug dump
---
Generate a pseudo-random database for testing and performance tuning purposes
Usage: clipboard-history help debug generate
---
Spam the server with random commands
Usage: clipboard-history help debug fuzz
---
Print this message or the help of the given subcommand(s)
Usage: clipboard-history help help