doc(user/rmsym.org):Describe rmsym

[BK-2020-03.git] / unitproc / bkmvln

diff --git a/unitproc/bkmvln b/unitproc/bkmvln
index 0e1cec521e6770be8ce89bb119c48ed7011804e3..87d3906991376600fa8bdb0733993a313f9c0898 100755 (executable)
--- a/unitproc/bkmvln
+++ b/unitproc/bkmvln
@@ -1,7 +1,13 @@
 #!/bin/bash
 #!/bin/bash

-#
-# inspired by https://stackoverflow.com/questions/8523159/how-do-i-move-a-relative-symbolic-link#8523293
-#          by Christopher Neylan
+# Desc: Moves sybolic link
+# Usage: bkmvln
+# Input: arg1: path of existing symbolic link
+#        arg2: path where link should be moved
+# Output: None
+# Depends: gnucoreutils 8.30
+# Ref/Attrib:
+#  1. Christopher Neylan. https://stackoverflow.com/questions/8523159/how-do-i-move-a-relative-symbolic-link#8523293
+#  2. Tomáš Pospíšek. https://stackoverflow.com/a/30508868

 
 help() {
    echo 'usage: mv_ln src_ln dest_dir'
 
 help() {
    echo 'usage: mv_ln src_ln dest_dir'


@@ -12,6 +18,8 @@ help() {
    exit 1
 }
 
    exit 1
 }
 

+# Show help if `--help` flag given, if arg1 isn't a symbolic link, or
+#   if arg2 isn't a directory.

 [ "$1" == "--help" ] || [ ! -L "$1" ] || [ ! -d "$2" ] && help
 
 set -e # exit on error
 [ "$1" == "--help" ] || [ ! -L "$1" ] || [ ! -d "$2" ] && help
 
 set -e # exit on error