config

A simple configuration manager

config.1 (2393B)

  1 '\" t
  2 .\" 2021 (C) Pablo
  3 .\" Free use of this software is granted under the terms of the GPL-3.0 License
  4 .\"
  5 .TH "CONFIG" "1" "2021-12-12" "\ \&" "\ \&"
  6 .ie \n(.g .ds Aq \(aq
  7 .el       .ds Aq '
  8 .ss \n[.ss] 0
  9 .nh
 10 .ad l
 11 .de URL
 12 \fI\\$2\fP <\\$1>\\$3
 13 ..
 14 .als MTO URL
 15 .if \n[.g] \{\
 16 .  mso www.tmac
 17 .  am URL
 18 .    ad l
 19 .  .
 20 .  am MTO
 21 .    ad l
 22 .  .
 23 .  LINKSTYLE blue R < >
 24 .\}
 25 .SH "CONFIG"
 26 config \- A simple configuration manager.
 27 .SH "SYNOPSIS"
 28 .sp
 29 \fBconfig\fP track [-d|--delete] FILE...
 30 .sp
 31 \fBconfig\fP add FILE...
 32 .sp
 33 \fBconfig\fP list
 34 .sp
 35 \fBconfig\fP status
 36 .sp
 37 \fBconfig\fP -- COMMAND [ARG...]
 38 .sp
 39 \fBconfig\fP commit [ARG...]
 40 .SH "DESCRIPTION"
 41 .sp
 42 The config(1) command uses a bare Git repository to track dotfiles.
 43 .SH "COMMANDS"
 44 .sp
 45 \fBtrack\fP
 46 .RS 4
 47 Add \fIFILE\fP to the list of files that should be tracked by config(1)
 48 .RE
 49 .RS 4
 50 The \fB-d\fP and \fB--delete\fP flags are used to remove \fIFILE\fP from the
 51 list of tracked files
 52 .RE
 53 .sp
 54 \fBadd\fP
 55 .RS 4
 56 Adds \fIFILE\fP to the git index if either \fIFILE\fP or any of its parents are
 57 in the list of tracked files
 58 .RE
 59 .RS 4
 60 This works the same as \fIgit-add(1)\fP, except for the fact that config(1)
 61 checks if \fIFILE\fP is in the list of tracked files
 62 .RE
 63 .sp
 64 \fBlist\fP
 65 .RS 4
 66 List the files that are tracked by config(1)
 67 .RE
 68 .sp
 69 \fBstatus\fP
 70 .RS 4
 71 Show the working tree status
 72 .RE
 73 .sp
 74 \fB--\fP
 75 .RS 4
 76 Pass the following command directly to Git
 77 .RE
 78 .sp
 79 Any other command is passed directly to Git. For example,
 80 .sp
 81 .if n .RS 4
 82 .nf
 83 .fam C
 84 $ config commit -m ...
 85 .fam
 86 .fi
 87 .if n .RE
 88 .sp
 89 is the same as
 90 .sp
 91 .if n .RS 4
 92 .nf
 93 .fam C
 94 $ config -- commit -m ...
 95 .fam
 96 .fi
 97 .if n .RE
 98 .sp
 99 which is the same as
100 .sp
101 .if n .RS 4
102 .nf
103 .fam C
104 $ git commit -m ...
105 .fam
106 .fi
107 .if n .RE
108 .sp
109 when run from the appropriate directory.
110 .SH "ENVIRONMENT"
111 .sp
112 \fB$DOTFILES_REPO\fP
113 .RS 4
114 Specify the location of the bare Git repo where the files
115 are stored. Defaults to \fB$XDG_DATA_HOME/dotfiles\fP or
116 \fB$HOME/.local/share/dotfiles\fP.
117 .RE
118 .sp
119 \fB$DOTFILES_LIST\fP
120 .RS 4
121 Specify the location of the list of files that should be
122 tracked by config(1). Defaults to \fB$XDG_CONFIG_HOME/dotfiles.list\fP or
123 \fB$HOME/.config/dotfiles.list\fP.
124 .RE
125 .SH "AUTHORS"
126 .sp
127 \fBconfig\fP was written by Pablo <\c
128 .MTO "pablo\-escobar\(atriseup.net" "" ">."
129 .SH "COPYING"
130 .sp
131 Copyright (C) 2021 Pablo.
132 Free use of this software is granted under the terms of the GPL\-3.0 License.