Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gc-nibrahim authored Dec 6, 2017
1 parent c287199 commit 73cb1de
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,21 +26,22 @@ Usage
FSEParser v 3.1 -- provided by G-C Partners, LLC
==========================================================================

Usage: FSEParser_V3.1.py -c CASENAME -q REPORT_QUERY_FILE -s SOURCEDIR -o OUTDIR
Usage: FSEParser_V3.1.py -c CASENAME -q REPORT_QUERIES -s SOURCEDIR -o OUTDIR

Options:
-h, --help show this help message and exit
-c CASENAME The name of the current session, used for naming standards
-q REPORTQUERIES The full path to the json file containing custom report
-q REPORTQUERIES The location of the report_queries.json file containing custom report
queries to generate targeted reports
-s SOURCEDIR The source directory containing fsevent files to be parsed
-o OUTDIR The destination directory used to store parsed reports

Notes
----------------------

- The report_queries.json file is required to process FSEvents. Use -q to specify the location when running the parser.
- Parsed records can be in excess of 1 million records.
- The script does not recursively search subdirectories in the source_dir provided. All fsevent files including carved gzip if any must be place in the same directory.
- The script does not recursively search subdirectories in the source_dir provided. All FSEvents files including carved gzip if any must be placed in the same directory.
- Currently the script does not perform deduplication. Duplicate records may occur when carved gzips are also parsed.


Expand Down Expand Up @@ -90,4 +91,4 @@ mask_hex: The hex representation of the record's mask.

source: The fullpath of the FSEvents file that the record was parsed from.

source_modified_time: The FSEvents source file modified date.
source_modified_time: The FSEvents source file modified date.

0 comments on commit 73cb1de

Please sign in to comment.