HuntnGather – Diff between revs 22 and 24

Subversion Repositories:
Rev:
Only display areas with differences – Ignore whitespace
Rev 22 Rev 24
1 Short: File indexing and search utilities. 1 Short: File indexing and search utilities.
2 Author: Wizardry and Steamworks 2 Author: Wizardry and Steamworks
3 Uploader: "Wizardry and Steamworks" <office@grimore.org> 3 Uploader: "Wizardry and Steamworks" <office@grimore.org>
4 Type: util/dir 4 Type: util/dir
5 Replaces: util/dir/HuntnGather.lha 5 Replaces: util/dir/HuntnGather.lha
6 Version: 1.7.2 6 Version: 1.7.3
7 Architecture: m68k-amigaos 7 Architecture: m68k-amigaos
8   8  
9 Hunt & Gather - File search and indexing utilities. 9 Hunt & Gather - File search and indexing utilities.
10 (or Hunt'n'Gather bro, ghetto style) 10 (or Hunt'n'Gather bro, ghetto style)
11   11  
12 © Copyright 2021 by Wizardry and Steamworks 12 © Copyright 2021 by Wizardry and Steamworks
13   13  
14 Released under the MIT License, all rights reserved. 14 Released under the MIT License, all rights reserved.
15   15  
16 -=:[ Changes ]:=- 16 -=:[ Changes ]:=-
17   17  
18 TBA: 18 20201026:
19 * Use AsyncIO. 19 * Use AsyncIO.
20   20  
21 -=:[ Introduction ]:=- 21 -=:[ Introduction ]:=-
22   22  
23   23  
24 Hunt and Gather are two utiltities for indexing and then searching 24 Hunt and Gather are two utiltities for indexing and then searching
25 fileswithin a drive or directory designed to speed up searching files. 25 fileswithin a drive or directory designed to speed up searching files.
26   26  
27 The Gather utility is meant to index any path and generate a search 27 The Gather utility is meant to index any path and generate a search
28 database. The Hunt utility will then open the database generated by 28 database. The Hunt utility will then open the database generated by
29 Gather and look for files matching the string provided to Hunt as 29 Gather and look for files matching the string provided to Hunt as
30 parameter. 30 parameter.
31   31  
32 The utility was designed to check large collections of icons but the 32 The utility was designed to check large collections of icons but the
33 indexing and the fast search results proved indispensable enough for a 33 indexing and the fast search results proved indispensable enough for a
34 self-standing program. 34 self-standing program.
35   35  
36 -=:[ Design ]:=- 36 -=:[ Design ]:=-
37   37  
38 Hunt and Gather are designed with constant memory usage in order to be 38 Hunt and Gather are designed with constant memory usage in order to be
39 suitable for all Amiga models. Namely, the Gather utility will search 39 suitable for all Amiga models. Namely, the Gather utility will search
40 all files in a given path, sort the files in ascending order by using 40 all files in a given path, sort the files in ascending order by using
41 an external merge sort (tailored down to a 256KiB memory limit). 41 an external merge sort (tailored down to a 256KiB memory limit).
42   42  
43 Conversely, Hunt uses brute force to search for files but by reading 43 Conversely, Hunt uses brute force to search for files but by reading
44 lines from the database without loading the entire database in RAM. 44 lines from the database without loading the entire database in RAM.
45 Perhaps ulterior versions of Hunt might partition the database file 45 Perhaps ulterior versions of Hunt might partition the database file
46 just like Gather does and then build Tries in oder to speed up finding 46 just like Gather does and then build Tries in oder to speed up finding
47 files on the filesystem. 47 files on the filesystem.
48   48  
49 The project adheres to the ANSI C standard and Amiga-centric semantics 49 The project adheres to the ANSI C standard and Amiga-centric semantics
50 are compiled conditionally (in case the "___AmigaOS__" macro is 50 are compiled conditionally (in case the "___AmigaOS__" macro is
51 defined at compile time).Otherwise, Hunt & Gather should run under any 51 defined at compile time).Otherwise, Hunt & Gather should run under any
52 platform that benefits from an ANSI C compiler. 52 platform that benefits from an ANSI C compiler.
53   53  
54 -=:[ Usage ]:=- 54 -=:[ Usage ]:=-
55   55  
56 First the Gather utility is used to index a path: 56 First the Gather utility is used to index a path:
57   57  
58   58  
59 Gather RAM: 59 Gather RAM:
60   60  
61   61  
62 which will create a file in the S: directory named "gahter.db". While 62 which will create a file in the S: directory named "gahter.db". While
63 Gather is running, the utility will display the number of indexed 63 Gather is running, the utility will display the number of indexed
64 directories and files on the command line. 64 directories and files on the command line.
65   65  
66 In order to look for a file, the Hunt utility is invoked with an 66 In order to look for a file, the Hunt utility is invoked with an
67 Amiga search pattern: 67 Amiga search pattern:
68   68  
69   69  
70 Hunt #?test#? 70 Hunt #?test#?
71   71  
72   72  
73 in this case, "#?test#?", that will be compared to all the files 73 in this case, "#?test#?", that will be compared to all the files
74 indexed previously by Gather. In case any of the files previously 74 indexed previously by Gather. In case any of the files previously
75 indexed by Gather contain the term "test", then the Hunt utility will 75 indexed by Gather contain the term "test", then the Hunt utility will
76 display the path to the file. 76 display the path to the file.
77   77  
78 -=:[ Gather ]:=- 78 -=:[ Gather ]:=-
79   79  
80 The Gather utility takes one single parameter representing the path 80 The Gather utility takes one single parameter representing the path
81 to be indexed; for example, all the following paths are valid: 81 to be indexed; for example, all the following paths are valid:
82   82  
83   83  
84 RAM: 84 RAM:
85 DH0:System/ 85 DH0:System/
86   86  
87   87  
88 When Gather runs, a database is created at "S:gather.db" by 88 When Gather runs, a database is created at "S:gather.db" by
89 overwriting the previous database. For best results, Gather should 89 overwriting the previous database. For best results, Gather should
90 run periodically and should scan a path that is most frequently 90 run periodically and should scan a path that is most frequently
91 searched for files. 91 searched for files.
92   92  
93 -=:[ Hunt ]:=- 93 -=:[ Hunt ]:=-
94   94  
95 Hunt is the counterpart to Gather and will search the database at 95 Hunt is the counterpart to Gather and will search the database at
96 "S:gather.db" for files matching the terms passed to Hunt on the 96 "S:gather.db" for files matching the terms passed to Hunt on the
97 command line. 97 command line.
98   98  
99 For instance: 99 For instance:
100   100  
101 Hunt #?test#? 101 Hunt #?test#?
102   102  
103 will search all files in the Gather database "S:gather.db" for the 103 will search all files in the Gather database "S:gather.db" for the
104 term "test". If any file within the database partially matches the 104 term "test". If any file within the database partially matches the
105 term "test", then Hunt will display the path on the command line. 105 term "test", then Hunt will display the path on the command line.
106 106
107 Hunt uses Amiga-style pattern for matching the file names. 107 Hunt uses Amiga-style pattern for matching the file names.
108 108
109 -=:[ Source ]:=- 109 -=:[ Source ]:=-
110   110  
111 The project is open sourced and licensed under MIT. The source code 111 The project is open sourced and licensed under MIT. The source code
112 is included in the AmiNET release or can be checked out via subversion 112 is included in the AmiNET release or can be checked out via subversion
113 from the Wizardry and Steamworks repository: 113 from the Wizardry and Steamworks repository:
114 114
115 svn co http://svn.grimore.org/HuntnGather 115 svn co http://svn.grimore.org/HuntnGather
116 116
117 -=:[ Mentions ]:=- 117 -=:[ Mentions ]:=-
118   118  
119 The code includes a shim for "getopt" in order to process command line 119 The code includes a shim for "getopt" in order to process command line
120 parameters on Amiga without changing the semantics. The shim is 120 parameters on Amiga without changing the semantics. The shim is
121 created by Daniel J. Barrett, barrett@cs.umass.edu and is available on 121 created by Daniel J. Barrett, barrett@cs.umass.edu and is available on
122 AmiNET: 122 AmiNET:
123 123
124 http://aminet.net/package/dev/misc/GetOpt-1.3 124 http://aminet.net/package/dev/misc/GetOpt-1.3
125 125
126 -=:[ Contact ]:=- 126 -=:[ Contact ]:=-
127   127  
128 E-Mail(tor): 128 E-Mail(tor):
129   129  
130 office@3wymlmcsvxiaqzmbepsdawqpk6o2qsk65jhms72qqjulk5u4bgmvs3qd.onion 130 office@3wymlmcsvxiaqzmbepsdawqpk6o2qsk65jhms72qqjulk5u4bgmvs3qd.onion
131   131  
132 Website: https://grimore.org/amiga/hunt_and_gather 132 Website: https://grimore.org/amiga/hunt_and_gather
133 Website(tor): 133 Website(tor):
134   134  
135 http://3wymlmcsvxiaqzmbepsdawqpk6o2qsk65jhms72qqjulk5u4bgmvs3qd.onion/ 135 http://3wymlmcsvxiaqzmbepsdawqpk6o2qsk65jhms72qqjulk5u4bgmvs3qd.onion/
136   136  
137 Discord: https://discord.gg/k9kyDsa 137 Discord: https://discord.gg/k9kyDsa
138 138
139   139