Skip to content

Commit

Permalink
More documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
thezeroalpha committed Feb 11, 2020
1 parent 12028bb commit 84f31cb
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
6 changes: 5 additions & 1 deletion conf
Original file line number Diff line number Diff line change
Expand Up @@ -379,11 +379,16 @@ This is a script to manage filesystem-wide symbolic links to your dotfiles (conf
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.
Every existing file will be backed up by appending the extension '.bak', before being overwritten.
If a directory in the destination path doesn't exist, it is automatically created.
`conf` doesn't remove empty directories after unlinking.
When linking/unlinking you either provide the name of the top directory, or the full name of the mapped path (see examples below for more information).
=head1 ARGUMENTS
The available commands are:
=over 4
=item * B<link [entry1 [entry2...]]>
Expand All @@ -409,7 +414,6 @@ Edit the map file with whatever you set as $EDITOR
List the current mappings.
=back
=head1 EXAMPLES
Expand Down
3 changes: 3 additions & 0 deletions conf.1
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,9 @@ Every existing file will be backed up by appending the extension '.bak', before
If a directory in the destination path doesn't exist, it is automatically created.
`conf` doesn't remove empty directories after unlinking.
When linking/unlinking you either provide the name of the top directory, or the full name of the mapped path (see examples below for more information).
.SH "ARGUMENTS"
.IX Header "ARGUMENTS"
The available commands are:
.IP "\(bu" 4
\&\fBlink [entry1 [entry2...]]\fR
.Sp
Expand Down

0 comments on commit 84f31cb

Please sign in to comment.