path: root/axe.1

.\" 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 "AXE" 1 "2024-05-03" "0.2.1" "Urchlay's Atari 8-bit Tools"
.SH NAME
axe \- ATR/XFD Editor
.\" RST source for axe(1) man page. Convert with:
.
.\" rst2man.py axe.rst > axe.1
.
.\" rst2man.py comes from the SBo development/docutils package.
.
.SH SYNOPSIS
.sp
\fBaxe\fP [\fI\-alvtu\fP] [\fI\-b newimage\fP] [\fI\-D file\fP] [\fI\-x file\fP] [\fI\-w file\fP] [\fI\-c dirname\fP] [\fI\-t\fP] [\fI\-d sector\fP] [\fIimagefile\fP]
.SH DESCRIPTION
.sp
\fBaxe\fP allows the user to access files stored inside a single\-density
Atari DOS 2.0S disk image (ATR or XFD). It can list the directory,
copy files into and out of the image, delete files in the image,
create a new image (either blank or containing files), and dump various
low\-level information about the image\(aqs filesystem structure.
.SH OPTIONS
.SS Standard Options:
.INDENT 0.0
.TP
.B \-b \fIfilename\fP
Create blank ATR image file called \fIfilename\fP\&. If \fIfilename\fP
already exists, it will be overwritten with no warning.
.TP
.B \-c \fIdirectory\fP
Create new ATR \fIimagefile\fP with contents of \fIdirectory\fP\&. If \fIimagefile\fP
already exists, it will be overwritten with no warning. Similar to \fBtar cf\fP\&.
.TP
.B \-D \fIfile\fP
Delete \fIfile\fP from \fIimagefile\fP\&. Ignores "locked" bit.
.TP
.B \-t \fIdirectory\fP
Extract all files in image to \fIdirectory\fP, which will be created and
must not already exist. Similar to \fBtar xf\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B  \-u
Unix <\-> Atari newline/EOL translation (use for text files only; breaks other file types).
.UNINDENT
.INDENT 0.0
.TP
.B \-w \fIfile\fP
Write \fIfile\fP to \fIimagefile\fP, overwrites if \fIfile\fP already exists. Ignores "locked" bit.
.TP
.B \-x \fIfile\fP
Extract (read) file from \fIimagefile\fP, write to current directory.
.UNINDENT
.SS Debugging Options:
.INDENT 0.0
.TP
.B  \-a
List all directory entries, even deleted/empty ones.
.UNINDENT
.INDENT 0.0
.TP
.B \-d \fIsector\fP
Dump a sector in decimal, hex, and binary.
.UNINDENT
.INDENT 0.0
.TP
.B  \-l
Trace and print sector links for all files on disk.
.TP
.B  \-v
Dump VTOC (sector 360) in decimal, hex, and binary.
.UNINDENT
.SH LIMITATIONS
.sp
\fBaxe\fP is ancient code, from last century. It has various design
flaws and bugs. At this point, it would be better to rewrite it from
scratch than to try & fix the existing code.
.sp
Only Atari DOS 2.0S and 100% compatible single\-density disk images are
supported. MyDOS images will work, but there\(aqs no support for MyDOS
subdirectories. There\(aqs no support for e.g. SpartaDOS or Atari DOS
3.0/4.0. Atari DOS 2.5 enhanced density images will work, the same
way they work on DOS 2.0S: files using the extra sectors will not be
readable, and \fBaxe\fP won\(aqt write to the extra sectors. Atari DOS 1.0
images (which are \fIvery\fP rare) can at least have the directory listed,
but I wouldn\(aqt recommend writing to them.
.sp
The "file locked" (aka read\-only) bit is ignored when writing, and
there\(aqs no way to lock or unlock files, though locked files do appear
with * next to the name in the directory listing.
.sp
It\(aqs possible to create files in a disk image with invalid filenames,
e.g. beginning with a number, or containing punctuation. Atari DOS
might or might not be able to even delete such files, but \fBaxe\fP will
be able to if it happens.
.sp
\fBaxe\fP does nothing with the boot sectors (sectors 1\-3) of the disk
image. When creating a new image, the boot sectors will be blank (all
zeroes), meaning the disk won\(aqt be bootable. If DOS.SYS is written to
an image with a DOS boot record, the boot record won\(aqt be updated with
the first sector of DOS.SYS, so the disk won\(aqt be bootable.
.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),
\fBblob2xex\fP(1),
\fBcart2xex\fP(1),
\fBdasm2atasm\fP(1),
\fBf2toxex\fP(1),
\fBfenders\fP(1),
\fBrom2cart\fP(1),
\fBunmac65\fP(1),
\fBxexamine\fP(1),
\fBxexcat\fP(1),
\fBxexsplit\fP(1),
\fBxfd2atr\fP(1),
\fBxex\fP(5),
\fBatascii\fP(7).
.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.
.