aboutsummaryrefslogtreecommitdiffstats
path: root/docs/usage.md
diff options
context:
space:
mode:
authorAndrey Konovalov <andreyknvl@google.com>2017-06-14 14:13:00 +0200
committerAndrey Konovalov <andreyknvl@google.com>2017-06-14 16:13:33 +0200
commit15826f50875c279b9c7b3c6d26322efe15f24cfb (patch)
treead941027922e67167e7e586eac42c64e5eedaef3 /docs/usage.md
parentfbec6b14d43b3885014393d928daa3ef2bbb1e8e (diff)
docs: move parts of README to docs
Diffstat (limited to 'docs/usage.md')
-rw-r--r--docs/usage.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/usage.md b/docs/usage.md
new file mode 100644
index 000000000..b609ff0d4
--- /dev/null
+++ b/docs/usage.md
@@ -0,0 +1,15 @@
+## Running syzkaller
+
+Start the `syz-manager` process as:
+```
+./bin/syz-manager -config my.cfg
+```
+
+The `-config` command line option gives the location of the configuration file [described above](#configuration).
+
+The `syz-manager` process will wind up QEMU virtual machines and start fuzzing in them.
+Found crashes, statistics and other information is exposed on the HTTP address provided in manager config.
+
+- [How to execute syzkaller programs](executing_syzkaller_programs.md)
+- [How to reproduce crashes](reproducing_crashes.md)
+- [How to connect several managers via Hub](connecting_several_managers.md)