aboutsummaryrefslogtreecommitdiff
path: root/atrsize.1
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2022-08-29 16:11:13 -0400
committerB. Watson <urchlay@slackware.uk>2022-08-29 16:11:13 -0400
commite2ba8458a5cfdfacfaf103e7ba97d610afa6c970 (patch)
treecd665e602e6e2b636578a7d3d7894380605dafcc /atrsize.1
downloadbw-atari8-tools-e2ba8458a5cfdfacfaf103e7ba97d610afa6c970.tar.gz
initial commit
Diffstat (limited to 'atrsize.1')
-rw-r--r--atrsize.1216
1 files changed, 216 insertions, 0 deletions
diff --git a/atrsize.1 b/atrsize.1
new file mode 100644
index 0000000..3b9b571
--- /dev/null
+++ b/atrsize.1
@@ -0,0 +1,216 @@
+.\" 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 "ATRSIZE" 1 "2022-08-27" "0.2.0" "Urchlay's Atari 8-bit Tools"
+.SH NAME
+atrsize \- Change the size of an Atari 8-bit ATR disk image, or create a blank ATR image
+.\" RST source for atrsize(1) man page. Convert with:
+.
+.\" rst2man.py atrsize.rst > atrsize.1
+.
+.\" rst2man.py comes from the SBo development/docutils package.
+.
+.SH SYNOPSIS
+.sp
+atrsize [\fB\-bB\fP] \fIinfile.atr\fP [\fIsectors\fP]
+.SH DESCRIPTION
+.sp
+Without the \fB\-b\fP or \fB\-B\fP options:
+.INDENT 0.0
+.INDENT 3.5
+\fIinfile.atr\fP will be backed up to \fIinfile.atr~\fP, and a new \fIinfile.atr\fP will
+be created. If \fIsectors\fP is given, the new image file will be truncated
+or extended to the new size. Without \fIsectors\fP, the new image\(aqs size will
+be set as follows:
+.TS
+center;
+|l|l|l|.
+_
+T{
+Density
+T} T{
+Original Sectors
+T} T{
+New Sectors
+T}
+_
+T{
+Either
+T} T{
+0 \- 2
+T} T{
+Error
+T}
+_
+T{
+Either
+T} T{
+3 \- 719
+T} T{
+720
+T}
+_
+T{
+Either
+T} T{
+720
+T} T{
+720 (no change)
+T}
+_
+T{
+Single
+T} T{
+721 \- 1039
+T} T{
+1040 (aka 1050 enhanced density)
+T}
+_
+T{
+Single
+T} T{
+1040
+T} T{
+1040 (no change)
+T}
+_
+T{
+Single
+T} T{
+1041 or more
+T} T{
+Unknown (must specify size)
+T}
+_
+T{
+Double
+T} T{
+721 \- 1339
+T} T{
+1440 (aka double sided, double density)
+T}
+_
+T{
+Double
+T} T{
+1440
+T} T{
+1440 (no change)
+T}
+_
+T{
+Double
+T} T{
+1441 or more
+T} T{
+Unknown (must specify size)
+T}
+_
+.TE
+.sp
+When \fIsectors\fP is given, its allowed range is from 3 to 65535. \fIinfile.atr\fP
+will be rewritten at the new size.
+.sp
+When \fBatrsize\fP changes the size of an image, the new ATR header
+will reflect the new size. If the new image is larger than the old
+image, \fBatrsize\fP pads the image with empty sectors containing all 0
+data bytes. If the new image is smaller than the old image, it is
+truncated, and any data in the old image that resides in the removed
+sectors will be lost.
+.sp
+For ATR images where the ATR header doesn\(aqt agree with the actual size
+of the file, the actual file size is used to determine the number of
+sectors. The output image will have its ATR header adjusted to reflect
+the actual file size of the image, if sectors is not given.
+.UNINDENT
+.UNINDENT
+.sp
+With \fB\-b\fP or \fB\-B\fP:
+.INDENT 0.0
+.INDENT 3.5
+\fBatrsize\fP will create a new, blank image called \fIinfile.atr\fP\&. If
+this file already exists, however, it will not be overwritten
+(instead, \fBatrsize\fP will exit with a "file exists" message).
+.sp
+If \fIsectors\fP is given, the new image\(aqs size will be set to that many
+sectors. If not given, the new image\(aqs size will be 720 sectors.
+.sp
+\fB\-b\fP creates a new image with 128\-byte sectors (single density)
+.sp
+\fB\-B\fP creates a new image with 256\-byte sectors (double density).
+.sp
+New images created with \fBatrsize\fP consist of a valid ATR header,
+and sectors filled with zeroes. No boot sectors, directory, VTOC,
+or filesystem are created. To use a blank image for file
+storage, it must be formatted with an Atari DOS (either in an
+emulator or with a real Atari via SIO2PC cable). If you\(aqre
+trying to create a blank DOS 2.0S disk, use \fBaxe \-b\fP\&.
+.UNINDENT
+.UNINDENT
+.SH NOTES
+.INDENT 0.0
+.IP \(bu 2
+\fBatrsize\fP cannot change the sector size (density) of an image under
+any circumstances. Only the sector count may be changed.
+.IP \(bu 2
+\fBatrsize\fP will fail if the input file doesn\(aqt have a valid ATR header.
+If it\(aqs an XFD (raw) image, use \fBxfd2atr\fP(1) to convert it to an ATR first.
+.UNINDENT
+.SH EXIT STATUS
+.sp
+Exit status is zero for success, non\-zero for failure.
+.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.
+.