README: show the launcher forms in the Usage capture modes

The Usage server section only showed the console script and mentioned the
launchers in prose.  It now lists the three capture modes for ./start.sh
(Linux/macOS) and start.bat (Windows) right after the console-script block,
with the pass-through example (--port).
This commit is contained in:
catarrh committed 2026-10-27 11:08:11 +03:00
1 parent f18a11edaf
commit 7801c62ca3
2 files changed
+44 -6

No files matched your search

+23 -4
View File
@@ -127,10 +127,8 @@ in [Usage](#usage) below.
Stores captured APDU traffic in SQLite and serves it over HTTP, together with Stores captured APDU traffic in SQLite and serves it over HTTP, together with
the bundled **SIMtrace Analyser** frontend (`frontend/` in a source checkout, the bundled **SIMtrace Analyser** frontend (`frontend/` in a source checkout,
bundled into the package on install) on the same origin. The commands below bundled into the package on install) on the same origin. Three capture
use the console script; from a source checkout the launchers take the same modes:
options (`./start.sh --capture gsmtap`, `start.bat --capture gsmtap`). Three
capture modes:
```sh ```sh
# Listen for GSMTAP from simtrace2-pysniff (or original simtrace2-sniff): # Listen for GSMTAP from simtrace2-pysniff (or original simtrace2-sniff):
@@ -143,6 +141,27 @@ simtrace-analyser-server --capture direct
simtrace-analyser-server --capture disabled simtrace-analyser-server --capture disabled
``` ```
From a source checkout or the runtime zip, the launchers run the same server
with the same options.
Linux/macOS:
```sh
./start.sh --capture gsmtap
./start.sh --capture direct
./start.sh --capture disabled
```
Windows:
```bat
start.bat --capture gsmtap
start.bat --capture direct
start.bat --capture disabled
```
Options pass through unchanged (`./start.sh --capture direct --port 8080`).
The server logs its capture liveness to stderr (each line timestamped The server logs its capture liveness to stderr (each line timestamped
with the local time): `Capture started` on begin, a periodic with the local time): `Capture started` on begin, a periodic
`Capture alive: session=N messages=M bytes=B dropped=D` heartbeat, and `Capture alive: session=N messages=M bytes=B dropped=D` heartbeat, and
+21 -2
View File
@@ -131,8 +131,6 @@ simtrace-analyser-server --capture gsmtap
Сохраняет захваченный APDU-трафик в SQLite и отдаёт его по HTTP вместе Сохраняет захваченный APDU-трафик в SQLite и отдаёт его по HTTP вместе
со встроенным фронтендом **SIMtrace Analyser** (`frontend/` в исходном клоне, при со встроенным фронтендом **SIMtrace Analyser** (`frontend/` в исходном клоне, при
установке — внутри пакета) на том же origin. установке — внутри пакета) на том же origin.
Команды ниже — консольная команда; при запуске из клона скрипты принимают те
же параметры (`./start.sh --capture gsmtap`, `start.bat --capture gsmtap`).
Три режима захвата: Три режима захвата:
```sh ```sh
@@ -146,6 +144,27 @@ simtrace-analyser-server --capture direct
simtrace-analyser-server --capture disabled simtrace-analyser-server --capture disabled
``` ```
При запуске из клона или рабочего zip те же режимы доступны через скрипты
запуска.
Linux/macOS:
```sh
./start.sh --capture gsmtap
./start.sh --capture direct
./start.sh --capture disabled
```
Windows:
```bat
start.bat --capture gsmtap
start.bat --capture direct
start.bat --capture disabled
```
Параметры передаются как есть (`./start.sh --capture direct --port 8080`).
Сервер пишет в stderr информацию о жизненном цикле захвата (каждая строка Сервер пишет в stderr информацию о жизненном цикле захвата (каждая строка
с локальным временем): `Capture started` при старте, периодический с локальным временем): `Capture started` при старте, периодический
heartbeat `Capture alive: session=N messages=M bytes=B dropped=D skipped=S` heartbeat `Capture alive: session=N messages=M bytes=B dropped=D skipped=S`