aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgramanas <anastasis.gramm2@gmail.com>2018-11-19 01:39:55 +0200
committergramanas <anastasis.gramm2@gmail.com>2018-11-19 01:39:55 +0200
commita6290ec9d98e3b7cc650db134b17ee6d6a64f46d (patch)
tree4d7616948c8448335f07508e8299a94713ab185a
parent7d10e2377b01ac3e38b412f6bc2fa2e384804057 (diff)
downloadck-a6290ec9d98e3b7cc650db134b17ee6d6a64f46d.tar.gz
ck-a6290ec9d98e3b7cc650db134b17ee6d6a64f46d.tar.bz2
ck-a6290ec9d98e3b7cc650db134b17ee6d6a64f46d.zip
Update readme
-rw-r--r--README.html295
-rw-r--r--README.org12
2 files changed, 183 insertions, 124 deletions
diff --git a/README.html b/README.html
index 4c8647c..286583d 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-11-14 Wed 16:42 -->
+<!-- 2018-11-19 Mon 01:39 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>&lrm;</title>
@@ -232,36 +232,36 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
-<li><a href="#orgac39c95">ck</a>
+<li><a href="#org501dc95">ck</a>
<ul>
-<li><a href="#org2f1cd2a">Technicalities</a></li>
-<li><a href="#orgb8c0efd">Download</a></li>
+<li><a href="#org34cb767">Technicalities</a></li>
+<li><a href="#org090a724">Download</a></li>
</ul>
</li>
<li><a href="#build-instructions">build it</a>
<ul>
-<li><a href="#org9b6c6f0">requirements</a></li>
-<li><a href="#org01b87bb">make &amp;&amp; install</a></li>
+<li><a href="#org3638199">requirements</a></li>
+<li><a href="#org73a5d1c">make &amp;&amp; install</a></li>
</ul>
</li>
-<li><a href="#org982cbd5">for devs</a>
+<li><a href="#org88418f5">for devs</a>
<ul>
-<li><a href="#org6b070c4">CMake options</a></li>
-<li><a href="#orgcd2bc40">compiler</a></li>
-<li><a href="#orgc1ff7c9">tests</a>
+<li><a href="#org8949557">CMake options</a></li>
+<li><a href="#orgaf8cc38">compiler</a></li>
+<li><a href="#org336c3ed">tests</a>
<ul>
-<li><a href="#org7c12f69">run tests</a></li>
-<li><a href="#org0629f99">test suite</a></li>
+<li><a href="#orgb9b2773">run tests</a></li>
+<li><a href="#org98a43db">test suite</a></li>
</ul>
</li>
</ul>
</li>
-<li><a href="#orga05b7b3">ck configuration</a></li>
+<li><a href="#orge6e9f86">ck configuration</a></li>
<li><a href="#usage">Usage</a>
<ul>
-<li><a href="#orgdeb4b8f">Initialize</a></li>
-<li><a href="#org9308f2c">Add configs</a></li>
-<li><a href="#org8fcf2fd">Using the ck actions</a></li>
+<li><a href="#org034a512">Initialize</a></li>
+<li><a href="#orgc8d3141">Add configs</a></li>
+<li><a href="#org5984569">Using the ck actions</a></li>
</ul>
</li>
<li><a href="#manpage">manpage</a></li>
@@ -269,9 +269,9 @@ for the JavaScript code in this tag.
</div>
</div>
<p align="center"><img src="res/logo.png"></p>
-<div id="outline-container-orgac39c95" class="outline-2">
-<h2 id="orgac39c95">ck</h2>
-<div class="outline-text-2" id="text-orgac39c95">
+<div id="outline-container-org501dc95" class="outline-2">
+<h2 id="org501dc95">ck</h2>
+<div class="outline-text-2" id="text-org501dc95">
<p>
<b>The Config Keeper</b>
</p>
@@ -327,9 +327,9 @@ with the rest of us).
</p>
</div>
-<div id="outline-container-org2f1cd2a" class="outline-3">
-<h3 id="org2f1cd2a">Technicalities</h3>
-<div class="outline-text-3" id="text-org2f1cd2a">
+<div id="outline-container-org34cb767" class="outline-3">
+<h3 id="org34cb767">Technicalities</h3>
+<div class="outline-text-3" id="text-org34cb767">
<p>
Upon adding a config to <b>ck</b>, it moves it to the specified folder and adds a symbolic link
back where it came from (<code>ln -s</code>).
@@ -342,9 +342,9 @@ majority should).
</div>
</div>
-<div id="outline-container-orgb8c0efd" class="outline-3">
-<h3 id="orgb8c0efd">Download</h3>
-<div class="outline-text-3" id="text-orgb8c0efd">
+<div id="outline-container-org090a724" class="outline-3">
+<h3 id="org090a724">Download</h3>
+<div class="outline-text-3" id="text-org090a724">
<p>
Go ahead and download <b>ck</b> and give it a try. It comes with a help sub-command
that explains any inquires you might have.
@@ -362,13 +362,13 @@ You can also read the manpage <a href="#manpage">down below</a>.
</div>
</div>
-<div id="outline-container-org262e9ab" class="outline-2">
-<h2 id="build-instructions"><a id="org262e9ab"></a>build it</h2>
+<div id="outline-container-org5314b35" class="outline-2">
+<h2 id="build-instructions"><a id="org5314b35"></a>build it</h2>
<div class="outline-text-2" id="text-build-instructions">
</div>
-<div id="outline-container-org9b6c6f0" class="outline-3">
-<h3 id="org9b6c6f0">requirements</h3>
-<div class="outline-text-3" id="text-org9b6c6f0">
+<div id="outline-container-org3638199" class="outline-3">
+<h3 id="org3638199">requirements</h3>
+<div class="outline-text-3" id="text-org3638199">
<ul class="org-ul">
<li>cmake</li>
<li>sqlite3-dev</li>
@@ -377,9 +377,9 @@ You can also read the manpage <a href="#manpage">down below</a>.
</div>
</div>
-<div id="outline-container-org01b87bb" class="outline-3">
-<h3 id="org01b87bb">make &amp;&amp; install</h3>
-<div class="outline-text-3" id="text-org01b87bb">
+<div id="outline-container-org73a5d1c" class="outline-3">
+<h3 id="org73a5d1c">make &amp;&amp; install</h3>
+<div class="outline-text-3" id="text-org73a5d1c">
<p>
Use <code>-DCMAKE_INSTALL_PREFIX</code> when running cmake to change the install path.
</p>
@@ -402,16 +402,16 @@ Use <code>-DCMAKE_INSTALL_PREFIX</code> when running cmake to change the install
</div>
</div>
-<div id="outline-container-org982cbd5" class="outline-2">
-<h2 id="org982cbd5">for devs</h2>
-<div class="outline-text-2" id="text-org982cbd5">
+<div id="outline-container-org88418f5" class="outline-2">
+<h2 id="org88418f5">for devs</h2>
+<div class="outline-text-2" id="text-org88418f5">
<p>
Please be <a href="https://www.gnu.org/philosophy/kind-communication.html">kind</a> to each other.
</p>
</div>
-<div id="outline-container-org6b070c4" class="outline-3">
-<h3 id="org6b070c4">CMake options</h3>
-<div class="outline-text-3" id="text-org6b070c4">
+<div id="outline-container-org8949557" class="outline-3">
+<h3 id="org8949557">CMake options</h3>
+<div class="outline-text-3" id="text-org8949557">
<p>
cmake accepts the following options:
</p>
@@ -432,9 +432,9 @@ To use any one of them append it after the cmake command like so:
</div>
</div>
-<div id="outline-container-orgcd2bc40" class="outline-3">
-<h3 id="orgcd2bc40">compiler</h3>
-<div class="outline-text-3" id="text-orgcd2bc40">
+<div id="outline-container-orgaf8cc38" class="outline-3">
+<h3 id="orgaf8cc38">compiler</h3>
+<div class="outline-text-3" id="text-orgaf8cc38">
<p>
Pick your favorite
</p>
@@ -464,9 +464,9 @@ Pick your favorite
</div>
</div>
-<div id="outline-container-orgc1ff7c9" class="outline-3">
-<h3 id="orgc1ff7c9">tests</h3>
-<div class="outline-text-3" id="text-orgc1ff7c9">
+<div id="outline-container-org336c3ed" class="outline-3">
+<h3 id="org336c3ed">tests</h3>
+<div class="outline-text-3" id="text-org336c3ed">
<p>
The testing "suite" is a bash script that runs regression
and unit tests. Regression tests are under the <code>tests/</code> directory
@@ -475,9 +475,9 @@ under <code>unit/</code> directory and test the code.
</p>
</div>
-<div id="outline-container-org7c12f69" class="outline-4">
-<h4 id="org7c12f69">run tests</h4>
-<div class="outline-text-4" id="text-org7c12f69">
+<div id="outline-container-orgb9b2773" class="outline-4">
+<h4 id="orgb9b2773">run tests</h4>
+<div class="outline-text-4" id="text-orgb9b2773">
<p>
First make sure you build ck with the <code>-DCK_TESTS=1</code> option. Then
go to the build directory and type:
@@ -489,9 +489,9 @@ go to the build directory and type:
</div>
</div>
-<div id="outline-container-org0629f99" class="outline-4">
-<h4 id="org0629f99">test suite</h4>
-<div class="outline-text-4" id="text-org0629f99">
+<div id="outline-container-org98a43db" class="outline-4">
+<h4 id="org98a43db">test suite</h4>
+<div class="outline-text-4" id="text-org98a43db">
<div class="org-src-container">
<pre class="src src-sh">$ ./test-ck -h
ck test suite
@@ -509,17 +509,17 @@ flags:
</div>
</div>
</div>
-<div id="outline-container-orga05b7b3" class="outline-2">
-<h2 id="orga05b7b3">ck configuration</h2>
-<div class="outline-text-2" id="text-orga05b7b3">
+<div id="outline-container-orge6e9f86" class="outline-2">
+<h2 id="orge6e9f86">ck configuration</h2>
+<div class="outline-text-2" id="text-orge6e9f86">
<p>
See the <a href="#manpage">manpage</a> below.
</p>
</div>
</div>
-<div id="outline-container-org001e3df" class="outline-2">
-<h2 id="usage"><a id="org001e3df"></a>Usage</h2>
+<div id="outline-container-orgd582e7c" class="outline-2">
+<h2 id="usage"><a id="orgd582e7c"></a>Usage</h2>
<div class="outline-text-2" id="text-usage">
<p>
ck's goal is to assist with the configuration file management.
@@ -529,9 +529,9 @@ ck's goal is to assist with the configuration file management.
This section is an example usage.
</p>
</div>
-<div id="outline-container-orgdeb4b8f" class="outline-3">
-<h3 id="orgdeb4b8f">Initialize</h3>
-<div class="outline-text-3" id="text-orgdeb4b8f">
+<div id="outline-container-org034a512" class="outline-3">
+<h3 id="org034a512">Initialize</h3>
+<div class="outline-text-3" id="text-org034a512">
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #528fd1;">cd</span> ~
<span style="color: #656565;"># </span><span style="color: #757575;">make the directories for the configs</span>
@@ -544,9 +544,9 @@ $ ck init configs/vc configs/sec
</div>
</div>
-<div id="outline-container-org9308f2c" class="outline-3">
-<h3 id="org9308f2c">Add configs</h3>
-<div class="outline-text-3" id="text-org9308f2c">
+<div id="outline-container-orgc8d3141" class="outline-3">
+<h3 id="orgc8d3141">Add configs</h3>
+<div class="outline-text-3" id="text-orgc8d3141">
<div class="org-src-container">
<pre class="src src-sh"><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>
@@ -574,9 +574,9 @@ $ sudo ck -c /home/ckuser add ssh /etc/ssh/sshd_config -s
</div>
</div>
-<div id="outline-container-org8fcf2fd" class="outline-3">
-<h3 id="org8fcf2fd">Using the ck actions</h3>
-<div class="outline-text-3" id="text-org8fcf2fd">
+<div id="outline-container-org5984569" class="outline-3">
+<h3 id="org5984569">Using the ck actions</h3>
+<div class="outline-text-3" id="text-org5984569">
<div class="org-src-container">
<pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">list the configs in a treelike structure with basename only</span>
$ ck list tree -b
@@ -596,17 +596,23 @@ $ ck search <span style="color: #bdbc61;">"search term with spaces"</span>
<span style="color: #656565;"># </span><span style="color: #757575;">escape symbols</span>
$ ck search <span style="color: #bdbc61;">\(</span>
-<span style="color: #656565;"># </span><span style="color: #757575;">edit the primary config of emacs</span>
+<span style="color: #656565;"># </span><span style="color: #757575;">edit the primary config of emacs wiht $EDITOR</span>
$ ck edit emacs
+<span style="color: #656565;"># </span><span style="color: #757575;">or with vi</span>
+$ ck e emacs --editor vi
+<span style="color: #656565;"># </span><span style="color: #757575;">run the command cat to it</span>
+$ ck edit emacs --command cat
+<span style="color: #656565;"># </span><span style="color: #757575;">or a complex editor call</span>
+$ ck edit emacs --command <span style="color: #bdbc61;">"emacsclient -a \"\" -t"</span>
<span style="color: #656565;"># </span><span style="color: #757575;">edit a non-primary config of ssh</span>
-$ ck e ssh authorized_keys
+$ ck e emacs init.el
<span style="color: #656565;"># </span><span style="color: #757575;">edit a root config</span>
-$ sudo ck -c /home/ckuser e ssh sshd_config
+$ ck e ssh -s
<span style="color: #656565;"># </span><span style="color: #757575;">delete a program with all the configs</span>
$ ck delete emacs
<span style="color: #656565;"># </span><span style="color: #757575;">or a specific config</span>
-$ ck del -c /home/ckuser/.emacs.d/init.el
+$ ck del emacs init.el
<span style="color: #656565;"># </span><span style="color: #757575;">restore all links (on a new instalation)</span>
$ ck restore all
@@ -622,11 +628,11 @@ $ ck --help e
</div>
</div>
-<div id="outline-container-orgbb97793" class="outline-2">
-<h2 id="manpage"><a id="orgbb97793"></a>manpage</h2>
+<div id="outline-container-org6aa4382" class="outline-2">
+<h2 id="manpage"><a id="org6aa4382"></a>manpage</h2>
<div class="outline-text-2" id="text-manpage">
<!-- Creator : groff version 1.22.3 -->
-<!-- CreationDate: Wed Nov 14 16:42:24 2018 -->
+<!-- CreationDate: Mon Nov 19 01:39:46 2018 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
@@ -684,14 +690,14 @@ manage configuration across the system</p>
<p style="margin-top: 1em"><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p style="margin-top: 1em">[<b>&minus;v</b>|<b>&minus;&minus;verbose</b>]
[<b>&minus;c</b>|<b>&minus;&minus;config&nbsp;</b><i>DIR</i>]
<i>action&nbsp;</i>[...]</p> </td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -700,11 +706,11 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p>[<b>version</b>|<b>&minus;&minus;version</b>]</p></td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -713,11 +719,11 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p><b>init</b> <i>VERSION_CONTROL_DIR SECRET_DIR</i></p></td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -726,12 +732,12 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p><b>add</b> <i>PROGRAM_NAME CONFIG_PATH</i>
[<b>&minus;p</b>] [<b>&minus;s</b>]</p></td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -740,12 +746,12 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p><b>delete</b> <i>PROGRAM_NAME</i>
[<i>CONFIG_BASENAME</i>]</p> </td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -754,11 +760,11 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p><b>list tree</b> [<b>&minus;a</b>] [<b>&minus;b</b>]</p></td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -767,13 +773,13 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p><b>list &minus;p&nbsp;</b><i>PROGRAM_NAME</i>
[<b>&minus;t&nbsp;</b><i>list-type</i>] [<b>&minus;a</b>]
[<b>&minus;b</b>]</p> </td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -782,13 +788,13 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p><b>list programs</b>
[<b>&minus;t&nbsp;</b><i>list-type</i>] [<b>&minus;a</b>]
[<b>&minus;b</b>]</p> </td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -797,13 +803,13 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p><b>list paths</b>
[<b>&minus;t&nbsp;</b><i>list-type</i>] [<b>&minus;a</b>]
[<b>&minus;b</b>]</p> </td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -812,11 +818,11 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p><b>list ckconf</b></p></td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -825,12 +831,14 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
-<p><b>edit</b> <i>PROGRAM_NAME</i>
-[<i>CONFIG_BASENAME</i>]</p> </td>
-<td width="15%">
+<p><b>edit</b> <i>PROGRAM_NAME</i> [<i>CONFIG_BASENAME</i>]
+[<b>&minus;&minus;editor&nbsp;</b><i>EDITOR</i>]
+[<b>&minus;&minus;command&nbsp;</b><i>COMMAND</i>]
+[<b>&minus;s</b>]</p> </td>
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -839,11 +847,11 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p><b>search</b> <i>SEARCH_TERM</i></p></td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -852,11 +860,11 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p><b>restore &minus;p</b> <i>PROGRAM_NAME</i></p></td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -865,11 +873,11 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p><b>restore all</b></p></td>
-<td width="15%">
+<td width="3%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
@@ -878,11 +886,11 @@ manage configuration across the system</p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="70%">
+<td width="82%">
<p><b>help&nbsp;</b><i>action</i></p></td>
-<td width="15%">
+<td width="3%">
</td></tr>
</table>
@@ -916,10 +924,10 @@ directory, and then symbolically linked back to it&rsquo;s
original place (<i>ln -s</i>).</p>
<p style="margin-left:11%; margin-top: 1em">In a later time
-you can sync the <i>VERSION_CONRTOL_DIR</i> and
+you can sync the <i>VERSION_CONTROL_DIR</i> and
<i>SECRET_DIR</i>. You can also <b>restore</b> the links
-given these two directories and the correspondig rc file and
-database.</p>
+given these two directories and the corresponding rc file
+and database.</p>
<h2>CONFIGURATION
<a name="CONFIGURATION"></a>
@@ -936,8 +944,8 @@ action</b> by default creates a directory in witch the
first search for the configuration in the folder shown by
the <i>$CK_CONFIG</i> environment variable. If it is set it
will use the <i>ckrc</i> and <i>ckdb</i> inside this
-directory. Else it wil use <i>$XDG_CONFIG_HOME/ck</i> and if
-that is not set as well it will fall back to
+directory. Else it will use <i>$XDG_CONFIG_HOME/ck</i> and
+if that is not set as well it will fall back to
<i>$HOME/.ck</i>.</p>
<p style="margin-left:11%; margin-top: 1em">One can have
@@ -955,8 +963,8 @@ details.</p>
<p style="margin-left:11%; margin-top: 1em">Change
-<b>ck</b> behaviour using the following options. They must
-be present before any <b>action. <br>
+<b>ck</b> behavior using the following options. They must be
+present before any <b>action. <br>
&minus;&minus;verbose</b>, <b>&minus;v</b></p>
<p style="margin-left:22%;">[WIP] <br>
@@ -973,7 +981,7 @@ order to work.</p>
<p style="margin-left:11%;"><b>&minus;&minus;version</b>,
<b>version</b></p>
-<p style="margin-left:22%;">Print version and licence
+<p style="margin-left:22%;">Print version and license
information, and quit.</p>
<h2>ACTIONS
@@ -1402,7 +1410,7 @@ a lisp list.</p></td></tr>
<td width="54%">
-<p>Show attributes to the listing (when aplicable). These
+<p>Show attributes to the listing (when applicable). These
are <b>[s]</b> for <b>secret</b>, <b>[p]</b> for
<b>primary</b> and <b>[root]</b> if the file is owned by the
root user.</p></td></tr>
@@ -1448,13 +1456,13 @@ USAGE</b></p>
<p><b>ck</b></p></td>
<td width="1%"></td>
-<td width="54%">
+<td width="82%">
-<p><b>edit</b> <i>PROGRAM_NAME</i>
-[<i>CONFIG_BASENAME</i>]</p> </td>
-<td width="28%">
-</td></tr>
+<p><b>edit</b> <i>PROGRAM_NAME</i> [<i>CONFIG_BASENAME</i>]
+[<b>&minus;&minus;editor&nbsp;</b><i>EDITOR</i>]
+[<b>&minus;&minus;command&nbsp;</b><i>COMMAND</i>]
+[<b>&minus;s</b>]</p> </td></tr>
</table>
<p style="margin-left:11%;"><b>ALIASES</b></p>
@@ -1496,10 +1504,55 @@ when editing a <b>config</b> other than the <b>primary</b>
one.</p> </td></tr>
</table>
+<p style="margin-left:11%;"><b>FLAGS</b></p>
+
+<table width="100%" border="0" rules="none" frame="void"
+ cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="14%"></td>
+<td width="26%">
+
+
+<p><b>&minus;&minus;editor&nbsp;</b><i>EDITOR</i></p></td>
+<td width="6%"></td>
+<td width="54%">
+
+
+<p>Use <i>EDITOR</i> to edit the config.</p></td></tr>
+<tr valign="top" align="left">
+<td width="14%"></td>
+<td width="26%">
+
+
+<p><b>&minus;&minus;command&nbsp;</b><i>COMMAND</i></p></td>
+<td width="6%"></td>
+<td width="54%">
+
+
+<p>The <i>COMMAND</i> string will be used instead of an
+editor.</p> </td></tr>
+<tr valign="top" align="left">
+<td width="14%"></td>
+<td width="26%">
+
+
+<p><b>&minus;&minus;s</b></p></td>
+<td width="6%"></td>
+<td width="54%">
+
+
+<p>Prepend the whole command with sudo, should you want to
+edit a <b>config</b> belonging to root.</p></td></tr>
+</table>
+
<p style="margin-left:11%;"><b>EXAMPLES</b></p>
<pre style="margin-left:14%;">$ ck edit emacs
-$ ck e tmux .tmux.conf</pre>
+$ ck edit emacs --command cat
+$ ck edit emacs --command &quot;emacsclient -a
+$ ck e tmux .tmux.conf
+$ ck e tmux .tmux.conf --editor vi
+$ ck e ssh -s</pre>
<p style="margin-left:11%; margin-top: 1em"><b>SEARCH
@@ -1595,7 +1648,7 @@ the user as the owner instead of the root.</p>
<p style="margin-left:11%; margin-top: 1em"><b>ck</b>
checks that the <b>configs</b> exist and that the location
-for the link is avaliable before making any links. However,
+for the link is available before making any links. However,
in the even that <b>symlink</b> fails for some other reason,
the process will stop as is. The user will have to take care
of the already created links, if that&rsquo;s the case.
@@ -1801,7 +1854,7 @@ flags</b>: @CMAKE_C_FLAGS@</p>
</div>
</div>
<div id="postamble" class="status">
-<p class="date">Created: 2018-11-14 Wed 16:42</p>
+<p class="date">Created: 2018-11-19 Mon 01:39</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
diff --git a/README.org b/README.org
index 6090850..756ed3a 100644
--- a/README.org
+++ b/README.org
@@ -205,12 +205,18 @@ This section is an example usage.
# escape symbols
$ ck search \(
- # edit the primary config of emacs
+ # edit the primary config of emacs wiht $EDITOR
$ ck edit emacs
+ # or with vi
+ $ ck e emacs --editor vi
+ # run the command cat to it
+ $ ck edit emacs --command cat
+ # or a complex editor call
+ $ ck edit emacs --command "emacsclient -a \"\" -t"
# edit a non-primary config of ssh
- $ ck e ssh authorized_keys
+ $ ck e emacs init.el
# edit a root config
- $ sudo ck -c /home/ckuser e ssh sshd_config
+ $ ck e ssh -s
# delete a program with all the configs
$ ck delete emacs