config

A simple configuration manager

Commit
21787f8c106b4daae67df800a74b22822e6e8bd4
Parent
250b589a4b9414fe6f2f718e29636c137c57dff0
Author
Pablo <pablo-escobar@riseup.net>
Date

Updated the documentation

Diffstat

1 file changed, 16 insertions, 19 deletions

Status File Name N° Changes Insertions Deletions
Modified config.1 35 16 19
diff --git a/config.1 b/config.1
@@ -2,7 +2,7 @@
 .\" 2021 (C) Pablo
 .\" Free use of this software is granted under the terms of the GPL-3.0 License
 .\"
-.TH "CONFIG" "1" "2021-17-08" "\ \&" "\ \&"
+.TH "CONFIG" "1" "2021-12-12" "\ \&" "\ \&"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0
@@ -26,42 +26,39 @@
 config \- A simple configuration manager.
 .SH "SYNOPSIS"
 .sp
-\fBconfig\fP update [\-e|\-\-edit] [-m MESSAGE]...
+\fBconfig\fP track [-d|--delete] FILE...
 .sp
 \fBconfig\fP add FILE...
 .sp
-\fBconfig\fP rm FILE...
-.sp
 \fBconfig\fP list
 .sp
 \fBconfig\fP status
 .sp
 \fBconfig\fP -- COMMAND [ARG...]
 .sp
-\fBconfig\fP log
+\fBconfig\fP commit [ARG...]
 .SH "DESCRIPTION"
 .sp
 The config(1) command uses a bare Git repository to track dotfiles.
 .SH "COMMANDS"
 .sp
-\fBupdate\fP
+\fBtrack\fP
+.RS 4
+Add \fIFILE\fP to the list of files that should be tracked by config(1)
+.RE
 .RS 4
-Add the current changes, commit and push to all remotes. If the \fI\-e\fP or
-\fI\-\-edit\fP options are specified, or if no arguments are passed, config(1)
-uses \fI$EDITOR\fP to get the commit message. In this case, further arguments
-are ignored. If one or more messages are specified via the \fI\-m\fP option,
-this messages are passed to \fIgit\fP directly. Note that the
-\fI\-e\fP/\fI\-\-edit\fP and \fI\-m\fP options are mutually excluding.
+The \fB-d\fP and \fB--delete\fP flags are used to remove \fIFILE\fP from the
+list of tracked files
 .RE
 .sp
 \fBadd\fP
 .RS 4
-Add \fIFILE\fP to the list of files that should be tracked by config(1)
+Adds \fIFILE\fP to the git index if either \fIFILE\fP or any of its parents are
+in the list of tracked files
 .RE
-.sp
-\fBrm\fP
 .RS 4
-Remove \fIFILE\fP from the list of files that should be tracked by config(1)
+This works the same as \fIgit-add(1)\fP, except for the fact that config(1)
+checks if \fIFILE\fP is in the list of tracked files
 .RE
 .sp
 \fBlist\fP
@@ -84,7 +81,7 @@ Any other command is passed directly to Git. For example,
 .if n .RS 4
 .nf
 .fam C
-$ config log
+$ config commit -m ...
 .fam
 .fi
 .if n .RE
@@ -94,7 +91,7 @@ is the same as
 .if n .RS 4
 .nf
 .fam C
-$ config -- log
+$ config -- commit -m ...
 .fam
 .fi
 .if n .RE
@@ -104,7 +101,7 @@ which is the same as
 .if n .RS 4
 .nf
 .fam C
-$ git log
+$ git commit -m ...
 .fam
 .fi
 .if n .RE