transport: Extend the documentation for each transport driver

This driver description we add to the code is automatically added to the
respective user manual sections.

Change-Id: I8807bfb11f43b167f1321d556e09ec5234fff629
This commit is contained in:
Harald Welte
2023-11-03 12:38:42 +01:00
parent baec4e9c81
commit 0ecbf63a02
4 changed files with 16 additions and 4 deletions

View File

@@ -167,6 +167,9 @@ class CalypsoSimLink(LinkBase):
@staticmethod
def argparse_add_reader_args(arg_parser: argparse.ArgumentParser):
osmobb_group = arg_parser.add_argument_group('OsmocomBB Reader')
osmobb_group = arg_parser.add_argument_group('OsmocomBB Reader', """Use an OsmocomBB compatible phone
to access the SIM inserted to the phone SIM slot. This will require you to run the OsmocomBB firmware inside
the phone (can be ram-loaded). It also requires that you run the ``osmocon`` program, which provides a unix
domain socket to which this reader driver can attach.""")
osmobb_group.add_argument('--osmocon', dest='osmocon_sock', metavar='PATH', default=None,
help='Socket path for Calypso (e.g. Motorola C1XX) based reader (via OsmocomBB)')