Skip to content

Commit

Permalink
[doc] config documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
asciimoo committed Feb 17, 2017
1 parent 0568b27 commit ee71867
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,29 @@ $ go get github.com/asciimoo/wuzz
$ "$GOPATH/bin/wuzz" --help
```


### Configuration

It is possible to override default settings in a configuration file.
The default location is `"$XDG_CONFIG_HOME/wuzz/config.toml"`on linux
and `~/.wuzz/config.toml` on other platforms.
`-c`/`--config` switches can be used to load config file from custom location.

See [example configuration](sample-config.toml) for more details.


### Commands

Keybinding | Description
----------------------------------------|---------------------------------------
<kbd>F1</kbd> | Display help
<kbd>Ctrl+R</kbd> | Send request
<kbd>Ret</kbd> | Send request (only from URL view)
<kbd>Ctrl+S</kbd> | Save response
<kbd>Ctrl+C</kbd> | Quit
<kbd>Ctrl+K</kbd>, <kbd>Shift+Tab</kbd> | Previous view
<kbd>Ctlr+J</kbd>, <kbd>Tab</kbd> | Next view
<kbd>Ctrl+H</kbd>, <kbd>Alt+H</kbd> | Toggle history
<kbd>Alt+H</kbd> | Toggle history
<kbd>Down</kbd> | Move down one view line
<kbd>Up</kbd> | Move up one view line
<kbd>Page down</kbd> | Move down one view page
Expand All @@ -53,4 +65,5 @@ Keybinding | Description

## Bugs

Bugs or suggestions? Visit the [issue tracker](https://github.com/asciimoo/wuzz/issues).
Bugs or suggestions? Visit the [issue tracker](https://github.com/asciimoo/wuzz/issues)
or join `#wuzz` on freenode
24 changes: 24 additions & 0 deletions sample-config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,27 @@ defaultURLScheme = "https"
formatJSON = true
preserveScrollPosition = true
insecure = false

# KEYBINDINGS
[keys.global]
CtrlH = "submit"
CtrlW = "save"
CtrlN = "nextView"
CtrlP = "prevView"
AltEnter = "history"

[keys.search]
Tab = "focus url"

[keys.url]
Tab = "focus search"

[keys.response-body]
j = "scrollDown"
k = "scrollUp"
J = "pageDown"
K = "pageUp"

[keys.response-headers]
j = "pageDown"
k = "pageUp"

0 comments on commit ee71867

Please sign in to comment.