aboutsummaryrefslogtreecommitdiffstats
path: root/docs/mitmdump.rst
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@nullcube.com>2018-02-22 17:21:34 +1300
committerAldo Cortesi <aldo@nullcube.com>2018-02-22 18:07:58 +1300
commit982508d30f887b4fe8b2a855792ae1e33f378222 (patch)
tree9d749a57929a950f0e177a9bf4d6cd7d9a88c16b /docs/mitmdump.rst
parent1cacefa104626e4e0df5ffb2aa8b0c6f16b615b2 (diff)
downloadmitmproxy-982508d30f887b4fe8b2a855792ae1e33f378222.tar.gz
mitmproxy-982508d30f887b4fe8b2a855792ae1e33f378222.tar.bz2
mitmproxy-982508d30f887b4fe8b2a855792ae1e33f378222.zip
All new documentation
This patch does a lot. - Ditch sphinx in favor of hugo. This gives us complete control of the layout and presentation of our docs. Henceforth, docs will be hosted on our website rather than ReadTheDocs. - Create a simple, clean doc layout and theme. - Remove large parts of the documentaion. I've ditched anything that was a) woefully out of date, b) too detailed, or c) too hard to maintain in the long term. - Huge updates to the docs themselves: completely rewrite addons documentation, add docs for core concepts like commands and options, and revise and tweak a lot of the existing docs. With this patch, we're also changing the way we publish and maintain the docs. From now on, we don't publish docs for every release. Instead, the website will contain ONE set of docs for each major release. The online docs will be updated if needed as minor releases are made. Docs are free to improve during minor releases, but anything that changes behaviour sufficiently to require a doc change warrants a new major release. This also leaves us free to progressively update and improve docs out of step with our release cadence. With this new scheme, I feel CI over the docs is less important. I've removed it for now, but won't object if someone wants to add it back in.
Diffstat (limited to 'docs/mitmdump.rst')
-rw-r--r--docs/mitmdump.rst66
1 files changed, 0 insertions, 66 deletions
diff --git a/docs/mitmdump.rst b/docs/mitmdump.rst
deleted file mode 100644
index 369bf0eb..00000000
--- a/docs/mitmdump.rst
+++ /dev/null
@@ -1,66 +0,0 @@
-.. _mitmdump:
-.. program:: mitmdump
-
-mitmdump
-========
-
-
-**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
-^^^^^^^^^^^^^^
-
->>> 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 (``-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 (``-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:
-
->>> 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**.
-