aboutsummaryrefslogtreecommitdiff
path: root/ksiders/atrdir.rst
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2024-05-10 17:40:31 -0400
committerB. Watson <urchlay@slackware.uk>2024-05-10 17:53:38 -0400
commite4a6e722021bf69b667822bea1862d6709d13564 (patch)
tree33663488e7d0831c524dd4878a28e73ff2ed29d0 /ksiders/atrdir.rst
parentf9dcbdd176785dfc9d49f3113ec6110199e9a246 (diff)
downloadbw-atari8-tools-e4a6e722021bf69b667822bea1862d6709d13564.tar.gz
convert ksiders man pages to RST, part 1 (atrdir).
Diffstat (limited to 'ksiders/atrdir.rst')
-rw-r--r--ksiders/atrdir.rst66
1 files changed, 66 insertions, 0 deletions
diff --git a/ksiders/atrdir.rst b/ksiders/atrdir.rst
new file mode 100644
index 0000000..290a937
--- /dev/null
+++ b/ksiders/atrdir.rst
@@ -0,0 +1,66 @@
+======
+atrdir
+======
+
+---------------------------------------------------------
+atrdir - print the directory of a DOS 2.0S ATR disk image
+---------------------------------------------------------
+
+.. include:: manhdr.rst
+
+SYNOPSIS
+========
+atrdir *imagefile.atr* [*wildcard*]
+
+DESCRIPTION
+===========
+
+**atrdir** prints the directory of an Atari DOS 2.x or MyDOS compatible
+ATR disk image. Sample output::
+
+ ---------------------------------------------------------------------
+ Directory of dos_20s.atr:*.*:
+ sector size = 128 sector count = 720
+
+ Directory of 'dos_20s.atr':
+
+ no f filename ext secs length startSec
+ -- - -------- --- ---- ------ --------
+ 0 * DOS SYS 039 4875 4
+ 1 * DUP SYS 042 5126 43
+ 2 AUTORUN SYS 001 88 85
+ ---------------------------------------------------------------------
+
+The f column contains an asterisk (*\**) for a locked file, a *D* for
+a deleted file, *:* for a MyDOS subdirectory, *<* for a DOS 2.5 file
+that uses sectors above 720, or nothing for any other file.
+
+*wildcard* is an optional glob pattern, such as *\*.sys*. If not given,
+the default is *\*.\**. *wildcard* is case insensitive; *\*.txt*
+is equivalent to *\*.TXT*. Most shells will require the argument to be
+quoted, to avoid the shell's normal wildcard expansion. The globbing
+semantics are similar to those of Atari DOS or POSIX sh, but are not
+identical to either.
+
+**atrdir** does not take any other options.
+
+NOTES
+=====
+
+DOS 2.5 disk images are not fully supported. Specifically, **atrdir**
+is unable to determine the size of files that use sectors above 720
+(those that are listed with *<*). Instead, the size will be reported
+as **??**.
+
+MyDOS large disk images (aka hard disk images) are supported.
+
+XFD format images are not supported.
+
+The current version of **atrdir** cannot determine the size of a MyDOS
+directory. Instead, the size is reported as **??**.
+
+**atrdir** cannot print the contents of MyDOS subdirectories.
+
+Exit status is zero for success, non-zero for failure.
+
+.. include:: manftr.rst