pySim-shell: Improve documentation

A number of new commands were recently introduced without proper
coverage in the documentation (user manual).  This includes equip,
bulk_script and others.

Change-Id: Ide7ba68ad90f6e5c2a41a2e3de22534258ebb7fd
This commit is contained in:
Harald Welte 2021-10-21 14:40:39 +02:00
parent 9a75410a88
commit bd02f84fbd
2 changed files with 37 additions and 1 deletions

View File

@ -196,6 +196,15 @@ export
:module: pySim-shell
:func: PySimCommands.export_parser
Please note that `export` works relative to the current working
directory, so if you are in `MF`, then the export will contain all known
files on the card. However, if you are in `ADF.ISIM`, only files below
that ADF will be part of the export.
Furthermore, it is strongly advised to first enter the ADM1 pin
(`verify_adm`) to maximize the chance of having permission to read
all/most files.
tree
~~~~
@ -216,9 +225,35 @@ Currently only ADM1 is supported.
reset
~~~~~
Perform card reset and display the card ATR.
intro
~~~~~
[Re-]Display the introductory banner
equip
~~~~~
Equip pySim-shell with a card; particularly useful if the program was
started before a card was present, or after a card has been replaced by
the user while pySim-shell was kept running.
bulk_script
~~~~~~~~~~~
.. argparse::
:module: pySim-shell
:func: PysimApp.bulk_script_parser
Run a script for bulk-provisioning of multiple cards.
echo
~~~~
.. argparse::
:module: pySim-shell
:func: PysimApp.echo_parser
Linear Fixed EF commands
------------------------

View File

@ -380,6 +380,7 @@ class PysimApp(cmd2.Cmd):
@cmd2.with_argparser(echo_parser)
@cmd2.with_category(CUSTOM_CATEGORY)
def do_echo(self, opts):
"""Echo (print) a string on the console"""
self.poutput(opts.string)
@with_default_category('pySim Commands')