overhaul the docs for win32, os x, and switchproxy

svn:r4612

3 files changed, 157 insertions, 100 deletions

diff --git a/doc/tor-doc-osx.html b/doc/tor-doc-osx.html
index de4262c1a3..868b85f7b8 100644
--- a/doc/tor-doc-osx.html
+++ b/doc/tor-doc-osx.html
@@ -67,26 +67,36 @@ configuration for Tor has been installed as part of the installer package.
 <a name="using"></a>
 <h2>Step Two: Configure your applications to use Tor</h2>
 
-<p>After installing Tor, you need to configure your applications to use
-it. The first step is to set up web browsing.
-Change your browser to HTTP proxy at localhost port 8118.
+<p>After installing Tor and Privoxy, you need to configure your
+applications to use them. The first step is to set up web browsing.</p>
+
+<p>If you're using Firefox (we recommend it), check out our <a
+href="tor-switchproxy.html">Tor SwitchProxy howto</a> to set up
+a plugin that makes it easy to switch between using Tor and using a
+direct connection.</p>
+
+<p>Otherwise, you need to manually configure your browser to HTTP proxy
+at localhost port 8118.
 (That's where Privoxy listens.)
 In Mozilla, this is in Mozilla|Preferences|Advanced|Proxies.
-In Firefox it's Firefox|Preferences|General|ConnectionSettings.
 You should set both your Web Proxy (HTTP) and your Secure Web Proxy
 (HTTPS or SSL) to localhost port 8118, to hide your SSL traffic too.
+You should consider configuring your "FTP Proxy" too; see <a
+href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#FtpProxy">this
+note</a> about Tor and ftp proxies.
+</p>
 
 <p>If you want to use Tor with Safari, you need to change your
 Network Settings. The process looks something like:</p>
 
-<img alt="LAN settings in IE"
+<img alt="Network settings"
 src="http://tor.eff.org/img/screenshot-osx-choose-network.png"
 border="1">
 
 <p>
 Select your Network Preferences from the Apple | Location menu.</p>
 
-<img alt="Proxy settings in IE"
+<img alt="Network preferences"
 src="http://tor.eff.org/img/screenshot-osx-choose-interface.png"
 border="1">
 <P>
@@ -95,12 +105,16 @@ border="1">
 more than one Interface you must change the proxy settings for each
 individually.</p>
 
-<img alt="Proxy settings in IE"
+<img alt="Proxy settings"
 src="http://tor.eff.org/img/screenshot-osx-proxy-settings.png"
 border="1">
 
-<p>Select and enter 127.0.0.1 and port 8118 for both Web Proxy (HTTP)
-and your Secure Web Proxy (HTTPS).  Leave your Use Passive FTP Mode (PASV) setting as is.</p>
+<p>Select and enter 127.0.0.1 and port 8118 for both
+Web Proxy (HTTP) and your Secure Web Proxy (HTTPS).
+You should consider clicking on "FTP Proxy" too; see <a
+href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#FtpProxy">this
+note</a> about Tor and ftp proxies. Leave your Use Passive FTP Mode
+(PASV) setting as is.</p>
 
 <p>Using privoxy is <strong>necessary</strong> because <a
 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#SOCKSAndDNS">browsers
@@ -109,48 +123,51 @@ DNS requests when they use a SOCKS proxy directly</a>, which is bad for
 your anonymity. Privoxy also removes certain dangerous headers from your
 web requests, and blocks obnoxious ad sites like Doubleclick.</p>
 
-<p>To test if it's working, you need to know your normal IP address
-so you can verify that the address really changes when running Tor.
-Your local IP address is shown by the <tt>ifconfig</tt> command.
-If you are behind a NAT/Firewall you can use one of the sites listed
-below to check which IP you are using.
-When that is done, start Tor and Privoxy and visit any of the sites again.
-If everything works, your IP address should have changed.
+<p>To Torify other applications that support HTTP proxies, just
+point them at Privoxy (that is, localhost port 8118). To use SOCKS
+directly (for instant messaging, Jabber, IRC, etc), you can point
+your application directly at Tor (localhost port 9050), but see <a
+href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#SOCKSAndDNS">this
+FAQ entry</a> for why this may be dangerous. For applications
+that support neither SOCKS nor HTTP, take a look at <a
+href="http://www.taiyo.co.jp/~gotoh/ssh/connect.html">connect</a> or
+<a href="http://www.dest-unreach.org/socat/">socat</a>.</p>
+
+<p>For information on how to Torify other applications, check out the
+<a href="http://wiki.noreply.org/wiki/TheOnionRouter/TorifyHOWTO">Torify
+HOWTO</a>.
 </p>
 
+<a name="verify"></a>
+<h2>Step Three: Make sure it's working</h2>
+
 <p>
-<!--<a href="http://peertech.org/privacy-knoppix/">peertech</a>, -->
 <a href="http://ipid.shat.net">ipid.shat.net</a> and
 <a href="http://www.showmyip.com/">showmyip.com</a>
-are sites that show your current IP so you can see
-what address and country you're coming from.
+are sites that show what IP address and country you appear to be coming
+from.
 </p>
 
-<p>
-If you have a personal firewall that limits your computer's ability
-to connect to itself, be sure to allow connections from your local
-applications to
-local port 8118 and port 9050. If your firewall blocks outgoing connections,
-punch a hole so it can connect to at least TCP ports 80, 443, and 9001-9033.
-For more troubleshooting suggestions, see <a
-href="http://wiki.noreply.org/wiki/TheOnionRouter/TorFAQ">the FAQ</a>.
+<p>If you don't know your current public IP address, this may not be a
+very useful test. To learn your IP address, run <tt>ifconfig</tt>.
+If you are behind a NAT or firewall, though, you won't be able
+to learn your public IP address. In this case, you should 1) configure
+your browser to connect directly (that is, stop using Privoxy), 2) check
+your IP address with one of the sites above, 3) point your browser back
+to Privoxy, and 4) see whether your IP address has changed.
 </p>
 
