update README for gitorious move
[lnf] / lnf-function
index 7bc88f0c5847ccab79a067b7c3b1ad7313eb6b7b..0d43112818fbc1ef4a59722cdd41665eb003f25d 100644 (file)
@@ -3,30 +3,59 @@
 # This program is under GPL v. 3 or later, see <http://www.gnu.org/licenses/>
 
 lnf() {
-    local help="lnf [--help] LN_ARGUMENTS...
-Create symlinks conveniently and forcefully.
-Remove existing file/links using trash-put or rm -rf if it is not available.
-Create directory if needed. Small change to ln argument semantics: for 2 arguments,
-the second is the link, never a directory to put the link in.
-LN_ARGUMENTS are passed to ln -s --, meaning no ln option arguments are supported."
-    if [[ $1 == --help ]]; then
+    local help="lnf - Create symlinks conveniently and forcefully.
+Usage:
+       lnf -T TARGET LINK_NAME     (1st form)
+       lnf TARGET                  (2nd form)
+       lnf TARGET... DIRECTORY     (3rd form)
+
+Remove existing file in the using trash-put or rm -rf if it is not available.
+Create directory if needed. Slightly more restrictive arguments than ln.
+
+In the 1st form, create a link to TARGET with the name LINK_NAME.  In the 2nd
+form, create a link to TARGET in the current directory.  In the 3rd form, create
+links to each TARGET in DIRECTORY."
+
+    if [[ $1 == --help || $# -eq 0 ]]; then
         echo "$help"
         return 0
     fi
-    
+
+    local nodir
+    if [[ $1 == -T ]]; then
+        nodir=-T
+        shift
+        if (( $# != 2 )); then
+            echo "lnf error: expected 2 arguments with -T flag. Got $#"
+            return 1
+        fi
+    fi
+
+    local reset_extglob=false
+    ! shopt extglob >/dev/null && reset_extglob=true
+    shopt -s extglob
+
+
     local remove x
-    if type -P dircolors >/dev/null; then
+    if type -P trash-put >/dev/null; then
         remove=trash-put
     else
         remove="rm -rf"
     fi
-    
-    if [[ $# -ge 3 ]]; then
+
+    if [[ $nodir ]]; then
+        if [[ -e "$2" || -L "$2" ]]; then
+            $remove "$2"
+        elif ! mkdir -p "$(dirname "$2")"; then
+            echo "lnf error: failed to make directory $(dirname "$2")"
+            return 1
+        fi
+    elif (( $# >= 2 )); then
         if [[ -d ${!#} ]]; then
             local oldcwd=$PWD
-            cd ${!#} # last arg
-            for x in "${@:1:$(($#-1))}"; do # all but last arg
-                # remove any trailing slashes
+            cd "${!#}" # last arg
+            for x in "${@:1:$(( $# - 1 ))}"; do # all but last arg
+                # remove any trailing slashes, uses extglob
                 x="${x%%+(/)}"
                 # remove any leading directory components
                 x="${x##*/}"
@@ -34,16 +63,15 @@ LN_ARGUMENTS are passed to ln -s --, meaning no ln option arguments are supporte
             done
             cd "$oldcwd"
         else
-            mkdir -p "${!#}"
-        fi
-    elif [[ $# -eq 2 ]]; then
-        if [[ -e "$2" || -L "$2" ]]; then
-            $remove "$2"
-        elif [[ ! -d "$2/.." ]]; then
-            mkdir -p "$2/.."
+            if ! mkdir -p "${!#}"; then
+                echo "lnf error: failed to make directory ${!#}"
+                return 1
+            fi
         fi
     elif  [[ $# -eq 1 ]]; then
         [[ -e "${1##*/}" || -L "${1##*/}" ]] && $remove "${1##*/}"
     fi
-    ln -s -- "$@"
+
+    $reset_extglob && shopt -u extglob
+    ln -s $nodir -- "$@"
 }