Add list with basename and update readme

1 files changed, 80 insertions, 0 deletions

diff --git a/ck.1 b/ck.1
index dd45d4f..d23d889 100644
--- a/ck.1
+++ b/ck.1
@@ -24,11 +24,13 @@ ck \- manage configuration across the system
 .br
 .B ck list
 .BR tree \ [ \-a ]
+.RB [ \-b ]
 .br
 .B ck list
 .RB { -p \ \fIPROGRAM_NAME\fR}\fR| programs | paths \ [ \-t
 .RB { plain | python | lisp } \fR]
 .RB [ \-a ]
+.RB [ \-b ]
 .br
 .B ck list ckconf
 .br
@@ -87,6 +89,39 @@ and
 You can also
 .B restore
 the links given these two directories and the correspondig rc file and database.
+
+.SH CONFIGURATION
+.B ck
+uses
+.B sqlite
+to index the configuration files. The
+.B init action
+by default creates a directory named
+.I .ck
+under
+.I $HOME
+in witch the
+.I ckrc
+and
+.I ckdb
+files reside. See the
+.B FILES
+section for more details.
+.P
+One can have multiple
+.B config directories
+with different configurations each.
+Using the
+.BR config \ or \ \-c
+option one can set the path
+in which ck will search for
+.I ckrc
+and
+.IR ckdb .
+See the
+.B OPTIONS
+section for more details.
+.P
 .SH OPTIONS
 Change
 .B ck
@@ -310,11 +345,13 @@ List programs, configs and ck configuration values.
 .in +.2i
 .B ck list
 .BR tree \ [ \-a ]
+.RB [ \-b ]
 .br
 .B ck list
 .RB { -p \ \fIPROGRAM_NAME\fR}\fR| programs | paths \ [ \-t
 .RB { plain | python | lisp } \fR]
 .RB [ \-a ]
+.RB [ \-b ]
 .br
 .B ck list ckconf
 .br
@@ -394,6 +431,13 @@ and
 .B [root]
 if the file is owned by the root user.
 .P
+.in +.2i
+.B \-b
+.in +.2i
+Print the
+.B config
+basename instead of the full path.
+.P
 .B EXAMPLES
 .in +.2i
 $ ck list tree -a
@@ -525,6 +569,42 @@ a specific
 .B program
 or all of them.
 .P
+.BR NOTE :
+If
+.B ck
+tracks
+.B configs
+that are owned by root, simply running
+.br
+.in +.2i
+$ ck restore \.\.\.
+.in
+.br
+will fail due to permissions. To remedy this,
+.B ck
+will alter the
+.BR owner \ and \ group
+of a link to match the one in the original
+.B config
+file.
+Thus, running
+.in +.2i
+$ sudo ck -c /home/ckuser/.ck restore \.\.\.
+.in
+will
+.B restore
+the root user's links as it should and the user links will have
+the user as the owner instead of the root.
+.P
+.B ck
+checks that the
+.B configs
+exist and that the location for the link
+is avaliable before making any links. However, in the even that
+.B symlink
+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's the case.
+.P
 .B USAGE
 .br
 .in +.2i