Skip to content
Newer
Older
100644 75 lines (48 sloc) 2.3 KB
99000d7 @rauchg Initial commit
authored
1
2 ## spot(1)
3
4 Tiny ack-style file search utility.
5
6 ### Features
7
8 * Short & written in Bash: you can edit it easily to suit your liking.
9 * Fast. Just `find` + `grep`.
10 * Searches most things by default instead of some known predefined extensions.
11 * Ignores .git, .svn, devices and binary files.
12
13 ### Usage
14
15 #### Smart phrases
16
17 All arguments constitute the search text. No need to wrap most searches
18 in double quotes.
19
20 ![](http://f.cl.ly/items/1Z063i0o3O2m0y2n0Q0d/Image%202012.03.04%2012:26:39%20PM.png)
21
22 #### Smart case
23
24 `spot` is case-insensitive by default. However, if your search term
25 contains an uppercase letter, it becomes sensitive!
26
27 ![](http://f.cl.ly/items/2N332F0V302x1X47042c/Image%202012.03.04%2012:35:22%20PM.png)
28
29 #### Smart targets
30
31 If the first argument contains a slash _and_ is a valid directory, the
32 search is constrained to that particular target.
33
34 ![](http://f.cl.ly/items/2u3x3T3j0B0q3s0T310t/Image%202012.03.04%2012:40:08%20PM.png)
35
36 #### Options
37
38 `spot -h` to see them.
39
40 ### Installation
41
42 Run this command:
43
44 ```
55160e7 @rauchg README fix
authored
45 curl https://raw.github.com/guille/spot/master/spot.sh -o ~/bin/spot && chmod +x ~/bin/spot
99000d7 @rauchg Initial commit
authored
46 ```
47
48 If you don't have `~/bin`, replace it with another directory in your
49 `$PATH`, like `/usr/local/bin`.
50
51 ### License
52
53 (The MIT License)
54
55 Copyright (c) 2011 Guillermo Rauch <guillermo@learnboost.com>
56
57 Permission is hereby granted, free of charge, to any person obtaining
58 a copy of this software and associated documentation files (the
59 'Software'), to deal in the Software without restriction, including
60 without limitation the rights to use, copy, modify, merge, publish,
61 distribute, sublicense, and/or sell copies of the Software, and to
62 permit persons to whom the Software is furnished to do so, subject to
63 the following conditions:
64
65 The above copyright notice and this permission notice shall be
66 included in all copies or substantial portions of the Software.
67
68 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
69 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
70 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
71 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
72 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
73 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
74 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.