summaryrefslogtreecommitdiff
path: root/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt48
1 files changed, 48 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..05922ef
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,48 @@
+automv.sh
+=========
+
+Usage:
+ ./automv.sh
+
+Prereqs:
+ Requires bash with the tools:
+ grep
+ xargs
+ find
+
+Setup:
+ the script searches the directory:
+ ./automv.d/
+ for any .conf files
+
+Overriding the automv.d location:
+ If you want to set a different automv.d location setup the:
+ AUTOMV_DIR
+ environment variable
+
+automv.d/ conf syntax
+=====================
+
+The conf files use the following syntax:
+
+# comments
+query=<query>
+ this is the query you want to use in 'find -regex'
+source=<source-dir>
+ this is the directory you want to search in
+target=<target-dir>
+ this is the target directory to move the found files to
+
+We explicitly parse out those 3 properties (see extract function in script)
+
+!!! Note - do not quote wrap anything - the script expects unwrapped values
+
+example conf
+============
+
+# jpegmv.conf
+# moves jpeg files downloaded to pictures
+query=.*\.jp[e]?g
+source=/home/user/Downloads/
+target=/home/user/Pictures/
+