commit 687ac44a4c625c993a7cbcccf5f019338f1346c8
parent cf2af3bfb173f7eb48652ea101c2fa68dd47b887
Author: GeaRSiX <gearsix@tuta.io>
Date: Mon, 27 Jul 2020 16:10:17 +0100
updated formatting in README
Diffstat:
| M | CHANGELOG | | | 1 | + |
| M | README | | | 70 | +++++++++++++++++++++++++++++++++++++++++++++++++++------------------- |
| M | src/dotfm.1 | | | 69 | +++++++++++++++++++++++++++++++++++++++++++++++++-------------------- |
3 files changed, 101 insertions(+), 39 deletions(-)
diff --git a/CHANGELOG b/CHANGELOG
@@ -6,6 +6,7 @@
- Added code comment header documenting the dotfm_* functions
- Now the DOTFILE arg can specify multiple dotfiles
- updated the README
+- added a manpage (src/dotfm.1), which is installed with dotfm in the Makefile
### DOTFM CSV FILE
diff --git a/README b/README
@@ -5,7 +5,10 @@ SYNOPSIS
dotfm [-h] [-d] [-v] [-q] COMMAND DOTFILE...
DESCRIPTION
- dotfm is designed to be simple and easy to use. It's really just a short-hand for managing symlinks of dotfiles (it's also helpful if you don't want to remember or type out the location of a dotfile everytime you want to modify it).
+ dotfm is designed to be simple and easy to use. It's really just a
+ short-hand for managing symlinks of dotfiles (it's also helpful if
+ you don't want to remember or type out the location of a dotfile
+ everytime you want to modify it).
ARGUMENTS
-h --help Displays help printout
@@ -15,34 +18,63 @@ ARGUMENTS
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.
+
+ 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.
+ 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
- Go to the source folder of dotfm and run either "sudo make link" or "sudo make install".
- The link option will create a symlink of the script from it's current location (useful if you want to modify it frequently).
- The install option will copy it to the install location (recommended for most users).
+ Go to the source folder of dotfm and run either "sudo make link"
+ or "sudo make install".
+
+ The link option will create a symlink of the script from it's
+ current location (useful if you want to modify it frequently).
+
+ The install option will copy it to the install location
+ (recommended for most users).
- 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"
-ENVIRONMENT
- EDITOR The text editor to edit dotfiles with. If not present, nano will be used.
+ENVIRONMENT VARIABLES
+ EDITOR The text editor to edit dotfiles with. If not present,
+ nano will be used.
-KNOWN DOTFILES
- 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).
+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).
+ 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>
diff --git a/src/dotfm.1 b/src/dotfm.1
@@ -1,4 +1,4 @@
-.\" 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)
+.\" 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"
.SH NAME
\fBdotfm \fP- a simple script to manage dotfiles.
@@ -13,7 +13,10 @@
.fam T
.fi
.SH DESCRIPTION
-\fBdotfm\fP is designed to be simple and easy to use. It's really just a short-hand for managing symlinks of dotfiles (it's also helpful if you don't want to remember or type out the location of a dotfile everytime you want to modify it).
+\fBdotfm\fP is designed to be simple and easy to use. It's really just a
+short-hand for managing symlinks of dotfiles (it's also helpful if
+you don't want to remember or type out the location of a dotfile
+everytime you want to modify it).
.SH ARGUMENTS
.TP
.B
@@ -36,41 +39,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.
+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.
.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).
+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).
.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.
+DOTFILE should be an alias for the dotfile to
+edit.
+Open the corresponding DOTFILE in $EDITOR or
+(if $EDITOR is not set) nano.
.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.
+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.
.SH INSTALL
-Go to the source folder of \fBdotfm\fP and run either "sudo make link" or "sudo make install".
-The link option will create a symlink of the script from it's current location (useful if you want to modify it frequently).
-The install option will copy it to the install location (recommended for most users).
+Go to the source folder of \fBdotfm\fP and run either "sudo make link"
+or "sudo make install".
.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.
+The link option will create a symlink of the script from it's
+current location (useful if you want to modify it frequently).
+.PP
+The install option will copy it to the install location
+(recommended for most users).
+.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.
.SH UNINSTALL
Go to the source folder of \fBdotfm\fP and run "sudo make uninstall"
-.SH ENVIRONMENT
+.SH ENVIRONMENT VARIABLES
.TP
.B
EDITOR
-The text editor to edit dotfiles with. If not present, nano will be used.
-.SH KNOWN DOTFILES
-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).
+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).
.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).
+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
gearsix <gearsix@tuta.io>
