From 7801c62ca3b06728a94c114781fdf0e5b289223b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=90=D0=BD=D1=82=D0=BE=D0=BD=20=D0=A2=D1=80=D0=BE=D1=88?= =?UTF-8?q?=D0=B8=D0=BD?= Date: Tue, 27 Oct 2026 11:08:11 +0300 Subject: [PATCH] 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). --- README.md | 27 +++++++++++++++++++++++---- README_RUS.md | 23 +++++++++++++++++++++-- 2 files changed, 44 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 699ec9f..a6094b9 100644 --- a/README.md +++ b/README.md @@ -127,10 +127,8 @@ in [Usage](#usage) below. Stores captured APDU traffic in SQLite and serves it over HTTP, together with the bundled **SIMtrace Analyser** frontend (`frontend/` in a source checkout, -bundled into the package on install) on the same origin. The commands below -use the console script; from a source checkout the launchers take the same -options (`./start.sh --capture gsmtap`, `start.bat --capture gsmtap`). Three -capture modes: +bundled into the package on install) on the same origin. Three capture +modes: ```sh # Listen for GSMTAP from simtrace2-pysniff (or original simtrace2-sniff): @@ -143,6 +141,27 @@ simtrace-analyser-server --capture direct 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 with the local time): `Capture started` on begin, a periodic `Capture alive: session=N messages=M bytes=B dropped=D` heartbeat, and diff --git a/README_RUS.md b/README_RUS.md index 6fd0e80..aefa5cc 100644 --- a/README_RUS.md +++ b/README_RUS.md @@ -131,8 +131,6 @@ simtrace-analyser-server --capture gsmtap Сохраняет захваченный APDU-трафик в SQLite и отдаёт его по HTTP вместе со встроенным фронтендом **SIMtrace Analyser** (`frontend/` в исходном клоне, при установке — внутри пакета) на том же origin. -Команды ниже — консольная команда; при запуске из клона скрипты принимают те -же параметры (`./start.sh --capture gsmtap`, `start.bat --capture gsmtap`). Три режима захвата: ```sh @@ -146,6 +144,27 @@ simtrace-analyser-server --capture direct 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 информацию о жизненном цикле захвата (каждая строка с локальным временем): `Capture started` при старте, периодический heartbeat `Capture alive: session=N messages=M bytes=B dropped=D skipped=S`