Allow user to specify the target directory

Makefile.am

@@ -9,6 +9,12 @@ dist_man_MANS = man/lsrc.1 man/mkrc.1 man/rcdn.1 man/rcup.1 man/rcrc.5 man/rcm.7
 dist_pkgdata_DATA = share/rcm.sh
 
 TESTS = \
+	test/rcup-target.t \
+	test/rcup-target-subst.t \
+	test/rcrc-target.t \
+	test/rcup-link-files-target.t \
+	test/rcup-link-files-target-trailing.t \
+	test/rcup-link-files-target-subst.t \
 	test/lsrc-dotfiles-dirs.t \
 	test/lsrc-excludes.t \
 	test/lsrc-hostname.t \

bin/lsrc.in

@@ -156,7 +156,7 @@ is_metafile() {
   host_portion="$(echo "$1" | sed -e 's/host-.*/host-/')"
   tag_portion="$(echo "$1" | sed -e 's/tag-.*/tag-/')"
 
-  [ "x$host_portion" = 'xhost-' -o "x$tag_portion" = 'xtag-' -o "x$1" = "xhooks" ]
+  [ "x$host_portion" = 'xhost-' -o "x$tag_portion" = 'xtag-' -o "x$1" = "xhooks" -o "x$1" = "xtarget" ]
 }
 
 dotfiles_dir_excludes() {
@@ -255,12 +255,13 @@ handle_command_line() {
   local undotted=
   local never_undotted=
 
-  while getopts :FVqvhI:x:B:S:s:U:u:t:d: opt; do
+  while getopts :FVqvhI:x:B:S:s:U:u:t:d:T: opt; do
     case "$opt" in
       F) show_sigils=1;;
       h) show_help ;;
       I) includes="$includes $OPTARG";;
       t) arg_tags="$arg_tags $OPTARG";;
+      T) TARGET=$(echo $OPTARG | envsubst) ;;
       v) verbosity=$(($verbosity + 1));;
       q) verbosity=$(($verbosity - 1));;
       d) dotfiles_dirs="$dotfiles_dirs $OPTARG";;
@@ -342,6 +343,7 @@ for DOTFILES_DIR in $DOTFILES_DIRS; do
   $DEBUG "undotted_file_globs: $undotted_file_globs"
   never_undotted_file_globs="$(dotfiles_dir_excludes "$DOTFILES_DIR" "$NEVER_UNDOTTED")"
   $DEBUG "never_undotted_file_globs: $never_undotted_file_globs"
+  current_dest_dir=$(get_target $DOTFILES_DIR)
 
   cd -- "$DOTFILES_DIR"
   DIR_STACK=":$DOTFILES_DIR"
@@ -356,7 +358,7 @@ for DOTFILES_DIR in $DOTFILES_DIRS; do
         dotted=1
       fi
 
-      handle_file "$file" "$DEST_DIR" "$host_files" . "$dotted" "$exclude_file_globs" "$include_file_globs" "$symlink_dirs_file_globs" "$mk_dirs_file_globs"
+      handle_file "$file" "$current_dest_dir" "$host_files" . "$dotted" "$exclude_file_globs" "$include_file_globs" "$symlink_dirs_file_globs" "$mk_dirs_file_globs"
     done
     popdir
   fi
@@ -373,7 +375,7 @@ for DOTFILES_DIR in $DOTFILES_DIRS; do
         if is_excluded "$file" "$undotted_file_globs" "$never_undotted_file_globs"; then
           dotted=1
         fi
-        handle_file "$file" "$DEST_DIR" "$DOTFILES_DIR/tag-$tag" . "$dotted" "$exclude_file_globs" "$include_file_globs" "$symlink_dirs_file_globs" "$mk_dirs_file_globs"
+        handle_file "$file" "$current_dest_dir" "$DOTFILES_DIR/tag-$tag" . "$dotted" "$exclude_file_globs" "$include_file_globs" "$symlink_dirs_file_globs" "$mk_dirs_file_globs"
       done
       popdir
     fi
@@ -392,6 +394,6 @@ for DOTFILES_DIR in $DOTFILES_DIRS; do
       dotted=1
     fi
 
