mirror of
https://oauth2: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@github.com/m1ngsama/TNT.git
synced 2026-06-26 09:14:38 +08:00
docs: refresh module quick reference
This commit is contained in:
parent
f39f07b205
commit
cd170d3245
3 changed files with 26 additions and 9 deletions
11
README.md
11
README.md
|
|
@ -248,11 +248,16 @@ sudo dnf install libssh-devel
|
||||||
TNT/
|
TNT/
|
||||||
├── src/ # source code
|
├── src/ # source code
|
||||||
│ ├── main.c # entry point
|
│ ├── main.c # entry point
|
||||||
|
│ ├── cli_text.c # startup CLI help and option text
|
||||||
│ ├── ssh_server.c # SSH server implementation
|
│ ├── ssh_server.c # SSH server implementation
|
||||||
|
│ ├── bootstrap.c # SSH authentication and session bootstrap
|
||||||
│ ├── chat_room.c # chat room logic
|
│ ├── chat_room.c # chat room logic
|
||||||
│ ├── message.c # message persistence
|
│ ├── message.c # message persistence
|
||||||
│ ├── history_view.c # message viewport and scroll state
|
│ ├── history_view.c # message viewport and scroll state
|
||||||
│ ├── support.c # quick support guide content
|
│ ├── help_text.c # full-screen and command help content
|
||||||
|
│ ├── support_text.c # quick support guide content
|
||||||
|
│ ├── i18n.c # language selection and shared UI text
|
||||||
|
│ ├── ratelimit.c # connection limits and rate limiting
|
||||||
│ ├── tui.c # terminal UI rendering
|
│ ├── tui.c # terminal UI rendering
|
||||||
│ ├── tui_status.c # status/input line rendering
|
│ ├── tui_status.c # status/input line rendering
|
||||||
│ └── utf8.c # UTF-8 character handling
|
│ └── utf8.c # UTF-8 character handling
|
||||||
|
|
@ -382,8 +387,8 @@ logged to stderr with the offending IP.
|
||||||
### Idle disconnect
|
### Idle disconnect
|
||||||
|
|
||||||
After `TNT_IDLE_TIMEOUT` seconds (default 1800 = 30 min) of no
|
After `TNT_IDLE_TIMEOUT` seconds (default 1800 = 30 min) of no
|
||||||
keystrokes, TNT prints `Disconnected: idle timeout (N min)` and closes
|
keystrokes, TNT prints a localized idle-timeout notice and closes the
|
||||||
the channel. Set the env var to `0` to disable.
|
channel. Set the env var to `0` to disable.
|
||||||
|
|
||||||
## Known Limitations
|
## Known Limitations
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -53,6 +53,8 @@
|
||||||
`host_key` / `messages.log` into the test directory.
|
`host_key` / `messages.log` into the test directory.
|
||||||
- Added `make security-test` and `make ci-test` so local runs can use the same
|
- Added `make security-test` and `make ci-test` so local runs can use the same
|
||||||
full verification path as GitHub Actions.
|
full verification path as GitHub Actions.
|
||||||
|
- Refreshed README and quick-reference module maps to match the current
|
||||||
|
`cli_text`, `help_text`, `support_text`, i18n, exec, and rate-limit modules.
|
||||||
- NORMAL mode now opens at the latest visible messages instead of the oldest
|
- NORMAL mode now opens at the latest visible messages instead of the oldest
|
||||||
in-memory message. Use `k`/PageUp to browse older history and `G`/End to
|
in-memory message. Use `k`/PageUp to browse older history and `G`/End to
|
||||||
return to the latest messages.
|
return to the latest messages.
|
||||||
|
|
|
||||||
|
|
@ -9,8 +9,11 @@ BUILD
|
||||||
make clean remove artifacts
|
make clean remove artifacts
|
||||||
|
|
||||||
TEST
|
TEST
|
||||||
./test_basic.sh basic functionality
|
make test strict unit + integration tests
|
||||||
./test_stress.sh 20 60 stress test (20 clients, 60s)
|
make test-advisory unit tests + advisory integration checks
|
||||||
|
make connection-limit-test per-IP concurrency/rate-limit checks
|
||||||
|
make security-test security feature checks
|
||||||
|
make ci-test same checks as GitHub Actions
|
||||||
|
|
||||||
DEBUG
|
DEBUG
|
||||||
ASAN_OPTIONS=detect_leaks=1 ./tnt
|
ASAN_OPTIONS=detect_leaks=1 ./tnt
|
||||||
|
|
@ -39,12 +42,19 @@ INSERT MODE
|
||||||
|
|
||||||
STRUCTURE
|
STRUCTURE
|
||||||
src/main.c entry, signals
|
src/main.c entry, signals
|
||||||
src/ssh_server.c SSH, threads, commands
|
src/cli_text.c startup CLI text
|
||||||
src/chat_room.c broadcast
|
src/ssh_server.c SSH listener and server setup
|
||||||
|
src/bootstrap.c SSH auth/session bootstrap
|
||||||
|
src/chat_room.c broadcast and room state
|
||||||
|
src/commands.c COMMAND-mode command dispatch
|
||||||
|
src/exec.c SSH exec command dispatch
|
||||||
src/message.c persistence, search
|
src/message.c persistence, search
|
||||||
src/history_view.c message viewport / scroll state
|
src/history_view.c message viewport / scroll state
|
||||||
src/support.c quick support guide content
|
src/help_text.c full-screen and command help text
|
||||||
src/tui.c rendering, help
|
src/support_text.c quick support guide content
|
||||||
|
src/i18n.c language selection and shared text
|
||||||
|
src/ratelimit.c connection limits and rate limiting
|
||||||
|
src/tui.c rendering
|
||||||
src/tui_status.c status/input line rendering
|
src/tui_status.c status/input line rendering
|
||||||
src/utf8.c unicode
|
src/utf8.c unicode
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue