From d0d3ce110fb7a91f9727262e787938abd91069ea Mon Sep 17 00:00:00 2001 From: Anastasis Grammenos Date: Sun, 23 Sep 2018 00:11:24 +0300 Subject: fix html --- README.html | 122 ++++++++++++++++++++++++++++++------------------------------ README.org | 1 + 2 files changed, 62 insertions(+), 61 deletions(-) diff --git a/README.html b/README.html index 72df0fc..8ea6981 100644 --- a/README.html +++ b/README.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + ‎ @@ -232,35 +232,35 @@ for the JavaScript code in this tag.

Table of Contents

-
-

1 ck

+
+

1 ck

The Config Keeper @@ -278,12 +278,12 @@ for the JavaScript code in this tag.

-
-

2 build it

+
+

2 build it

-
-

2.1 requirements

+
+

2.1 requirements

  • clang (llvm) or gcc (gnu)
    • @@ -293,8 +293,8 @@ for the JavaScript code in this tag.
-
-

2.2 compiler

+
+

2.2 compiler

By default I use clang, if you want to use gcc just @@ -303,8 +303,8 @@ edit the CMakeLists.txt file and change clang to

-
-

2.3 make

+
+

2.3 make

# clone the repo
@@ -323,12 +323,12 @@ edit the CMakeLists.txt file and change clang to
-
-

3 for devs

+
+

3 for devs

-
-

3.1 make

+
+

3.1 make

Just build with address sanitizer enabled like so: @@ -350,8 +350,8 @@ llvm has better asan than gcc, so I use that.

-
-

3.2 tests

+
+

3.2 tests

The testing "suite" is a bash script that runs regression @@ -361,8 +361,8 @@ under unit/ directory and test the code.

-
-

3.2.1 run tests

+
+

3.2.1 run tests

Simply go to the build dir and type. @@ -374,8 +374,8 @@ Simply go to the build dir and type.

-
-

3.2.2 test suite

+
+

3.2.2 test suite

$ ./check_ck -h
@@ -394,8 +394,8 @@ flags:
-
-

4 manual

+
+

4 manual

ck's goal is to assist with the configuration file management. @@ -446,8 +446,8 @@ of flags one has to pass to ck.

-
-

4.1 ck configuration

+
+

4.1 ck configuration

ck uses sqlite to index the configuration files. The init @@ -490,12 +490,12 @@ $ ck -c /someplace/else ...

-
-

4.2 Actions

+
+

4.2 Actions

-
-

4.2.1 init

+
+

4.2.1 init

or i or -i @@ -506,8 +506,8 @@ init takes exactly 2 arguments.

    -
  • configdir: where all the configs will live
    • -
  • secretdir: where all the secret configs will live
    • +
  • config_dir: where all the configs will live
    • +
  • secret_dir: where all the secret configs will live

@@ -526,8 +526,8 @@ $ ck init /path_to/where_you_want/your_configs/to_be -

4.2.2 add

+
+

4.2.2 add

or a or -a @@ -538,12 +538,12 @@ Add takes 2 to 4 arguments.

    -
  • programname: the name of the program you add a config to
    • -
  • configpath: the path to the config
    • +
  • program_name: the name of the program you add a config to
    • +
  • config_path: the path to the config
  • Optional: (order doesn't matter)
    • -p: the config will be the primary (relevant on edit below)
      • -
    • -s: the config will be stored in the secretdir
      • +
    • -s: the config will be stored in the secret_dir
@@ -572,8 +572,8 @@ $ ck add program_name config_path [-s] [-p]
-
-

4.2.3 list

+
+

4.2.3 list

or ls or l or -l @@ -614,8 +614,8 @@ $ ck ls programs -t lisp

-
-

4.2.4 search

+
+

4.2.4 search

or s or -s @@ -651,8 +651,8 @@ $ ck search alias

-
-

4.2.5 edit

+
+

4.2.5 edit

or e or -e @@ -673,7 +673,7 @@ To do it use:

-

Created: 2018-09-23 Sun 00:02

+

Created: 2018-09-23 Sun 00:11

Validate

diff --git a/README.org b/README.org index 13becc6..ba0913f 100644 --- a/README.org +++ b/README.org @@ -1,3 +1,4 @@ +#+OPTIONS: ^:nil #+html:

* ck *The Config Keeper* -- cgit v1.2.3