aboutsummaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2018-02-20 17:14:21 +0100
committerGitHub <noreply@github.com>2018-02-20 17:14:21 +0100
commit29ef663aa10a2cef5e6e1d310848d888d0d8e379 (patch)
treea607124a1af4d6c388820e9026ff5750ea8ede94 /examples
parent1d23d50a9d1f4d4c864aa982df3274e344aa0a46 (diff)
downloadmitmproxy-29ef663aa10a2cef5e6e1d310848d888d0d8e379.tar.gz
mitmproxy-29ef663aa10a2cef5e6e1d310848d888d0d8e379.tar.bz2
mitmproxy-29ef663aa10a2cef5e6e1d310848d888d0d8e379.zip
add documentation for custom_option.py
Diffstat (limited to 'examples')
-rw-r--r--examples/simple/custom_option.py10
1 files changed, 10 insertions, 0 deletions
diff --git a/examples/simple/custom_option.py b/examples/simple/custom_option.py
index 5b6070dd..8d0cfe7f 100644
--- a/examples/simple/custom_option.py
+++ b/examples/simple/custom_option.py
@@ -1,3 +1,13 @@
+"""
+This example shows how addons can register custom options
+that can be configured at startup or during execution
+from the options dialog within mitmproxy.
+
+Example:
+
+$ mitmproxy --set custom=true
+$ mitmproxy --set custom # shorthand for boolean options
+"""
from mitmproxy import ctx