Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Version 0.8.0

* new OzzyScope command * backward incompatibility issue: 'most_recent' and 'most_frequent' modes renamed respectively to 'most recent' and 'most frequent'. Removed 'g:ozzy_open_files_recursively' option.
  • Loading branch information...
commit 80173377a9ad89680661b51417ab80e78eee2c42 1 parent 12dd74d
Giacomo Comitti authored November 02, 2012 vim-scripts committed November 09, 2012
561  doc/ozzy.txt
... ...
@@ -1,431 +1,404 @@
1 1
 *ozzy.txt* *ozzy*
2 2
 
3  
-                                    Ozzy
4  
-                            Quick files launcher.
5  
-
6  
-                                     ~
7  
-                              Reference Manual
8  
-                                  v.0.7.2
9  
-
  3
+                                     Ozzy
  4
+                             Quick files launcher.
  5
+                   
  6
+                                      ~
  7
+                               Reference Manual
  8
+                                   v.0.8.0
  9
+                   
10 10
 ==============================================================================
11 11
 CONTENTS                                                       *ozzy-contents*
12 12
 
13  
-     1. Overview .............................. |ozzy-overview|
14  
-     2. Usage ................................. |ozzy-usage|
15  
-     3. Modes ................................. |ozzy-modes|
16  
-     4. Freeze Ozzy ........................... |ozzy-freeze|
17  
-     5. Inspector ............................. |ozzy-inspector|
18  
-     6. Commands .............................. |ozzy-commands|
19  
-     7. Mappings .............................. |ozzy-mappings|
20  
-     8. Settings .............................. |ozzy-settings|
21  
-     9. Changelog ............................. |ozzy-changelog|
22  
-    10. License ............................... |ozzy-license|
23  
-    11. Credits ............................... |ozzy-credits|
  13
+           1. Overview .............................. |ozzy-overview|
  14
+           2. Usage ................................. |ozzy-usage|
  15
+           3. Commands .............................. |ozzy-commands|
  16
+           4. Settings .............................. |ozzy-settings|
  17
+           5. Changelog ............................. |ozzy-changelog|
  18
+           6. License ............................... |ozzy-license|
  19
+           7. Credits ............................... |ozzy-credits|
24 20
 
25 21
 
26 22
 ==============================================================================
27 23
 1. Overview                                                    *ozzy-overview*
28 24
 
