docs(man): add save and replay examples#35
Merged
Conversation
The SAVED SESSIONS section and OPTIONS entries for --save/--replay landed in #32, but the EXAMPLES section only covered pcap/mitm/TUI-filter usage. Add three examples mirroring the README so the manpage stands alone: tapgres --save session.jsonl tapgres --replay session.jsonl --tui tapgres --replay session.jsonl -Y 'message.type == "Query"'
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds save/replay usage to the EXAMPLES section of the manpage. The SAVED
SESSIONS prose and the
--save/--replayOPTIONS entries already landed in#32, but the EXAMPLES section only covered pcap/mitm/TUI-filter usage.
Why
So the manpage is self-contained and matches the README, which already shows
--saveand--replayinvocations.Changes
man/sections.md— three new examples (pandoc → roff viagen_manpage):tapgres --save session.jsonl— tee every decoded record to versioned JSONLtapgres --replay session.jsonl --tui— reopen a saved session in the TUItapgres --replay session.jsonl -Y 'message.type == "Query"'— replay through a display filterVerification
man/tapgres.1(git-ignored, produced at packaging time).man --warnings -l man/tapgres.1→ 0 warnings.Notes
man/tapgres.1is git-ignored and rebuilt fromman/sections.md+ clapdoc-comments by
examples/gen_manpage.rs(seeflake.nix:70-72), so this isthe only source file that needs to change.