commit c3a60e2a394b21fdb4a495e9ad00a59fcfca3fe5
parent 637bdfe4331286fc628baa2074f8634396306613
Author: gearsix <gearsix@tuta.io>
Date: Fri, 25 Sep 2020 16:57:41 +0100
updated README & fixed formatting
Diffstat:
| M | README | | | 102 | ++++++++++++++++++++++++++++++++++++++++---------------------------------------- |
| M | src/dotfm.1 | | | 89 | ++++++++++++++++++++++++++++++++++++++++--------------------------------------- |
2 files changed, 96 insertions(+), 95 deletions(-)
diff --git a/README b/README
@@ -11,70 +11,70 @@ DESCRIPTION
everytime you want to modify it).
ARGUMENTS
- -h --help Displays help printout
+ -h --help Displays help printout
-d --debug Display debug logs
-v --version Display dotfm version
-q --quiet Tell dotfm to shutup (hide info logs)
COMMANDS
Multiple DOTFILE args can be passed to each command.
-
- install <DOTFILE>... DOTFILE should be a filepath of the dotfile to
- install.
- If the filename of DOTFILE is known, a symlink
- will be created at the install location (found
- in KNOWN_LOCATIONS).
- If the filename is not recognised, then you'll
- be prompted for an install location an aliases
- to call the dotfile by.
-
- remove <DOTFILE>... DOTFILE should be an alias for the dotfile to
- remove.
- Remove the file located at the install
- location of the dotfile with an alias matching
- DOTFILE. Will only remove if the file has been
- installed by dotfm (found in DOTFM_CSV_FILE).
-
- edit <DOTFILE>... DOTFILE should be an alias for the dotfile to
- edit.
- Open the corresponding DOTFILE in $EDITOR or
- (if $EDITOR is not set) nano.
-
- list [<DOTFILE>...] DOTFILE is optional, if set it should be an
- alias of the dotfile to list.
- Display a table of the install location and
- aliases of all or specified dotfiles.
+
+ install <DOTFILE>...
+ create a symlink from DOTFILE to it's install location. DOTFILE
+ should be the filepath of the dotfile to install.
+
+ If DOTFILE is recognised by dotfm, then a symlink will be created
+ at the known install location.
+
+ If DOTFILE is not recognised by dotfm, then you'll be prompted for
+ an install location and aliases to reference the dotfile by when
+ using dotfm.
+
+ remove <DOTFILE>...
+ Remove the file at the install location of the dotfile with an alias
+ matching DOTFILE. This is a destructive function, use it carefully.
+
+ Will only remove the file if the file has been installed by dotfm
+ (and can be found in DOTFM CSV FILE).
+
+ edit <DOTFILE>...
+ Open DOTFILE in $EDITOR or nano if $EDITOR is not present.
+
+ DOTFILE should be an alias of the dotfile to edit.
+
+ list [<DOTFILE>...]
+ Print a table of the install locations and aliases for all
+ dotfiles. If one or more DOTFILE arguments are present, then only
+ dotfiles with matching aliases will be listed.
INSTALL
- Go to the source folder of dotfm and run either "sudo make link"
- or "sudo make install".
+ Go to the source folder of dotfm and run "sudo make install" or "sudo
+ make link".
- The link option will create a symlink of the script from it's
- current location (useful if you want to modify it frequently).
+ "sudo make install" - copy dotfm to the install location (recommended
+ for most users).
- The install option will copy it to the install location
- (recommended for most users).
+ "sudo make link" - create a symlink of dotfm from its current location
+ to the install location (useful if you want to modify it frequently).
- By default the install location of dotfm is /usr/local/bin/dotfm.
- To modify this, just edit the value of DESTBINDIR in the Makefile.
+ By default the install location of dotfm is /usr/local/bin/dotfm. To
+ modify this, just edit the value of DESTBINDIR in the Makefile.
UNINSTALL
- Go to the source folder of dotfm and run "sudo make uninstall"
+ Go to the source folder of dotfm and run "sudo make uninstall".
-ENVIRONMENT VARIABLES
- EDITOR The text editor to edit dotfiles with. If not present,
- nano will be used.
+ENVIRONMENT
+ EDITOR The text editor to edit dotfiles with. If not present,
+ nano will be used.
HINTS
- I would recommend modifying the "KNOWN_DOTFILES" array in src/
- dotfm.py to suite your own needs. I've tried to put most of the
- standard dotfiles in there, however it's not exhaustive (although
- I do plan on adding to it over-time).
-
- Doing this will allow you to easily install dotfiles that you
- often use which aren't currently present KNOWN_DOTFILES (instead
- of having to specify the install location and aliases for it
- everytime).
-
-AUTHORS
- - gearsix <gearsix@tuta.io>
+ I would recommend modifying the "KNOWN DOTFILES" array in src/ dotfm.py
+ to suite your own needs.
+
+ If you can think of more standard-dotfiles that you think
+ should be present in "KNOWN DOTFILES" feel free to get in touch and
+ contribute to the list.
+
+AUTHORS & CONTRIBUTORS
+ - gearsix <gearsix@tuta.io> = original author
+ - marta dias - https://www.instagram.com/marta.dias.z/ = contributed the wonderful logo
diff --git a/src/dotfm.1 b/src/dotfm.1
@@ -1,5 +1,6 @@
-.\" Text automatically generated by txt2man $(txt2man -d "20 July 2020" -t dotfm -s 1 -v "README" -r "v2.0.0" -s 1 README > src/dotfm.1)
-.TH dotfm 1 "20 July 2020" "v2.0.0" "README"
+.\" txt2man -d "20 July 2020" -t dotfm -s 1 -v "dotfm README" -r "v2.0.0" -s 1 README.txt
+.\" Text automatically generated by txt2man
+.TH dotfm 1 "20 July 2020" "v2.0.0" "dotfm README"
.SH NAME
\fBdotfm \fP- a simple script to manage dotfiles.
\fB
@@ -39,67 +40,67 @@ Multiple DOTFILE args can be passed to each command.
.TP
.B
install <DOTFILE>\.\.\.
-DOTFILE should be a filepath of the dotfile to
-install.
-If the filename of DOTFILE is known, a symlink
-will be created at the install location (found
-in KNOWN_LOCATIONS).
-If the filename is not recognised, then you'll
-be prompted for an install location an aliases
-to call the dotfile by.
+create a symlink from DOTFILE to it's install location. DOTFILE
+should be the filepath of the dotfile to install.
+.RS
+.PP
+If DOTFILE is recognised by \fBdotfm\fP, then a symlink will be created
+at the known install location.
+.PP
+If DOTFILE is not recognised by \fBdotfm\fP, then you'll be prompted for
+an install location and aliases to reference the dotfile by when
+using \fBdotfm\fP.
+.RE
.TP
.B
remove <DOTFILE>\.\.\.
-DOTFILE should be an alias for the dotfile to
-remove.
-Remove the file located at the install
-location of the dotfile with an alias matching
-DOTFILE. Will only remove if the file has been
-installed by \fBdotfm\fP (found in DOTFM_CSV_FILE).
+Remove the file at the install location of the dotfile with an alias
+matching DOTFILE. This is a destructive function, use it carefully.
+.RS
+.PP
+Will only remove the file if the file has been installed by \fBdotfm\fP
+(and can be found in DOTFM CSV FILE).
+.RE
.TP
.B
edit <DOTFILE>\.\.\.
-DOTFILE should be an alias for the dotfile to
-edit.
-Open the corresponding DOTFILE in $EDITOR or
-(if $EDITOR is not set) nano.
+Open DOTFILE in $EDITOR or nano if $EDITOR is not present.
+.RS
+.PP
+DOTFILE should be an alias of the dotfile to edit.
+.RE
.TP
.B
list [<DOTFILE>\.\.\.]
-DOTFILE is optional, if set it should be an
-alias of the dotfile to list.
-Display a table of the install location and
-aliases of all or specified dotfiles.
+Print a table of the install locations and aliases for all
+dotfiles. If one or more DOTFILE arguments are present, then only
+dotfiles with matching aliases will be listed.
.SH INSTALL
-Go to the source folder of \fBdotfm\fP and run either "sudo make link"
-or "sudo make install".
+Go to the source folder of \fBdotfm\fP and run "sudo make install" or "sudo
+make link".
.PP
-The link option will create a symlink of the script from it's
-current location (useful if you want to modify it frequently).
+"sudo make install" - copy \fBdotfm\fP to the install location (recommended
+for most users).
.PP
-The install option will copy it to the install location
-(recommended for most users).
+"sudo make link" - create a symlink of \fBdotfm\fP from its current location
+to the install location (useful if you want to modify it frequently).
.PP
-By default the install location of \fBdotfm\fP is /usr/local/bin/\fBdotfm\fP.
-To modify this, just edit the value of DESTBINDIR in the Makefile.
+By default the install location of \fBdotfm\fP is /usr/local/bin/\fBdotfm\fP. To
+modify this, just edit the value of DESTBINDIR in the Makefile.
.SH UNINSTALL
-Go to the source folder of \fBdotfm\fP and run "sudo make uninstall"
-.SH ENVIRONMENT VARIABLES
+Go to the source folder of \fBdotfm\fP and run "sudo make uninstall".
+.SH ENVIRONMENT
.TP
.B
EDITOR
The text editor to edit dotfiles with. If not present,
nano will be used.
.SH HINTS
-I would recommend modifying the "KNOWN_DOTFILES" array in src/
-dotfm.py to suite your own needs. I've tried to put most of the
-standard dotfiles in there, however it's not exhaustive (although
-I do plan on adding to it over-time).
+I would recommend modifying the "KNOWN DOTFILES" array in src/ dotfm.py
+to suite your own needs.
.PP
-Doing this will allow you to easily install dotfiles that you
-often use which aren't currently present KNOWN_DOTFILES (instead
-of having to specify the install location and aliases for it
-everytime).
-.SH AUTHORS
-.IP \(bu 3
+If you can think of more standard-dotfiles that you think
+should be present in "KNOWN DOTFILES" feel free to get in touch and
+contribute to the list.
+.SH AUTHOR
gearsix <gearsix@tuta.io>
