diff options
Diffstat (limited to 'README.html')
| -rw-r--r-- | README.html | 186 |
1 files changed, 105 insertions, 81 deletions
diff --git a/README.html b/README.html index e51fc39..2180663 100644 --- a/README.html +++ b/README.html @@ -3,7 +3,7 @@ "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-07 Sun 16:25 --> +<!-- 2018-10-08 Mon 23:46 --> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <title>‎</title> @@ -232,35 +232,35 @@ for the JavaScript code in this tag. <h2>Table of Contents</h2> <div id="text-table-of-contents"> <ul> -<li><a href="#org84db86d">ck</a></li> -<li><a href="#org079cefd">build it</a> +<li><a href="#org1c6aa01">ck</a></li> +<li><a href="#orgbf1d4c5">build it</a> <ul> -<li><a href="#org309e80c">requirements</a></li> -<li><a href="#org41965f5">compiler</a></li> -<li><a href="#org6696ef0">make</a></li> +<li><a href="#org8edf2df">requirements</a></li> +<li><a href="#org30b18cc">compiler</a></li> +<li><a href="#org28e3d41">make</a></li> </ul> </li> -<li><a href="#org06e00e7">for devs</a> +<li><a href="#orgcd61fbc">for devs</a> <ul> -<li><a href="#orgcb6d6ca">CMake options</a></li> -<li><a href="#org73af3d7">tests</a> +<li><a href="#org713cf8f">CMake options</a></li> +<li><a href="#orga6955dd">tests</a> <ul> -<li><a href="#org792dc4d">run tests</a></li> -<li><a href="#orgac7c553">test suite</a></li> +<li><a href="#org6219fcc">run tests</a></li> +<li><a href="#orgd4349ab">test suite</a></li> </ul> </li> </ul> </li> -<li><a href="#org52a2560">manual</a> +<li><a href="#org1d127b7">manual</a> <ul> -<li><a href="#org09a0c5c">ck configuration</a></li> -<li><a href="#orgd61b3e4">Actions</a> +<li><a href="#orge5785e3">ck configuration</a></li> +<li><a href="#orga717caf">Actions</a> <ul> -<li><a href="#org3ca7b35">init</a></li> -<li><a href="#orga12b072">add</a></li> -<li><a href="#orgab0f98c">list</a></li> -<li><a href="#orgdc0a7ed">search</a></li> -<li><a href="#orgd947583">edit</a></li> +<li><a href="#org29304ac">init</a></li> +<li><a href="#org8841e7c">add</a></li> +<li><a href="#orgc9a5e19">list</a></li> +<li><a href="#org73e5182">search</a></li> +<li><a href="#org9b41294">edit</a></li> </ul> </li> </ul> @@ -269,22 +269,22 @@ for the JavaScript code in this tag. </div> </div> <p align="center"><img src="res/logo.png" width="30%" height="30%" /></p> -<div id="outline-container-org84db86d" class="outline-2"> -<h2 id="org84db86d">ck</h2> -<div class="outline-text-2" id="text-org84db86d"> +<div id="outline-container-org1c6aa01" class="outline-2"> +<h2 id="org1c6aa01">ck</h2> +<div class="outline-text-2" id="text-org1c6aa01"> <p> <b>The Config Keeper</b> </p> </div> </div> -<div id="outline-container-org079cefd" class="outline-2"> -<h2 id="org079cefd">build it</h2> -<div class="outline-text-2" id="text-org079cefd"> +<div id="outline-container-orgbf1d4c5" class="outline-2"> +<h2 id="orgbf1d4c5">build it</h2> +<div class="outline-text-2" id="text-orgbf1d4c5"> </div> -<div id="outline-container-org309e80c" class="outline-3"> -<h3 id="org309e80c">requirements</h3> -<div class="outline-text-3" id="text-org309e80c"> +<div id="outline-container-org8edf2df" class="outline-3"> +<h3 id="org8edf2df">requirements</h3> +<div class="outline-text-3" id="text-org8edf2df"> <ul class="org-ul"> <li>clang (llvm) or gcc (gnu)</li> <li>cmake</li> @@ -293,9 +293,9 @@ for the JavaScript code in this tag. </div> </div> -<div id="outline-container-org41965f5" class="outline-3"> -<h3 id="org41965f5">compiler</h3> -<div class="outline-text-3" id="text-org41965f5"> +<div id="outline-container-org30b18cc" class="outline-3"> +<h3 id="org30b18cc">compiler</h3> +<div class="outline-text-3" id="text-org30b18cc"> <div class="org-src-container"> <pre class="src src-sh">> export <span style="color: #ffac4a;">CC</span>=clang <span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">or</span> @@ -305,9 +305,9 @@ for the JavaScript code in this tag. </div> </div> -<div id="outline-container-org6696ef0" class="outline-3"> -<h3 id="org6696ef0">make</h3> -<div class="outline-text-3" id="text-org6696ef0"> +<div id="outline-container-org28e3d41" class="outline-3"> +<h3 id="org28e3d41">make</h3> +<div class="outline-text-3" id="text-org28e3d41"> <div class="org-src-container"> <pre class="src src-sh"><span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">clone the repo</span> > cd ~/code; git clone https://gitlab.com/grm-grm/ck @@ -325,13 +325,13 @@ for the JavaScript code in this tag. </div> </div> -<div id="outline-container-org06e00e7" class="outline-2"> -<h2 id="org06e00e7">for devs</h2> -<div class="outline-text-2" id="text-org06e00e7"> +<div id="outline-container-orgcd61fbc" class="outline-2"> +<h2 id="orgcd61fbc">for devs</h2> +<div class="outline-text-2" id="text-orgcd61fbc"> </div> -<div id="outline-container-orgcb6d6ca" class="outline-3"> -<h3 id="orgcb6d6ca">CMake options</h3> -<div class="outline-text-3" id="text-orgcb6d6ca"> +<div id="outline-container-org713cf8f" class="outline-3"> +<h3 id="org713cf8f">CMake options</h3> +<div class="outline-text-3" id="text-org713cf8f"> <p> cmake accepts the following options: </p> @@ -371,9 +371,9 @@ llvm has better asan than gcc, so I use that. </div> </div> -<div id="outline-container-org73af3d7" class="outline-3"> -<h3 id="org73af3d7">tests</h3> -<div class="outline-text-3" id="text-org73af3d7"> +<div id="outline-container-orga6955dd" class="outline-3"> +<h3 id="orga6955dd">tests</h3> +<div class="outline-text-3" id="text-orga6955dd"> <p> The testing "suite" is a bash script that runs regression and unit tests. Regression tests are under the <code>tests/</code> directory @@ -382,24 +382,25 @@ under <code>unit/</code> directory and test the code. </p> </div> -<div id="outline-container-org792dc4d" class="outline-4"> -<h4 id="org792dc4d">run tests</h4> -<div class="outline-text-4" id="text-org792dc4d"> +<div id="outline-container-org6219fcc" class="outline-4"> +<h4 id="org6219fcc">run tests</h4> +<div class="outline-text-4" id="text-org6219fcc"> <p> -Simply go to the build dir and type. +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">$ ./check_ck +<pre class="src src-sh">$ ./test-ck </pre> </div> </div> </div> -<div id="outline-container-orgac7c553" class="outline-4"> -<h4 id="orgac7c553">test suite</h4> -<div class="outline-text-4" id="text-orgac7c553"> +<div id="outline-container-orgd4349ab" class="outline-4"> +<h4 id="orgd4349ab">test suite</h4> +<div class="outline-text-4" id="text-orgd4349ab"> <div class="org-src-container"> -<pre class="src src-sh">$ ./check_ck -h +<pre class="src src-sh">$ ./test-ck -h ck test suite use without flags to run all tests @@ -415,9 +416,9 @@ flags: </div> </div> </div> -<div id="outline-container-org52a2560" class="outline-2"> -<h2 id="org52a2560">manual</h2> -<div class="outline-text-2" id="text-org52a2560"> +<div id="outline-container-org1d127b7" class="outline-2"> +<h2 id="org1d127b7">manual</h2> +<div class="outline-text-2" id="text-org1d127b7"> <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 @@ -467,9 +468,9 @@ of flags one has to pass to ck. </p> </div> -<div id="outline-container-org09a0c5c" class="outline-3"> -<h3 id="org09a0c5c">ck configuration</h3> -<div class="outline-text-3" id="text-org09a0c5c"> +<div id="outline-container-orge5785e3" class="outline-3"> +<h3 id="orge5785e3">ck configuration</h3> +<div class="outline-text-3" id="text-orge5785e3"> <p> ck uses sqlite to index the configuration files. The init action creates a <b>.ck</b> directory (under $HOME) @@ -511,13 +512,13 @@ $ ck -c /someplace/else ... </div> </div> -<div id="outline-container-orgd61b3e4" class="outline-3"> -<h3 id="orgd61b3e4">Actions</h3> -<div class="outline-text-3" id="text-orgd61b3e4"> +<div id="outline-container-orga717caf" class="outline-3"> +<h3 id="orga717caf">Actions</h3> +<div class="outline-text-3" id="text-orga717caf"> </div> -<div id="outline-container-org3ca7b35" class="outline-4"> -<h4 id="org3ca7b35">init</h4> -<div class="outline-text-4" id="text-org3ca7b35"> +<div id="outline-container-org29304ac" class="outline-4"> +<h4 id="org29304ac">init</h4> +<div class="outline-text-4" id="text-org29304ac"> <p> or i or -i </p> @@ -547,9 +548,9 @@ $ ck init /path_to/where_you_want/your_configs/to_be <span style="color: #E6DB74 </div> </div> -<div id="outline-container-orga12b072" class="outline-4"> -<h4 id="orga12b072">add</h4> -<div class="outline-text-4" id="text-orga12b072"> +<div id="outline-container-org8841e7c" class="outline-4"> +<h4 id="org8841e7c">add</h4> +<div class="outline-text-4" id="text-org8841e7c"> <p> or a or -a </p> @@ -590,9 +591,9 @@ $ ck add program_name config_path [-s] [-p] </div> </div> -<div id="outline-container-orgab0f98c" class="outline-4"> -<h4 id="orgab0f98c">list</h4> -<div class="outline-text-4" id="text-orgab0f98c"> +<div id="outline-container-orgc9a5e19" class="outline-4"> +<h4 id="orgc9a5e19">list</h4> +<div class="outline-text-4" id="text-orgc9a5e19"> <p> or ls or l or -l </p> @@ -636,9 +637,9 @@ $ ck ls programs -t lisp </div> </div> -<div id="outline-container-orgdc0a7ed" class="outline-4"> -<h4 id="orgdc0a7ed">search</h4> -<div class="outline-text-4" id="text-orgdc0a7ed"> +<div id="outline-container-org73e5182" class="outline-4"> +<h4 id="org73e5182">search</h4> +<div class="outline-text-4" id="text-org73e5182"> <p> or s or -s </p> @@ -687,26 +688,49 @@ $ for i ($(ck ls paths)) grep -E <span style="color: #E6DB74;">'A|B'</span> $<sp </div> </div> -<div id="outline-container-orgd947583" class="outline-4"> -<h4 id="orgd947583">edit</h4> -<div class="outline-text-4" id="text-orgd947583"> +<div id="outline-container-org9b41294" class="outline-4"> +<h4 id="org9b41294">edit</h4> +<div class="outline-text-4" id="text-org9b41294"> <p> or e or -e </p> <p> -<code>=--WIP--=</code> +Edit configurations with <code>$EDITOR</code>. </p> <p> -Currently edit can only edit the primary config of a program. +Edit takes at least one and up to two arguments. </p> <p> -To do it use: +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">$ ck edit program_name +<pre class="src src-sh"><span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">suppose this is our ck instance</span> +$ ck list tree -a +emacs: +|- init.el +|- accounts.el [s] +|- orgconf.org [p] + +<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">edit the primary emacs config</span> +$ ck edit emacs + +<span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">edit a specific emacs config, other than the primary</span> +$ ck edit emacs accounts.el </pre> </div> </div> @@ -715,7 +739,7 @@ To do it use: </div> </div> <div id="postamble" class="status"> -<p class="date">Created: 2018-10-07 Sun 16:25</p> +<p class="date">Created: 2018-10-08 Mon 23:46</p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> </div> </body> |