-<p>To Torify another application that supports HTTP, just point
-it at Privoxy (that is, localhost port 8118). To use SOCKS
-directly (for example, for instant messaging, Jabber, IRC, etc),
-point your application directly at Tor (localhost port 9050). For
-applications that support neither SOCKS nor HTTP, take a look at <a
-href="http://www.taiyo.co.jp/~gotoh/ssh/connect.html">connect</a> or
-<a href="http://www.dest-unreach.org/socat/">socat</a>.
-<br />
-For more information how to Torify other applications in detail visit
-the <a href="http://wiki.noreply.org/wiki/TheOnionRouter/TorifyHOWTO">Torify HOWTO</a>.
-<p>If you have suggestions for improving this document, please post
-them on <a href="http://bugs.noreply.org/tor">our bugtracker</a> in the
-website category. Thanks!</p>
+<p> If you have a personal firewall that limits your computer's
+ability to connect to itself, be sure to allow connections from
+your local applications to local port 8118 and port 9050. If
+your firewall blocks outgoing connections, punch a hole so
+it can connect to at least TCP ports 80 and 443, and then see <a
+href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#FirewalledClient">this
+FAQ entry</a>.
+</p>
 
-<h2>How To Uninstall</h2>
+<a name="uninstall"></a>
+<h2>How To Uninstall Tor and Privoxy</h2>
 
 <p>The Tor 0.1.0.x series does not come with an uninstaller; this feature
   will be added in the 0.1.1.x series.  If you want to remove Tor on OSX,
@@ -166,7 +183,8 @@ website category. Thanks!</p>
 
 <p>To erase all remaining Tor and Privoxy files from your computer, delete
   the following:
-   <ul><li>/Library/Tor</li>
+   <ul>
+   <li>/Library/Tor</li>
    <li>/Library/Privoxy</li>
    <li>/usr/bin/tor</li>
    <li>/usr/bin/tor_resolve</li>
@@ -177,6 +195,12 @@ website category. Thanks!</p>
   </ul>
 </p>
 
+<hr />
+
+<p>If you have suggestions for improving this document, please post
+them on <a href="http://bugs.noreply.org/tor">our bugtracker</a> in the
+website category. Thanks!</p>
+
 <p>$Id$</p>
 
 </body>
