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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2018-10-23 Tue 10:35 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>‎</title>
<meta name="generator" content="Org mode" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
/*]]>*/-->
</style>
<script type="text/javascript">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2018 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org188eec0">ck</a></li>
<li><a href="#org5cf05fb">build it</a>
<ul>
<li><a href="#orgddaa24b">requirements</a></li>
<li><a href="#org4b2326a">compiler</a></li>
<li><a href="#orgcc546ab">make</a></li>
</ul>
</li>
<li><a href="#org8c57e12">for devs</a>
<ul>
<li><a href="#org6c910a6">CMake options</a></li>
<li><a href="#org9be5ed3">tests</a>
<ul>
<li><a href="#orgbe86272">run tests</a></li>
<li><a href="#org136123c">test suite</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#org1b4ae92">manual</a>
<ul>
<li><a href="#org028f12c">ck configuration</a></li>
<li><a href="#org675d6b6">Actions</a>
<ul>
<li><a href="#orgd421244">init</a></li>
<li><a href="#org400c289">add</a></li>
<li><a href="#orgab0ce16">list</a></li>
<li><a href="#orgb29e969">search</a></li>
<li><a href="#orgd0ea024">edit</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<p align="center"><img src="res/logo.png"></p>
<div id="outline-container-org188eec0" class="outline-2">
<h2 id="org188eec0">ck</h2>
<div class="outline-text-2" id="text-org188eec0">
<p>
<b>The Config Keeper</b>
</p>
</div>
</div>
<div id="outline-container-org5cf05fb" class="outline-2">
<h2 id="org5cf05fb">build it</h2>
<div class="outline-text-2" id="text-org5cf05fb">
</div>
<div id="outline-container-orgddaa24b" class="outline-3">
<h3 id="orgddaa24b">requirements</h3>
<div class="outline-text-3" id="text-orgddaa24b">
<ul class="org-ul">
<li>clang (llvm) or gcc (gnu)</li>
<li>cmake</li>
<li>sqlite3-dev</li>
</ul>
</div>
</div>
<div id="outline-container-org4b2326a" class="outline-3">
<h3 id="org4b2326a">compiler</h3>
<div class="outline-text-3" id="text-org4b2326a">
<div class="org-src-container">
<pre class="src src-sh">> export <span style="color: #baba36;">CC</span>=clang
<span style="color: #656565;"># </span><span style="color: #757575;">or</span>
> export <span style="color: #baba36;">CC</span>=gcc
</pre>
</div>
</div>
</div>
<div id="outline-container-orgcc546ab" class="outline-3">
<h3 id="orgcc546ab">make</h3>
<div class="outline-text-3" id="text-orgcc546ab">
<p>
Use <code>-DCMAKE_INSTALL_PREFIX</code> when running cmake to change the install path.
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">clone the repo</span>
> cd ~/code; git clone https://gitlab.com/grm-grm/ck
<span style="color: #656565;"># </span><span style="color: #757575;">make a build directory and enter it</span>
> mkdir ~/ck_build; <span style="color: #528fd1;">cd</span> ~/ck_build;
<span style="color: #656565;"># </span><span style="color: #757575;">run cmake</span>
> cmake ~/code/ck
<span style="color: #656565;"># </span><span style="color: #757575;">run make</span>
> make
<span style="color: #656565;"># </span><span style="color: #757575;">install it</span>
> make install
<span style="color: #656565;"># </span><span style="color: #757575;">run ck</span>
> ck
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org8c57e12" class="outline-2">
<h2 id="org8c57e12">for devs</h2>
<div class="outline-text-2" id="text-org8c57e12">
<p>
Please be <a href="https://www.gnu.org/philosophy/kind-communication.html">kind</a> to each other.
</p>
</div>
<div id="outline-container-org6c910a6" class="outline-3">
<h3 id="org6c910a6">CMake options</h3>
<div class="outline-text-3" id="text-org6c910a6">
<p>
cmake accepts the following options:
</p>
<div class="org-src-container">
<pre class="src src-cmake"><span style="color: #6aaf50;">option</span>(CK_ASAN <span style="color: #bdbc61;">"Build with asan"</span>)
<span style="color: #6aaf50;">option</span>(CK_DEBUG <span style="color: #bdbc61;">"Build with debug symbols"</span>)
<span style="color: #6aaf50;">option</span>(CK_TESTS <span style="color: #bdbc61;">"Make the tests"</span>)
<span style="color: #6aaf50;">option</span>(CK_SHARED <span style="color: #bdbc61;">"Build with shared lib"</span>)
</pre>
</div>
<p>
To use any one of them append it after the cmake command like so:
</p>
<div class="org-src-container">
<pre class="src src-sh">cmake -DCK_ASAN=1 -DCK_DEBUG=1 -DCK_TESTS=1 ~/code/ck
</pre>
</div>
<p>
Just build with address sanitizer enabled like so:
llvm has better asan than gcc, so I use that.
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">clone the repo</span>
> cd ~/code; git clone https://gitlab.com/grm-grm/ck
<span style="color: #656565;"># </span><span style="color: #757575;">make a build directory and enter it</span>
> mkdir ~/ck_build; <span style="color: #528fd1;">cd</span> ~/ck_build;
<span style="color: #656565;"># </span><span style="color: #757575;">run cmake</span>
> cmake -DCK_ASAN=1 -DCK_DEBUG=1 -DCK_TESTS=1 ~/code/ck
<span style="color: #656565;"># </span><span style="color: #757575;">run make</span>
> make
<span style="color: #656565;"># </span><span style="color: #757575;">run ck</span>
> ./ck
</pre>
</div>
</div>
</div>
<div id="outline-container-org9be5ed3" class="outline-3">
<h3 id="org9be5ed3">tests</h3>
<div class="outline-text-3" id="text-org9be5ed3">
<p>
The testing "suite" is a bash script that runs regression
and unit tests. Regression tests are under the <code>tests/</code> directory
and are bash scripts that test <code>ck</code> functionality. Unit tests reside
under <code>unit/</code> directory and test the code.
</p>
</div>
<div id="outline-container-orgbe86272" class="outline-4">
<h4 id="orgbe86272">run tests</h4>
<div class="outline-text-4" id="text-orgbe86272">
<p>
First make sure you build ck with the <code>-DCK_TESTS=1</code> option. Then
go to the build directory and type:
</p>
<div class="org-src-container">
<pre class="src src-sh">$ ./test-ck
</pre>
</div>
</div>
</div>
<div id="outline-container-org136123c" class="outline-4">
<h4 id="org136123c">test suite</h4>
<div class="outline-text-4" id="text-org136123c">
<div class="org-src-container">
<pre class="src src-sh">$ ./test-ck -h
ck test suite
use without flags to run all tests
flags:
-u, --unit run only the unit tests
-r, --regression run only the regression tests
-c, --clear remove test files
use if the tests crush unexpectedly
-h, --help, * print this
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="outline-container-org1b4ae92" class="outline-2">
<h2 id="org1b4ae92">manual</h2>
<div class="outline-text-2" id="text-org1b4ae92">
<p>
ck's goal is to assist with the configuration file management.
To that end it tries to provides a cli interface that is pretty straight-forward
and intuitive.
</p>
<p>
Example usage:
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">initialize new ck</span>
$ ck init /path_to/where_you_want/your_configs/to_be <span style="color: #bdbc61;">\</span>
/path_to/the_secret/directory
<span style="color: #656565;"># </span><span style="color: #757575;">add emacs configs</span>
<span style="color: #656565;">## </span><span style="color: #757575;">primary config</span>
$ ck add emacs ~/.emacs.d/orgconf.org -p
<span style="color: #656565;">## </span><span style="color: #757575;">secret config, with passwords and naughty words</span>
$ ck add emacs ~/.emacs.d/accounts.org -s
<span style="color: #656565;">## </span><span style="color: #757575;">and another one for emacs</span>
$ ck add emacs ~/.emacs.d/init.el
<span style="color: #656565;"># </span><span style="color: #757575;">add tmux config</span>
$ ck add tmux ~/.tmux.conf -p
<span style="color: #656565;"># </span><span style="color: #757575;">list the configs</span>
$ ck list tree
$ ck list paths -t lisp
$ ck list programs -t python
$ ck list -p emacs
<span style="color: #656565;"># </span><span style="color: #757575;">search the configs</span>
$ ck search search-term
$ ck search <span style="color: #bdbc61;">"\"search term with spaces\""</span>
$ ck search <span style="color: #bdbc61;">"\("</span> <span style="color: #656565;">#</span><span style="color: #757575;">escape symbols</span>
</pre>
</div>
<p>
The first command after typing <b>ck</b> is the action you wish to perform. Actions are
a very important concept of ck. With an action you can initialize <b>ck</b>, add/move/delete
configuration files to it, edit them, list them in various ways and search in their content.
</p>
<p>
Actions expect their arguments in the order specified below. This is done to reduce the amount
of flags one has to pass to ck.
</p>
</div>
<div id="outline-container-org028f12c" class="outline-3">
<h3 id="org028f12c">ck configuration</h3>
<div class="outline-text-3" id="text-org028f12c">
<p>
ck uses sqlite to index the configuration files. The init
action creates a <b>.ck</b> directory (under $HOME)
in witch the <b>ckrc</b> and the <b>ckdb</b> reside. The first one contains
the two directories described above while the other one is the
sqlite db.
</p>
<p>
One can have multiple config directories with different configurations
each.
</p>
<p>
Using the special keyword <b>config</b> (or <b>-c</b>) you can set the path
in which ck will search for the <b>.ck</b> directory.
</p>
<p>
You can prefix every action with this and ck will use the configuration
directory of your choice.
</p>
<p>
Usage:
</p>
<div class="org-src-container">
<pre class="src src-sh">$ ck config ~/ ... <span style="color: #656565;"># </span><span style="color: #757575;">the default behaviour</span>
<span style="color: #656565;"># </span><span style="color: #757575;">/someplace/else must exist or</span>
<span style="color: #656565;"># </span><span style="color: #757575;">the action following it must be init</span>
$ ck -c /someplace/else ...
</pre>
</div>
</div>
</div>
<div id="outline-container-org675d6b6" class="outline-3">
<h3 id="org675d6b6">Actions</h3>
<div class="outline-text-3" id="text-org675d6b6">
</div>
<div id="outline-container-orgd421244" class="outline-4">
<h4 id="orgd421244">init</h4>
<div class="outline-text-4" id="text-orgd421244">
<p>
or i or -i
</p>
<p>
init takes exactly 2 arguments.
</p>
<ul class="org-ul">
<li><b>config_dir</b>: where all the configs will live</li>
<li><b>secret_dir</b>: where all the secret configs will live</li>
</ul>
<p>
Use init to initialize a new ck database.
</p>
<p>
Usage:
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">initialize new ck</span>
$ ck init /path_to/where_you_want/your_configs/to_be <span style="color: #bdbc61;">\</span>
/path_to/the_secret/directory
</pre>
</div>
</div>
</div>
<div id="outline-container-org400c289" class="outline-4">
<h4 id="org400c289">add</h4>
<div class="outline-text-4" id="text-org400c289">
<p>
or a or -a
</p>
<p>
Adds a configuration to the ck database.
Add takes 2 to 4 arguments.
</p>
<ul class="org-ul">
<li><b>program_name</b>: the name of the program you add a config to</li>
<li><b>config_path</b>: the path to the config</li>
<li>Optional: (order doesn't matter)
<ul class="org-ul">
<li><b>-p</b>: the config will be the primary (relevant on edit below)</li>
<li><b>-s</b>: the config will be stored in the secret_dir</li>
</ul></li>
</ul>
<p>
Keep in mind:
</p>
<ul class="org-ul">
<li>The config has to exist.</li>
<li>If you are adding a config to a program already existing in ckdb make
sure to use the same name.</li>
<li>Each program can have only one primary config.</li>
</ul>
<p>
Usage:
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">add config to ck</span>
$ ck add program_name config_path [-s] [-p]
</pre>
</div>
</div>
</div>
<div id="outline-container-orgab0ce16" class="outline-4">
<h4 id="orgab0ce16">list</h4>
<div class="outline-text-4" id="text-orgab0ce16">
<p>
or ls or l or -l
</p>
<p>
List stuff ck knows about.
</p>
<p>
You can use the keywords:
</p>
<ul class="org-ul">
<li><b>paths</b>: to print all the paths ck tracks</li>
<li><b>programs</b>: to print all the programs ck tracks</li>
<li><b>-p progName</b>: (without the "<>") to print the paths of a specific program</li>
</ul>
<p>
With the flag <b>-t</b> and then one of the follwing types one can change
the way the list is printed:
</p>
<ul class="org-ul">
<li><b>plain</b>: simple listing (default)</li>
<li><b>python</b>: print like a python list</li>
<li><b>lisp</b>: print like a lisp list</li>
</ul>
<p>
Using the keyword <b>tree</b> ck can list the configurations under their
corresponding program, in a treelike structure.
</p>
<p>
Passing the <b>-a</b> flag will enable the listing of config attributes (secret or primary).
It is best used with tree or plain paths.
</p>
<p>
With the keyword <b>ckconf</b> ck will list it's own configuration values (in ckrc).
</p>
<p>
Usage:
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">list tree structure, with attributes</span>
$ ck list tree -a
<span style="color: #656565;"># </span><span style="color: #757575;">list paths in python</span>
$ ck l paths -t python
<span style="color: #656565;"># </span><span style="color: #757575;">list programs in lisp</span>
$ ck ls programs -t lisp
<span style="color: #656565;"># </span><span style="color: #757575;">list emacs' configurations [with attributes]</span>
$ ck ls -p emacs [-a]
<span style="color: #656565;"># </span><span style="color: #757575;">list bash configurations in lisp</span>
$ ck ls -p bash -t lisp
<span style="color: #656565;"># </span><span style="color: #757575;">list ck configuration</span>
$ ck -l ckconf
</pre>
</div>
</div>
</div>
<div id="outline-container-orgb29e969" class="outline-4">
<h4 id="orgb29e969">search</h4>
<div class="outline-text-4" id="text-orgb29e969">
<p>
or grep or s or -s
</p>
<p>
Perform infile grep in all the configurations ck keeps track of.
</p>
<p>
Takes one argument, the <b>search-term</b>.
</p>
<p>
To search for terms with spaces you have to put them in quotes.
</p>
<p>
Usage:
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">search for parenthesis</span>
$ ck search <span style="color: #bdbc61;">\(</span>
<span style="color: #656565;"># </span><span style="color: #757575;">search term with spaces</span>
$ ck grep <span style="color: #bdbc61;">"This is a space"</span>
<span style="color: #656565;"># </span><span style="color: #757575;">both</span>
$ ck s <span style="color: #bdbc61;">"(add 2 4)"</span>
<span style="color: #656565;"># </span><span style="color: #757575;">and a normal one</span>
$ ck -s alias
</pre>
</div>
<p>
If you want to use more advanced grep techniques or even
a different pattern matching program you can do it like so:
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">with xargs</span>
$ ck ls paths | xargs grep -E <span style="color: #bdbc61;">'A|B'</span>
<span style="color: #656565;"># </span><span style="color: #757575;">or in bash</span>
$ for i<span style="color: #5180b3;"> in</span> $(ck ls paths); <span style="color: #5180b3;">do</span> grep -E <span style="color: #bdbc61;">'A|B'</span> $<span style="color: #baba36;">i</span>; <span style="color: #5180b3;">done</span>
<span style="color: #656565;"># </span><span style="color: #757575;">or in zsh</span>
$ for i ($(ck ls paths)) grep -E <span style="color: #bdbc61;">'A|B'</span> $<span style="color: #baba36;">i</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgd0ea024" class="outline-4">
<h4 id="orgd0ea024">edit</h4>
<div class="outline-text-4" id="text-orgd0ea024">
<p>
or e or -e
</p>
<p>
Edit configurations with <code>$EDITOR</code>.
</p>
<p>
Edit takes at least one and up to two arguments.
</p>
<p>
The first argument is the <b>programName</b>. If the program has a primary configuration
edit will open this. If the program has only one configuration edit will open it.
If the program has more than 1 configurations and no primary, it will print the
avaliable configurations and exit.
</p>
<p>
The second argument is the <b>configName</b>. If it exists it will open, else it will
print the avaliable configurations and exit.
</p>
<p>
Usage:
</p>
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">suppose this is our ck instance</span>
$ ck list tree -a
emacs:
|- init.el
|- accounts.el [s]
|- orgconf.org [p]
<span style="color: #656565;"># </span><span style="color: #757575;">edit the primary emacs config</span>
$ ck edit emacs
<span style="color: #656565;"># </span><span style="color: #757575;">edit a specific emacs config, other than the primary</span>
$ ck edit emacs accounts.el
</pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="date">Created: 2018-10-23 Tue 10:35</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>
|
