aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@nullcube.com>2012-09-17 11:04:57 +1200
committerAldo Cortesi <aldo@nullcube.com>2012-09-17 11:04:57 +1200
commite039940f49aa057903c50aa9e0feb13da9990820 (patch)
tree2ea2a01d671b38d465dc7a62a5a92190e408b11b
parent3f9263a57a5d365fe5d058ed584f596944443eff (diff)
downloadmitmproxy-e039940f49aa057903c50aa9e0feb13da9990820.tar.gz
mitmproxy-e039940f49aa057903c50aa9e0feb13da9990820.tar.bz2
mitmproxy-e039940f49aa057903c50aa9e0feb13da9990820.zip
Doc stubs.
-rw-r--r--doc-src/index.html39
-rw-r--r--doc-src/index.py3
-rw-r--r--doc-src/mitmproxy.html1
-rw-r--r--doc-src/transparent.html (renamed from doc-src/scripting.html)0
-rw-r--r--doc-src/transparent/index.py7
-rw-r--r--doc-src/transparent/linux.html0
-rw-r--r--doc-src/transparent/openbsd.html0
-rw-r--r--doc-src/transparent/osx.html0
8 files changed, 34 insertions, 16 deletions
diff --git a/doc-src/index.html b/doc-src/index.html
index c0236f73..3b6d122d 100644
--- a/doc-src/index.html
+++ b/doc-src/index.html
@@ -4,23 +4,25 @@
<li><a href="@!urlTo("install.html")!@">Installation</a></li>
<li><a href="@!urlTo("mitmproxy.html")!@">mitmproxy</a></li>
<li><a href="@!urlTo("mitmdump.html")!@">mitmdump</a></li>
- <li>Features</li>
- <ul>
- <li><a href="@!urlTo("clientreplay.html")!@">Client-side replay</a></li>
- <li><a href="@!urlTo("serverreplay.html")!@">Server-side replay</a></li>
- <li><a href="@!urlTo("sticky.html")!@">Sticky cookies and auth</a></li>
- <li><a href="@!urlTo("reverseproxy.html")!@">Reverse proxy mode</a></li>
- <li><a href="@!urlTo("upstreamcerts.html")!@">Upstream Certs</a></li>
- <li><a href="@!urlTo("replacements.html")!@">Replacements</a></li>
- <li><a href="@!urlTo("anticache.html")!@">Anticache</a></li>
- <li><a href="@!urlTo("filters.html")!@">Filter expressions</a></li>
- </ul>
- <li>Scripting mitmproxy</li>
+ <li>Features
+ <ul>
+ <li><a href="@!urlTo("clientreplay.html")!@">Client-side replay</a></li>
+ <li><a href="@!urlTo("serverreplay.html")!@">Server-side replay</a></li>
+ <li><a href="@!urlTo("sticky.html")!@">Sticky cookies and auth</a></li>
+ <li><a href="@!urlTo("reverseproxy.html")!@">Reverse proxy mode</a></li>
+ <li><a href="@!urlTo("upstreamcerts.html")!@">Upstream Certs</a></li>
+ <li><a href="@!urlTo("replacements.html")!@">Replacements</a></li>
+ <li><a href="@!urlTo("anticache.html")!@">Anticache</a></li>
+ <li><a href="@!urlTo("filters.html")!@">Filter expressions</a></li>
+ </ul>
+ </li>
+ <li>Scripting mitmproxy
<ul>
<li><a href="@!urlTo("scripting/inlinescripts.html")!@">Inline Scripts</a></li>
<li><a href="@!urlTo("scripting/libmproxy.html")!@">libmproxy</a></li>
</ul>
- <li><a href="@!urlTo("ssl.html")!@">Setting up SSL interception</a></li>
+ </li>
+ <li><a href="@!urlTo("ssl.html")!@">Setting up SSL interception</a>
<ul>
<li><a href="@!urlTo("certinstall/firefox.html")!@">Firefox</a></li>
<li><a href="@!urlTo("certinstall/osx.html")!@">OSX</a></li>
@@ -28,11 +30,20 @@
<li><a href="@!urlTo("certinstall/ios.html")!@">iPhone/iPad</a></li>
<li><a href="@!urlTo("certinstall/android.html")!@">Android</a></li>
</ul>
- <li>Tutorials</li>
+ </li>
+ <li><a href="@!urlTo("transparent.html")!@">Setting up Transparent Proxying</a>
+ <ul>
+ <li><a href="@!urlTo("transparent/linux.html")!@">Linux</a></li>
+ <li><a href="@!urlTo("transparent/osx.html")!@">OSX</a></li>
+ <li><a href="@!urlTo("transparent/osx.html")!@">OpenBSD</a></li>
+ </ul>
+ </li>
+ <li>Tutorials
<ul>
<li> <a href="@!urlTo("tutorials/30second.html")!@">Client replay: a 30 second example</a> </li>
<li> <a href="@!urlTo("tutorials/gamecenter.html")!@">Setting highscores on Apple's GameCenter</a> </li>
</ul>
+ </li>
<li><a href="@!urlTo("faq.html")!@">FAQ</a></li>
<li><a href="@!urlTo("admin.html")!@">Administrivia</a></li>
</ul>
diff --git a/doc-src/index.py b/doc-src/index.py
index 379d6372..27faf602 100644
--- a/doc-src/index.py
+++ b/doc-src/index.py
@@ -79,10 +79,9 @@ pages = [
Page("reverseproxy.html", "Reverse proxy mode"),
Page("anticache.html", "Anticache"),
Page("filters.html", "Filter expressions"),
- Page("scripting.html", "Scripts"),
- Directory("scripting"),
Page("ssl.html", "Setting up SSL interception"),
Directory("certinstall"),
+ Directory("scripting"),
Directory("tutorials"),
Page("faq.html", "FAQ"),
Page("admin.html", "Administrivia")
diff --git a/doc-src/mitmproxy.html b/doc-src/mitmproxy.html
index 7908e259..f5bdbef8 100644
--- a/doc-src/mitmproxy.html
+++ b/doc-src/mitmproxy.html
@@ -45,6 +45,7 @@ which shows you exactly what's there without any changes. You can change modes
using the _m_ key.
+
## Grid Editor
Much of the data that we'd like to interact with in mitmproxy is structured.
diff --git a/doc-src/scripting.html b/doc-src/transparent.html
index e69de29b..e69de29b 100644
--- a/doc-src/scripting.html
+++ b/doc-src/transparent.html
diff --git a/doc-src/transparent/index.py b/doc-src/transparent/index.py
new file mode 100644
index 00000000..fa2a67da
--- /dev/null
+++ b/doc-src/transparent/index.py
@@ -0,0 +1,7 @@
+from countershape import Page
+
+pages = [
+ Page("linux.html", "Linux"),
+ Page("osx.html", "OSX"),
+ Page("openbsd.html", "OpenBSD"),
+]
diff --git a/doc-src/transparent/linux.html b/doc-src/transparent/linux.html
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/doc-src/transparent/linux.html
diff --git a/doc-src/transparent/openbsd.html b/doc-src/transparent/openbsd.html
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/doc-src/transparent/openbsd.html
diff --git a/doc-src/transparent/osx.html b/doc-src/transparent/osx.html
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/doc-src/transparent/osx.html