diff --git a/doc/tor-doc-win32.html b/doc/tor-doc-win32.html
index 6389913245..414ece83a8 100644
--- a/doc/tor-doc-win32.html
+++ b/doc/tor-doc-win32.html
@@ -66,8 +66,9 @@ src="http://tor.eff.org/img/screenshot-win32-dos-window.png" />
 
 <p>Tor comes configured as a client by default. It uses a built-in
 default configuration file, and most people won't need to change any of
-the settings. Tor is now installed. Close the Tor client for now by
-closing the cmd window.</p>
+the settings. Tor is now installed. <!--Close the Tor client for now by
+closing the cmd window.-->
+</p>
 
 <a name="privoxy"></a>
 <h2>Step Two: Install Privoxy for Web Browsing</h2>
@@ -80,8 +81,9 @@ The first step is to set up web browsing. Start by installing <a
 href="http://www.privoxy.org/">Privoxy</a> (click on 'recent releases',
 then scroll down to the MS Windows installer packages). Privoxy is a filtering
 web proxy that integrates well with Tor. Once it's installed, it should
-appear in your system tray as a "P" in a circle, as pictured below: Exit from
-Privoxy for now by right clicking on the "P" icon and finding the exit option.
+appear in your system tray as a "P" in a circle, as pictured below:
+<!-- Exit from
+Privoxy for now by right clicking on the "P" icon and finding the exit option.-->
 </p>
 
 <img alt="privoxy icon in the system tray"
@@ -111,8 +113,7 @@ order to stop this you will need to comment out two lines by inserting a
 <tt>logfile privoxy.log</tt><br>
 and the line <br>
 <tt>jarfile jar.log</tt><br>
-Be sure to save. You'll need to exit and restart Privoxy for the changes
-to take effect.
+Be sure to save.
 </p>
 
 <img border="1" alt="comment out logfile"
@@ -125,7 +126,8 @@ src="http://tor.eff.org/img/screenshot-win32-privoxy-edit-3.png" />
 
 <br>
 
-<p>Instructions for restarting Privoxy:</p>
+<p>You'll need to exit and restart Privoxy for the changes to take effect:
+</p>
 <ol>
 <li>Right click on the Privoxy systray icon and choose "Exit Privoxy".</li>
 <li>Left click on Start Menu then Programs then Privoxy.  Select the
@@ -136,70 +138,90 @@ tray again.</li>
 <a name="using"></a>
 <h2>Step Three: Configure your applications to use Tor</h2>
 
