From c298fbfadc707116b30783e0577b0a179b07bb54 Mon Sep 17 00:00:00 2001
From: Aldo Cortesi <aldo@nullcube.com>
Date: Mon, 9 Apr 2012 15:15:41 +1200
Subject: Documentation.

---
 doc-src/certinstall/android.html |  4 ++-
 doc-src/index.html               |  1 +
 doc-src/index.py                 |  1 +
 doc-src/install.html             | 57 ++++++++++++++++++++++++++++++++++++++++
 doc-src/replacements.html        |  4 ++-
 5 files changed, 65 insertions(+), 2 deletions(-)
 create mode 100644 doc-src/install.html

(limited to 'doc-src')

diff --git a/doc-src/certinstall/android.html b/doc-src/certinstall/android.html
index 1c250339..3f57c39e 100644
--- a/doc-src/certinstall/android.html
+++ b/doc-src/certinstall/android.html
@@ -97,5 +97,7 @@ When you start mitmproxy, make sure that the upstream certificate option is set
 (use the _--upstream-cert_ command-line option, or enable it interactively
 using the _o_ shortcut):
 
-    mitmproxy --upstream-cert
+<pre class="terminal">
+mitmproxy --upstream-cert
+</pre>
 
diff --git a/doc-src/index.html b/doc-src/index.html
index 3caf41eb..d3ff6f17 100644
--- a/doc-src/index.html
+++ b/doc-src/index.html
@@ -1,6 +1,7 @@
 
 <ul class="docindex">
     <li><a href="@!urlTo("intro.html")!@">Introduction</a></li>
+    <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>
diff --git a/doc-src/index.py b/doc-src/index.py
index 17fa8b19..722506ab 100644
--- a/doc-src/index.py
+++ b/doc-src/index.py
@@ -68,6 +68,7 @@ ns.filt_help = filt_help
 pages = [
     Page("index.html", "docs"),
     Page("intro.html", "Introduction"),
+    Page("install.html", "Installation"),
     Page("mitmproxy.html", "mitmproxy"),
     Page("mitmdump.html", "mitmdump"),
     Page("clientreplay.html", "Client-side replay"),
diff --git a/doc-src/install.html b/doc-src/install.html
new file mode 100644
index 00000000..0968cd66
--- /dev/null
+++ b/doc-src/install.html
@@ -0,0 +1,57 @@
+
+## Using Pip 
+
+The preferred way to install mitmproxy is to use
+[pip](http://pypi.python.org/pypi/pip). A single command will install the
+latest release of mitmproxy, along with all its dependencies:
+
+<pre>
+sudo pip install mitmproxy
+</pre>
+
+
+## From Source
+
+- When installing from source, you will need to install the
+[dependencies](@!urlTo("intro.html")!@) by hand. 
+- Then run the following command from the base of the source distribution:
+    
+<pre>
+sudo python setup.py install
+</pre>
+
+
+## OSX
+
+- Make sure that XCode is installed from the App Store, and that the
+command-line tools have been downloaded (XCode/Preferences/Downloads).
+- Install __pip__ using the following command:
+    
+<pre>
+sudo easy_install pip
+</pre>
+
+- Now use __pip__ to set up the dependencies and do the install:
+
+<pre>
+sudo pip install mitmproxy
+</pre>
+
+This procedure may vary if, for instance, you've installed Python from an
+external source like [homebrew](http://mxcl.github.com/homebrew/). In that
+case, the easiest way to proceed is to first install __easy_install__, then
+continue as above.
+
+There are a few bits of customization you might want to do to make mitmproxy
+comfortable to use. At the moment, mitmproxy's color scheme is optimized for a
+dark background terminal, so you probably want to change the default. You can
+use the OSX <b>open</b> program to create a simple and effective
+<b>~/.mailcap</b> file to view HTTP bodies:
+
+<pre>
+application/*; /usr/bin/open -Wn %s
+audio/*; /usr/bin/open -Wn %s
+image/*; /usr/bin/open -Wn %s
+video/*; /usr/bin/open -Wn %s
+</pre>
+
diff --git a/doc-src/replacements.html b/doc-src/replacements.html
index 27a4fd4b..986e773a 100644
--- a/doc-src/replacements.html
+++ b/doc-src/replacements.html
@@ -43,7 +43,9 @@ thousands of characters. To cope with this, there's a variation of the
 replacement hook specifier that lets you load the replacement text from a file.
 So, you might start __mitmdump__ as follows:
 
-    mitmdump --replace-from-file :~q:foo:~/xss-exploit
+<pre class="terminal">
+mitmdump --replace-from-file :~q:foo:~/xss-exploit
+</pre>
 
 This will load the replacement text from the file __~/xss-exploit__.
 
-- 
cgit v1.2.3