aboutsummaryrefslogtreecommitdiffstats
path: root/ck.1
diff options
context:
space:
mode:
authorgramanas <anastasis.gramm2@gmail.com>2018-10-28 11:41:49 +0200
committergramanas <anastasis.gramm2@gmail.com>2018-10-28 11:41:49 +0200
commit8ad6cfa33d6a37605599be5673c4acecc7eca5af (patch)
tree5f5d1e5263ba769efdab4d95fbdc28a5808afb76 /ck.1
parentde394e24d0dae3ff879295ab4574d2071c92b77d (diff)
downloadck-8ad6cfa33d6a37605599be5673c4acecc7eca5af.tar.gz
ck-8ad6cfa33d6a37605599be5673c4acecc7eca5af.tar.bz2
ck-8ad6cfa33d6a37605599be5673c4acecc7eca5af.zip
Add root attribute in list, finish manpage
Diffstat (limited to 'ck.1')
-rw-r--r--ck.1116
1 files changed, 110 insertions, 6 deletions
diff --git a/ck.1 b/ck.1
index 8ddf4ef..dd45d4f 100644
--- a/ck.1
+++ b/ck.1
@@ -77,7 +77,7 @@ Upon adding a
.I config
to
.BR ck ,
-it is moved to the appropriate directory, and the symbolically linked
+it is moved to the appropriate directory, and then symbolically linked
back to it's original place (\fIln -s\fR).
.P
In a later time you can sync the
@@ -271,7 +271,6 @@ This will not touch the actual file and link. It is up to the user
to handle it.
.P
.B USAGE
-.br
.in +.2i
.B ck delete
.IR PROGRAM_NAME | \fR{\fB\-c \ \fICONFIG_PATH\fR}
@@ -385,10 +384,15 @@ to print it like a lisp list.
.in +.2i
Add attributes to the listing (when aplicable).
The attributes are
-.B [\-s]
-for secret and
-.B [\-p]
-for primary.
+.B [s]
+for
+.BR secret ,
+.B [p]
+for
+.B primary
+and
+.B [root]
+if the file is owned by the root user.
.P
.B EXAMPLES
.in +.2i
@@ -400,6 +404,29 @@ $ ck list programs -t python
.br
$ ck list -p emacs
.SS "Edit configs"
+Edit a
+.B config
+stored in
+.B ck
+with the
+.IR $EDITOR .
+.B Edit
+will open the
+.B primary config
+of the
+.BR program .
+If there is no
+.B primary config
+but the
+.B program
+only has one
+.BR config ,
+.B edit
+will open that.
+Whenever there is ambiguity, a list
+of possible
+.B configs
+will be shown.
.P
.B USAGE
.br
@@ -414,6 +441,30 @@ $ ck list -p emacs
.P
.B ARGUMENTS
.in +.2i
+.I PROGRAM_NAME
+.in +.2i
+The name of the
+.B program
+to be edited. If the
+.B program
+has only one
+.B config
+or you want to edit the
+.B primary
+one, no further action is required.
+.P
+.in +.2i
+.I CONFIG_BASENAME
+.in +.2i
+The basename of the
+.B config
+to be edited. This has to follow the
+.B program
+name. It is only needed when editing a
+.B config
+other than the
+.B primary
+one.
.P
.B EXAMPLES
.in +.2i
@@ -421,6 +472,15 @@ $ ck edit emacs
.br
$ ck e tmux .tmux.conf
.SS "Search configs"
+Grep through the configs. This
+.B action
+is equivalent to this:
+.P
+$ ck ls paths | xargs grep -H -n "search term"
+.P
+Thus for more advanced search through the
+.B configs
+one can use other programs and replace grep in the command above.
.P
.B USAGE
.br
@@ -435,11 +495,35 @@ $ ck e tmux .tmux.conf
.P
.B ARGUMENTS
.in +.2i
+.I SEARCH_TERM
+.in +.2i
+The term you wish to search for. If it's a phrase enclose it in "".
+If it's a special character you can escape it with \\ (backslash).
.P
.B EXAMPLES
.in +.2i
$ ck search "search term"
+$ ck search "\(require"
.SS "Restore configs"
+Given a working
+.B ck
+instance (\fIckdb \fR+ \fIckrc\fR + directories in \fIckrc\fR with
+.BR configs ), \ restore
+shall recreate the links from the
+.B config
+directories in
+.I ckrc
+back to their corresponding position when added to
+.BR ck .
+It is useful for copying
+.B configs
+to a new linux installation or
+.B restoring
+deleted links. It can either
+.B restore
+a specific
+.B program
+or all of them.
.P
.B USAGE
.br
@@ -454,6 +538,18 @@ $ ck search "search term"
.P
.B ARGUMENTS
.in +.2i
+.I PROGRAM_NAME
+.in +.2i
+The name of the
+.B program
+to be restored.
+.P
+.in +.2i
+.B all
+.in +.2i
+Restore all
+.B programs ck
+keeps track of.
.P
.B EXAMPLES
.in +.2i
@@ -461,6 +557,9 @@ $ ck restore all
.br
$ ck restore -p emacs
.SS "Get help"
+Get help for any given
+.B action
+from the command line.
.P
.B USAGE
.br
@@ -474,6 +573,11 @@ $ ck restore -p emacs
.P
.B ARGUMENTS
.in +.2i
+.I action
+.in +.2i
+Any
+.B action alias
+you wish to get help for.
.P
.B EXAMPLES
.in +.2i