aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@corte.si>2018-05-15 10:34:55 +1200
committerAldo Cortesi <aldo@corte.si>2018-05-15 10:34:55 +1200
commit2db223decbf2aecb80aa3adc96643e84100bbb22 (patch)
tree219b177da9b95c1e99a8ce658fbdd9c34bdeda51 /docs
parentfe4c371001c0c9f1895e3ed6dea7506617b5e3cb (diff)
downloadmitmproxy-2db223decbf2aecb80aa3adc96643e84100bbb22.tar.gz
mitmproxy-2db223decbf2aecb80aa3adc96643e84100bbb22.tar.bz2
mitmproxy-2db223decbf2aecb80aa3adc96643e84100bbb22.zip
docs: console key binding docs and example
Diffstat (limited to 'docs')
-rw-r--r--docs/src/content/tools-mitmproxy.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/src/content/tools-mitmproxy.md b/docs/src/content/tools-mitmproxy.md
index 6505fac4..d3f05aef 100644
--- a/docs/src/content/tools-mitmproxy.md
+++ b/docs/src/content/tools-mitmproxy.md
@@ -16,3 +16,21 @@ kept in memory, which means that it's intended for taking and manipulating
small-ish samples. Use the `?` shortcut key to view, context-sensitive
documentation from any **mitmproxy** screen.
+### Key binding configuration
+
+Mitmproxy's key bindings can be customized through in the
+`~/.mitmproxy/keys.yaml` file. This file consists of a sequence of maps, with
+the following keys:
+
+* `key` (**mandatory**): The key to bind.
+* `cmd` (**mandatory**): The command to execute when the key is pressed.
+* `context`: A list of contexts in which the key should be bound. By default this is **global** (i.e. the key is bound everywhere). Valid contexts are `chooser`, `commands`, `dataviewer`, `eventlog`, `flowlist`, `flowview`, `global`, `grideditor`, `help`, `keybindings`, `options`.
+* `help`: A help string for the binding which will be shown in the key binding browser.
+
+#### Example
+
+{{< example src="examples/keys.yaml" lang="yaml" >}}
+
+
+
+