-    handle_file "$file" "$DEST_DIR" "$DOTFILES_DIR" . "$dotted" "$exclude_file_globs" "$include_file_globs" "$symlink_dirs_file_globs" "$mk_dirs_file_globs"
+    handle_file "$file" "$current_dest_dir" "$DOTFILES_DIR" . "$dotted" "$exclude_file_globs" "$include_file_globs" "$symlink_dirs_file_globs" "$mk_dirs_file_globs"
   done
 done

bin/rcdn.in

@@ -10,7 +10,7 @@ remove_link() {
 
   $DEBUG "remove_link $1 $2 $3"
 
-  if [ "x$dest" = "x/" -o "x$dest" = "x$DEST_DIR" ]; then
+  if [ "x$dest" = "x/" -o "x$dest" = "x$TARGET" ]; then
     $VERBOSE "not a symlink, skipping: $original"
   elif [ -L "$dest" -o "x$sigil" = "xX" ]; then
     rm_v -rf "$dest"
@@ -44,14 +44,15 @@ handle_command_line() {
   local never_undotted=
   local hostname=
 
-  while getopts :VqvhIKk:x:S:s:U:u:t:d:B: opt; do
+  while getopts :VqvhIKk:x:S:s:U:u:t:d:B:T: opt; do
     case "$opt" in
       h) show_help ;;
       B) hostname="$OPTARG" ;;
       I) includes="$includes $OPTARG";;
       k) run_hooks=1 ;;
       K) run_hooks=0 ;;
       t) arg_tags="$arg_tags $OPTARG" ;;
+      T) TARGET=$(echo $OPTARG | envsubst) ;;
       S) symlink_dirs="$symlink_dirs $OPTARG";;
       s) never_symlink_dirs="$never_symlink_dirs $OPTARG";;
       U) undotted="$undotted $OPTARG";;

bin/rcup.in

@@ -122,7 +122,7 @@ replace_file() {
 }
 
 is_nested() {
-  echo "$1" | sed "s:$DEST_DIR/::" | grep '/' >/dev/null
+  echo "$1" | sed "s:$(get_target $1)/::" | grep '/' >/dev/null
 }
 
 is_identical() {
@@ -213,7 +213,7 @@ handle_command_line() {
   REPLACE_ALL=0
   GENERATE=
 
-  while getopts :CVqvfghikKI:x:S:s:U:u:t:d:B: opt; do
+  while getopts :CVqvfghikKI:x:S:s:U:u:t:d:B:T: opt; do
     case "$opt" in
       B) hostname="$OPTARG" ;;
       C) always_copy=1 ;;
@@ -227,6 +227,7 @@ handle_command_line() {
       K) run_hooks=0 ;;
       q) verbosity=$(($verbosity - 1)) ;;
       t) arg_tags="$arg_tags $OPTARG" ;;
+      T) TARGET=$(echo $OPTARG | envsubst) ;;
       S) symlink_dirs="$symlink_dirs $OPTARG";;
       s) never_symlink_dirs="$never_symlink_dirs $OPTARG";;
       U) undotted="$undotted $OPTARG";;
@@ -301,7 +302,7 @@ handle_command_line "$@"
 
 run_hooks pre up
 
-dests_and_srcs="$(lsrc $LS_ARGS)"
+dests_and_srcs="$(lsrc -T $TARGET $LS_ARGS)"
 
 saved_ifs="$IFS"
 IFS='

man/lsrc.1

@@ -19,7 +19,8 @@
 .Op files ...
 .Sh DESCRIPTION
 This program lists all configuration files, both the sources in the
-dotfiles directories and the destinations in your home directory.
+dotfiles directories and the destinations in the destination
+directory (by default your home directory).
 .
 See
 .Xr rcup 1 ,
@@ -90,6 +91,8 @@ protect it from your shell.
 .
 .It Fl t Ar TAG
 list dotfiles according to TAG
+.It Fl T Ar DIR
+consider dotfiles having destinations within target directory DIR
 .
 .It Fl U Ar excl_pat
 the rc files or directories matching this pattern will not be symlinked or