29  
-Ozzy allows you to open almost any file from anywhere. Just give a file name
30  
-and (if the file has been accessed at leat once in the past) the most
31  
-frequently used file or the most recently accessed one is picked for you, no
32  
-more entire paths to digit or folder to cd into! 
33  
-
34  
-
35  
-==============================================================================
36  
-2. Usage                                                          *ozzy-usage*
37  
-
38  
-Ozzy is very straightforward to use. Once installed, you can start editing your
39  
-favourite files as always. Once you open a file Ozzy registers it and from then
40  
-you can open that file with the following command: 
41  
-
42  
-    :Ozzy <file name>
43  
-
44  
-If Ozzy has in its database only one file that match the given `<file name>`, 
45  
-then that file is opened. If Ozzy find more that one match in its database, 
46  
-it has to decide what is the right file to open. By default Ozzy opens the most
47  
-frquently used file but you can change this behaviour to open the most recently 
48  
-used file, or even the file closest to the current working directory (context mode).
49  
-See [Modes](#ozzy-modes) for more informations.      
50  
-If you want to open a file regardless its frequency, access time or the current
51  
-context, you can specify a partial path:   
52  
-
53  
-    :Ozzy <partial path>/<file name>
54  
-
55  
-But what if you want to open a bunch of files at the same time? Well, if you
56  
-end the `<file name>` with a forward slash `/`, Ozzy will interpret it as
57  
-a directory and it will open all files contained into it (not recursively and
58  
-only those files that Ozzy has in its database).
59  
-
60  
-
61  
-If the filename is long or you don't remember part of it you can use command
62  
-line completion using the <TAB> key to cycle through possible matches.   
  25
+Ozzy let you easily open files from the command line. It's pretty much a file
  26
+indexer that keeps track of the files you edit day by day. When you need to
  27
+open a specific file just use its name and depending on some criterion
  28
+(customizable) the right file will be opened.   
63 29
 
64 30
 
65 31
 ==============================================================================
66  
-3. Modes                                                          *ozzy-modes*
  32
+2. Basic Usage                                                    *ozzy-usage*
67 33
 
68  
-A mode determines how Ozzy chooses the right file to open when it is faced with
69  
-a buch of file in its database that match the file the user want to 
70  
-open. There are three modes available: 
  34
+Ozzy is very straightforward to use. Once installed, you can start editing 
  35
+files as always. Once you open a file Ozzy keeps track of it and from then you
  36
+can open that file with the following command:
71 37
 
72  
-    * 'most frequent': the most frequently used file is opened.
  38
+  :Ozzy <file name>
73 39
 
74  
-    * 'most recent': the most recently used file is opened.
  40
+How Ozzy knows the right file to open when there are two or more files with the
  41
+same name? Ozzy by default opens the file who has been opened more times. You
  42
+can customize this behavior setting the |g:ozzy_mode| variable to the
  43
+following values:
75 44
 
76  
-    * 'context': the file closest the current working directory is opened.
  45
+  * 'most frequent': open the most frequently opened file.
  46
+  * 'most recent': open the most recently opened file.
  47
+  * 'context': open the closest file respect to the current working directory.
77 48
 
78  
-The default mode is 'most frequent' but you can toggle between the three modes 
79  
-during a vim session with the |OzzyToggleMode| command or set the default mode 
80  
-by setting the |g:ozzy_mode| option.
  49
+You are not limited to just file names. The |Ozzy| command accepts even partial
  50
+paths such as ':Ozzy directory/filename' and directory names such as 
  51
+':Ozzy directory/'. In the latter case note the presence of a forward slash as
  52
+the last character: this cause Ozzy to open all the files contained in the
  53
+directory (note that only files tracked by Ozzy will be opened).
81 54
 
82  
-
83  
-==============================================================================
84  
-4. Freeze Ozzy                                                   *ozzy-freeze*
85  
-
86  
-When Ozzy is frozen it does not update its database every time you open a file.
87  
-Though, you can still use all the Ozzy commands. If you want to freeze Ozzy
88  
-for a long period of time you can set the |g:ozzy_freeze| option in your .vimrc
89  
-file. If you want to freeze Ozzy for a brief period you can toggle on and off 
90  
-this option using the |OzzyToggleFreeze| command during a vim session.
  55
+Command line tab completion is supported but only for file names.   
91 56
 
92 57
 
93 58
 ==============================================================================
94  
-5. Inspector                                                  *ozzy-inspector*
95  
-
96  
-The Inspector is the place where you can do tricky things. Here, besides some
97  
-information about the current Ozzy status, you can inspect the whole content of
98  
-the database where are stored all the files you have opened until now.
99  
-The database is presented as a list of records where each records represent
100  
-a single file with some additional information: the file path, the frequency
101  
-usage and a last access date attribute.
102  
-But you can do more than simply inspect the content of the database. 
103  
-Below are listed all the keyboard keys you can use during an Inspector session
104  
-and their relative actions:
105  
-
106  
-    key   meaning
107  
-    ---   --------------------------------------------
108  
-    q     to quit inspector
109  
-    ?     to toggle help
110  
-    p     to toggle between absolute and relative to home paths
111  
-    f     to order records by frequency
112  
-    a     to order records by date and time
113  
-    r     to reverse the current records order
114  
-    o     to open the file on the current line
115  
-    +     to increase the frequency of the file on the current line
116  
-    *     as above but increases the frequency by 5
117  
-    -     to decrease the frequency of the file on the current line
118  
-    _     (underscore) as above but decreases the frequency by 5
119  
-    t     to touch the file on the current line (set its last access attribute to now)
120  
-    dd    to remove from the list the record under the cursor (or an entire selection)
121  
-
122  
-Note: The current line is the line where the cursor is positioned.
123  
-      To move up and down the records list use the classic hjkl keys.
124  
-
125  
-
126  
-==============================================================================
127  
-6. Commands                                                    *ozzy-commands*
  59
+3. Commands                                                    *ozzy-commands*
128 60
 
129 61
 ------------------------------------------------------------------------------
130  
-Ozzy <file name>
  62
+Ozzy                                                                    *Ozzy*
131 63
 shortcut: O
132 64
 
133  
-If Ozzy has in its database a file that match the given `<file name>`, then it
134  
-is opened. If you ends <file name> with a forward slash `/` Ozzy will interpret
135  
-the argument as a directory and it will open all the files in that direcory
136  
-according to the |g:ozzy_max_num_of_files_to_open|
137  
-option. In fact, if there more files, only the most recently or frequently
138  
-accessed (according to g:ozzy_mode) will be opened. Note however that Ozzy does
139  
-not really inspect the real directory on the file system to scan for files, but
140  
-instead, it will search exclusively in its database for matches. You have to
141  
-open files at leat once 'manually' before Ozzy can open them for you.  
142  
-
143  
-See also |ozzy-modes| to find out how to change the behaviour of this
144  
-command when there are two or more files that match the given <file name>.
145  
-
  65
+ | possible arguments:
  66
+ |
  67
+ | * a file name
  68
+ | * a partial path (example: directory/filename)
  69
+ | * a path ending with a forward slash (example: directory/)
  70
+
  71
+Depending to the type of the passed argument this command performs different
  72
+actions:
  73
+
  74
+  * if a file name is given then a file in the index that match the give name is
  75
+    opened (the right file is selected depending on the current mode: most
  76
+    frequent, most recent or context). See also the option |g:ozzy_ignore_ext|.
  77
+
  78
+  * if a partial path ending with a filename is given the the behavior descibed
  79
+    above is retained but there might be less potenyial conflicts.
  80
+
  81
+  * if a partial path ending with a forward slash is given the all files
  82
+    contained in that directory will be opened (only those files tracked by
  83
+    Ozzy). If Ozzy has in its index two or more directories with tha same name, 
  84
+    the right one is selected according to the current mode:
  85
+
  86
+    - 'most frequent': the directory that contains more frequently opened files 
  87
+      is opened.
  88
+    - 'most recent': the directory that contains more recently accessed files is
  89
+      opened.
  90
+    - 'context': the closests directory is opened.
  91
+   
  92
+Note however that Ozzy does not really scan the physical directory on the file
  93
+system, but instead it will search exclusively in its database for possible
  94
+matches. You have to open files at least once manually or with the
  95
+|OzzyAddDirectory| command before Ozzy can open them.
  96
+                                                     
146 97
 
147 98
 ------------------------------------------------------------------------------
148 99
 OzzyInspect                                                      *OzzyInspect*
149 100
 shortcut: Oi
150 101
 
151  
-Open the database inspector. 
152  
-See also |ozzy-inspector|.
  102
+Opens the Inspector buffer. This place is where you can inspect the whole file
  103
+index and perform some actions on single entries like increasing the access
  104
+frequency, setting the last access time, doing various sorts, ecc.. For more
  105
+information about available actions type '?' inside the Inspector buffer. 
153 106
 
154 107
 
155 108
 ------------------------------------------------------------------------------
156  
-OzzyAddDirectory <directory> [options]                      *OzzyAddDirectory*                                 
157  
-shortcut: OAdd
  109
+OzzyScope                                                          *OzzyScope*
  110
+shortcut: Oscope
  111
+
  112
+ | possible arguments:
  113
+ |
  114
+ | * an absolute path
  115
+ | * . (single dot)
  116
+ | * .. (two dots)
  117
+ | * ... (three dots)
  118
+
  119
+Sets the Ozzy scope to the given path. By default the scope is global but once
  120
+you set it to a certain 'path' Ozzy will be no more able to open files that
  121
+reside outside that 'path'. Further, they will be no more indexed and
  122
+included command line completion. Already indexed files won't be removed:
  123
+you can still interact with them throughout the Inspector. If you want to add
  124
+all files contained into the current working directory you can use the '.'
  125
+shortcut instead. To add the current parent directory use the '..' argument.
  126
+Use the '...' argument to add the project root directory (see the
  127
+|g:ozzy_what_in_project_root| option). By default Ozzy assumes the project 
  128
+root directory as the one containing a '.git', '.hg' or a '.svn' folder along 
  129
+the current working directory path.
  130
+To restore the global scope use the command with no arguments.
  131
+
  132
+You can customize the default behavior with the following options:
  133
+
  134
+  * -p <comma separated list>: override the global |g:ozzy_what_in_project_root| 
  135
+    option. Works only with the special argument '...'.          
158 136
 
159  
-To add all files contained into the given <directory> (except those contained
160  
-into hidden directories). The <directory> argument must be an absolute path
161  
-but if you want to add all files contained into the current working directory
162  
-you can use the '.' shortcut instead. To add the current parent directory use
163  
-the '..' argument. Use the '...' argument to add the project root directory.
164  
-By default Ozzy assumes it is the one that contains a '.git', '.hg' or a 
165  
-'.svn' folder along the current working directory path. You can override this
166  
-behavior setting the |g:ozzy_what_in_project_root| setting or with the 
167  
-'-p <list>' command line option but the effect of the latter will last for 
168  
-just the current command).
169 137
 