-<p>Then change your browser to HTTP proxy at localhost port 8118.
+<p>After installing Tor and Privoxy, you need to configure your
+applications to use them. The first step is to set up web browsing.</p>
+
+<p>If you're using Firefox (we recommend it), check out our <a
+href="tor-switchproxy.html">Tor SwitchProxy howto</a> to set up
+a plugin that makes it easy to switch between using Tor and using a
+direct connection.</p>
+
+<p>Otherwise, you need to manually configure your browser to HTTP proxy
+at localhost port 8118.
 (That's where Privoxy listens.)
-In Firefox it's Tools|Options|General|Connection Settings.
 In Mozilla, this is in Edit|Preferences|Advanced|Proxies.
 In Opera 7.5x it's Tools|Preferences|Network|Proxy servers.
 In IE, it's Tools|Internet Options|Connections|LAN Settings|Advanced.
-You should also set your SSL proxy (IE calls it "Secure") to the same
-thing, to hide your SSL traffic too. In IE, this looks something like:</p>
+You should click the "use the same proxy server for all protocols"
+button; but see <a
+href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#FtpProxy">this
+note</a> about Tor and ftp proxies.
+<!--You should also set your SSL proxy (IE calls it "Secure") to the same
+thing, to hide your SSL traffic too.--> In IE, this looks something like:</p>
 
-<img alt="LAN settings in IE"
-src="http://tor.eff.org/img/screenshot-win32-ie-lan.jpg" />
 <img alt="Proxy settings in IE"
 src="http://tor.eff.org/img/screenshot-win32-ie-proxies.jpg" />
 
 <p>Using privoxy is <strong>necessary</strong> because <a
 href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#SOCKSAndDNS">browsers
-leak your
-DNS requests when they use a SOCKS proxy directly</a>, which is bad for
-your anonymity. Privoxy also removes certain dangerous headers from your
-web requests, and blocks obnoxious ad sites like Doubleclick.</p>
+leak your DNS requests when they use a SOCKS proxy directly</a>, which
+is bad for your anonymity. Privoxy also removes certain dangerous
+headers from your web requests, and blocks obnoxious ad sites like
+Doubleclick.</p>
+
+<p>To Torify other applications that support HTTP proxies, just
+point them at Privoxy (that is, localhost port 8118). To use SOCKS
+directly (for instant messaging, Jabber, IRC, etc), you can point
+your application directly at Tor (localhost port 9050), but see <a
+href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#SOCKSAndDNS">this
+FAQ entry</a> for why this may be dangerous. For applications
+that support neither SOCKS nor HTTP, take a look at <a
+href="http://www.socks.permeo.com/Download/SocksCapDownload/index.asp">SocksCap</a>,
+<a href="http://www.freecap.ru/eng/">FreeCap</a>, or the <a
+href="http://www.hummingbird.com/products/nc/socks/index.html?cks=y">Hummingbird</a>
+SOCKS client. (FreeCap is free software; the others are proprietary.)</p>
 
-<p>To test if it's working, you need to know your normal IP address so you can
-verify that the address really changes when running Tor.
-Go to the Start menu, click Run and enter <tt>cmd</tt>.
-At the command prompt, enter <tt>ipconfig /a</tt>. If you are behind a NAT/Firewall/Router
-you can use one of the sites listed below to check which IP you are using.
-When that is done, clear your browser's cache, start Tor and Privoxy and visit any of the sites again.
-If everything works, your IP address should have changed.
+<p>For information on how to Torify other applications, check out the
+<a href="http://wiki.noreply.org/wiki/TheOnionRouter/TorifyHOWTO">Torify
+HOWTO</a>.
 </p>
 
+<a name="verify"></a>
+<h2>Step Four: Make sure it's working</h2>
+
 <p>
-<!--<a href="http://peertech.org/privacy-knoppix/">peertech</a>, -->
 <a href="http://ipid.shat.net">ipid.shat.net</a> and
 <a href="http://www.showmyip.com/">showmyip.com</a>
-are sites that show your current IP so you can see
-what address and country you're coming from.
+are sites that show what IP address and country you appear to be coming
+from.
 </p>
 
-<p>
-If you have a personal firewall that limits your computer's ability
-to connect to itself, be sure to allow connections from your local
-applications to
-local port 8118 and port 9050. If your firewall blocks outgoing connections,
-punch a hole so it can connect to at least TCP ports 80, 443, and 9001-9033.
-For more troubleshooting suggestions, see <a
-href="http://wiki.noreply.org/wiki/TheOnionRouter/TorFAQ">the FAQ</a>.
-</p>
-
-<p>To Torify another application that supports HTTP, just point it at Privoxy
-(that is, localhost port 8118). To use SOCKS directly (for example, for
-instant messaging, Jabber, IRC, etc), point your application directly at
-Tor (localhost port 9050). For applications that support neither SOCKS
-nor HTTP, take a look at <a
-href="http://www.socks.permeo.com/Download/SocksCapDownload/index.asp">SocksCap</a>,
-<a href="http://www.freecap.ru/eng/">FreeCap</a>,
-or the <a
-href="http://www.hummingbird.com/products/nc/socks/index.html?cks=y">Hummingbird</a>
-SOCKS client. (FreeCap is free software; the others are proprietary.)<br />
-For more information how to Torify other applications in detail visit
-the <a href="http://wiki.noreply.org/wiki/TheOnionRouter/TorifyHOWTO">Torify HOWTO</a>.
+<p>If you don't know your current public IP address, this may not be a
+very useful test. To learn your IP address, go to the Start menu, click
+Run and enter <tt>cmd</tt>. At the command prompt, enter <tt>ipconfig
+/a</tt>. If you are behind a NAT or firewall, though, you won't be able
+to learn your public IP address. In this case, you should 1) configure
+your browser to connect directly (that is, stop using Privoxy), 2) check
+your IP address with one of the sites above, 3) point your browser back
+to Privoxy, and 4) see whether your IP address has changed.
+</p>
 
