aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2013-10-08 09:12:03 +0200
committerMattias Andrée <maandree@operamail.com>2013-10-08 09:12:03 +0200
commit049e5cd5da3bd563f58b252315aa768528521118 (patch)
treef3d4e903f7a1427635043e17720dadbb3e7ee6fa
parentadd legal files (diff)
downloadbfind-049e5cd5da3bd563f58b252315aa768528521118.tar.gz
bfind-049e5cd5da3bd563f58b252315aa768528521118.tar.bz2
bfind-049e5cd5da3bd563f58b252315aa768528521118.tar.xz
add readme
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--README30
1 files changed, 30 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..2c887f9
--- /dev/null
+++ b/README
@@ -0,0 +1,30 @@
+Minimalitic `find` using breadth first crawling.
+
+The entire invocation syntax is:
+
+ bfind [--xdev] [--hardlinks] [--symlinks] DIRECTORY
+
+With --xdev crawling will not be restricted to
+one mount point.
+
+With --hardlinks bfind will be hardlink aware
+on directories.
+
+With --symlinks, bfind will visit directories
+symlinks points, and directories will never
+be revisited. Visited directories will be
+memorised by absolute path name.
+
+
+Short option alternatives:
+
+ -x --xdev
+ -h --hardlinks
+ -s --symlinks
+
+ Short options can be combined
+
+
+Each link will always start with DIRECTORY
+and always and with a /.
+