170  
-You can customize the default behavior of this command with the following 
171  
-options:
  138
+------------------------------------------------------------------------------
  139
+OzzyAddDirectory                                            *OzzyAddDirectory*                                 
  140
+shortcut: Oadd
  141
+
  142
+ | possible arguments:
  143
+ |
  144
+ | * an absolute path
  145
+ | * . (single dot)
  146
+ | * .. (two dots)
  147
+ | * ... (three dots) 
172 148
 
  149
+To add all files contained into the given 'path' (by default except those
  150
+contained into hidden directories). If you want to add all files contained into
  151
+the current working directory you can use the '.' shortcut instead. To add the
  152
+current parent directory use the '..' argument. Use the '...' argument to add
  153
+the project root directory (see the |g:ozzy_what_in_project_root| option). By
  154
+default Ozzy assumes the project root directory as the one containing a '.git',
  155
+'.hg' or a '.svn' folder along the current working directory path.
173 156
 
174  
-   -h: to add files contained into hidden directories.
  157
+You can customize the default behavior with the following options:
175 158
 
176  
-   -a <comma separated list>: use this option to add only specific files.
177  
-       See below for all the allowed patterns.
  159
+  * -h: add files contained into hidden directories.
178 160
 
179  
-   -i <comma separated list>: use this option to ignore specific files.
180  
-       See below for all the allowed patterns.
  161
+  * -a <comma separated list>: add only specific files. See below for allowed
  162
+    patterns.
181 163
 
182  
-   -p <comma separated list>: use this option to override the global 
183  
-       |g:ozzy_what_in_project_root| setting. 
  164
+  * -i <comma separated list>: ignore specific files. See below for allowed 
  165
+    patterns. 
184 166
 
  167
+  * -p <comma separated list>: override the global |g:ozzy_what_in_project_root|
  168
+    option. Works only with the special argument '...'.
185 169
 
186  
-Below are listed all the patterns you can use:
  170
+Allowed patterns:
187 171
 
188  
-    - *.<ext>  
189  
-    all files with extension '<ext>'.
190  
-    examples: *.py *.cpp
  172
+  * '*.<ext>'     
  173
+    all file names with extension <ext>     
  174
+    examples: *.py, *.cpp
191 175
 
192  
-    - <file name>.*
193  
-    all files named '<file name>' regardless the extension (note that the files
194  
-    that exactly match <file name> will be considered too).
195  
-    examples: doc.* log.* README.*
  176
+  * '<file name>.*'   
  177
+    all files named <file name> regardless the extension (file names that 
  178
+    exactly match <file name> will be considered too).    
  179
+    examples: doc.*, log.*, README.*
196 180
 
197  
-    - <file name> 
198  
-    all file names that exactly match '<file name>'.
199  
-    examples: test.py junk.txt LICENSE 
  181
+  * '<file name>'    
  182
+    all file names that exactly match <file name>.     
  183
+    examples: test.py, junk.txt, LICENSE
200 184
 
201  
-    - <path>/
202  
-    all file paths that contains '<path>/'.
203  
-    examples: doc/ (every file in <anything>/doc/)    
  185
+  * '<partial path>/'   
  186
+    all paths that contain <path>.    
  187
+    examples: doc/ (every file in a folder called 'doc')   
204 188
 
205 189
 
206 190
 ------------------------------------------------------------------------------
207 191
 OzzyRemove <pattern>                                              *OzzyRemove*
208 192
 shortcut: Orm
209 193
 
210  
-To remove from the database all the files that match the given pattern. Below
211  
-the accepted patterns:
  194
+ | possible arguments:
  195
+ |
  196
+ | * a pattern (see below for allowed patterns)
  197
+ | * % 
212 198
 
213  
-    - *.<ext>  
214  
-    all files with extension '<ext>'.
215  
-    examples: *.py *.cpp
  199
+To remove from the index all the entries that match the given pattern. Use the
  200
+special '%' argument if you want to remove the current file. 
216 201
 
217  
-    - <file name>.*
218  
-    all files named '<file name>' regardless the extension (note that the files
219  
-    that exactly match <file name> will be removed too).
220  
-    examples: doc.* log.* README.*
  202
+Allowed patterns:
221 203
 
222  
-    - <file name> 
223  
-    all file names that exactly match '<file name>'.
224  
-    examples: test.py junk.txt LICENSE 
  204
+  * '*.<ext>'     
  205
+    all file names with extension <ext>     
  206
+    examples: *.py, *.cpp
225 207
 
226  
-    - <file path>
227  
-    all file paths that ends with '<file path>'.
228  
-    examples: /doc/file.txt (every 'file.txt' in a folder called 'doc')
229  
-              /Users/donald/file.txt (a specific file.txt)
  208
+  * '<file name>.*'   
  209
+    all files named <file name> regardless the extension (file names that 
  210
+    exactly match <file name> will be considered too).    
  211
+    examples: doc.*, log.*, README.*
230 212
 
231  
-    - <path>/
232  
-    all file paths that contains '<path>/'.
  213
+  * '<file name>'    
  214
+    all file names that exactly match <file name>.     
  215
+    examples: test.py, junk.txt, LICENSE
  216
+
  217
+  * '<partial path>/'   
  218
+    all paths that contain <path>.    
233 219
     examples: doc/ (every file in a folder called 'doc')    
234 220
 
235 221
 
236 222
 ------------------------------------------------------------------------------
237  
-OzzyKeepLast <time period>                                      *OzzyKeepLast*
  223
+OzzyKeepLast                                                    *OzzyKeepLast*
238 224
 shortcut: Okeep
239 225
 
240  
-Where <time period> is an argument composed of two parts: a number n > 0 and
241  
-a string, separated by a space. This two parts together represent a period of
242  
-time. See the examples below:
243  
-
244  
-    - Okeep 15 minutes
245  
-    - Okeep 2 hours
246  
-    - Okeep 1 day
247  
-    - Okeep 3 weeks
  226
+ | possible arguments:
  227
+ |
  228
+ | * number [m | min | minute | minutes]  
  229
+ | * number [h | hour | hours]  
  230
+ | * number [d | day | days]  
  231
+ | * number [w | week | weeks]
  232
+ |    
  233
+ | where number >= 0
248 234
 
249  
-When you give such a command, then all the database entries (files) that have
250  
-not been accessed at least once in the last n (minutes, hours, days or weeks) 
251  
-will be removed. This options may helps to keep the database ordinated. 
252  
-There are shortcuts for specifying minutes, hours, days, and weeks:
  235
+Removes all entries (files) from the index that have not been accessed at least
  236
+once in the last n (minutes, hours, days or weeks). This options might helps to
  237
+keep the index clean and ordinated.
253 238
 
