From ad31ffb8f571caf777c755b9dd9f4aadd941df82 Mon Sep 17 00:00:00 2001 From: Anastasis Grammenos Date: Thu, 1 Nov 2018 13:35:50 +0200 Subject: Make manpage more readable --- ck.1 | 77 +++++++++++++++++++++++++------------------------------------------- 1 file changed, 28 insertions(+), 49 deletions(-) (limited to 'ck.1') diff --git a/ck.1 b/ck.1 index cd94646..cb507e6 100644 --- a/ck.1 +++ b/ck.1 @@ -167,45 +167,38 @@ database and initialize it. Create the ck config file .RI ( ckrc ) and add the directory paths to it. -.P +.TP 2 .B USAGE -.br -.in +.2i .B ck init .I VERSION_CONTROL_DIR SECRET_DIR -.P +.TP 2 .B ALIASES -.in +.2i .BR init , \ i , \ \-i -.P +.TP 2 .B ARGUMENTS -.in +.2i +.ns +.RS 2 +.TP 21 .I VERSION_CONTROL_DIR -.br -.in +.2i The directory where .B configs will be stored by default. .B File must exist\fR. -.P -.in +.2i +.TP 21 .I SECRET_DIR -.br -.in +.2i The directory where .B configs will be stored when using the .B \-s flag in .B add\fR. \fBFile must exist\fR. -.br -.P +.RE +.TP 2 .B EXAMPLES -.in +.2i -.br +.EX $ ck init /home/ckuser/configs/vc home/ckuser/configs/sec -.br $ ck i configs/vc configs/sec +.EE .SS "Add config" Add a .B config @@ -225,76 +218,62 @@ The will open the .B primary config by default. -.P +.TP 2 .B USAGE -.br -.in +.2i .B ck add .I PROGRAM_NAME CONFIG_PATH .RB [ \-p ] .RB [ \-s ] -.P +.TP 2 .B ALIASES -.in +.2i .BR add , \ a , \ \-a -.P +.TP 2 .B ARGUMENTS -.in +.2i +.ns +.RS 2 +.TP 21 .I PROGRAM_NAME -.br -.in +.2i The name of the .B program the .B config belongs at. -.P -.in +.2i +.TP 21 .I CONFIG_PATH -.br -.in +.2i Path to the .BR config . Can be relative. -.P +.RE +.TP 2 .B FLAGS -.br -.in +.2i +.ns +.RS 2 +.TP 21 .B \-s -.br -.in +.2i Mark the .B config as secret. It will be stored on the .IR SECRET_DIR . -.P -.in +.2i +.TP 21 .B \-p -.br -.in +.2i Mark the .B config as primary. The .B edit action will open this by default. -.P +.RE +.TP 2 .B EXAMPLES -.in +.2i -.br +.EX # add emacs configs -.br ## primary config -.br $ ck add emacs ~/.emacs.d/orgconf.org -p -.br ## secret config, with passwords -.br $ ck add emacs ~/.emacs.d/accounts.org -s -.br ## another one for emacs -.br $ ck add emacs ~/.emacs.d/init.el +.EE .SS "Delete config" Delete a .B config -- cgit v1.2.3