<p>laforge has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/pysim/+/25882">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">pySim-shell: Improve documentation<br><br>A number of new commands were recently introduced without proper<br>coverage in the documentation (user manual).  This includes equip,<br>bulk_script and others.<br><br>Change-Id: Ide7ba68ad90f6e5c2a41a2e3de22534258ebb7fd<br>---<br>M docs/shell.rst<br>M pySim-shell.py<br>2 files changed, 37 insertions(+), 1 deletion(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/pysim refs/changes/82/25882/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/docs/shell.rst b/docs/shell.rst</span><br><span>index 3d56c6d..e5d70a0 100644</span><br><span>--- a/docs/shell.rst</span><br><span>+++ b/docs/shell.rst</span><br><span>@@ -196,6 +196,15 @@</span><br><span>    :module: pySim-shell</span><br><span>    :func: PySimCommands.export_parser</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+Please note that `export` works relative to the current working</span><br><span style="color: hsl(120, 100%, 40%);">+directory, so if you are in `MF`, then the export will contain all known</span><br><span style="color: hsl(120, 100%, 40%);">+files on the card.  However, if you are in `ADF.ISIM`, only files below</span><br><span style="color: hsl(120, 100%, 40%);">+that ADF will be part of the export.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Furthermore, it is strongly advised to first enter the ADM1 pin</span><br><span style="color: hsl(120, 100%, 40%);">+(`verify_adm`) to maximize the chance of having permission to read</span><br><span style="color: hsl(120, 100%, 40%);">+all/most files.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> </span><br><span> tree</span><br><span> ~~~~</span><br><span>@@ -216,9 +225,35 @@</span><br><span> </span><br><span> reset</span><br><span> ~~~~~</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span> Perform card reset and display the card ATR.</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+intro</span><br><span style="color: hsl(120, 100%, 40%);">+~~~~~</span><br><span style="color: hsl(120, 100%, 40%);">+[Re-]Display the introductory banner</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+equip</span><br><span style="color: hsl(120, 100%, 40%);">+~~~~~</span><br><span style="color: hsl(120, 100%, 40%);">+Equip pySim-shell with a card; particularly useful if the program was</span><br><span style="color: hsl(120, 100%, 40%);">+started before a card was present, or after a card has been replaced by</span><br><span style="color: hsl(120, 100%, 40%);">+the user while pySim-shell was kept running.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+bulk_script</span><br><span style="color: hsl(120, 100%, 40%);">+~~~~~~~~~~~</span><br><span style="color: hsl(120, 100%, 40%);">+.. argparse::</span><br><span style="color: hsl(120, 100%, 40%);">+   :module: pySim-shell</span><br><span style="color: hsl(120, 100%, 40%);">+   :func: PysimApp.bulk_script_parser</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Run a script for bulk-provisioning of multiple cards.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+echo</span><br><span style="color: hsl(120, 100%, 40%);">+~~~~</span><br><span style="color: hsl(120, 100%, 40%);">+.. argparse::</span><br><span style="color: hsl(120, 100%, 40%);">+   :module: pySim-shell</span><br><span style="color: hsl(120, 100%, 40%);">+   :func: PysimApp.echo_parser</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> </span><br><span> Linear Fixed EF commands</span><br><span> ------------------------</span><br><span>diff --git a/pySim-shell.py b/pySim-shell.py</span><br><span>index 1fc09ef..3fc5859 100755</span><br><span>--- a/pySim-shell.py</span><br><span>+++ b/pySim-shell.py</span><br><span>@@ -380,6 +380,7 @@</span><br><span>  @cmd2.with_argparser(echo_parser)</span><br><span>    @cmd2.with_category(CUSTOM_CATEGORY)</span><br><span>         def do_echo(self, opts):</span><br><span style="color: hsl(120, 100%, 40%);">+              """Echo (print) a string on the console"""</span><br><span>             self.poutput(opts.string)</span><br><span> </span><br><span> @with_default_category('pySim Commands')</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/pysim/+/25882">change 25882</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/pysim/+/25882"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: pysim </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: Ide7ba68ad90f6e5c2a41a2e3de22534258ebb7fd </div>
<div style="display:none"> Gerrit-Change-Number: 25882 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>