Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tysmith authored Jun 28, 2019
1 parent 555da40 commit 4e3aaa6
Showing 1 changed file with 0 additions and 67 deletions.
67 changes: 0 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,73 +24,6 @@ FFPuppet must be installed first. Steps can be found [here](https://github.com/M
##### To install after cloning the repository
pip install --user -e <grizzly_repository>

Usage
-----
```
$ python -m grizzly -h
usage: __main__.py
[--accepted-extensions ACCEPTED_EXTENSIONS [ACCEPTED_EXTENSIONS ...]]
[-c CACHE] [--coverage] [-e EXTENSION] [--fuzzmanager] [-h]
[--ignore IGNORE [IGNORE ...]] [-i INPUT]
[--launch-timeout LAUNCH_TIMEOUT] [--log-limit LOG_LIMIT]
[-m MEMORY] [--mime MIME] [--platform PLATFORM] [-p PREFS]
[--relaunch RELAUNCH] [--rr] [--s3-fuzzmanager]
[--soft-asserts] [-t TIMEOUT] [--tool TOOL] [--valgrind]
[-w WORKING_PATH] [--xvfb]
binary adapter
positional arguments:
binary Firefox binary to run
adapter Available adapters: <list of adapters>
optional arguments:
--accepted-extensions ACCEPTED_EXTENSIONS [ACCEPTED_EXTENSIONS ...]
Space separated list of supported file extensions. ie:
html svg (default: all)
-c CACHE, --cache CACHE
Maximum number of additional test cases to include in
report (default: 0)
--coverage Enable coverage collection
-e EXTENSION, --extension EXTENSION
Install an extension. Specify the path to the xpi or
the directory containing the unpacked extension. To
install multiple extensions specify multiple times
--fuzzmanager Report results to FuzzManager
-h, --help show this help message and exit
--ignore IGNORE [IGNORE ...]
Space separated ignore list. ie: log-limit memory
timeout (default: nothing)
-i INPUT, --input INPUT
Test case or directory containing test cases
--launch-timeout LAUNCH_TIMEOUT
Number of seconds to wait before LaunchError is raised
(default: 300)
--log-limit LOG_LIMIT
Log file size limit in MBs (default: 'no limit')
-m MEMORY, --memory MEMORY
Browser process memory limit in MBs (default: 'no
limit')
--mime MIME Specify a mime type
--platform PLATFORM Platforms available: ffpuppet (default: ffpuppet)
-p PREFS, --prefs PREFS
prefs.js file to use
--relaunch RELAUNCH Number of iterations performed before relaunching the
browser (default: 1000)
--rr Use RR (Linux only)
--s3-fuzzmanager Report large attachments (if any) to S3 and then the
crash & S3 link to FuzzManager
--soft-asserts Detect soft assertions
-t TIMEOUT, --timeout TIMEOUT
Iteration timeout in seconds (default: 60)
--tool TOOL Override tool name used when reporting issues to
FuzzManager
--valgrind Use Valgrind (Linux only)
-w WORKING_PATH, --working-path WORKING_PATH
Working directory. Intended to be used with ram-
drives. (default: '/tmp')
--xvfb Use Xvfb (Linux only)
```

Fuzzing builds & prefs.js
-------------------------
Fuzzing builds can be found in [taskcluster](https://tools.taskcluster.net/index/gecko.v2.mozilla-central.latest.firefox) or the [fuzzfetch](https://github.com/MozillaSecurity/fuzzfetch) (**recommended**) tool can be used to download a build.
Expand Down

0 comments on commit 4e3aaa6

Please sign in to comment.