diff options
Diffstat (limited to 'xfd2atr.1')
| -rw-r--r-- | xfd2atr.1 | 132 |
1 files changed, 132 insertions, 0 deletions
diff --git a/xfd2atr.1 b/xfd2atr.1 new file mode 100644 index 0000000..9e5c541 --- /dev/null +++ b/xfd2atr.1 @@ -0,0 +1,132 @@ +.\" 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 "XFD2ATR" 1 "2022-08-27" "0.2.0" "Urchlay's Atari 8-bit Tools" +.SH NAME +xfd2atr \- Convert an Atari 8-bit XFD (raw) disk image to an ATR image. +.\" RST source for xfd2atr(1) man page. Convert with: +. +.\" rst2man.py xfd2atr.rst > xfd2atr.1 +. +.\" rst2man.py comes from the SBo development/docutils package. +. +.SH SYNOPSIS +.sp +\fIxfd2atr\fP [\fI\-sd\fP] \fIinfile.xfd\fP [\fIoutfile.atr\fP] +.SH DESCRIPTION +.sp +\fBxfd2atr\fP generates and adds a 16\-byte ATR header to an XFD +image. If no \fB\-s\fP or \fB\-d\fP options are given, xfd2atr tries to +guess the density based on the file size. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \-s +Assume the image uses single density (128\-byte) sectors, instead +of trying to guess the density from the file size. +.TP +.B \-d +Assume the image uses double density (256\-byte) sectors, instead +of trying to guess the density from the file size. +.UNINDENT +.SH NOTES +.sp +You may use \fB\-\fP for \fIinfile\fP to read from standard input and/or +\fB\-\fP for \fIoutfile\fP to write to standard output. If a filename is +supplied for \fIoutfile\fP, it will always be used as\-is (no \fI\&.atr\fP +extension will be appended). +.sp +If \fIoutfile\fP is omitted, it is constructed like so: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP \(bu 2 +If reading from standard input, write to standard output. +.IP \(bu 2 +If reading from a file whose name ends with an \fI\&.xfd\fP or \fI\&.XFD\fP +extension, replace the extension with \fI\&.atr\fP\&. +.IP \(bu 2 +Otherwise, append \fI\&.atr\fP to the input filename. +.UNINDENT +.UNINDENT +.UNINDENT +.sp +Since XFD images are raw dumps with no header or structure, it\(aqs +impossible to know the correct density (bytes/sector) for a given +image for certain. +.sp +However, no known Atari\-compatible disk format uses other than 128 +or 256 bytes per sector (or possibly 512, for some hard disk images, +but \fBxfd2atr\fP doesn\(aqt support these). This means file that isn\(aqt a +multiple of 128 bytes in size will be rejected. +.sp +Likewise, no known format uses an odd number of sectors, and +it\(aqs assumed that all double\-density images will begin with 3 +single\-density boot sectors (true of all floppy images you\(aqre +ever likely to run across; may not be true of hard disk images). +.sp +Given these assumptions, \fBxfd2atr\fP is able to make an educated +guess about the correct sector size and count to use for the ATR +header it generates. If it guesses wrong, the resulting ATR image +will be unusable; if this happens, re\-run \fBxfd2atr\fP and force the +density with \fB\-s\fP or \fB\-d\fP\&. +.SH EXIT STATUS +.sp +Exit status is zero for success, non\-zero for failure. Further, +exit status will be 1 for errors involving file I/O (file not found, +permissions, etc), and 2 for structural errors in the XFD file. +.SH COPYRIGHT +.sp +WTFPL. See \fI\%http://www.wtfpl.net/txt/copying/\fP for details. +.SH AUTHOR +.INDENT 0.0 +.IP B. 3 +Watson <\fI\%urchlay@slackware.uk\fP>; Urchlay on irc.libera.chat \fI##atari\fP\&. +.UNINDENT +.SH SEE ALSO +.sp +\fBa8eol\fP(1), +\fBa8utf8\fP(1), +\fBatr2xfd\fP(1), +\fBatrsize\fP(1), +\fBaxe\fP(1), +\fBblob2c\fP(1), +\fBcart2xex\fP(1), +\fBdasm2atasm\fP(1), +\fBfenders\fP(1), +\fBrom2cart\fP(1), +\fBunmac65\fP(1), +\fBxexcat\fP(1), +\fBxexsplit\fP(1), +\fBxfd2atr\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. +. |