254  
-    - minutes: m, min, minute, minutes
255  
-    - hours: h, hour, hours
256  
-    - days: d, day, days
257  
-    - weeks: w, week, weeks
  239
+Examples:
258 240
 
259  
-See also the |g:ozzy_keep| option.  
  241
+* OzzyKeepLast 2 weeks: removes all files not accessed in the last two weeks. 
260 242
 
261 243
 
262 244
 ------------------------------------------------------------------------------
263 245
 OzzyReset                                                          *OzzyReset*
264 246
 
265  
-To remove all files entries from the database.
  247
+To remove all the entries from the database index.
266 248
 
267 249
 
268 250
 ------------------------------------------------------------------------------
269 251
 OzzyToggleMode                                                *OzzyToggleMode*
270 252
 
271  
-To toggle between 'most frequent' and 'most recent' modes.
272  
-See |ozzy-modes| and |g:ozzy_mode|. 
  253
+To toggle between 'most frequent', 'most recent' and 'context' modes. See the 
  254
+|g:ozzy_mode| option.
273 255
 
274 256
 
275 257
 ------------------------------------------------------------------------------
276 258
 OzzyToggleFreeze                                            *OzzyToggleFreeze*
277 259
 
278  
-To toggle between 'freeze on' and 'freeze off' modes.
279  
-See also |ozzy-freeze| and |g:ozzy_freeze|. 
  260
+To toggle between 'freeze on' and 'freeze off' modes. See the |g:ozzy_freeze| 
  261
+option.    
280 262
 
281 263
 
282 264
 ------------------------------------------------------------------------------
283 265
 OzzyToggleExtension                                      *OzzyToggleExtension*
284 266
 
285  
-To toggle between 'consider extension' and 'ignore extensions' mode.
286  
-See also the |g:ozzy_ignore_ext| option.
  267
+To toggle between 'consider extension' and 'ignore extensions' modes. See the
  268
+|g:ozzy_ignore_ext| option.
287 269
 
288 270
 
289 271
 ==============================================================================
290  
-8. Settings                                                    *ozzy-settings*
  272
+4. Settings                                                    *ozzy-settings*
291 273
 
292 274
 ------------------------------------------------------------------------------
293 275
 g:ozzy_mode                                                      *g:ozzy_mode* 
294 276
 
295  
-Set this variable to define the default behaviour for opening files. 
  277
+Set this variable to define the behavior when opening files. 
296 278
 Below all the available modes:
297 279
 
298  
-    * 'most_frequent': the most used file with the given name is opened.
299  
-    * 'most_recent': the most recently accessed file is opened.
300  
-    * 'context': the file closest to the current working directory is opened.
  280
+  * 'most frequent': open the most frequently opened file.
  281
+  * 'most recent': open the most recently opened file.
  282
+  * 'context': open the closest file respect to the current working directory.
301 283
 
302  
-default: 'most_frequent'
  284
+default: 'most frequent'  
303 285
 
304 286
 
305 287
 ------------------------------------------------------------------------------
306 288
 g:ozzy_freeze                                                  *g:ozzy_freeze* 
307 289
 
308  
-Set to 1 this variable and Ozzy will not add any new file to its database nor
309  
-will update any existent file. If you want to freeze Ozzy only for a brief
310  
-period of time during a vim session, you can toggle this option on and off 
  290
+If setted to 1 Ozzy will no more adds or updates any files in its internal
  291
+index but files already tracked will still be available for opening.
  292
+
  293
+To freeze Ozzy only for a short period you can toggle this option on and off
311 294
 with the |OzzyToggleFreeze| command.
312 295
 
313 296
 default: 0
314 297
 
315 298
 
316 299
 ------------------------------------------------------------------------------
317  
-g:ozzy_ignore_ext                                          *g:ozzy_ignore_ext* 
  300
+g:ozzy_scope                                                    *g:ozzy_scope* 
318 301
 
319  
-Set this option to 1 and Ozzy will ignore extension when serching in its
320  
-database for the file to open. Suppose that Ozzy has two entries in its
321  
-database: /file1.rb and /file1.py. If this option is set to 0 you must specify
322  
-the file name and the extension in order to open one of these two files,
323  
-otherwise no file will be opened. If you set this option to 0 there is no more
324  
-need to specify the extension and Ozzy will open the file that has been most
325  
-frequently (or recently, according to the current mode), though, you can still 
326  
-specify the extnsion if you want.
  302
+Set this option to an absolute path in order to limit the scope of the whole
  303
+Ozzy activity. That is, Ozzy will index and update only files under that path.
  304
+See also the |OzzyScope| command.
327 305
 
328  
-default: 1
  306
+default = ''   
329 307
 
330 308
 
331 309
 ------------------------------------------------------------------------------
332  
-g:ozzy_ignore                                                  *g:ozzy_ignore* 
  310
+g:ozzy_ignore_ext                                          *g:ozzy_ignore_ext* 
333 311
 
334  
-This is a list containing naive patterns that tell Ozzy what to ignore. That is, 
335  
-any file that match any of these patterns will not be added to the database or
336  
-updated if already exists in the database. Below all the accepted patterns:
  312
+If setted to 1 Ozzy will ignore extension when serching in its index for the
  313
+right file to open.  Suppose that Ozzy has two entries in its database:
  314
+'/file.rb' and '/file.py' and this option is setted to 1: you can open any of
  315
+these two file just using their filename: 'file'. Ozzy will open the right
  316
+file according to the current mode.
337 317
 
338  
-    - *.<ext>  
339  
-    all files with extension '<ext>'.
340  
-    examples: *.py *.cpp
  318
+default: 1    
341 319
 
342  
-    - <file name>.*
343  
-    all files named '<file name>' regardless the extension (note that the files
344  
-    that exactly match <file name> will be ignored too).
345  
-    examples: doc.* log.* README.*
346 320
 
347  
-    - <file name> 
348  
-    all file names that exactly match '<file name>'.
349  
-    examples: test.py junk.txt LICENSE 
  321
+------------------------------------------------------------------------------
  322
+g:ozzy_ignore                                                  *g:ozzy_ignore* 
350 323
 
351  
-    - <file path>
352  
-    all file paths that ends with '<file path>'.
353  
-    examples: /doc/file.txt (every 'file.txt' in a folder called 'doc')
354  
-              /Users/donald/file.txt (a specific file.txt)
  324
+This is a list containing naive patterns to tell Ozzy what to ignore. That is, 
  325
+any file that match any of these patterns will not be added to the database (or
  326
+updated if already indexed). Below the allowed patterns:
355 327
 
356  
-    - <path>/
357  
-    all file paths that contains '<path>/'.
358  
-    examples: vim/runtime/doc/ (every file in <anything>/vim/runtime/doc)
  328
+  * '*.<ext>'     
  329
+    all file names with extension <ext>     
  330
+    examples: *.py, *.cpp
359 331
 
360  
-default: []
  332
+  * '<file name>.*'   
  333
+    all files named <file name> regardless the extension (file names that 
  334
+    exactly match <file name> will be considered too).    
  335
+    examples: doc.*, log.*, README.*
361 336
 
  337
+  * '<file name>'    
  338
+    all file names that exactly match <file name>.     
  339
+    examples: test.py, junk.txt, LICENSE
362 340
 
363  
-------------------------------------------------------------------------------
364  
-g:ozzy_keep                                                      *g:ozzy_keep* 
  341
+  * '<partial path>/'   
  342
+    all paths that contain <path>.    
  343
+    examples: doc/ (every file in a folder called 'doc')   
  344
+         
  345
+default: []    
365 346
 
366  
-This option can be set to a number n >= 0 where n represent a number of days.
367  
-If set to 0 (default) this options simply do nothing. If set to a number n > 0,
368  
-then all the database entries (files) that have not been accessed in the
369  
-last n days  at least once will be automatically removed. This options may
370  
-helps to keep fresh and clean the database.
371 347
 
372  
-example: let g:ozzy_keep = 30 
373  
-         if a file registered in the database is not accessed for 30 days, it
374  
-         is removed.
  348
+------------------------------------------------------------------------------
  349
+g:ozzy_keep                                                      *g:ozzy_keep* 
375 350
 
376  
-default: 0
  351
+This option can be set to a number n &gt;= 0, where n represent a number of
  352
+days.  If set to 0 this options simply do nothing. If set to a number n &gt; 0,
  353
+then all the database entries (files) that have not been accessed in the last
  354
+n days at least once will be automatically removed. This options might helps 
  355
+to keep clean the database.
377 356
 
378  
--------------------------------------------------------------------------------
379  
-g:ozzy_max_num_files_to_open                     *g:ozzy_max_num_files_to_open*     
  357
+example: 
380 358
 
381  
-The max number of files that can be opened when you open multiple files with the 
382  
-`Ozzy` command. If this option is set to `0` no limit on is applied.
383  
-See also the |Ozzy| command.
  359
+  * 'let g:ozzy_keep = 30' : if an indexed file is not accessed for 30 days, it
  360
+    is removed.
384 361
 
385  
-default: 0         
  362
+default: 0       
386 363
 
387 364
 
388  
--------------------------------------------------------------------------------
389  
-g:ozzy_open_files_recursively                   *g:ozzy_open_files_recursively*     
  365
+------------------------------------------------------------------------------
  366
+g:ozzy_what_in_project_root                      *g:ozzy_what_in_project_root* 
390 367
 
391  
-Set this option to open all files recursively when using the |Ozzy| command with
392  
-a directory name (<path>/) as argument. If set to 0, only those files that are
393  
-directly contained in the given directory (only one level depth) will be opened.
394  
-See also the |Ozzy| command.
  368
+This setting is a list of files or directories names used by Ozzy to determine
  369
+the current project root. That is, Ozzy assumes the project root directory
  370
+as the one containing a '.git', '.hg' or a '.svn' folder along the current
  371
+working directory path. (option used in |OzzyAddDirecory| and |OzzyScope| 
  372
+commands)
395 373
 
396  
-default: 1        
  374
+default: ['.git', '.hg', '.svn']  
397 375
 
398 376
 
399 377
 ------------------------------------------------------------------------------
400  
-g:ozzy_enable_shortcuts                              *g:ozzy_enable_shortcuts* 
401  
-
402  
-If set to 1, this option enables the commands shortcut. Below all the available 
403  
-commands shortcuts with their respective 'long version':
  378
+g:ozzy_ignore_case                                        *g:ozzy_ignore_case* 
404 379
 
405  
-    - O : Ozzy
406  
-    - Oi : OzzyInspect
407  
-    - Orm : OzzyRemove
408  
-    - Okeep : OzzyKeepLast
  380
+If set to 1, this option enables case insensitive command line completion and
  381
+files opening. This means you can type lowercase file names all the time  
  382
+regardless the real case.
409 383
 
410  
-default: 1
  384
+default: 0   
411 385
 
412  
-------------------------------------------------------------------------------
413  
-g:ozzy_what_in_project_root                      *g:ozzy_what_in_project_root* 
  386
+ 
  387
+-------------------------------------------------------------------------------
  388
+g:ozzy_max_num_files_to_open                     *g:ozzy_max_num_files_to_open*     
414 389
 
415  
-This setting is a list representing file or directory names used by Ozzy to 
416  
-determine the current project root.
  390
+The max number of files that can be opened when you open multiple files with the 
  391
+|Ozzy| command. If this option is set to '0' no limit on is applied.
417 392
 
418  
-default: ['.git', '.hg', '.svn']
  393
+default: 0               
419 394
 
420 395
 
421 396
 ------------------------------------------------------------------------------
422  
-g:ozzy_ignore_case                                        *g:ozzy_ignore_case* 
  397
+g:ozzy_enable_shortcuts                              *g:ozzy_enable_shortcuts* 
423 398
 
424  
-If set to 1, this option enables case insensitive command line completion and
425  
-files opening. Thi means you can type lowercase file names all the time  
426  
-regardless their real case. 
  399
+If set to 1, this option enables the commands shortcut.
427 400
 
428  
-default: 0   
  401
+default: 1       
429 402
 
430 403
 
431 404
 ------------------------------------------------------------------------------
@@ -449,11 +422,12 @@ default: 'T'
449 422
 ------------------------------------------------------------------------------
450 423
 g:ozzy_context_flag                                      *g:ozzy_context_flag* 
451 424
 
452  
-This option represent the flag returned by the OzzyModeFlag() function when the 
453  
-current mode is set to 'context'.
  425
+This option represent the flag returned by the OzzyContextFlag() function when 
  426
+the current mode is set to 'context'.
454 427
 
455 428
 default: 'C'    
456 429
 
  430
+
457 431
 ------------------------------------------------------------------------------
458 432
 g:ozzy_freeze_off_flag                                *g:ozzy_freeze_off_flag* 
459 433
  
@@ -473,7 +447,13 @@ default: 'freeze'
473 447
 
474 448
 
475 449
 ==============================================================================
476  
-9. Changelog                                                  *ozzy-changelog*
  450
+5. Changelog                                                  *ozzy-changelog*
  451
+
  452
+v0.8.0
  453
+  * new OzzyScope command
  454
+  * backward incompatibility issue: 'most_recent' and 'most_frequent' modes 
  455
+    renamed respectively to 'most recent' and 'most frequent'. Removed 
  456
