HuntnGather – Diff between revs 5 and 8

Subversion Repositories:
Rev:
Only display areas with differences – Ignore whitespace
Rev 5 Rev 8
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.4 6 Version: 1.5
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 -=:[ ChangeLog ]:=- 16 -=:[ ChangeLog ]:=-
17   -  
18 20210117: -  
19 * Implement Amiga-style command line arguments processing. -  
20   17  
21 20210110: 18 20210110:
22 * Fixes for the new pattern matching. 19 * Fixes for the new pattern matching.
23   20  
24 20210109: 21 20210109:
25 * Add the ability to specify the database file for all tools (-d). 22 * Add the ability to specify the database file for all tools (-d).
26 * Perform some file checking for all tools before running. 23 * Perform some file checking for all tools before running.
27 * Add Amiga-style pattern matching with Hunt. 24 * Add Amiga-style pattern matching with Hunt.
28   25  
29 20210107: 26 20210107:
30 * Add the quiet option (-q) to the Gather tool. 27 * Add the quiet option (-q) to the Gather tool.
31 * Process arguments cannonically for both Hunt & Gather. 28 * Process arguments cannonically for both Hunt & Gather.
32 * Switch to a case-insensitive search for Hunt. 29 * Switch to a case-insensitive search for Hunt.
33   30  
34 20210105: 31 20210105:
35 * Ensure the database is sorted for future development. 32 * Ensure the database is sorted for future development.
36 * Insert CTRL+C breaking of both tools for AmigaOS. 33 * Insert CTRL+C breaking of both tools for AmigaOS.
37 * Make both tools more verbose. 34 * Make both tools more verbose.
38 * Dot the is, dash the ts... 35 * Dot the is, dash the ts...
39   36  
40 -=:[ Introduction ]:=- 37 -=:[ Introduction ]:=-
41   38  
42   39  
43 Hunt and Gather are two utiltities for indexing and then searching 40 Hunt and Gather are two utiltities for indexing and then searching
44 fileswithin a drive or directory designed to speed up searching files. 41 fileswithin a drive or directory designed to speed up searching files.
45   42  
46 The Gather utility is meant to index any path and generate a search 43 The Gather utility is meant to index any path and generate a search
47 database. The Hunt utility will then open the database generated by 44 database. The Hunt utility will then open the database generated by
48 Gather and look for files matching the string provided to Hunt as 45 Gather and look for files matching the string provided to Hunt as
49 parameter. 46 parameter.
50   47  
51 The utility was designed to check large collections of icons but the 48 The utility was designed to check large collections of icons but the
52 indexing and the fast search results proved indispensable enough for a 49 indexing and the fast search results proved indispensable enough for a
53 self-standing program. 50 self-standing program.
54   51  
55 -=:[ Design ]:=- 52 -=:[ Design ]:=-
56   53  
57 Hunt and Gather are designed with constant memory usage in order to be 54 Hunt and Gather are designed with constant memory usage in order to be
58 suitable for all Amiga models. Namely, the Gather utility will search 55 suitable for all Amiga models. Namely, the Gather utility will search
59 all files in a given path, sort the files in ascending order by using 56 all files in a given path, sort the files in ascending order by using
60 an external merge sort (tailored down to a 256KiB memory limit). 57 an external merge sort (tailored down to a 256KiB memory limit).
61   58  
62 Conversely, Hunt uses brute force to search for files but by reading 59 Conversely, Hunt uses brute force to search for files but by reading
63 lines from the database without loading the entire database in RAM. 60 lines from the database without loading the entire database in RAM.
64 Perhaps ulterior versions of Hunt might partition the database file 61 Perhaps ulterior versions of Hunt might partition the database file
65 just like Gather does and then build Tries in oder to speed up finding 62 just like Gather does and then build Tries in oder to speed up finding
66 files on the filesystem. 63 files on the filesystem.
67   64  
68 The project adheres to the ANSI C standard and Amiga-centric semantics 65 The project adheres to the ANSI C standard and Amiga-centric semantics
69 are compiled conditionally (in case the "___AmigaOS__" macro is 66 are compiled conditionally (in case the "___AmigaOS__" macro is
70 defined at compile time).Otherwise, Hunt & Gather should run under any 67 defined at compile time).Otherwise, Hunt & Gather should run under any
71 platform that benefits from an ANSI C compiler. 68 platform that benefits from an ANSI C compiler.
72   69  
73 -=:[ Usage ]:=- 70 -=:[ Usage ]:=-
74   71  
75 First the Gather utility is used to index a path: 72 First the Gather utility is used to index a path:
76   73  
77   74  
78 Gather RAM: 75 Gather RAM:
79   76  
80   77  
81 which will create a file in the S: directory named "gahter.db". While 78 which will create a file in the S: directory named "gahter.db". While
82 Gather is running, the utility will display the number of indexed 79 Gather is running, the utility will display the number of indexed
83 directories and files on the command line. 80 directories and files on the command line.
84   81  
85 In order to look for a file, the Hunt utility is invoked with an Amiga 82 In order to look for a file, the Hunt utility is invoked with an Amiga
86 search pattern: 83 search pattern:
87   84  
88   85  
89 Hunt #?test#? 86 Hunt #?test#?
90   87  
91   88  
92 in this case, "#?test#?", that will be compared to all the files indexed 89 in this case, "#?test#?", that will be compared to all the files indexed
93 previously by Gather. In case any of the files previously indexed by 90 previously by Gather. In case any of the files previously indexed by
94 Gather contain the term "test", then the Hunt utility will display 91 Gather contain the term "test", then the Hunt utility will display
95 the path to the file. 92 the path to the file.
96   93  
97 -=:[ Gather ]:=- 94 -=:[ Gather ]:=-
98   95  
99 The Gather utility takes one single parameter representing the path 96 The Gather utility takes one single parameter representing the path
100 to be indexed; for example, all the following paths are valid: 97 to be indexed; for example, all the following paths are valid:
101   98  
102   99  
103 RAM: 100 RAM:
104 DH0:System/ 101 DH0:System/
105   102  
106   103  
107 When Gather runs, a database is created at "S:gather.db" by 104 When Gather runs, a database is created at "S:gather.db" by
108 overwriting the previous database. For best results, Gather should 105 overwriting the previous database. For best results, Gather should
109 run periodically and should scan a path that is most frequently 106 run periodically and should scan a path that is most frequently
110 searched for files. 107 searched for files.
111   108  
112 -=:[ Hunt ]:=- 109 -=:[ Hunt ]:=-
113   110  
114 Hunt is the counterpart to Gather and will search the database at 111 Hunt is the counterpart to Gather and will search the database at
115 "S:gather.db" for files matching the terms passed to Hunt on the 112 "S:gather.db" for files matching the terms passed to Hunt on the
116 command line. 113 command line.
117   114  
118 For instance: 115 For instance:
119   116  
120 Hunt #?test#? 117 Hunt #?test#?
121   118  
122 will search all files in the Gather database "S:gather.db" for the 119 will search all files in the Gather database "S:gather.db" for the
123 term "test". If any file within the database partially matches the 120 term "test". If any file within the database partially matches the
124 term "test", then Hunt will display the path on the command line. 121 term "test", then Hunt will display the path on the command line.
125 122
126 Hunt uses Amiga-style pattern for matching the file names. 123 Hunt uses Amiga-style pattern for matching the file names.
127 124
128 -=:[ Source ]:=- 125 -=:[ Source ]:=-
129   126  
130 The project is open sourced and licensed under MIT. The source code 127 The project is open sourced and licensed under MIT. The source code
131 is included in the AmiNET release or can be checked out via subversion 128 is included in the AmiNET release or can be checked out via subversion
132 from the Wizardry and Steamworks repository: 129 from the Wizardry and Steamworks repository:
133 130
134 svn co http://svn.grimore.org/HuntnGather 131 svn co http://svn.grimore.org/HuntnGather
135 132
136 -=:[ Mentions ]:=- 133 -=:[ Mentions ]:=-
137   134  
138 The code includes a shim for "getopt" in order to process command line 135 The code includes a shim for "getopt" in order to process command line
139 parameters on Amiga without changing the semantics. The shim is created 136 parameters on Amiga without changing the semantics. The shim is created
140 by Daniel J. Barrett, barrett@cs.umass.edu and is available on AmiNET: 137 by Daniel J. Barrett, barrett@cs.umass.edu and is available on AmiNET:
141 138
142 http://aminet.net/package/dev/misc/GetOpt-1.3 139 http://aminet.net/package/dev/misc/GetOpt-1.3
143 140
144 -=:[ Contact ]:=- 141 -=:[ Contact ]:=-
145   142  
146 E-Mail(tor): office@kaarvixjxfdy2wv2.onion 143 E-Mail(tor): office@kaarvixjxfdy2wv2.onion
147 Website: https://grimore.org/amiga/hunt_and_gather 144 Website: https://grimore.org/amiga/hunt_and_gather
148 Website(tor): http://kaarvixjxfdy2wv2.onion 145 Website(tor): http://kaarvixjxfdy2wv2.onion
149 Discord: https://discord.gg/k9kyDsa 146 Discord: https://discord.gg/k9kyDsa
150 147
151   148