From 2db223decbf2aecb80aa3adc96643e84100bbb22 Mon Sep 17 00:00:00 2001 From: Aldo Cortesi Date: Tue, 15 May 2018 10:34:55 +1200 Subject: docs: console key binding docs and example --- docs/src/content/tools-mitmproxy.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'docs/src') 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" >}} + + + + -- cgit v1.2.3