+    'g:ozzy_open_files_recursively' option.
477 457
 
478 458
 v0.7.2
479 459
   * fixed some behavior issues with OzzyAddDirectory, OzzyOpen commands and in 
@@ -530,16 +510,13 @@ v0.1
530 510
 
531 511
 
532 512
 ==============================================================================
533  
-10. License                                                     *ozzy-license*
  513
+6. License                                                      *ozzy-license*
534 514
 
535 515
 Ozzy is MIT licensed.
536 516
 
537 517
 
538 518
 ==============================================================================
539  
-11. Credits                                                     *ozzy-credits*
540  
-
541  
-Developed by Giacomo Comitti
  519
+7. Credits                                                      *ozzy-credits*
542 520
 
  521
+Author: Giacomo Comitti
543 522
 Git repository: https://github.com/gcmt/ozzy.vim
544  
-
545  
-Contributors:
359  ozzy-0.7.2/README.md
Source Rendered
... ...
@@ -1,359 +0,0 @@
1  
-# Ozzy.vim
2  
-
3  
-**v0.7.2**
4  
-
5  
-
6  
-Ozzy allows you to open almost any file from anywhere. Just give a file name
7  
-and (if the file has been accessed at leat once in the past) the most
8  
-frequently used file or the most recently accessed one is picked for you, no
9  
-more entire paths to digit or folder to cd into!
10  
-
11  
-
12  
-## Requirements
13  
-
14  
-* vim 7.3+
15  
-* vim compiled with python 2.6+
16  
-
17  
-
18  
-## Usage
19  
-
20  
-Ozzy is very straightforward to use. Once installed, you can start editing your
21  
-favourite files as always. Once you open a file Ozzy registers it and from then
22  
-you can open that file with the following command:
23  
-
24  
-```
25  
-:Ozzy <file name>
26  
-```
27  
-
28  
-If Ozzy has in its database only one file that match the given `<file name>`, 
29  
-then that file is opened. If Ozzy find more that one match in its database, 
30  
-it has to decide what is the right file to open. By default Ozzy opens the most
31  
-frquently used file but you can change this behaviour to open the most recently 
32  
-used file, or even the file closest to the current working directory (context mode).
33  
-See |ozzy-modes| for more informations.    
34  
-If you want to open a file regardless its frequency, access time or the current context,
35  
-you can specify a partial path:
36  
-
37  
-```
38  
-:Ozzy <partial path>/<file name>
39  
-```
40  
-
41  
-But what if you want to open a bunch of files at the same time? Well, if you
42  
-end the `<file name>` with a forward slash `/`, Ozzy will interpret it as
43  
-a directory and it will open all files contained into that directory (only 
44  
-those files that Ozzy has in its database).
45  
-
46  
-
47  
-If the filename is long or you don't remember part of it you can use command
48  
-line completion using the &lt;TAB&gt; key to cycle through possible matches.
49  
-
50  
-
51  
-<a name="ozzy-modes" />
52  
-## Modes
53  
- 
54  
-A mode determines how Ozzy chooses the right file to open when it is faced with
55  
-a buch of file in its database that match the file the user want to 
56  
-open. There are three modes available: 
57  
-
58  
-* `most frequent`: the most frequently used file is opened.
59  
-
60  
-* `most recent`: the most recently used file is opened.
61  
-
62  
-* `context`: the file closest to the current working directory is opened.
63  
-
64  
-The default mode is 'most frequent' but you can toggle between the three modes 
65  
-during a vim session with the [OzzyToggleMode](#ozzy-toggle-mode) command or set the default mode 
66  
-by setting the [g:ozzy_mode](#ozzy_mode) option.
67  
-
68  
-
69  
-## Freeze ozzy
70  
- 
71  
-When Ozzy is frozen it does not update its database every time you open a file.
72  
-Though, you can still use all the Ozzy commands. If you want to freeze Ozzy
73  
-for a long period of time you can set the [g:ozzy_freeze](#ozzy_freeze) option in your .vimrc
74  
-file. If you want to freeze Ozzy for a brief period you can toggle on and off 
75  
-this option using the [OzzyToggleFreeze](#ozzy-toggle-freeze) command during a vim session.     
76  
-
77  
-
78  
-<a name="ozzy-inspector" />
79  
-## Inspector
80  
-
81  
-The Inspector is the place where you can do tricky things. Here, besides some
82  
-information about the current Ozzy status, you can inspect the whole content of
83  
-the database where are stored all the files you have opened until now.
84  
-The database is presented as a list of records where each records represent
85  
-a single file with some additional information: the file path, the frequency
86  
-usage and a last access date attribute.
87  
-But you can do more than simply inspect the content of the database. 
88  
-Below are listed all the keyboard keys you can use during an Inspector session
89  
-and their relative actions:
90  
-
91  
-```
92  
-    key   meaning
93  
-    ---   --------------------------------------------
94  
-    q     to quit inspector
95  
-    ?     to toggle help
96  
-    p     to toggle between absolute and relative to home paths
97  
-    f     to order records by frequency
98  
-    a     to order records by date and time
99  
-    r     to reverse the current records order
100  
-    o     to open the file on the current line
101  
-    +     to increase the frequency of the file on the current line
102  
-    *     as above but increases the frequency by 5
103  
-    -     to decrease the frequency of the file on the current line
104  
-    _     (underscore) as above but decreases the frequency by 5
105  
-    t     to touch the file on the current line (set its last access attribute to now)
106  
-    dd    to remove from the list the record under the cursor (or an entire selection)
107  
-
108  
-    Note: The current line is the line where the cursor is positioned.
109  
-          To move up and down the records list use the classic hjkl keys.
110  
-```
111  
-
112  
-## Commands
113  
-
114  
-<a name="ozzy-command" />     
115  
-**Ozzy &lt;file name&gt;**  
116  
-shortcut: O
117  
-
118  
-If Ozzy has in its database a file that match the given `<file name>`, then it
119  
-is opened. If you ends <file name> with a forward slash `/` Ozzy will interpret
120  
-the argument as a directory and it will open all the files in that direcory
121  
-according to the [g:ozzy_max_num_of_files_to_open](#max_num_of_files_to_open)
122  
-option. In fact, if there more files, only the most recently or frequently
123  
-accessed (according to g:ozzy_mode) will be opened. Note however that Ozzy does
124  
-not really inspect the real directory on the file system to scan for files, but
125  
-instead, it will search exclusively in its database for matches.  You have to
126  
-open files at leat once 'manually' before Ozzy can open them for you.
127  
-
128  
-See [Modes](#ozzy-modes) to find out how to change the behaviour of this
129  
-command when there are two or more files that match the given `<file name>`.
130  
-
131  
-
132  
-
133  
--------------------------------------------------------------------------------
134  
-<a name="ozzyinspect-command" />     
135  
-**OzzyInspect**            
136  
-shortcut: Oi
137  
-
138  
-Open the database inspector.    
139  
-See also [Inspector](#ozzy-inspector).
140  
-
141  
-
142  
--------------------------------------------------------------------------------
143  
-<a name="ozzyadd-command" />     
144  
-**OzzyAddDirectory <directory> [options]**                     
145  
-shortcut: OAdd
146  
-
147  
-To add all files contained into the given `directory` (except those contained
148  
-into hidden directories). The `directory` argument must be an absolute path
149  
-but if you want to add all files contained into the current working directory
150  
-you can use the `.` shortcut instead. To add the current parent directory use
151  
-the `..` argument. Use the `...` argument to add the project root directory. 
152  
-By default *Ozzy* assumes it is the one that contains a `.git`, `.hg` or a `.svn` 
153  
-folder along the current working directory path. You can override this behavior
154  
-setting the `g:ozzy_what_in_project_root` option).
155  
-
156  
-You can customize the default behavior of this command with the following options:
157  
-
158  
-
159  
-* `-h`: to add files contained into hidden directories.
160  
-
161  
-* `-a <comma separated list>`: use this option to add only specific files.
162  
-   See below for all the allowed patterns.
163  
-
164  
-* `-i <comma separated list>`: use this option to ignore specific files.
165  
-   See below for all the allowed patterns.
166  
-
167  
-Below are listed all the patterns you can use:
168  
-
169  
-* `*.<ext>`     
170  
-all files with extension `<ext>`.     
171  
-*examples*: `*.py`, `*.cpp`
172  
-
173  
-* `<file name>.*`   
174  
-all files named `<file name>` regardless the extension (note that the files
175  
-that exactly match `<file name>` will be considered too).    
176  
-*examples*: `doc.*`, `log.*`, `README.*`
177  
-
178  
-* `<file name>`    
179  
-all file names that exactly match `<file name>`.     
180  
-*examples*: `test.py`, `junk.txt`, `LICENSE` 
181  
-
182  
-* `<path>/`   
183  
-all file paths that contains `<path>/`.    
184  
-*examples*: `doc/` (every file in a folder called 'doc') 
185  
-
186  
-
187  
--------------------------------------------------------------------------------
188  
-<a name="ozzyremove-command" />     
189  
-**OzzyRemove &lt;pattern&gt;**       
190  
-shortcut: Orm
191  
-
192  
-To remove from the database all the files that match the given pattern. Below
193  
-the accepted patterns:
194  
-
195  
-* `*.<ext>`     
196  
-all files with extension `<ext>`.     
197  
-*examples*: `*.py`, `*.cpp`
198  
-
199  
-* `<file name>.*`   
200  
-all files named `<file name>` regardless the extension (note that the files
201  
-that exactly match `<file name>` will be removed too).    
202  
-*examples*: `doc.*`, `log.*`, `README.*`
203  
-
204  
-* `<file name>`    
205  
-all file names that exactly match `<file name>`.     
206  
-*examples*: `test.py`, `junk.txt`, `LICENSE` 
207  
-
208  
-* `<file path>`   
209  
-all file paths that ends with '<file path>'.    
210  
-*examples*: `/doc/file.txt` (every 'file.txt' in a folder called 'doc'), `/Users/donald/file.txt` (a specific file.txt)
211  
-
212  
-* `<path>/`   
213  
-all file paths that contains `<path>/`.    
214  
-*examples*: `doc/` (every file in a folder called 'doc')    
215  
-
216  
-
217  
--------------------------------------------------------------------------------
218  
-<a name="ozzykeeplast-command" />     
219  
-**OzzyKeepLast &lt;time period&gt;**       
220  
-shortcut: Okeep
221  
-
222  
-Where <time period> is an argument composed of two parts: a number n > 0 and
223  
-a string, separated by a space. This two parts together represent a period of
224  
-time. See the examples below:
225  
-
226  
-* OzzyKeepLast 15 minutes
227  
-* OzzyKeepLast 2 hours
228  
-* OzzyKeepLast 1 day
229  
-* OzzyKeepLast 3 weeks
230  
-
231  
-When you give such a command, then all the database entries (files) that have
232  
-not been accessed at least once in the last n (minutes, hours, days or weeks) 
233  
-will be removed. This options may helps to keep the database ordinated. 
234  
-There are shortcuts for specifying minutes, hours, days, and weeks:
235  
-
236  
-* *minutes*: m, min, minute, minutes
237  
-* *hours*: h, hour, hours
238  
-* *days*: d, day, days
239  
-* *weeks*: w, week, weeks
240  
-
241  
-See also the [g:ozzy_keep](#ozzy_keep) option.
242  
-
243  
-
244  
--------------------------------------------------------------------------------
245  
-<a name="ozzyreset-command" />     
246  
-**OzzyReset**                   
247  
-
248  
-To remove all files entries from the database.
249  
-
250  
-
251  
--------------------------------------------------------------------------------
252  
-<a name="ozzy-toggle-mode" />
253  
-**OzzyToggleMode**            
254  
-
255  
-To toggle between `most frequent` and `most recent` modes.   
256  
-See also [Modes](#ozzy-modes) and the [g:ozzy_mode](#ozzy_mode) option. 
257  
-
258  
-
259  
--------------------------------------------------------------------------------
260  
-<a name="ozzy-toggle-freeze" />
261  
-**OzzyToggleFreeze**                                        
262  
-
263  
-To toggle between `freeze on` and `freeze off` modes.    
264  
-See also [Ozzy freeze](#ozzy-freeze) and the [g:ozzy_freeze](#ozzy_freeze) option. 
265  
-
266  
-
267  
--------------------------------------------------------------------------------
268  
-**OzzyToggleExtension**                                   
269  
-
270  
-To toggle between `consider extension` and `ignore extensions` mode.    
271  
-See also the [g:ozzy_ignore_ext](#ozzy_ignore_ext) option.     
272  
-
273  
-
274  
-## Basic settings
275  
-
276  
-
277  
-<a name="ozzy_mode" />
278  
-**g:ozzy_mode**                 
279  
-
280  
-Set this variable to define the default behaviour for opening files. 
281  
-Below all the available modes:
282  
-
283  
-* `most_frequent`: the most used file with the given name is opened.
284  
-* `most_recent`: the most recently accessed file is opened.
285  
-* `context`: the file closest to the current working directory is opened.
286  
-
287  
-*default:* 'most_frequent'
288  
-
289  
--------------------------------------------------------------------------------
290  
-<a name="ozzy_ignore_ext" />
291  
-**g:ozzy_ignore_ext**         
292  
-
293  
-Set this option to 1 and Ozzy will ignore extension when serching in its
294  
-database for the file to open. Suppose that Ozzy has two entries in its
295  
-database: */file1.rb* and */file1.py*. If this option is set to 0 you must specify
296  
-the file name and the extension in order to open one of these two files,
297  
-otherwise no file will be opened. If you set this option to 0 there is no more
298  
-need to specify the extension and Ozzy will open the file that has been most
299  
-frequently (or recently, according to the current mode), though, you can still 
300  
-specify the extnsion if you want.
301  
-
302  
-*default:* 1
303  
-
304  
--------------------------------------------------------------------------------
305  
-<a name="ozzy_ignore" />
306  
-**g:ozzy_ignore**        
307  
-
308  
-This is a list containing naive patterns that tell Ozzy what to ignore. That is, 
309  
-any file that match any of these patterns will not be added to the database or
310  
-updated if already exists in the database. Below all the accepted patterns:
311  
-
312  
-* `*.<ext>`    
313  
-all files with extension `<ext>`.    
314  
-*examples*: `*.py`, `*.cpp`
315  
-
316  
-* `<file name>.*`   
317  
-all files named `<file name>` regardless the extension (note that the files
318  
-that exactly match `<file name>` will be ignored too).   
319  
-*examples*: `doc.*`, `log.*`, `README.*`
320  
-
321  
-* `<file name>`    
322  
-all file names that exactly match `<file name>`.   
323  
-*examples*: `test.py`, `junk.txt`, `LICENSE` 
324  
-
325  
-* `<file path>`  
326  
-all file paths that ends with '<file path>'.   
327  
-*examples*: `/doc/file.txt` (every 'file.txt' in a folder called 'doc'), `/Users/donald/file.txt` (a specific file.txt)
328  
-
329  
-* `<path>/`  
330  
-all file paths that contains `<path>/`.   
331  
-*examples*: `doc/` (every file in a folder called 'doc')  
332  
-
333  
-*default:* []
334  
-
335  
--------------------------------------------------------------------------------
336  
-<a name="ozzy_keep" />
337  
-**g:ozzy_keep**           
338  
-
339  
-This option can be set to a number n >= 0 where n represent a number of days.
340  
-If set to 0 (default) this options simply do nothing. If set to a number n > 0,
341  
-then all the database entries (files) that have not been accessed in the
342  
-last n days  at least once will be automatically removed. This options may
343  
-helps to keep fresh and clean the database.
344  
-
345  
-example: 
346  
-* let g:ozzy_keep = 30 (if a file registered in the database is not accessed for 30 days, it is removed)
347  
-
348  
-*default:* 0
349  
-
350  
--------------------------------------------------------------------------------
351  
-<a name="ozzy_freeze" />
352  
-**g:ozzy_freeze**                                              
353  
-
354  
-Set to 1 this variable and Ozzy will not add any new file to its database nor
355  
-will update any existent file. If you want to freeze Ozzy only for a brief
356  
-period of time during a vim session, you can toggle this option on and off 
357  
-with the *OzzyToggleFreeze* command.
358  
-
359  
-*default:* 0    
0  ozzy-0.7.2/LICENSE.txt → ozzy-0.8.0/LICENSE.txt
File renamed without changes
423  ozzy-0.8.0/README.md
Source Rendered
... ...
@@ -0,0 +1,423 @@
  1
+# Ozzy.vim
  2
+
  3
+**v0.8.0**
  4
+
  5
+Ozzy let you easily open files from the command line. It's pretty much a file
  6
+indexer that keeps track of the files you edit day by day. When you need to open
  7
+a specific file just use its name and depending on some criterion (customizable) 
  8
+the right file will be opened.
  9
+
  10
+
  11
+## Requirements
  12
+
  13
+* vim 7.3+
  14
+* vim compiled with python 2.6+
  15
+
  16
+
  17
+## Installation
  18
+
  19
+Use Pathogen or Vundle, no excuses.
  20
+
  21
+
  22
+## Basic usage
  23
+
  24
+Ozzy is very straightforward to use. Once installed, you can start editing 
  25
+files as always. Once you open a file Ozzy keeps track of it and from then you
  26
+can open that file with the following command:
  27
+
  28
+```
  29
+:Ozzy <file name>
  30
+```
  31
+
  32
+How Ozzy knows the right file to open when there are two or more files with the
  33
+same name? Ozzy by default opens the file who has been opened more times. You
  34
+can customize this behavior setting the `g:ozzy_mode` variable to the
  35
+following values:
  36
+
  37
+* `'most frequent'`: open the most frequently opened file.
  38
+* `'most recent'`: open the most recently opened file.
  39
+* `'context'`: open the closest file respect to the current working directory.
  40
+
  41
+You are not limited to just file names. The `Ozzy` command accepts even partial
  42
+paths such as `:Ozzy directory/filename` and directory names such as 
  43
+`:Ozzy directory/`. In the latter case note the presence of a forward slash as
  44
+the last character: this cause Ozzy to open all the files contained in the
  45
+directory (note that only files tracked by Ozzy will be opened).
  46
+
  47
+Command line `tab` completion is supported but only for file names.
  48
+
  49
+
  50
+## Commands
  51
+
  52
+Here the list of all the available commands and their shortcuts (enabled with the
  53
+`g:ozzy_enable_shortcuts` option).
  54
+
  55
+
  56
+### Ozzy (O)
  57
+```
  58
+possible arguments:
  59
+
  60
+* a file name
  61
+* a partial path (example: directory/filename)
  62
+* a path ending with a forward slash (example: directory/)
  63
+```
  64
+
  65
+Depending to the type of the passed argument this command performs different
  66
+actions:
  67
+
  68
+* if a file name is given then a file in the index that match the give name is
  69
+  opened (the right file is selected depending on the current mode: most
  70
+  frequent, most recent or context). See also the option `g:ozzy_ignore_ext`.
  71
+
  72
+* if a partial path ending with a filename is given the the behavior descibed
  73
+  above is retained but there might be less potenyial conflicts.
  74
+
  75
+* if a partial path ending with a forward slash is given the all files
  76
+  contained in that directory will be opened (only those files tracked by
  77
+  Ozzy). If Ozzy has in its index two or more directories with the same name, 
  78
+  the right one is selected according to the current mode:
  79
+
  80
+  - `'most frequent'`: the directory that contains more frequently opened files is opened.
  81
+  - `'most recent'`: the directory that contains more recently accessed files is opened.
  82
+  - `'context'`: the closest directory is opened.
  83
+   
  84
+Note however that Ozzy does not really scan the physical directory on the file
  85
+system, but instead it will search exclusively in its database for possible
  86
+matches. You have to open files at least once manually or with the