From 29ef663aa10a2cef5e6e1d310848d888d0d8e379 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Tue, 20 Feb 2018 17:14:21 +0100 Subject: add documentation for custom_option.py --- examples/simple/custom_option.py | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'examples/simple/custom_option.py') 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 -- cgit v1.2.3