diff options
| -rw-r--r-- | README.html | 131 | ||||
| -rw-r--r-- | README.org | 13 |
2 files changed, 74 insertions, 70 deletions
diff --git a/README.html b/README.html index 8ea6981..dc571b9 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-09-23 Sun 00:11 --> +<!-- 2018-09-23 Sun 00:15 --> <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="#orga937ace">1. ck</a></li> -<li><a href="#orge3e7a68">2. build it</a> +<li><a href="#orgabc7ed9">1. ck</a></li> +<li><a href="#org6be3d50">2. build it</a> <ul> -<li><a href="#org0e96418">2.1. requirements</a></li> -<li><a href="#orgc3dd6b8">2.2. compiler</a></li> -<li><a href="#org88635c0">2.3. make</a></li> +<li><a href="#org4bd678f">2.1. requirements</a></li> +<li><a href="#orgf5f91da">2.2. compiler</a></li> +<li><a href="#org11d220b">2.3. make</a></li> </ul> </li> -<li><a href="#org6bfdd90">3. for devs</a> +<li><a href="#org8fd7fd2">3. for devs</a> <ul> -<li><a href="#org4975cbf">3.1. make</a></li> -<li><a href="#orgb7a1471">3.2. tests</a> +<li><a href="#orgce0d9f2">3.1. make</a></li> +<li><a href="#orge93a04c">3.2. tests</a> <ul> -<li><a href="#orgf2a5d40">3.2.1. run tests</a></li> -<li><a href="#orgbfb08a1">3.2.2. test suite</a></li> +<li><a href="#orgdbd1581">3.2.1. run tests</a></li> +<li><a href="#org44510f6">3.2.2. test suite</a></li> </ul> </li> </ul> </li> -<li><a href="#org00cf4c1">4. manual</a> +<li><a href="#org4b83d30">4. manual</a> <ul> -<li><a href="#org0b02a6c">4.1. ck configuration</a></li> -<li><a href="#org310a86a">4.2. Actions</a> +<li><a href="#orgae3d0fc">4.1. ck configuration</a></li> +<li><a href="#orgea8c5fd">4.2. Actions</a> <ul> -<li><a href="#org8e54599">4.2.1. init</a></li> -<li><a href="#org0d2c69f">4.2.2. add</a></li> -<li><a href="#org8de5cbd">4.2.3. list</a></li> -<li><a href="#org3144007">4.2.4. search</a></li> -<li><a href="#orge77921c">4.2.5. edit</a></li> +<li><a href="#org5a6e5ef">4.2.1. init</a></li> +<li><a href="#org55f3471">4.2.2. add</a></li> +<li><a href="#orgd480808">4.2.3. list</a></li> +<li><a href="#org99d8d45">4.2.4. search</a></li> +<li><a href="#orgb8ec7b9">4.2.5. edit</a></li> </ul> </li> </ul> @@ -269,8 +269,8 @@ 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-orga937ace" class="outline-2"> -<h2 id="orga937ace"><span class="section-number-2">1</span> ck</h2> +<div id="outline-container-orgabc7ed9" class="outline-2"> +<h2 id="orgabc7ed9"><span class="section-number-2">1</span> ck</h2> <div class="outline-text-2" id="text-1"> <p> <b>The Config Keeper</b> @@ -278,12 +278,12 @@ for the JavaScript code in this tag. </div> </div> -<div id="outline-container-orge3e7a68" class="outline-2"> -<h2 id="orge3e7a68"><span class="section-number-2">2</span> build it</h2> +<div id="outline-container-org6be3d50" class="outline-2"> +<h2 id="org6be3d50"><span class="section-number-2">2</span> build it</h2> <div class="outline-text-2" id="text-2"> </div> -<div id="outline-container-org0e96418" class="outline-3"> -<h3 id="org0e96418"><span class="section-number-3">2.1</span> requirements</h3> +<div id="outline-container-org4bd678f" class="outline-3"> +<h3 id="org4bd678f"><span class="section-number-3">2.1</span> requirements</h3> <div class="outline-text-3" id="text-2-1"> <ul class="org-ul"> <li>clang (llvm) or gcc (gnu)</li> @@ -293,8 +293,8 @@ for the JavaScript code in this tag. </div> </div> -<div id="outline-container-orgc3dd6b8" class="outline-3"> -<h3 id="orgc3dd6b8"><span class="section-number-3">2.2</span> compiler</h3> +<div id="outline-container-orgf5f91da" class="outline-3"> +<h3 id="orgf5f91da"><span class="section-number-3">2.2</span> compiler</h3> <div class="outline-text-3" id="text-2-2"> <p> By default I use clang, if you want to use gcc just @@ -303,8 +303,8 @@ edit the <code>CMakeLists.txt</code> file and change <code>clang</code> to <code </div> </div> -<div id="outline-container-org88635c0" class="outline-3"> -<h3 id="org88635c0"><span class="section-number-3">2.3</span> make</h3> +<div id="outline-container-org11d220b" class="outline-3"> +<h3 id="org11d220b"><span class="section-number-3">2.3</span> make</h3> <div class="outline-text-3" id="text-2-3"> <div class="org-src-container"> <pre class="src src-sh"><span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">clone the repo</span> @@ -323,12 +323,12 @@ edit the <code>CMakeLists.txt</code> file and change <code>clang</code> to <code </div> </div> -<div id="outline-container-org6bfdd90" class="outline-2"> -<h2 id="org6bfdd90"><span class="section-number-2">3</span> for devs</h2> +<div id="outline-container-org8fd7fd2" class="outline-2"> +<h2 id="org8fd7fd2"><span class="section-number-2">3</span> for devs</h2> <div class="outline-text-2" id="text-3"> </div> -<div id="outline-container-org4975cbf" class="outline-3"> -<h3 id="org4975cbf"><span class="section-number-3">3.1</span> make</h3> +<div id="outline-container-orgce0d9f2" class="outline-3"> +<h3 id="orgce0d9f2"><span class="section-number-3">3.1</span> make</h3> <div class="outline-text-3" id="text-3-1"> <p> Just build with address sanitizer enabled like so: @@ -350,8 +350,8 @@ llvm has better asan than gcc, so I use that. </div> </div> -<div id="outline-container-orgb7a1471" class="outline-3"> -<h3 id="orgb7a1471"><span class="section-number-3">3.2</span> tests</h3> +<div id="outline-container-orge93a04c" class="outline-3"> +<h3 id="orge93a04c"><span class="section-number-3">3.2</span> tests</h3> <div class="outline-text-3" id="text-3-2"> <p> The testing "suite" is a bash script that runs regression @@ -361,8 +361,8 @@ under <code>unit/</code> directory and test the code. </p> </div> -<div id="outline-container-orgf2a5d40" class="outline-4"> -<h4 id="orgf2a5d40"><span class="section-number-4">3.2.1</span> run tests</h4> +<div id="outline-container-orgdbd1581" class="outline-4"> +<h4 id="orgdbd1581"><span class="section-number-4">3.2.1</span> run tests</h4> <div class="outline-text-4" id="text-3-2-1"> <p> Simply go to the build dir and type. @@ -374,8 +374,8 @@ Simply go to the build dir and type. </div> </div> -<div id="outline-container-orgbfb08a1" class="outline-4"> -<h4 id="orgbfb08a1"><span class="section-number-4">3.2.2</span> test suite</h4> +<div id="outline-container-org44510f6" class="outline-4"> +<h4 id="org44510f6"><span class="section-number-4">3.2.2</span> test suite</h4> <div class="outline-text-4" id="text-3-2-2"> <div class="org-src-container"> <pre class="src src-sh">$ ./check_ck -h @@ -394,8 +394,8 @@ flags: </div> </div> </div> -<div id="outline-container-org00cf4c1" class="outline-2"> -<h2 id="org00cf4c1"><span class="section-number-2">4</span> manual</h2> +<div id="outline-container-org4b83d30" class="outline-2"> +<h2 id="org4b83d30"><span class="section-number-2">4</span> manual</h2> <div class="outline-text-2" id="text-4"> <p> ck's goal is to assist with the configuration file management. @@ -446,8 +446,8 @@ of flags one has to pass to ck. </p> </div> -<div id="outline-container-org0b02a6c" class="outline-3"> -<h3 id="org0b02a6c"><span class="section-number-3">4.1</span> ck configuration</h3> +<div id="outline-container-orgae3d0fc" class="outline-3"> +<h3 id="orgae3d0fc"><span class="section-number-3">4.1</span> ck configuration</h3> <div class="outline-text-3" id="text-4-1"> <p> ck uses sqlite to index the configuration files. The init @@ -490,12 +490,12 @@ $ ck -c /someplace/else ... </div> </div> -<div id="outline-container-org310a86a" class="outline-3"> -<h3 id="org310a86a"><span class="section-number-3">4.2</span> Actions</h3> +<div id="outline-container-orgea8c5fd" class="outline-3"> +<h3 id="orgea8c5fd"><span class="section-number-3">4.2</span> Actions</h3> <div class="outline-text-3" id="text-4-2"> </div> -<div id="outline-container-org8e54599" class="outline-4"> -<h4 id="org8e54599"><span class="section-number-4">4.2.1</span> init</h4> +<div id="outline-container-org5a6e5ef" class="outline-4"> +<h4 id="org5a6e5ef"><span class="section-number-4">4.2.1</span> init</h4> <div class="outline-text-4" id="text-4-2-1"> <p> or i or -i @@ -526,14 +526,15 @@ $ ck init /path_to/where_you_want/your_configs/to_be <span style="color: #E6DB74 </div> </div> -<div id="outline-container-org0d2c69f" class="outline-4"> -<h4 id="org0d2c69f"><span class="section-number-4">4.2.2</span> add</h4> +<div id="outline-container-org55f3471" class="outline-4"> +<h4 id="org55f3471"><span class="section-number-4">4.2.2</span> add</h4> <div class="outline-text-4" id="text-4-2-2"> <p> or a or -a </p> <p> +Adds a configuration to the ck database. Add takes 2 to 4 arguments. </p> @@ -548,17 +549,13 @@ Add takes 2 to 4 arguments. </ul> <p> -Use add to add a new config for ck to keep track of. -</p> - -<p> Keep in mind: </p> <ul class="org-ul"> -<li>The config has to exist</li> +<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> +sure to use the same name.</li> +<li>Each program can have only one primary config.</li> </ul> <p> @@ -572,8 +569,8 @@ $ ck add program_name config_path [-s] [-p] </div> </div> -<div id="outline-container-org8de5cbd" class="outline-4"> -<h4 id="org8de5cbd"><span class="section-number-4">4.2.3</span> list</h4> +<div id="outline-container-orgd480808" class="outline-4"> +<h4 id="orgd480808"><span class="section-number-4">4.2.3</span> list</h4> <div class="outline-text-4" id="text-4-2-3"> <p> or ls or l or -l @@ -614,8 +611,8 @@ $ ck ls programs -t lisp </div> </div> -<div id="outline-container-org3144007" class="outline-4"> -<h4 id="org3144007"><span class="section-number-4">4.2.4</span> search</h4> +<div id="outline-container-org99d8d45" class="outline-4"> +<h4 id="org99d8d45"><span class="section-number-4">4.2.4</span> search</h4> <div class="outline-text-4" id="text-4-2-4"> <p> or s or -s @@ -651,12 +648,18 @@ $ ck search alias </div> </div> -<div id="outline-container-orge77921c" class="outline-4"> -<h4 id="orge77921c"><span class="section-number-4">4.2.5</span> edit</h4> +<div id="outline-container-orgb8ec7b9" class="outline-4"> +<h4 id="orgb8ec7b9"><span class="section-number-4">4.2.5</span> edit</h4> <div class="outline-text-4" id="text-4-2-5"> <p> or e or -e -<code>~--WIP--~</code> +</p> + +<p> +<code>=--WIP--=</code> +</p> + +<p> Currently edit can only edit the primary config of a program. </p> @@ -673,7 +676,7 @@ To do it use: </div> </div> <div id="postamble" class="status"> -<p class="date">Created: 2018-09-23 Sun 00:11</p> +<p class="date">Created: 2018-09-23 Sun 00:15</p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> </div> </body> @@ -159,6 +159,7 @@ Usage: *** add or a or -a +Adds a configuration to the ck database. Add takes 2 to 4 arguments. - *program_name*: the name of the program you add a config to @@ -167,13 +168,11 @@ Add takes 2 to 4 arguments. + *-p*: the config will be the primary (relevant on edit below) + *-s*: the config will be stored in the secret_dir -Use add to add a new config for ck to keep track of. - Keep in mind: -- The config has to exist +- The config has to exist. - If you are adding a config to a program already existing in ckdb make - sure to use the same name -- Each program can have only one primary config + sure to use the same name. +- Each program can have only one primary config. Usage: #+BEGIN_SRC sh @@ -231,7 +230,9 @@ Usage: *** edit or e or -e -~~--WIP--~~ + +==--WIP--== + Currently edit can only edit the primary config of a program. To do it use: |