diff options
| -rw-r--r-- | ksiders/atrextr.1 | 137 | ||||
| -rw-r--r-- | ksiders/atrextr.rst | 64 | ||||
| -rw-r--r-- | ksiders/manftr.rst | 23 | ||||
| -rw-r--r-- | ksiders/manhdr.rst | 7 | ||||
| -rw-r--r-- | ksiders/ver.rst | 1 |
5 files changed, 181 insertions, 51 deletions
diff --git a/ksiders/atrextr.1 b/ksiders/atrextr.1 index 9912f76..f4799d1 100644 --- a/ksiders/atrextr.1 +++ b/ksiders/atrextr.1 @@ -1,64 +1,99 @@ -.TH ATREXTR "1" "April 2007" "atrextr" "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 "ATREXTR" 1 "2024-05-10" "0.9.0" "Ken Siders' Atari 8-bit Tools" .SH NAME -\fBatrextr\fR \- extract files from an ATR image - +atrextr \- extract files from an ATR image .SH SYNOPSIS -\fBatrextr\fR \fIimagefile.atr\fR [\fIfile\fR] [\fIdir\fR] - +.sp +\fBatrextr\fP \fIimagefile.atr\fP [\fIfile\fP] [\fIdir\fP] .SH DESCRIPTION -\fBatrextr\fR extracts one or more files from an Atari DOS 2.x or MyDOS +.sp +\fBatrextr\fP extracts one or more files from an Atari DOS 2.x or MyDOS compatible ATR disk image. Extracted files are written to the current -directory. -.PP -\fIfile\fR is an optional filename or wildcard pattern, -such as \fIautorun.sys\fR or \fI*.sys\fR. If not -given, the default is \fI*.*\fR. \fIfile\fR is case insensitive: -\fIreadme.txt\fR is equivalent to \fIREADME.TXT\fR, and -\fI*.txt\fR is equivalent to \fI*.TXT\fR. If a wildcard is used, -most shells will require the argument -to be quoted, to avoid the shell's normal wildcard expansion. The -wildcard semantics are similar to those of Atari DOS or POSIX sh, but -are not identical to either. -.PP -\fIdir\fR is the directory to extract files to. If omitted, the default -is the current directory. If \fIdir\fR is to be given, \fIfile\fR must -also be given (although it may be specified as \fI""\fR, equivalent -to \fI"*.*"\fR). -.PP -\fBatrextr\fR does not take any other options. +directory, by default. +.sp +\fIfile\fP is an optional filename or wildcard pattern, such as \fIautorun.sys\fP +or \fI*.sys\fP\&. If not given, the default is \fI*.*\fP\&. \fIfile\fP is case +insensitive: \fIreadme.txt\fP is equivalent to \fIREADME.TXT\fP, and \fI*.txt\fP is +equivalent to \fI*.TXT\fP\&. If a wildcard is used, most shells will require +the argument to be quoted, to avoid the shell\(aqs normal wildcard +expansion. The wildcard semantics are similar to those of Atari DOS or +POSIX sh, but are not identical to either. +.sp +\fIdir\fP is the directory to extract files to. If omitted, the default is +the current directory. If \fIdir\fP is to be given, \fIfile\fP must also be given +(although it may be specified as \fI""\fP, equivalent to \fI*.*\fP). +.sp +\fBatrextr\fP does not take any other options. .SH NOTES -DOS 2.5 disk images are not fully supported. Specifically, \fBatrextr\fR -is unable to extract files that use sectors above 720 (those -that are listed with \fI<\fR, in \fBatrdir\fR or Atari DOS 2.5). These -files will be silently skipped, exactly as Atari DOS 2.0S does when reading -a 2.5 enhanced density disk. -.PP -MyDOS subdirectories are not supported. Only files in the root directory -of a disk image can be extracted. -.PP +.sp +DOS 2.5 disk images are not fully supported. Specifically, \fBatrextr\fP +is unable to extract files that use sectors above 720 (those that +are listed with \fI<\fP, in \fIatrdir\fP or Atari DOS 2.5). These files will be +silently skipped, exactly as Atari DOS 2.0S does when reading a 2.5 +enhanced density disk. +.sp +MyDOS subdirectories are not supported. Only files in the root +directory of a disk image can be extracted. +.sp MyDOS large disk images (aka hard disk images) are supported, though -without subdirectory support, \fBatrextr\fR can't extract most of the -files in a typical hard disk image. -.PP -XFD format images are not supported. Neither are SpartaDOS, Atari DOS 3/4, -DOS XE, or other non-standard DOS formats. -.PP +without subdirectory support, \fBatrextr\fP can\(aqt extract most of the files +in a typical hard disk image. +.sp +XFD format images are not supported. Neither are SpartaDOS, Atari DOS +3/4, DOS XE, or other non\-standard DOS formats. +.sp There should be options to translate Atari EOL characters to and from UNIX newlines, and to convert the extracted filenames to lowercase. -.PP +.sp Exit status is zero if all files were extracted successfully, or -non-zero if any errors occurred. In case of a non-zero return, +non\-zero if any errors occurred. In case of a non\-zero return, some files may still have been extracted (though some or all of them may be truncated or corrupt). +.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 -\&\fIatrdir\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/atrextr.rst b/ksiders/atrextr.rst new file mode 100644 index 0000000..59abd35 --- /dev/null +++ b/ksiders/atrextr.rst @@ -0,0 +1,64 @@ +======= +atrextr +======= + +------------------------------- +extract files from an ATR image +------------------------------- + +.. include:: manhdr.rst + +SYNOPSIS +======== + +**atrextr** *imagefile.atr* [*file*] [*dir*] + +DESCRIPTION +=========== + +**atrextr** extracts one or more files from an Atari DOS 2.x or MyDOS +compatible ATR disk image. Extracted files are written to the current +directory, by default. + +*file* is an optional filename or wildcard pattern, such as *autorun.sys* +or *\*.sys*. If not given, the default is *\*.\**. *file* is case +insensitive: *readme.txt* is equivalent to *README.TXT*, and *\*.txt* is +equivalent to *\*.TXT*. If a wildcard is used, most shells will require +the argument to be quoted, to avoid the shell's normal wildcard +expansion. The wildcard semantics are similar to those of Atari DOS or +POSIX sh, but are not identical to either. + +*dir* is the directory to extract files to. If omitted, the default is +the current directory. If *dir* is to be given, *file* must also be given +(although it may be specified as *""*, equivalent to *\*.\**). + +**atrextr** does not take any other options. + +NOTES +===== + +DOS 2.5 disk images are not fully supported. Specifically, **atrextr** +is unable to extract files that use sectors above 720 (those that +are listed with *<*, in *atrdir* or Atari DOS 2.5). These files will be +silently skipped, exactly as Atari DOS 2.0S does when reading a 2.5 +enhanced density disk. + +MyDOS subdirectories are not supported. Only files in the root +directory of a disk image can be extracted. + +MyDOS large disk images (aka hard disk images) are supported, though +without subdirectory support, **atrextr** can't extract most of the files +in a typical hard disk image. + +XFD format images are not supported. Neither are SpartaDOS, Atari DOS +3/4, DOS XE, or other non-standard DOS formats. + +There should be options to translate Atari EOL characters to and from +UNIX newlines, and to convert the extracted filenames to lowercase. + +Exit status is zero if all files were extracted successfully, or +non-zero if any errors occurred. In case of a non-zero return, +some files may still have been extracted (though some or all of them +may be truncated or corrupt). + +.. include:: manftr.rst diff --git a/ksiders/manftr.rst b/ksiders/manftr.rst new file mode 100644 index 0000000..f266eea --- /dev/null +++ b/ksiders/manftr.rst @@ -0,0 +1,23 @@ +COPYRIGHT +========= + +Copyright 1997, Ken Siders. + +AUTHOR +====== + +Ken Siders was the original author of this utility. + +Man page and Linux port done by B. Watson <urchlay@slackware.uk>; +Urchlay on irc.libera.chat *##atari*. + +SEE ALSO +======== + +**atrdir**\(1), +**atrextr**\(1), +**makeatr**\(1), +**sortatr**\(1). + +Any good Atari 8-bit book: *De Re Atari*, *The Atari BASIC Reference +Manual*, the *OS Users' Guide*, *Mapping the Atari*, etc. diff --git a/ksiders/manhdr.rst b/ksiders/manhdr.rst new file mode 100644 index 0000000..30f7264 --- /dev/null +++ b/ksiders/manhdr.rst @@ -0,0 +1,7 @@ +.. include:: ver.rst +.. |date| date:: + +:Manual section: 1 +:Manual group: Ken Siders' Atari 8-bit Tools +:Date: |date| +:Version: |version| diff --git a/ksiders/ver.rst b/ksiders/ver.rst new file mode 100644 index 0000000..b76201c --- /dev/null +++ b/ksiders/ver.rst @@ -0,0 +1 @@ +.. |version| replace:: 0.9.0 |