Skip to content

Commit

Permalink
A few minor updates to the user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
gcla committed Jan 9, 2021
1 parent 88f0374 commit 547b3a6
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Termshark is inspired by Wireshark, and depends on tshark for all its intelligen

```console
$ termshark -h
termshark v2.1.1
termshark v2.2.0

A wireshark-inspired terminal user interface for tshark. Analyze network traffic interactively from your terminal.
See https://termshark.io for more information.
Expand Down Expand Up @@ -334,6 +334,7 @@ Many of termshark's operations can be initiated from the command-line. After ope
- **logs** - Show termshark's log file (Unix-only)
- **map** - Map a keypress to a key sequence (see `help map`)
- **marks** - Show file-local and global packet marks
- **no-theme** - Clear theme for the current terminal color mode
- **quit** - Quit termshark
- **recents** - Load a pcap from those recently-used
- **set** - Set various config properties (see `help set`)
Expand All @@ -344,6 +345,25 @@ Many of termshark's operations can be initiated from the command-line. After ope
Some commands require a parameter or more. Candidate completions will be shown when possible; you can then scroll up or down through them and hit tab
or enter to complete the candidate. Candidates are filtered as you type. Hit enter to run a valid command or hit `ctrl-c` to close the command-line.

### Vim Navigation

Termshark lets you navigate the UI using familiar Vim key bindings and tries to apply other Vim concepts where it makes sense. All tabular views
support Vim's `hjkl` navigation keys. Here is a list of other Vim-style bindings:

- **gg** - Go to the top of the current table
- **G** - Go to the bottom of the current table
- **5gg** - Go to the 5th row of the table
- **C-w C-w** - Switch panes (same as tab)
- **C-w =** - Equalize pane spacing
- **ma** - Mark current packet (use a through z)
- **'a** - Jump to packet marked 'a'
- **mA** - Mark current packet + pcap (use A through Z)
- **'A** - Jump to packet + pcap marked 'A'
- **''** - After a jump; jump back to prior packet
- **ZZ** - Quit without confirmation

The command-line supports some Vim shortcuts too e.g. `:q!` to quit immediately.

### Macros

To support navigational shortcuts that are not directly built-in to the termshark UI, you can now create simple keyboard macros. These are modeled on
Expand Down

0 comments on commit 547b3a6

Please sign in to comment.