Change in pysim[master]: pySim-shell: Improve documentation

[laforge]

laforge has submitted this change. ( https://gerrit.osmocom.org/c/pysim/+/25882 )

Change subject: pySim-shell: Improve documentation
......................................................................

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
---
M docs/shell.rst
M pySim-shell.py
2 files changed, 37 insertions(+), 1 deletion(-)

Approvals:
  Jenkins Builder: Verified
  laforge: Looks good to me, approved



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 @@
    :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 @@
 
 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 @@
 	@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')

-- 
To view, visit https://gerrit.osmocom.org/c/pysim/+/25882
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: pysim
Gerrit-Branch: master
Gerrit-Change-Id: Ide7ba68ad90f6e5c2a41a2e3de22534258ebb7fd
Gerrit-Change-Number: 25882
Gerrit-PatchSet: 1
Gerrit-Owner: laforge <laforge at osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: dexter <pmaier at sysmocom.de>
Gerrit-Reviewer: laforge <laforge at osmocom.org>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20211024/f6b09057/attachment.htm>