X-Git-Url: http://www.git.stargrave.org/?p=glocate.git;a=blobdiff_plain;f=README;fp=README;h=e5d6fd212d1112f1fa25948c8884a29ec50308cf4aa665a5fccd931cd5a99ae5;hp=8c52b350ce33c6e2b4f83ae2dd4fc980b342b8d3fa0b79ac2917988101f77477;hb=e5a64361a0537c82d3fbc21b986fc2815f394571f46a0e4128ced789a6712f36;hpb=db65ffeff7274def395c8ee747873d0e9d8250b75f543b6ac0d7bbd079cce66d

diff --git a/README b/README
index 8c52b35..e5d6fd2 100644
--- a/README
+++ b/README
@@ -38,10 +38,12 @@ Its indexing algorithm is following:
 
 Searching is trivial:
 
-* there is no actual searching, just a streaming through all the
-  database file sequentially
-* if some root is specified, then the program will output only its
-  hierarchy path, exiting after it is finished
+* searching is performed on each record streamed from the database
+* if -root is specified, then search will stop after that hierarchy part
+  is over
+* by default all elements are printed, unless you provide a single
+  argument that becomes "*X*" pattern matched on case-lowered path
+  elements
 
 Updating algorithm is following:
 
@@ -77,13 +79,21 @@ How to use it?
     $ glocate -db /tmp/glocate.db -tree
     [beauty tree-like list of files with sizes and mtimes]
 
-    $ glocate -db /tmp/glocate.db some/sub/path
-    [just a part of the whole hierarchy]
+    $ glocate -db /tmp/glocate.db -root music
+    [just a music hierarchy path]
 
-and update it carefully:
+    $ glocate -db /tmp/glocate.db -root music blasphemy | grep "/$"
+    music/Blasphemy-2001-Gods_Of_War_+_Blood_Upon_The_Altar/
+    music/Cryptopsy-1994-Blasphemy_Made_Flesh/
+    music/Infernal_Blasphemy-2005-Unleashed/
+    music/Ravenous-Assembled_In_Blasphemy/
+    music/Sect_Of_Execration-2002-Baptized_Through_Blasphemy/
+    music/Spectral_Blasphemy-2012-Blasphmemial_Catastrophic/
+
+and update it carefully, providing the strip prefix to -update:
 
     $ zfs snap big@snap2
-    $ zfs diff -FH big@snap2 | glocate -db /tmp/glocate.db -strip /big/ -update
+    $ zfs diff -FH big@snap2 | glocate -db /tmp/glocate.db -update /big/
 
 glocate is copylefted free software: see the file COPYING for copying
 conditions.