man/rcdn.1

@@ -98,6 +98,8 @@ This can be repeated.
 .It Fl t Ar TAG
 remove dotfiles according to
 .Ar TAG
+.It Fl T Ar DIR
+remove dotfiles relative to target directory DIR
 .It Fl U Ar EXCL_PAT
 any rc file or directory that matches
 .Ar EXCL_PAT

man/rcm.7.mustache

@@ -139,6 +139,27 @@ option. For example:
 .Pp
 .Dl mkrc -U bin
 .
+.Ss COMMON PROBLEM: CHANGING THE TARGET LOCATION DEPENDENT ON THE VALUE OF AN ENVIRONMENT VARIABLE
+By default, the rcm suite will assume that all dotfiles are installed relative to
+.Pa $HOME .
+If instead, the dotfiles are to be installed to, say,
+.Pa $XDG_CONFIG_HOME ,
+there are two options:
+
+The default target can be redefined by using
+.Va TARGET
+location in the rcrc file, or by using the
+.Fl T
+flag.  References to environment variables can be specified in any of these,
+e.g.
+.Pp
+.Dl rcup -T $XDG_CONFIG_HOME
+
+A new target can be specified for just one dotfiles directory by using the
+.Pa target
+meta-file (see
+.Xr rcup 1).
+.
 .Sh QUICK START FOR EMPTY DOTFILES DIRECTORIES
 This section is for those who do not have an existing dotfiles
 directory and whose dotfiles are standard.
@@ -249,6 +270,35 @@ macOS users should see the
 .Sx BUGS
 section for more details.
 .
+.Sh ALTERNATIVE TARGET INSTALL LOCATIONS
+.
+Sometimes it is useful to instruct rcm to install dotfiles to a location
+other than
+.Sx $HOME .
+
+The default target directory is taken to be the first specified by:
+.Bl -enum offset indent -compact
+.It
+command-line flag
+.Fl T ,
+for an invocation of rcup, rcdn, or lsrc.
+.It
+Variable
+.Va TARGET
+in the rcrc file. (see
+.Xr rcrc 5
+and the
+.Sx FILES
+section below)
+.It
+$HOME
+.El
+
+A target location can also be specified on a per dotfiles directory basis.
+This is achieved by placing meta-file
+.Pa target
+in the root, which contains a single line denoting the desired target directory.
+
 .Sh STANDALONE INSTALLATION SCRIPT
 .
 The

man/rcrc.5

@@ -54,6 +54,8 @@ command, but this command is non-standard and can prove unreliable. The
 variable forces a known hostname.
 .It Va TAGS
 the default tags.
+.It Va TARGET
+the new default location to manage dotfiles relative to
 .
 .It Va SYMLINK_DIRS
 a space-separated list of patterns. Directories matching a pattern are

man/rcup.1

@@ -93,6 +93,8 @@ This option can be repeated.
 .It Fl t Ar TAG
 install dotfiles according to
 .Ar TAG
+.It Fl T Ar DIR
+install dotfiles relative to target directory DIR
 .It Fl U Ar EXCL_PAT
 any rc file that matches
 .Ar EXCL_PAT
@@ -148,8 +150,8 @@ option in
 .Xr rcrc 5
 can be used to list files that must only be copied.
 .Pp
-Three meta files are supported: host-specific files, tagged files,
-hooks.
+Four meta files are supported: host-specific files, tagged files,
+hooks, targets.
 .Pp
 Host-specific files go in a directory named for the host, prefixed with
 .Pa host- .
@@ -192,6 +194,21 @@ and
 .Pa hooks/pre-up/4-eyes
 will run before
 .Pa hooks/post-up/2-u-nothing-compares .
+.Pp
+Target files go directly in the dotfiles directory, and are named
+.Pa target .
+The first line in the file that is non-empty and refers to an existant
+directory is selected to be the target for the dotfiles directory.
+If no lines satisfy these requirements, then rcm falls back to the
+default target.
+Lines in the target file can consist of environment variables, prefixed
+with $. E.g.
+
+.Dl Sx $XDG_CONFIG_HOME
+.Dl $HOME/.config
+
+Directs rcm to manage dotfiles in the standard XDG compliant configuration directory.
+
 .Sh ALGORITHM
 It is instructive to understand the process
 .Nm rcup

