Browse Source

Fix client_id/bank_id/slot_nr range in manual + --help output

The RSPRO.asn protocol defines the ranges 0..1023 for slot, bank
and client IDs.  Don't make misleading claims in manual and/or
help messages.

Change-Id: Id383b2bea4c014e7b61ae02e7062ba4db5c2dc20
changes/21/26921/1
Harald Welte 6 months ago
parent
commit
55f12b8e38
  1. 6
      doc/manuals/chapters/remsim-bankd.adoc
  2. 8
      doc/manuals/chapters/remsim-client.adoc
  3. 4
      src/bankd/bankd_main.c
  4. 4
      src/client/remsim_client_main.c

6
doc/manuals/chapters/remsim-bankd.adoc

@ -61,7 +61,7 @@ approach seems to make more sense.
==== SYNOPSIS
*osmo-remsim-bankd* [-h] [-V] [-d LOGOPT] [-i A.B.C.D] [-p <1-65535>] [-b <1-65535>] [-n <1-65535>] [-I A.B.C.D] [-P <1-65535> ]
*osmo-remsim-bankd* [-h] [-V] [-d LOGOPT] [-i A.B.C.D] [-p <1-65535>] [-b <1-1023>] [-n <1-1023>] [-I A.B.C.D] [-P <1-65535> ]
==== OPTIONS
@ -77,11 +77,11 @@ approach seems to make more sense.
*-p, --server-port <1-65535>*::
Specify the remote TCP port number of the `osmo-remsim-server` to which
this bankd shall establish its RSPRO control connection
*-b, --bank-id <1-65535>*::
*-b, --bank-id <1-1023>*::
Specify the numeric bank identifier of the SIM bank this bankd
instance operates. Must be unique among all banks connecting to the
same `osmo-remsim-server`.
*-n, --num-slots <1-65535>*::
*-n, --num-slots <1-1023>*::
Specify the number of slots that this bankd handles.
*-I, --bind-IP A.B.C.D*::
Specify the local IP address to which the socket for incoming connections

8
doc/manuals/chapters/remsim-client.adoc

@ -82,11 +82,11 @@ osmo-remsim-client-st2 currently has the following command-line options:
*-p, --server-port <1-65535>*::
Specify the remote TCP port number of the `osmo-remsim-server` to which
this client shall establish its RSPRO control connection
*-c, --client-id <1-65535>*::
*-c, --client-id <1-1023>*::
Specify the numeric client identifier of the SIM bank this bankd
instance operates. The tuple of client-id and client-slot must be
unique among all clients connecting to the same `osmo-remsim-server`.
*-n, --client-slot <0-65535>*::
*-n, --client-slot <0-1023>*::
Specify the slot number served within this client. The tuple of
client-id and client-slot must be unique among all clients connecting
to the same `osmo-remsim-server`.
@ -224,11 +224,11 @@ osmo-remsim-client-shell currently has the following command-line options:
*-p, --server-port <1-65535>*::
Specify the remote TCP port number of the `osmo-remsim-server` to which
this client shall establish its RSPRO control connection
*-c, --client-id <1-65535>*::
*-c, --client-id <1-1023>*::
Specify the numeric client identifier of the SIM bank this bankd
instance operates. The tuple of client-id and client-slot must be
unique among all clients connecting to the same `osmo-remsim-server`.
*-n, --client-slot <0-65535>*::
*-n, --client-slot <0-1023>*::
Specify the slot number served within this client. The tuple of
client-id and client-slot must be unique among all clients connecting
to the same `osmo-remsim-server`.

4
src/bankd/bankd_main.c

@ -277,8 +277,8 @@ static void printf_help()
" -d --debug option Enable debug logging (e.g. DMAIN:DST2)\n"
" -i --server-host A.B.C.D remsim-server IP address (default: 127.0.0.1)\n"
" -p --server-port <1-65535> remsim-server TCP port (default: 9998)\n"
" -b --bank-id <1-65535> Bank Identifier of this SIM bank (default: 1)\n"
" -n --num-slots <1-65535> Number of Slots in this SIM bank (default: 8)\n"
" -b --bank-id <1-1023> Bank Identifier of this SIM bank (default: 1)\n"
" -n --num-slots <1-1023> Number of Slots in this SIM bank (default: 8)\n"
" -I --bind-ip A.B.C.D Local IP address to bind for incoming client\n"
" connections (default: INADDR_ANY)\n"
" -P --bind-port <1-65535> Local TCP port to bind for incoming client\n"

4
src/client/remsim_client_main.c

@ -30,8 +30,8 @@ static void printf_help()
" -d --debug option Enable debug logging (e.g. DMAIN:DST2)\n"
" -i --server-ip A.B.C.D remsim-server IP address\n"
" -p --server-port 13245 remsim-server TCP port\n"
" -c --client-id <0-65535> RSPRO ClientId of this client\n"
" -n --client-slot <0-65535> RSPRO SlotNr of this client\n"
" -c --client-id <0-1023> RSPRO ClientId of this client\n"
" -n --client-slot <0-1023> RSPRO SlotNr of this client\n"
" -e --event-script <path> event script to be called by client\n"
#ifdef USB_SUPPORT
" -V --usb-vendor VENDOR_ID\n"

Loading…
Cancel
Save