diff options
author | Aldo Cortesi <aldo@nullcube.com> | 2014-01-27 14:16:23 +1300 |
---|---|---|
committer | Aldo Cortesi <aldo@nullcube.com> | 2014-01-27 14:16:23 +1300 |
commit | f47d89ff4e710f6d2df755fe526e91a5cf236cfa (patch) | |
tree | 61c35a397e569619ae7022fb006279d86a0d88eb /doc-src/mitmdump.html | |
parent | 47c7e37723b416605f232cd85818f41d865a9f85 (diff) | |
download | mitmproxy-f47d89ff4e710f6d2df755fe526e91a5cf236cfa.tar.gz mitmproxy-f47d89ff4e710f6d2df755fe526e91a5cf236cfa.tar.bz2 mitmproxy-f47d89ff4e710f6d2df755fe526e91a5cf236cfa.zip |
Revert "Move the doc tree out into its own repo."
This reverts commit 8f88fcedd601c0033b4469b66626a83011879baf.
Diffstat (limited to 'doc-src/mitmdump.html')
-rw-r--r-- | doc-src/mitmdump.html | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc-src/mitmdump.html b/doc-src/mitmdump.html new file mode 100644 index 00000000..792f9c52 --- /dev/null +++ b/doc-src/mitmdump.html @@ -0,0 +1,68 @@ + +__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 _--help_ flag output for complete +documentation. + + + +# Examples + + +## Saving traffic + +<pre class="terminal"> +> mitmdump -w outfile +</pre> + +Start up mitmdump in proxy mode, and write all traffic to __outfile__. + + +## Filtering saved traffic + +<pre class="terminal"> +> mitmdump -nr infile -w outfile "~m post" +</pre> + +Start mitmdump without binding to the proxy port (_-n_), read all flows from +infile, apply the specified filter expression (only match POSTs), and write to +outfile. + + +## Client replay + +<pre class="terminal"> +> mitmdump -nc outfile +</pre> + +Start mitmdump without binding to the proxy port (_-n_), then replay all +requests from outfile (_-c filename_). Flags combine in the obvious way, so +you can replay requests from one file, and write the resulting flows to +another: + +<pre class="terminal"> +> mitmdump -nc srcfile -w dstfile +</pre> + +See the [Client-side Replay](@!urlTo("clientreplay.html")!@) section for more information. + + +## Running a script + +<pre class="terminal"> +> mitmdump -s examples/add_header.py +</pre> + +This runs the __add_header.py__ example script, which simply adds a new header +to all responses. + + +## Scripted data transformation + +<pre class="terminal"> +> mitmdump -ns examples/add_header.py -r srcfile -w dstfile +</pre> + +This command loads flows from __srcfile__, transforms it according to the +specified script, then writes it back to __dstfile__. + |