add examples to the command line options for remsim-bankd and remsim-client

Change-Id: Idfa6352ce90dd36dd27306d6c8a2023935ed822d
4 years ago · 68f95100bf
parent 293c114629
commit 68f95100bf
7 changed files with 24 additions and 1 deletions
--- a/contrib/etc_default/osmo-remsim-client-0
+++ b/contrib/etc_default/osmo-remsim-client-0
@ -4,3 +4,4 @@
 REMSIM_I="0"
 REMSIM_H="2-1.1"
 REMSIM_c="0"
+REMSIM_n="0"
--- a/contrib/etc_default/osmo-remsim-client-1
+++ b/contrib/etc_default/osmo-remsim-client-1
@ -4,3 +4,4 @@
 REMSIM_I="1"
 REMSIM_H="2-1.1"
 REMSIM_c="0"
+REMSIM_n="1"
--- a/contrib/etc_default/osmo-remsim-client-2
+++ b/contrib/etc_default/osmo-remsim-client-2
@ -4,3 +4,4 @@
 REMSIM_I="0"
 REMSIM_H="2-1.4"
 REMSIM_c="0"
+REMSIM_n="2"
--- a/contrib/etc_default/osmo-remsim-client-3
+++ b/contrib/etc_default/osmo-remsim-client-3
@ -4,3 +4,4 @@
 REMSIM_I="1"
 REMSIM_H="2-1.4"
 REMSIM_c="0"
+REMSIM_n="3"
--- a/contrib/systemd/osmo-remsim-client@.service
+++ b/contrib/systemd/osmo-remsim-client@.service
@ -6,7 +6,7 @@ Type=simple
 Restart=always
 EnvironmentFile=/etc/default/osmo-remsim-client
 EnvironmentFile=/etc/default/osmo-remsim-client-%i
-ExecStart=/usr/bin/osmo-remsim-client-st2 $GLOBAL_CLIENT_OPTS -I $REMSIM_I -H $REMSIM_H -c $REMSIM_c
+ExecStart=/usr/bin/osmo-remsim-client-st2 $GLOBAL_CLIENT_OPTS -I $REMSIM_I -H $REMSIM_H -c $REMSIM_c -n $REMSIM_n
 RestartSec=2

 [Install]
--- a/doc/manuals/chapters/remsim-bankd.adoc
+++ b/doc/manuals/chapters/remsim-bankd.adoc
@ -85,6 +85,16 @@ approach seems to make more sense.
  Specify the local TCP port to whicc the socket for incoming connections
  from `osmo-remsim-client`s is bound to.

+==== Examples
+.remsim-server is on 10.2.3.4, cardreader has 5 slots:
+----
+osmo-remsim-bankd -i 10.2.3.4 -n 5
+----
+.remsim-server is on 10.2.3.4, cardreader has 4 slots, local ip is 10.5.4.3
+----
+osmo-remsim-bankd -i 10.2.3.4 -n 4 -I 10.5.4.3
+----
+
 === Logging

 `osmo-remsim-bankd` currently logs to stdout only, and the logging
--- a/doc/manuals/chapters/remsim-client.adoc
+++ b/doc/manuals/chapters/remsim-client.adoc
@ -83,6 +83,15 @@ osmo-remsim-client-st2 currently has the following command-line options:
  and will later be overridden by the ATR as specified by
  `osmo-remsim-bankd` once a card has been mapped to this client.

+==== Examples
+.remsim-server is on 10.2.3.4, sysmoQMOD on usb bus, all 4 modems:
+----
+osmo-remsim-client-st2 -s 10.2.3.4 -V 1d50 -P 4004 -C 1 -I 0 -H 2-1.1 -c 0 -n 0
+osmo-remsim-client-st2 -s 10.2.3.4 -V 1d50 -P 4004 -C 1 -I 1 -H 2-1.1 -c 0 -n 1
+osmo-remsim-client-st2 -s 10.2.3.4 -V 1d50 -P 4004 -C 1 -I 0 -H 2-1.4 -c 0 -n 2
+osmo-remsim-client-st2 -s 10.2.3.4 -V 1d50 -P 4004 -C 1 -I 1 -H 2-1.4 -c 0 -n 3
+----
+
 === Logging

 `osmo-remsim-client` currently logs to stdout only, and the logging