-<p>If you have suggestions for improving this document, please <a
-href="mailto:tor-bugs@freehaven.net">send them to us</a>. Thanks!</p>
+<p> If you have a personal firewall that limits your computer's
+ability to connect to itself, be sure to allow connections from
+your local applications to local port 8118 and port 9050. If
+your firewall blocks outgoing connections, punch a hole so
+it can connect to at least TCP ports 80 and 443, and then see <a
+href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#FirewalledClient">this
+FAQ entry</a>.
+</p>
+
+<hr />
+
+<p>If you have suggestions for improving this document, please post
+them on <a href="http://bugs.noreply.org/tor">our bugtracker</a> in the
+website category. Thanks!</p>
 
 <p>$Id$</p>
 </body>
 </html>
+
diff --git a/doc/tor-switchproxy.html b/doc/tor-switchproxy.html
index 8df86ab6ed..0a690bf1a1 100644
--- a/doc/tor-switchproxy.html
+++ b/doc/tor-switchproxy.html
@@ -26,7 +26,6 @@ SwitchProxy works anywhere Firefox works. Hopefully everybody else can
 follow along just fine.</p>
 
 <hr />
-
 <a name="zero"></a>
 <h3>Step Zero: Download and Install Tor and Privoxy</h3>
 
@@ -43,7 +42,6 @@ one</a> of OS X Tor installation howto, since our OS X package includes
 Privoxy and configures it already.</p>
 
 <hr />
-
 <a name="one"></a>
 <h3>Step One: Download and Install SwitchProxy</h3>
 
@@ -66,17 +64,19 @@ src="http://tor.eff.org/img/screenshot-switchproxy-plugin-starting.jpg" />
 <p>Once the installer is finished, it will tell you that SwitchProxy
 will be working once you restart Firefox:</p>
 
+<p>Once the installer is finished, you should close all of your FireFox
+windows and restart the program.</p>
+
 <img alt="firefox plugin finished"
 src="http://tor.eff.org/img/screenshot-switchproxy-plugin-finished.jpg" />
 
 <hr />
-
 <a name="two"></a>
 <h3>Step Two: Configure SwitchProxy</h3>
 
-<p>Now restart your Firefox. You'll notice there's a new toolbar
+<p>When you restart Firefox, you'll notice there's a new toolbar
 that lets you control your proxies. Now we're going to set up a proxy
-configuration for Privoxy. Click on "add":</p>
+configuration for Tor. Click on "add" in the new Proxy toolbar:</p>
 
 <img alt="new toolbar"
 src="http://tor.eff.org/img/screenshot-switchproxy-toolbar.jpg" />
@@ -104,8 +104,7 @@ Click on the pull-down list and select tor, as shown here:</p>
 <img alt="switch to tor"
 src="http://tor.eff.org/img/screenshot-switchproxy-switch.jpg" />
 
-<p>Almost done. It may look like you're using Tor now, but you need to
-click "Apply" to make your change take effect:</p>
+<p>Almost done. Click "Apply" to make your change take effect:</p>
 
 <img alt="apply"
 src="http://tor.eff.org/img/screenshot-switchproxy-apply.jpg" />
@@ -119,6 +118,18 @@ to get a German exit node</a>:</p>
 src="http://tor.eff.org/img/screenshot-switchproxy-german.jpg" />
 
 <hr />
+<a name="two"></a>
+<h3>Step Three: Check if it works</h3>
+
+<p>In the above example, it was clear that it worked because the web
+page showed up in a different language. To be more certain, though,
+you'll want to verify that your Tor is working. Do
+<a href="http://tor.eff.org/doc/tor-doc-win32.html#verify">step four</a>
+of the Windows Tor installation howto, or
+<a href="http://tor.eff.org/doc/tor-doc-osx.html#verify">step three</a>
+of the OS X Tor installation howto.</p>
+
+<hr />
 
 <p>If you have suggestions for improving this document, please <a
 href="mailto:tor-bugs@freehaven.net">send them to us</a>. Thanks!</p>