From e4a6e722021bf69b667822bea1862d6709d13564 Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Fri, 10 May 2024 17:40:31 -0400 Subject: convert ksiders man pages to RST, part 1 (atrdir). --- ksiders/atrdir.1 | 137 +++++++++++++++++++++++++++++++++++------------------ ksiders/atrdir.rst | 66 ++++++++++++++++++++++++++ 2 files changed, 157 insertions(+), 46 deletions(-) create mode 100644 ksiders/atrdir.rst diff --git a/ksiders/atrdir.1 b/ksiders/atrdir.1 index 6e2d0bf..d68d099 100644 --- a/ksiders/atrdir.1 +++ b/ksiders/atrdir.1 @@ -1,65 +1,110 @@ -.TH ATRDIR "1" "April 2007" "atrdir" "Ken Siders' Atari 8-bit Tools" +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ATRDIR" 1 "2024-05-10" "0.9.0" "Ken Siders' Atari 8-bit Tools" .SH NAME -\fBatrdir\fR \- print the directory of an ATR disk image +atrdir \- atrdir - print the directory of a DOS 2.0S ATR disk image .SH SYNOPSIS -\fBatrdir\fR \fIimagefile.atr\fR [\fIwildcard\fR] +.sp +atrdir \fIimagefile.atr\fP [\fIwildcard\fP] .SH DESCRIPTION -\fBatrdir\fR prints the directory of an Atari DOS 2.x or MyDOS compatible +.sp +\fBatrdir\fP prints the directory of an Atari DOS 2.x or MyDOS compatible ATR disk image. Sample output: -.PP +.INDENT 0.0 +.INDENT 3.5 +.sp .nf ---------------------------------------------------------------------- +.ft C +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Directory of dos_20s.atr:*.*: sector size = 128 sector count = 720 - -Directory of 'dos_20s.atr': +Directory of \(aqdos_20s.atr\(aq: 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 ---------------------------------------------------------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.ft P .fi -.PP -The \fIf\fR column contains an asterisk (\fI*\fR) for a locked file, -a \fID\fR for a deleted file, \fI:\fR for a MyDOS subdirectory, -\fI<\fR for a DOS 2.5 file that uses sectors above 720, -or nothing for any other file. -.PP -\fIwildcard\fR is an optional glob pattern, such as \fI*.sys\fR. If not -given, the default is \fI*.*\fR. \fIwildcard\fR is case insensitive; -\fI*.txt\fR is equivalent to \fI*.TXT\fR. 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. -.PP -\fBatrdir\fR does not take any other options. +.UNINDENT +.UNINDENT +.sp +The f column contains an asterisk (\fI*\fP) for a locked file, a \fID\fP for +a deleted file, \fI:\fP for a MyDOS subdirectory, \fI<\fP for a DOS 2.5 file +that uses sectors above 720, or nothing for any other file. +.sp +\fIwildcard\fP is an optional glob pattern, such as \fI*.sys\fP\&. If not given, +the default is \fI*.*\fP\&. \fIwildcard\fP is case insensitive; \fI*.txt\fP +is equivalent to \fI*.TXT\fP\&. Most shells will require the argument to be +quoted, to avoid the shell\(aqs normal wildcard expansion. The globbing +semantics are similar to those of Atari DOS or POSIX sh, but are not +identical to either. +.sp +\fBatrdir\fP does not take any other options. .SH NOTES -.PP -DOS 2.5 disk images are not fully supported. Specifically, \fBatrdir\fR -is unable to determine the size of files that use sectors above 720 (those -that are listed with \fI<\fR). Instead, the size will be reported as \fB??\fR. -.PP +.sp +DOS 2.5 disk images are not fully supported. Specifically, \fBatrdir\fP +is unable to determine the size of files that use sectors above 720 +(those that are listed with \fI<\fP). Instead, the size will be reported +as \fB??\fP\&. +.sp MyDOS large disk images (aka hard disk images) are supported. -.PP +.sp XFD format images are not supported. -.PP -The current version of \fBatrdir\fR cannot determine the size of a MyDOS -directory. Instead, the size is reported as \fB??\fR. -.PP -\fBatrdir\fR cannot print the contents of MyDOS subdirectories. -.PP -Exit status is zero for success, non-zero for failure. +.sp +The current version of \fBatrdir\fP cannot determine the size of a MyDOS +directory. Instead, the size is reported as \fB??\fP\&. +.sp +\fBatrdir\fP cannot print the contents of MyDOS subdirectories. +.sp +Exit status is zero for success, non\-zero for failure. +.SH COPYRIGHT +.sp +Copyright 1997, Ken Siders. .SH AUTHOR -Ken Siders <\fBatari8bit@columbus.rr.com\fR> -.PP -Man page by B. Watson <\fBurchlay@urchlay.com\fR> +.sp +Ken Siders was the original author of this utility. +.sp +Man page and Linux port done by B. Watson <\fI\%urchlay@slackware.uk\fP>; +Urchlay on irc.libera.chat \fI##atari\fP\&. .SH SEE ALSO -\&\fIatrextr\fR\|(1), \&\fImakeatr\fR\|(1), \&\fIsortatr\fR\|(1), -\&\fIunmakatr\fR\|(1). -.PP -Ken Siders Atari 8\-bit page: -.br -http://atari.ksiders.tzo.com/a8emulators.html +.sp +\fBatrdir\fP(1), +\fBatrextr\fP(1), +\fBmakeatr\fP(1), +\fBsort\fP(1). +.sp +Any good Atari 8\-bit book: \fIDe Re Atari\fP, \fIThe Atari BASIC Reference +Manual\fP, the \fIOS Users\(aq Guide\fP, \fIMapping the Atari\fP, etc. +.\" Generated by docutils manpage writer. +. 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 -- cgit v1.2.3