Skip to content

Commit

Permalink
More documentation updates for upcoming v2.4
Browse files Browse the repository at this point in the history
  • Loading branch information
gcla committed Jul 3, 2022
1 parent f48fcfd commit 8d23c3d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Termshark
A terminal user-interface for tshark, inspired by Wireshark.

**V2.3 is out now with custom columns, magic wormhole and more! See the [ChangeLog](CHANGELOG.md#changelog).**
**V2.4 is out now with packet search and profiles! See the [ChangeLog](CHANGELOG.md#changelog).**

![demo21](/../gh-pages/images/demo21.png?raw=true)

Expand Down
10 changes: 9 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Termshark is inspired by Wireshark, and depends on tshark for all its intelligen

```console
$ termshark -h
termshark v2.3.0
termshark v2.4.0

A wireshark-inspired terminal user interface for tshark. Analyze network traffic interactively from your terminal.
See https://termshark.io for more information.
Expand All @@ -59,6 +59,7 @@ Application Options:
-f=<capture filter> Apply capture filter.
-t=<timestamp format>[a|ad|adoy|d|dd|e|r|u|ud|udoy] Set the format of the packet timestamp printed in summary lines.
--tty=<tty> Display the UI on this terminal.
-C, --profile=<profile> Start with this configuration profile.
--pass-thru=[auto|true|false] Run tshark instead (auto => if stdout is not a tty). (default: auto)
--log-tty Log to the terminal.
-h, --help Show this help message.
Expand Down Expand Up @@ -517,6 +518,13 @@ determines it needs to regenerate parts of the UI e.g. if packet colors or colum
currently using profile "old", the settings for "new" are initialized from "old" (the toml file is copied); but then further changes apply to profile
"new" only.

Note that some configuration settings are read only from the default profile. These include

- `main.term` - termshark will launch on this tty (Unix-only)




### Dark Mode

If termshark is too bright for your taste, try dark-mode. To enable, hit Esc to open the main menu and select "Toggle Dark Mode".
Expand Down
2 changes: 1 addition & 1 deletion version.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

package termshark

var Version string = "v2.3.0+"
var Version string = "v2.4.0"

//======================================================================
// Local Variables:
Expand Down

0 comments on commit 8d23c3d

Please sign in to comment.