From 7d10e2377b01ac3e38b412f6bc2fa2e384804057 Mon Sep 17 00:00:00 2001 From: gramanas Date: Sun, 18 Nov 2018 20:58:35 +0200 Subject: Update edit and add edit test --- ck.1 | 44 +++++++++++++++++++++++++++++++++++++------- 1 file changed, 37 insertions(+), 7 deletions(-) (limited to 'ck.1') diff --git a/ck.1 b/ck.1 index a1c3d5e..205270e 100644 --- a/ck.1 +++ b/ck.1 @@ -68,6 +68,9 @@ ck \- manage configuration across the system .B edit .I PROGRAM_NAME .RI [ CONFIG_BASENAME ] +.OP \-\-editor EDITOR +.OP \-\-command COMMAND +.OP \-s .YS \" Search .SY ck @@ -125,12 +128,12 @@ 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 -.I VERSION_CONRTOL_DIR +.I VERSION_CONTROL_DIR and .IR SECRET_DIR . You can also .B restore -the links given these two directories and the correspondig rc file and database. +the links given these two directories and the corresponding rc file and database. .SH CONFIGURATION .B ck uses @@ -153,7 +156,7 @@ environment variable. If it is set it will use the .I ckrc and .I ckdb -inside this directory. Else it wil use +inside this directory. Else it will use .I $XDG_CONFIG_HOME/ck and if that is not set as well it will fall back to .IR $HOME/.ck . @@ -175,7 +178,7 @@ section for more details. .SH OPTIONS Change .B ck -behaviour using the following options. They must be present before any +behavior using the following options. They must be present before any .B action. .TP .B \-\-verbose\fR, \fB\-v @@ -190,7 +193,7 @@ residing in .IR DIR . .TP .B \-\-version\fR, \fBversion -Print version and licence information, and quit. +Print version and license information, and quit. .SH ACTIONS Each .B action @@ -473,7 +476,7 @@ to print it like a python array or to print it like a lisp list. .TP 21 .B \-a -Show attributes to the listing (when aplicable). +Show attributes to the listing (when applicable). These are .B [s] for @@ -530,6 +533,9 @@ will be shown. .B edit .I PROGRAM_NAME .RI [ CONFIG_BASENAME ] +.OP \-\-editor EDITOR +.OP \-\-command COMMAND +.OP \-s .YS .RE .TP 2 @@ -563,10 +569,34 @@ other than the one. .RE .TP 2 +.B FLAGS +.ns +.RS 2 +.TP 21 +.BI \-\-editor \ EDITOR +Use +.I EDITOR +to edit the config. +.TP 21 +.BI \-\-command \ COMMAND +The +.I COMMAND +string will be used instead of an editor. +.TP 21 +.B \-\-s +Prepend the whole command with sudo, should you want to edit a +.B config +belonging to root. +.RE +.TP 2 .B EXAMPLES .EX $ ck edit emacs +$ ck edit emacs --command cat +$ ck edit emacs --command "emacsclient -a \"\" -t" $ ck e tmux .tmux.conf +$ ck e tmux .tmux.conf --editor vi +$ ck e ssh -s .EE .SS "SEARCH CONFIGS" Grep through the configs. This @@ -659,7 +689,7 @@ the user as the owner instead of the root. checks that the .B configs exist and that the location for the link -is avaliable before making any links. However, in the even that +is available 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. -- cgit v1.2.3