From 74b3b842fefec6a05d17bbdf365cd92c82fd3503 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Fri, 4 Sep 2015 16:17:55 +0200 Subject: rewrite basic docs for readthedocs --- docs/mitmdump.rst | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/mitmdump.rst (limited to 'docs/mitmdump.rst') diff --git a/docs/mitmdump.rst b/docs/mitmdump.rst new file mode 100644 index 00000000..c56903ec --- /dev/null +++ b/docs/mitmdump.rst @@ -0,0 +1,4 @@ +.. _mitmdump: + +mitmdump +======== \ No newline at end of file -- cgit v1.2.3 From 1165e35e1b6a3ae59afb6d9e259f75a201406174 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Sat, 5 Sep 2015 20:15:35 +0200 Subject: docs++ --- docs/mitmdump.rst | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) (limited to 'docs/mitmdump.rst') diff --git a/docs/mitmdump.rst b/docs/mitmdump.rst index c56903ec..d9b4a26b 100644 --- a/docs/mitmdump.rst +++ b/docs/mitmdump.rst @@ -1,4 +1,66 @@ .. _mitmdump: +.. program:: mitmdump mitmdump -======== \ No newline at end of file +======== + + +**mitmdump** is the command-line companion to mitmproxy. It provides +tcpdump-like functionality to let you view, record, and programmatically +transform HTTP traffic. See the :option:`--help` flag output for complete +documentation. + + + +Examples +-------- + +Saving traffic +^^^^^^^^^^^^^^ + +>>> mitmdump -w outfile + +Start up mitmdump in proxy mode, and write all traffic to **outfile**. + + +Filtering saved traffic +^^^^^^^^^^^^^^^^^^^^^^^ + +>>> mitmdump -nr infile -w outfile "~m post" + +Start mitmdump without binding to the proxy port (:option:`-n`), read all flows from +infile, apply the specified filter expression (only match POSTs), and write to +outfile. + + +Client replay +^^^^^^^^^^^^^ + +>>> mitmdump -nc outfile + +Start mitmdump without binding to the proxy port (:option:`-n`), then replay all +requests from outfile (:option:`-c filename`). Flags combine in the obvious way, so +you can replay requests from one file, and write the resulting flows to +another: + +>>> mitmdump -nc srcfile -w dstfile + +See the :ref:`clientreplay` section for more information. + + +Running a script +^^^^^^^^^^^^^^^^ + +>>> mitmdump -s examples/add_header.py + +This runs the **add_header.py** example script, which simply adds a new header +to all responses. + +Scripted data transformation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +>>> mitmdump -ns examples/add_header.py -r srcfile -w dstfile + +This command loads flows from **srcfile**, transforms it according to the +specified script, then writes it back to **dstfile**. + -- cgit v1.2.3