aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Welte <laforge@osmocom.org>2021-10-21 14:40:39 +0200
committerHarald Welte <laforge@osmocom.org>2021-10-21 14:41:43 +0200
commitbd02f84fbdf139cefc1af24769972617d2b0dd0b (patch)
treeff09f456e6427f8f0a1bcdb65f5f5f0e4aa213e0
parent9a75410a88de667232d9194352e7ab1572322ed6 (diff)
pySim-shell: Improve documentationHEADmaster
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
-rw-r--r--docs/shell.rst37
-rwxr-xr-xpySim-shell.py1
2 files changed, 37 insertions, 1 deletions
diff --git a/docs/shell.rst b/docs/shell.rst
index 3d56c6d..e5d70a0 100644
--- a/docs/shell.rst
+++ b/docs/shell.rst
@@ -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
------------------------
diff --git a/pySim-shell.py b/pySim-shell.py
index 1fc09ef..3fc5859 100755
--- a/pySim-shell.py
+++ b/pySim-shell.py
@@ -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')