Add a general file analysis overview/how-to document.

This commit is contained in:
Jon Siwek 2013-05-23 14:29:13 -05:00
parent f82167d067
commit 9c86a3ee0e
4 changed files with 190 additions and 3 deletions

View file

@ -22,11 +22,13 @@ export {
extract_filename: string &optional;
## An event which will be generated for all new file contents,
## chunk-wise.
## chunk-wise. Used when *tag* is
## :bro:see:`FileAnalysis::ANALYZER_DATA_EVENT`.
chunk_event: event(f: fa_file, data: string, off: count) &optional;
## An event which will be generated for all new file contents,
## stream-wise.
## stream-wise. Used when *tag* is
## :bro:see:`FileAnalysis::ANALYZER_DATA_EVENT`.
stream_event: event(f: fa_file, data: string) &optional;
} &redef;