commit 2ab9bfd5e3b58fbe8f772d71cbd7be12dd33ac91
parent 991dc6f7703f675d0d15397f1b4e3725cbc35749
Author: Alex Balgavy <a.balgavy@gmail.com>
Date: Fri, 31 Jan 2020 22:07:30 +0100
Update documentation
Diffstat:
3 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -3,9 +3,10 @@
1. Download the `conf` script, make it executable, and put it in your `$PATH`.
2. Set value of `$DOTFILES` to the location of your dotfiles, either in the environment, or in the `conf` script itself.
3. Set up your dotfiles hierarchy in any way you want.
-3. Put a map file in the root of $DOTFILES. This file defines how your dotfiles/folders map to other locations in your filesystem.
-4. Write the name of your map file in the `conf` script.
-5. Use `conf`, and profit, maybe. Run `conf -h` or `conf -man` to get help.
+3. Put a map file in the root of $DOTFILES.
+ This file defines how your dotfiles/folders map to other locations in your filesystem.
+ By default, the file is named "dot.map", but this can be changed by manually editing the script.
+4. Use `conf`, and profit, maybe. Run `conf -h` or `conf -man` to get help.
## FAQ
### How do you write a map file?
diff --git a/conf b/conf
@@ -372,6 +372,7 @@ pod2usage({ -verbose => 2, -exitval => 1}) if $manual;
This is a script to manage filesystem-wide symbolic links to your dotfiles (configuration), based on definitions in the map file.
The location of the map file is set in the script itself, using the $MAPFILE variable.
+The default name of the mapfile is "dot.map", and it is located in the root of your dotfiles folder.
The location of your dotfiles is set either using the $DOTFILES environment variable, or inside the script itself.
=head1 ARGUMENTS
diff --git a/conf.1 b/conf.1
@@ -168,6 +168,7 @@ conf \- Manage your dotfiles.
.IX Header "DESCRIPTION"
This is a script to manage filesystem-wide symbolic links to your dotfiles (configuration), based on definitions in the map file.
The location of the map file is set in the script itself, using the \f(CW$MAPFILE\fR variable.
+The default name of the mapfile is \*(L"dot.map\*(R", and it is located in the root of your dotfiles folder.
The location of your dotfiles is set either using the \f(CW$DOTFILES\fR environment variable, or inside the script itself.
.SH "ARGUMENTS"
.IX Header "ARGUMENTS"
