aboutsummaryrefslogtreecommitdiff
path: root/ksiders/atrextr.1
diff options
context:
space:
mode:
Diffstat (limited to 'ksiders/atrextr.1')
-rw-r--r--ksiders/atrextr.164
1 files changed, 64 insertions, 0 deletions
diff --git a/ksiders/atrextr.1 b/ksiders/atrextr.1
new file mode 100644
index 0000000..9912f76
--- /dev/null
+++ b/ksiders/atrextr.1
@@ -0,0 +1,64 @@
+.TH ATREXTR "1" "April 2007" "atrextr" "Ken Siders' Atari 8-bit Tools"
+.SH NAME
+\fBatrextr\fR \- extract files from an ATR image
+
+.SH SYNOPSIS
+\fBatrextr\fR \fIimagefile.atr\fR [\fIfile\fR] [\fIdir\fR]
+
+.SH DESCRIPTION
+\fBatrextr\fR 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.
+.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
+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
+There should be options to translate Atari EOL characters to and from
+UNIX newlines, and to convert the extracted filenames to lowercase.
+.PP
+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).
+.SH AUTHOR
+Ken Siders <\fBatari8bit@columbus.rr.com\fR>
+.PP
+Man page by B. Watson <\fBurchlay@urchlay.com\fR>
+
+.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