aboutsummaryrefslogtreecommitdiffstats
path: root/docs/features
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2016-06-06 19:08:46 -0700
committerMaximilian Hils <git@maximilianhils.com>2016-06-06 19:10:19 -0700
commit83f852298132ef6c3757cdc10a34f237a2df33ab (patch)
tree891a880b85d8ca06ffb07405464fd0c5745d78b7 /docs/features
parent9a1cc166434a505a18e48501d96cb0081601f99e (diff)
downloadmitmproxy-83f852298132ef6c3757cdc10a34f237a2df33ab.tar.gz
mitmproxy-83f852298132ef6c3757cdc10a34f237a2df33ab.tar.bz2
mitmproxy-83f852298132ef6c3757cdc10a34f237a2df33ab.zip
docs: remove option directive
inserting " .. option::" tags create ugly markup, so we just ditch this entirely and continue using refs.
Diffstat (limited to 'docs/features')
-rw-r--r--docs/features/anticache.rst4
-rw-r--r--docs/features/clientreplay.rst6
-rw-r--r--docs/features/passthrough.rst10
-rw-r--r--docs/features/proxyauth.rst10
-rw-r--r--docs/features/replacements.rst10
-rw-r--r--docs/features/responsestreaming.rst6
-rw-r--r--docs/features/reverseproxy.rst6
-rw-r--r--docs/features/serverreplay.rst10
-rw-r--r--docs/features/setheaders.rst6
-rw-r--r--docs/features/socksproxy.rst6
-rw-r--r--docs/features/sticky.rst4
-rw-r--r--docs/features/tcpproxy.rst2
-rw-r--r--docs/features/upstreamcerts.rst6
-rw-r--r--docs/features/upstreamproxy.rst6
14 files changed, 46 insertions, 46 deletions
diff --git a/docs/features/anticache.rst b/docs/features/anticache.rst
index 65d22bab..411b284b 100644
--- a/docs/features/anticache.rst
+++ b/docs/features/anticache.rst
@@ -2,7 +2,7 @@
Anticache
=========
-When the :option:`--anticache` option is passed to mitmproxy, it removes headers
+When the ``--anticache`` option is passed to mitmproxy, it removes headers
(``if-none-match`` and ``if-modified-since``) that might elicit a
``304 not modified`` response from the server. This is useful when you want to make
sure you capture an HTTP exchange in its totality. It's also often used during
@@ -10,6 +10,6 @@ sure you capture an HTTP exchange in its totality. It's also often used during
================== ======================
-command-line :option:`--anticache`
+command-line ``--anticache``
mitmproxy shortcut :kbd:`o` then :kbd:`a`
================== ======================
diff --git a/docs/features/clientreplay.rst b/docs/features/clientreplay.rst
index b0eb6792..50740bcf 100644
--- a/docs/features/clientreplay.rst
+++ b/docs/features/clientreplay.rst
@@ -12,7 +12,7 @@ conversation, where requests may have been made concurrently.
You may want to use client-side replay in conjunction with the
:ref:`anticache` option, to make sure the server responds with complete data.
-================== =================
-command-line :option:`-c path`
+================== ===========
+command-line ``-c path``
mitmproxy shortcut :kbd:`c`
-================== =================
+================== ===========
diff --git a/docs/features/passthrough.rst b/docs/features/passthrough.rst
index b7b5df84..ea628dad 100644
--- a/docs/features/passthrough.rst
+++ b/docs/features/passthrough.rst
@@ -20,10 +20,10 @@ take a look at the :ref:`responsestreaming` feature.
How it works
------------
-================== =============================
-command-line :option:`--ignore regex`
+================== ======================
+command-line ``--ignore regex``
mitmproxy shortcut :kbd:`o` then :kbd:`I`
-================== =============================
+================== ======================
mitmproxy allows you to specify a regex which is matched against a ``host:port`` string
@@ -32,7 +32,7 @@ mitmproxy allows you to specify a regex which is matched against a ``host:port``
There are two important quirks to consider:
- **In transparent mode, the ignore pattern is matched against the IP and ClientHello SNI host.** While we usually infer the
- hostname from the Host header if the :option:`--host` argument is passed to mitmproxy, we do not
+ hostname from the Host header if the ``--host`` argument is passed to mitmproxy, we do not
have access to this information before the SSL handshake. If the client uses SNI however, then we treat the SNI host as an ignore target.
- In regular mode, explicit HTTP requests are never ignored. [#explicithttp]_ The ignore pattern is
applied on CONNECT requests, which initiate HTTPS or clear-text WebSocket connections.
@@ -42,7 +42,7 @@ Tutorial
If you just want to ignore one specific domain, there's usually a bulletproof method to do so:
-1. Run mitmproxy or mitmdump in verbose mode (:option:`-v`) and observe the ``host:port``
+1. Run mitmproxy or mitmdump in verbose mode (``-v``) and observe the ``host:port``
information in the serverconnect messages. mitmproxy will filter on these.
2. Take the ``host:port`` string, surround it with ^ and $, escape all dots (. becomes \\.)
and use this as your ignore pattern:
diff --git a/docs/features/proxyauth.rst b/docs/features/proxyauth.rst
index bfd32fbd..afdbb639 100644
--- a/docs/features/proxyauth.rst
+++ b/docs/features/proxyauth.rst
@@ -10,8 +10,8 @@ upstream servers. For now, only HTTP Basic authentication is supported. The
proxy auth options are not compatible with the transparent, socks or reverse proxy
mode.
-================== =============================
-command-line :option:`--nonanonymous`,
- :option:`--singleuser USER`,
- :option:`--htpasswd PATH`
-================== =============================
+================== ======================
+command-line ``--nonanonymous``,
+ ``--singleuser USER``,
+ ``--htpasswd PATH``
+================== ======================
diff --git a/docs/features/replacements.rst b/docs/features/replacements.rst
index 8f760866..b4643dd2 100644
--- a/docs/features/replacements.rst
+++ b/docs/features/replacements.rst
@@ -54,7 +54,7 @@ So, you might start **mitmdump** as follows:
This will load the replacement text from the file ``~/xss-exploit``.
-Both the :option:`--replace` and :option:`--replace-from-file` flags can be passed multiple
+Both the ``--replace`` and ``--replace-from-file`` flags can be passed multiple
times.
@@ -65,8 +65,8 @@ The :kbd:`R` shortcut key in the mitmproxy options menu (:kbd:`o`) lets you add
replacement hooks using a built-in editor. The context-sensitive help (:kbd:`?`) has
complete usage information.
-================== =============================
-command-line :option:`--replace`,
- :option:`--replace-from-file`
+================== =======================
+command-line ``--replace``,
+ ``--replace-from-file``
mitmproxy shortcut :kbd:`o` then :kbd:`R`
-================== =============================
+================== =======================
diff --git a/docs/features/responsestreaming.rst b/docs/features/responsestreaming.rst
index 9dc27bf4..66b5cae0 100644
--- a/docs/features/responsestreaming.rst
+++ b/docs/features/responsestreaming.rst
@@ -19,9 +19,9 @@ On the command-line
Streaming can be enabled on the command line for all response bodies exceeding a certain size.
The SIZE argument understands k/m/g suffixes, e.g. 3m for 3 megabytes.
-================== =============================
-command-line :option:`--stream SIZE`
-================== =============================
+================== =================
+command-line ``--stream SIZE``
+================== =================
.. warning::
diff --git a/docs/features/reverseproxy.rst b/docs/features/reverseproxy.rst
index 87065e73..86a5b2e4 100644
--- a/docs/features/reverseproxy.rst
+++ b/docs/features/reverseproxy.rst
@@ -7,9 +7,9 @@ In reverse proxy mode, mitmproxy accepts standard HTTP(S) requests and forwards
them to the specified upstream server. This is in contrast to :ref:`upstreamproxy`, in which
mitmproxy forwards HTTP(S) proxy requests to an upstream proxy server.
-================== =====================================
-command-line :option:`-R http[s]://hostname[:port]`
-================== =====================================
+================== ================================
+command-line ``-R http[s]://hostname[:port]``
+================== ================================
Here, **http[s]** signifies if the proxy should use TLS to connect to the server.
mitmproxy always accepts both encrypted and unencrypted requests and transforms
diff --git a/docs/features/serverreplay.rst b/docs/features/serverreplay.rst
index 261a1bd6..d70b6514 100644
--- a/docs/features/serverreplay.rst
+++ b/docs/features/serverreplay.rst
@@ -13,7 +13,7 @@ By default, :program:`mitmproxy` excludes request headers when matching incoming
requests with responses from the replay file. This works in most circumstances,
and makes it possible to replay server responses in situations where request
headers would naturally vary, e.g. using a different user agent.
-The :option:`--rheader headername` command-line option allows you to override
+The ``--rheader headername`` command-line option allows you to override
this behaviour by specifying individual headers that should be included in matching.
@@ -30,10 +30,10 @@ recording. So, if they were in the past at the time of recording, they will be
in the past at the time of replay, and vice versa. Cookie expiry times are
updated in a similar way.
-You can turn off response refreshing using the :option:`--norefresh` argument, or using
+You can turn off response refreshing using the ``--norefresh`` argument, or using
the :kbd:`o` options shortcut within :program:`mitmproxy`.
-================== =================
-command-line :option:`-S path`
+================== ===========
+command-line ``-S path``
mitmproxy shortcut :kbd:`S`
-================== =================
+================== ===========
diff --git a/docs/features/setheaders.rst b/docs/features/setheaders.rst
index cbc8b6a5..aa991bf4 100644
--- a/docs/features/setheaders.rst
+++ b/docs/features/setheaders.rst
@@ -13,7 +13,7 @@ Example: Set the **Host** header to "example.com" for all requests.
mitmdump -R http://example.com --setheader :~q:Host:example.com
-================== =============================
-command-line :option:`--setheader PATTERN`
+================== =======================
+command-line ``--setheader PATTERN``
mitmproxy shortcut :kbd:`o` then :kbd:`H`
-================== =============================
+================== =======================
diff --git a/docs/features/socksproxy.rst b/docs/features/socksproxy.rst
index 76d4cda9..e1686f45 100644
--- a/docs/features/socksproxy.rst
+++ b/docs/features/socksproxy.rst
@@ -5,6 +5,6 @@ SOCKS Mode
In this mode, mitmproxy acts as a SOCKS5 proxy server.
-================== =================
-command-line :option:`--socks`
-================== =================
+================== ===========
+command-line ``--socks``
+================== ===========
diff --git a/docs/features/sticky.rst b/docs/features/sticky.rst
index a79cbe8d..7be5f842 100644
--- a/docs/features/sticky.rst
+++ b/docs/features/sticky.rst
@@ -21,7 +21,7 @@ record the authentication process once, and simply replay it on startup every ti
to interact with the secured resources.
================== ======================
-command-line :option:`-t FILTER`
+command-line ``-t FILTER``
mitmproxy shortcut :kbd:`o` then :kbd:`t`
================== ======================
@@ -36,6 +36,6 @@ authentication through the proxy. Note that :program:`mitmproxy` doesn't (yet) s
replay of HTTP Digest authentication.
================== ======================
-command-line :option:`-u FILTER`
+command-line ``-u FILTER``
mitmproxy shortcut :kbd:`o` then :kbd:`A`
================== ======================
diff --git a/docs/features/tcpproxy.rst b/docs/features/tcpproxy.rst
index fd0746a2..1d6fbd12 100644
--- a/docs/features/tcpproxy.rst
+++ b/docs/features/tcpproxy.rst
@@ -18,7 +18,7 @@ How it works
------------
================== ======================
-command-line :option:`--tcp HOST`
+command-line ``--tcp HOST``
mitmproxy shortcut :kbd:`o` then :kbd:`T`
================== ======================
diff --git a/docs/features/upstreamcerts.rst b/docs/features/upstreamcerts.rst
index af2e2226..d2a82ca2 100644
--- a/docs/features/upstreamcerts.rst
+++ b/docs/features/upstreamcerts.rst
@@ -17,7 +17,7 @@ certs in transparent mode.
Upstream cert sniffing is on by default, and can optionally be turned off.
-================== =============================
-command-line :option:`--no-upstream-cert`
+================== ======================
+command-line ``--no-upstream-cert``
mitmproxy shortcut :kbd:`o` then :kbd:`U`
-================== =============================
+================== ======================
diff --git a/docs/features/upstreamproxy.rst b/docs/features/upstreamproxy.rst
index e06833c2..a4ccf57f 100644
--- a/docs/features/upstreamproxy.rst
+++ b/docs/features/upstreamproxy.rst
@@ -7,6 +7,6 @@ In this mode, mitmproxy accepts proxy requests and unconditionally forwards all
requests to a specified upstream proxy server. This is in contrast to :ref:`reverseproxy`,
in which mitmproxy forwards ordinary HTTP requests to an upstream server.
-================== ===================================
-command-line :option:`-U http://hostname[:port]`
-================== ===================================
+================== =============================
+command-line ``-U http://hostname[:port]``
+================== =============================