From 453075c77abe640282e27c6674d151d63296de0a Mon Sep 17 00:00:00 2001
From: Aldo Cortesi <aldo@nullcube.com>
Date: Sun, 19 Jan 2014 18:08:50 +1300
Subject: Doc and readme tweaks.

---
 doc-src/_nav.html                  | 15 ++++++++-------
 doc-src/features/forwardproxy.html | 16 ++++++++++++++++
 doc-src/features/index.py          |  1 +
 doc-src/features/reverseproxy.html | 10 ++++++----
 4 files changed, 31 insertions(+), 11 deletions(-)
 create mode 100644 doc-src/features/forwardproxy.html

(limited to 'doc-src')

diff --git a/doc-src/_nav.html b/doc-src/_nav.html
index 3b7c9e80..b256f47f 100644
--- a/doc-src/_nav.html
+++ b/doc-src/_nav.html
@@ -11,6 +11,7 @@
         $!nav("anticache.html", this, state)!$
         $!nav("clientreplay.html", this, state)!$
         $!nav("filters.html", this, state)!$
+        $!nav("forwardproxy.html", this, state)!$
         $!nav("proxyauth.html", this, state)!$
         $!nav("replacements.html", this, state)!$
         $!nav("serverreplay.html", this, state)!$
@@ -21,27 +22,27 @@
 
     <li class="nav-header">Installing Certificates</li>
         $!nav("ssl.html", this, state)!$
+        $!nav("certinstall/android.html", this, state)!$
         $!nav("certinstall/firefox.html", this, state)!$
-        $!nav("certinstall/osx.html", this, state)!$
-        $!nav("certinstall/windows7.html", this, state)!$
         $!nav("certinstall/ios.html", this, state)!$
         $!nav("certinstall/ios-simulator.html", this, state)!$
-        $!nav("certinstall/android.html", this, state)!$
+        $!nav("certinstall/osx.html", this, state)!$
+        $!nav("certinstall/windows7.html", this, state)!$
 
     <li class="nav-header">Transparent Proxying</li>
         $!nav("transparent.html", this, state)!$
         $!nav("transparent/linux.html", this, state)!$
         $!nav("transparent/osx.html", this, state)!$
 
+    <li class="nav-header">Scripting mitmproxy</li>
+        $!nav("scripting/inlinescripts.html", this, state)!$
+        $!nav("scripting/libmproxy.html", this, state)!$
+
     <li class="nav-header">Tutorials</li>
         $!nav("tutorials/30second.html", this, state)!$
         $!nav("tutorials/gamecenter.html", this, state)!$
         $!nav("tutorials/transparent-dhcp.html", this, state)!$
 
-    <li class="nav-header">Scripting mitmproxy</li>
-        $!nav("scripting/inlinescripts.html", this, state)!$
-        $!nav("scripting/libmproxy.html", this, state)!$
-
     <li class="nav-header">Hacking</li>
         $!nav("dev/testing.html", this, state)!$
 </ul>
diff --git a/doc-src/features/forwardproxy.html b/doc-src/features/forwardproxy.html
new file mode 100644
index 00000000..203520d5
--- /dev/null
+++ b/doc-src/features/forwardproxy.html
@@ -0,0 +1,16 @@
+
+In this mode, mitmproxy accepts proxy requests and unconditionally forwards all
+requests to a specified upstream server. This is in contrast to <a
+href="@!urlTo("reverseproxy.html")!@">reverse proxy mode</a>, in which
+mitmproxy forwards ordinary HTTP requests to an upstream server.
+
+<table class="table">
+    <tbody>
+        <tr>
+            <th width="20%">command-line</th> <td>-F http[s]://hostname[:port]</td>
+        </tr>
+        <tr>
+            <th>mitmproxy shortcut</th> <td><b>F</b></td>
+        </tr>
+    </tbody>
+</table>
diff --git a/doc-src/features/index.py b/doc-src/features/index.py
index f7efc23a..e15f3311 100644
--- a/doc-src/features/index.py
+++ b/doc-src/features/index.py
@@ -4,6 +4,7 @@ pages = [
     Page("anticache.html", "Anticache"),
     Page("clientreplay.html", "Client-side replay"),
     Page("filters.html", "Filter expressions"),
+    Page("forwardproxy.html", "Forward proxy mode"),
     Page("setheaders.html", "Set Headers"),
     Page("serverreplay.html", "Server-side replay"),
     Page("sticky.html", "Sticky cookies and auth"),
diff --git a/doc-src/features/reverseproxy.html b/doc-src/features/reverseproxy.html
index 524df083..d399cdc0 100644
--- a/doc-src/features/reverseproxy.html
+++ b/doc-src/features/reverseproxy.html
@@ -1,9 +1,11 @@
 
-In reverse proxy mode, mitmproxy acts as a standard HTTP server and forwards
-all requests to the specified upstream server. Note that the displayed URL for
-flows in this mode will use the value of the __Host__ header field from the
-request, not the reverse proxy server.
+In reverse proxy mode, mitmproxy accepts standard HTTP requests and forwards
+them to the specified upstream server. This is in contrast to <a
+href="@!urlTo("forwardproxy.html")!@">forward proxy mode</a>, in which
+mitmproxy forwards HTTP proxy requests to an upstream server.
 
+Note that the displayed URL for flows in this mode will use the value of the
+__Host__ header field from the request, not the reverse proxy server. 
 
 <table class="table">
     <tbody>
-- 
cgit v1.2.3