share/rcm.sh.in

@@ -3,7 +3,7 @@ VERSION="@PACKAGE_VERSION@"
 #set -x
 
 DEBUG=:
-DEST_DIR="$HOME"
+TARGET="$HOME"
 PRINT=echo
 PROMPT=echo_n
 ERROR=echo_error
@@ -149,8 +149,8 @@ run_hooks() {
 
 de_dot() {
   $DEBUG "de_dot $1"
-  $DEBUG "  with DEST_DIR: $DEST_DIR"
-  echo "$1" | sed -e "s|$DEST_DIR/||" | sed -e 's/^\.//'
+  $DEBUG "  with TARGET: $TARGET"
+  echo "$1" | sed -e "s|$TARGET/||" | sed -e 's/^\.//'
 }
 
 DELIMITER="\a"
@@ -167,8 +167,24 @@ decode() {
   echo "$file" | tr "$DELIMITER" " "
 }
 
+get_target() {
+  while read line; do
+    line=$(echo "$line" | envsubst)
+    [ -z "$line" ] && continue
+    if [ -d $line ]; then
+      echo $line
+      return 0
+    fi
+  done 2> /dev/null < "$1/target"
+
+  if [ $? -ne 0 ]; then
+    echo $TARGET
+  fi
+}
+
 : ${RCRC:=$HOME/.rcrc}
 
 if [ -r "$RCRC" ]; then
   . "$RCRC"
 fi
+

test/rcrc-target.t

@@ -0,0 +1,13 @@
+  $ . "$TESTDIR/helper.sh"
+
+The target for rcup should be specifiable on the command line
+
+  $ touch .dotfiles/example
+  > mkdir "$HOME/target2"
+
+  $ echo 'TARGET="$HOME/target2"' > $HOME/.rcrc
+
+  $ rcup -v > /dev/null
+
+  $ assert_linked "$HOME/target2/.example" "$HOME/.dotfiles/example"
+

test/rcup-link-files-target-subst.t

@@ -0,0 +1,19 @@
+  $ . "$TESTDIR/helper.sh"
+
+Should create symlinks for files and directories, at the location specified by
+the target metafile.  Should correctly handly variable substitution
+
+  $ touch .dotfiles/example
+  > mkdir .dotfiles/nested/
+  > touch .dotfiles/nested/example
+  > mkdir .dotfiles/nested/deeply
+  > touch .dotfiles/nested/deeply/example
+
+  $ mkdir "$HOME/home2"
+  > echo '$HOME/home2' > .dotfiles/target
+
+  $ rcup -v > /dev/null
+
+  $ assert_linked "$HOME/home2/.example" "$HOME/.dotfiles/example"
+  $ assert_linked "$HOME/home2/.nested/example" "$HOME/.dotfiles/nested/example"
+  $ assert_linked "$HOME/home2/.nested/deeply/example" "$HOME/.dotfiles/nested/deeply/example"

test/rcup-link-files-target-trailing.t

@@ -0,0 +1,19 @@
+  $ . "$TESTDIR/helper.sh"
+
+Should create symlinks for files and directories, at the location specified by
+the target metafile, with trailing forward slash
+
+  $ touch .dotfiles/example
+  > mkdir .dotfiles/nested/
+  > touch .dotfiles/nested/example
+  > mkdir .dotfiles/nested/deeply
+  > touch .dotfiles/nested/deeply/example
+
+  $ mkdir "$HOME/home2"
+  > echo "$HOME/home2/" > .dotfiles/target
+
+  $ rcup -v > /dev/null
+
+  $ assert_linked "$HOME/home2/.example" "$HOME/.dotfiles/example"
+  $ assert_linked "$HOME/home2/.nested/example" "$HOME/.dotfiles/nested/example"
+  $ assert_linked "$HOME/home2/.nested/deeply/example" "$HOME/.dotfiles/nested/deeply/example"