Skip to content

Commit 2fa3a7f

Browse files
committed
[files] updated docs
1 parent df8feab commit 2fa3a7f

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/commands/files/list.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,15 @@ Paths
1919

2020
The most general way of file listing is to not specify a file type (defaulting
2121
to unknown), and giving the directory path. Such a path should use ``/`` as
22-
separators (contrary to other Windows conventions) and should end with a ``/``.
22+
separators (contrary to other Windows conventions) and might end with a ``/``.
2323

2424
If a special type of file is to be listed (e.g. database), then it is enough
2525
to specify the file type, the path can be left out.
2626

2727
.. note::
2828

29-
On newer instruments giving just the directory path might not be enough
30-
to list all files in the directory. It may be necessary to give the path
31-
in a glob-like pattern, with wildcards for the filenames (e.g. to to list
32-
all files in the Data folder, the path would be ``Data/*.*``)
29+
On older instruments, the file listing might not return directories. In
30+
these cases the recursive file tree cannot be created.
3331

3432
Examples
3533
--------
@@ -42,7 +40,12 @@ Examples
4240
.. code-block:: shell
4341
:caption: Listing all exported files on a CF card
4442
45-
iman list files -d cf COM1 Data/
43+
iman list files -d cf COM1 Data
44+
45+
.. code-block:: shell
46+
:caption: Listing all contents of a directory recursively
47+
48+
iman list files --depth 0 COM1 Data
4649
4750
Usage
4851
-----

0 commit comments

Comments
 (0)