aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@nullcube.com>2011-08-05 08:07:40 +1200
committerAldo Cortesi <aldo@nullcube.com>2011-08-05 08:07:40 +1200
commitbe133e7a0b8b968e23b0813c64e205aa9e829e76 (patch)
treec2ac8d704a1f16335ada6a656fc66d5819860504
parentffd7043ee76212a27461ac7bd372d3f2790a71ac (diff)
downloadmitmproxy-be133e7a0b8b968e23b0813c64e205aa9e829e76.tar.gz
mitmproxy-be133e7a0b8b968e23b0813c64e205aa9e829e76.tar.bz2
mitmproxy-be133e7a0b8b968e23b0813c64e205aa9e829e76.zip
More documentation stubbing.
-rw-r--r--doc-src/index.html5
-rw-r--r--doc-src/mitmproxy.html16
-rw-r--r--doc-src/mitmproxy/eventlog.html0
-rw-r--r--doc-src/mitmproxy/index.py3
-rw-r--r--doc-src/screenshots/mitmproxy.pngbin0 -> 175466 bytes
5 files changed, 19 insertions, 5 deletions
diff --git a/doc-src/index.html b/doc-src/index.html
index 27bcc896..61a033be 100644
--- a/doc-src/index.html
+++ b/doc-src/index.html
@@ -4,11 +4,10 @@
<li><a href="@!urlTo("mitmproxy.html")!@">mitmproxy</a></li>
<ul>
<li><a href="@!urlTo("mitmproxy/interception.html")!@">Interception</a></li>
- <li><a href="@!urlTo("mitmproxy/encodings.html")!@">Encodings</a></li>
- <li><a href="@!urlTo("mitmproxy/eventlog.html")!@">Event log</a></li>
+ <li><a href="@!urlTo("mitmproxy/encodings.html")!@">Dealing with encodings</a></li>
</ul>
<li><a href="@!urlTo("mitmdump.html")!@">mitmdump</a></li>
- <li>Features</li>
+ <li>Concepts</li>
<ul>
<li><a href="@!urlTo("clientreplay.html")!@">Client-side replay</a></li>
<li><a href="@!urlTo("serverreplay.html")!@">Server-side replay</a></li>
diff --git a/doc-src/mitmproxy.html b/doc-src/mitmproxy.html
index e69de29b..da4c2a82 100644
--- a/doc-src/mitmproxy.html
+++ b/doc-src/mitmproxy.html
@@ -0,0 +1,16 @@
+
+__mitmproxy__ is a console tool that allows interactive examination and
+modification of HTTP traffic.
+
+## Connection list
+
+<img src="@!urlTo("screenshots/mitmproxy.png")!@"/>
+
+
+- Looking at the connection list, we can see that we visited __gmail.com__,
+which then returned a 301 redirect.
+- The statusbar tells us that there are 11 flows in the list, and that we're
+currently using the "pretty" view mode.
+- Also visible is the __Event log__, which can be toggled on and off with the
+__v__ keyboard shortcut. This displays events like client connection
+information, errors, and script output.
diff --git a/doc-src/mitmproxy/eventlog.html b/doc-src/mitmproxy/eventlog.html
deleted file mode 100644
index e69de29b..00000000
--- a/doc-src/mitmproxy/eventlog.html
+++ /dev/null
diff --git a/doc-src/mitmproxy/index.py b/doc-src/mitmproxy/index.py
index d7e9717c..889f039c 100644
--- a/doc-src/mitmproxy/index.py
+++ b/doc-src/mitmproxy/index.py
@@ -2,6 +2,5 @@ from countershape import Page
pages = [
Page("interception.html", "Interception"),
- Page("encodings.html", "Encodings"),
- Page("eventlog.html", "Event log"),
+ Page("encodings.html", "Dealing with encodings"),
]
diff --git a/doc-src/screenshots/mitmproxy.png b/doc-src/screenshots/mitmproxy.png
new file mode 100644
index 00000000..1766167e
--- /dev/null
+++ b/doc-src/screenshots/mitmproxy.png
Binary files differ