HuntnGather – Blame information for rev 20

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