From 33aa86ca08798fd96296c648d1b9a69bc219b948 Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Thu, 10 Nov 2016 00:03:36 +0000 Subject: system/franny: Added (Atari 8-bit disk image utility). Signed-off-by: David Spencer --- system/franny/README | 4 + system/franny/franny.1 | 341 ++++++++++++++++++++++++++++++++++++++++ system/franny/franny.SlackBuild | 92 +++++++++++ system/franny/franny.info | 10 ++ system/franny/franny.rst | 286 +++++++++++++++++++++++++++++++++ system/franny/slack-desc | 19 +++ 6 files changed, 752 insertions(+) create mode 100644 system/franny/README create mode 100644 system/franny/franny.1 create mode 100644 system/franny/franny.SlackBuild create mode 100644 system/franny/franny.info create mode 100644 system/franny/franny.rst create mode 100644 system/franny/slack-desc (limited to 'system/franny') diff --git a/system/franny/README b/system/franny/README new file mode 100644 index 0000000000..f62f5a6b88 --- /dev/null +++ b/system/franny/README @@ -0,0 +1,4 @@ +franny (Atari 8-bit disk image utility) + +Franny is a command-line ATR disk image editor. It supports AtariDOS II +and SpartaDOS 2 disk formats. diff --git a/system/franny/franny.1 b/system/franny/franny.1 new file mode 100644 index 0000000000..2a1eaf7f0e --- /dev/null +++ b/system/franny/franny.1 @@ -0,0 +1,341 @@ +.\" Man page generated from reStructuredText. +. +.TH FRANNY 1 "2016-11-09" "1.1.3" "SlackBuilds.org" +.SH NAME +franny \- Atari 8-bit disk image editor +. +.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 +.. +.\" RST source for franny(1) man page. Convert with: +. +.\" rst2man.py franny.rst > franny.1 +. +.\" rst2man.py comes from the SBo development/docutils package. +. +.SH SYNOPSIS +.sp +franny [\fI\-options\fP] [\fIfile.atr\fP] +.sp +franny\-extract.sh [\fIfile.atr\fP] [\fItarget_directory\fP] +.sp +franny\-insert.sh [\fIfile.atr\fP] [\fIsource_directory\fP] +.SH DESCRIPTION +.sp +Franny is an ATR and XFD disk image editor. It supports AtariDOS II and +SpartaDOS 2 and 3 disk formats. Single, enhanced, double, and custom +formats are supported, though writing to AtariDOS images is limited to +the first 720 sectors. +.sp +There are also two scripts: +.INDENT 0.0 +.TP +.B franny\-extract.sh +dump all files from ATR or XFD to specified directory (works like atr2unix) +.TP +.B franny\-insert.sh +insert all files from specified directory to ATR (works like unix2atr) +.UNINDENT +.SH OPTIONS +.sp +All options that take an argument require a space between the option +and its argument, \fIexcept\fP the \-L option, which doesn\(aqt allow a space. +.sp +Generally, uppercase options can be thought of as commands, which edit +the given disk image, and lowercase options can be thought of as options +to the uppercase commands. +.INDENT 0.0 +.TP +.B \-A +Add file to image. Paths must be given by using \-i and \-o. Writing past +sector 720 on an AtariDOS image is not supported. +.TP +.B \-C +Create new image. Will not be bootable. Use \-d, \-f, \-m, \-s, \-t, \-T options +to control the image type. Default is 256 bytes per sector, 720 sectors, +SpartaDOS filesystem, ATR image, normal (non\-sio2ide) image type. +.UNINDENT +.INDENT 0.0 +.TP +.B \-d [s|d] +Sector size for \-C [single|double]; default: double. Single is 128 bytes/sector, double +is 256. +.TP +.B \-f [a|s] +File system type for \-C [AtariDOS II|Sparta 2.0]; default: Sparta 2.0. +.UNINDENT +.INDENT 0.0 +.TP +.B \-F +Format image. Ignores any \-d, \-f, \-m, \-s, \-t, \-T options. +.TP +.B \-h +Show help and exit. +.TP +.BI \-i \ filename +Input filename (source file for \-A and \-S). When using the \-S option, +the filename is treated case\-insensitively, unless it contains a +directory path. +.TP +.B \-I +Image summary. Shows disk label, filesystem type, density, total +sectors, free sectors, image type (standard or sio2ide) and image +media (ATR for ATR images, RAW for XFD images). +.TP +.BI \-l \ format +List format used by \-L. Default is \fB"A F.E S B D T"\fP\&. The format specifiers +are: +.sp +\fBA\fP: Attributes (R for locked files, D for directories, H for hidden files) +.sp +\fBB\fP: Size in bytes +.sp +\fBD\fP: Date. For AtariDOS images, this is always "00\-00\-2000". +.sp +\fBE\fP: Filename extension +.sp +\fBF\fP: Filename (minus the extension) +.sp +\fBS\fP: Size in sectors +.sp +\fBT\fP: Time. For AtariDOS images, this is always "00:00:00". +.sp +Any other character represents itself. The list above is case\-insensitive. +.sp +For example, this gives a more AtariDOS\-like display: +.INDENT 7.0 +.INDENT 3.5 +franny \-L \-l "fe s" file.atr +.UNINDENT +.UNINDENT +.TP +.BI \-L\fB mask +List directory. Mask is optional; default: *.* (all files). NOTE +that NO SPACE is allowed before the mask, unlike all the other franny +options! Also, the mask is case\-sensitive (e.g. \-L*.SYS, not \-L*.sys). +Files using the DOS 2.5 extra sectors on enhanced density disks will +display, but without the < > around them like DOS 2.5 does. +.UNINDENT +.INDENT 0.0 +.TP +.B \-m [a|r] +Media type for \-C (atr|raw); default: atr. Raw images are also known as XFD images. +.UNINDENT +.INDENT 0.0 +.TP +.BI \-M \ dirname +Create directory. Only works for SpartaDOS images. +.TP +.BI \-N \ name +Set volume name. Only works for SpartaDOS images. +.TP +.BI \-o \ filename +Output filename (destination file for \-A and \-S). When using the \-A option, +the filename is treated case\-insensitively, unless it contains a directory path. +.UNINDENT +.INDENT 0.0 +.TP +.B \-O [a|r] +New media type (BROKEN). This option is apparently supposed to convert +between ATR and XFD, but it doesn\(aqt appear to actually do anything. +.UNINDENT +.INDENT 0.0 +.TP +.BI \-R \ dirname +Remove dir. Only works for SpartaDOS images. +.TP +.BI \-s \ sectors +Total sectors for \-C. For standard single or double density, use 720. For 1050 enhanced +density (aka \(aqmedium\(aq), use 1040. +.TP +.B \-S +Save (extract) filename from image. Paths must be given with \-i and \-o. +.UNINDENT +.INDENT 0.0 +.TP +.B \-t [s|m|d|f|F] +Image templates for \-C [single|medium|double|full/Full(65535 sectors, 128/256 bytes each)]. +Used for \-C option. \(aqs\(aq is equivalent to "\-s 720 \-d s", etc. +.TP +.B \-T [d|s] +change image type (default|sio2ide). Only applies to ATR images, not RAW/XFD. +.UNINDENT +.INDENT 0.0 +.TP +.BI \-U \ Filename +Unlink (remove) file. filename is case\-sensitive. +.TP +.B \-v +Show version and exit. +.TP +.BI \-V \ sector +view (dump) sector in hex and ASCII. Output is OK for ATR images but +badly formatted for raw/XFD. +.UNINDENT +.SH EXIT STATUS +.sp +franny returns 0 for success and non\-zero for failure. On failure, +a diagnostic message is printed to standard error. +.SH DIAGNOSTICS +.sp +franny: You can specify only one command. +.INDENT 0.0 +.INDENT 3.5 +Only one of the \-A \-C \-I \-L \-M \-N \-O \-R \-S \-T \-U \-V options may be given. +.UNINDENT +.UNINDENT +.sp +franny: Cannot open image \(aq[\fIimage\fP]\(aq +.INDENT 0.0 +.INDENT 3.5 +This means the image is invalid. Either it\(aqs not actually an Atari +disk image, or it\(aqs a boot disk that doesn\(aqt contain a filesystem, +or it\(aqs a truncated image (see NOTES), or you don\(aqt have permission +to read the file. +.UNINDENT +.UNINDENT +.sp +franny: Specified file is not regular file. +.INDENT 0.0 +.INDENT 3.5 +Means the image file or the file given to the \-i / \-o options doesn\(aqt +exist, or is something other than a regular file or a symlink to a +regular file (e.g. a directory or a device node). +.UNINDENT +.UNINDENT +.sp +franny: Command failed. +.INDENT 0.0 +.INDENT 3.5 +Catch\-all error message. Can be caused by: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP \(bu 2 +attempting to access a nonexistant file in the image +.IP \(bu 2 +a \(aqdisk full\(aq condition (trying to copy too much data into the image) +.IP \(bu 2 +trying to create/delete a subdirectory on an AtariDOS image (currently not supported) +.IP \(bu 2 +trying to delete or overwrite a locked file in the image (unfortunately franny has no way to unlock files) +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.sp +franny: Cannot change directory. +.INDENT 0.0 +.INDENT 3.5 +For SpartaDOS images, the given subdirectory doesn\(aqt exist within the image. Remember to use > +as a path separator, and quote any arguments containing > to avoid the shell +interpreting it as a redirection. Also, directory names are case\-sensitive. +.sp +For AtariDOS images, any attempt to copy files to/from a subdirectory +will give this error, as subdirs aren\(aqt supported in AtariDOS images. +.UNINDENT +.UNINDENT +.SH NOTES +.sp +franny is intended for use only with disk images containing +AtariDOS/MyDOS\-compatible or SpartaDOS 2/3 filesystems. Attempting to +edit non\-filesystem\-bearing images (such as boot disks) will fail and/or +have unpredictable results. +.sp +Most emulators support truncated or \(aqshort\(aq disk images, where only the +sectors actually used are stored in the file. franny is unable to operate +properly with truncated images, even if the missing part of the image +contains no filesystem data (sectors containing all zeroes). This type +of image can be turned back into a full image with a dd command such as +.INDENT 0.0 +.INDENT 3.5 +dd if=truncated.atr of=fixed.atr bs=92176 count=1 conv=sync +.UNINDENT +.UNINDENT +.sp +92176 is for a single\-density image. Replace with 184336 for double density +or 133120 for 1050 enhanced density. For ATR images, this is \fB(number_of_sectors * bytes_per_sector) + 16\fP\&. For XFD (raw) images, don\(aqt add the 16. +.sp +The \-I option will mis\-identify most non\-filesystem boot or data disks as +containing a Sparta 2 filesystem. The other options will (usually?) fail +with \(aqCannot open image\(aq for non\-fs disks (see DIAGNOSTICS). +.sp +Filenames within the image can be entered in lowercase with the \-i or \-o +options, but they\(aqre always converted to uppercase (and truncated to 8.3 +format, if they\(aqre not already). If the filename contains a directory +path, only the base filename gets converted, NOT the directory name(s). +Also, this ONLY applies to \-i and \-o. The other options that take Atari +filenames require them to match exactly (e.g. \-U autorun.sys will fail, +use \-U AUTORUN.SYS instead). +.sp +There is no way to delete or overwrite a locked file within the image, as +franny has no Unlock option. There\(aqs also no Lock option. +.sp +Also missing is a Rename option. To rename a file, do something like this: +.INDENT 0.0 +.INDENT 3.5 +franny \-S \-i sxhand.sys \-o sxhand.sys image.atr +.sp +franny \-U SXHAND.SYS image.atr +.sp +franny \-A \-i sxhand.sys \-o autorun.sys image.atr +.UNINDENT +.UNINDENT +.sp +The above renames SXHAND.SYS to AUTORUN.SYS. Note that the \-U option +required the filename in uppercase. +.sp +The \-O option doesn\(aqt work. You can convert an ATR image to a raw one +with dd: +.INDENT 0.0 +.INDENT 3.5 +dd if=disk.atr of=disk.xfd bs=16 skip=1 +.UNINDENT +.UNINDENT +.SH BUGS +.sp +Some things are not implemented yet. Main disability is write support for +enhanced density in AtariDOS II disk format. Second problem is mydos\(aqs +subdirectories. An extra tool to develop is a gui. +.sp +The \-O (new media type) option doesn\(aqt work. +.sp +The franny\-insert.sh script will fail, if any of the files/directories +contain spaces or other shell metacharacters such as > or |. +.sp +Report bugs to \fI\%ten.egrofecruos.stsil@leved\-8irata\fP\&. +.SH COPYRIGHT +.sp +See the file /usr/doc/franny\-1.1.3/copying for license information. +.SH AUTHORS +.sp +Rafael \(aqBob_er\(aq Ciepiela <\fI\%ten.egrofecruos.sresu@re_bob\fP> \- Coder and designer of the franny program itself. +.sp +This man page written for the SlackBuilds.org project +by B. Watson, and is licensed under the WTFPL. +.\" Generated by docutils manpage writer. +. diff --git a/system/franny/franny.SlackBuild b/system/franny/franny.SlackBuild new file mode 100644 index 0000000000..e2520299f6 --- /dev/null +++ b/system/franny/franny.SlackBuild @@ -0,0 +1,92 @@ +#!/bin/sh + +# Slackware build script for franny + +# Written by B. Watson (yalhcru@gmail.com) + +# Licensed under the WTFPL. See http://www.wtfpl.net/txt/copying/ for details. + +PRGNAM=franny +VERSION=${VERSION:-1.1.3} +BUILD=${BUILD:-1} +TAG=${TAG:-_SBo} + +if [ -z "$ARCH" ]; then + case "$( uname -m )" in + i?86) ARCH=i586 ;; + arm*) ARCH=arm ;; + *) ARCH=$( uname -m ) ;; + esac +fi + +CWD=$(pwd) +TMP=${TMP:-/tmp/SBo} +PKG=$TMP/package-$PRGNAM +OUTPUT=${OUTPUT:-/tmp} + +if [ "$ARCH" = "i586" ]; then + SLKCFLAGS="-O2 -march=i586 -mtune=i686" + LIBDIRSUFFIX="" +elif [ "$ARCH" = "i686" ]; then + SLKCFLAGS="-O2 -march=i686 -mtune=i686" + LIBDIRSUFFIX="" +elif [ "$ARCH" = "x86_64" ]; then + SLKCFLAGS="-O2 -fPIC" + LIBDIRSUFFIX="64" +else + SLKCFLAGS="-O2" + LIBDIRSUFFIX="" +fi + +set -e + +rm -rf $PKG +mkdir -p $TMP $PKG $OUTPUT +cd $TMP +rm -rf $PRGNAM-$VERSION +tar xvf $CWD/$PRGNAM-$VERSION.tgz +cd $PRGNAM-$VERSION +chown -R root:root . +find -L . \ + \( -perm 777 -o -perm 775 -o -perm 750 -o -perm 711 -o -perm 555 \ + -o -perm 511 \) -exec chmod 755 {} \; -o \ + \( -perm 666 -o -perm 664 -o -perm 640 -o -perm 600 -o -perm 444 \ + -o -perm 440 -o -perm 400 \) -exec chmod 644 {} \; + +# doubleplusungood refs unfiles. +sed -i 's,\$(PACKAGE)\.\(mo\|pot\|1\),,g' Makefile + +# ugh. +sed -i "s,-g\\>,$SLKCFLAGS," Makefile + +# -L/lib is the default already on 32-bit slack, and doesn't cause +# a problem on pure 64-bit slack... but it'll break the build on +# multilib, so get rid of it. +sed -i "s,-L/lib,," Makefile + +# binary installed stripped by default. +make $PRGNAM install PREFIX=$PKG/usr + +# extract.sh and insert.sh names are too generic, rename: +mv $PKG/usr/bin/extract.sh $PKG/usr/bin/$PRGNAM-extract.sh +mv $PKG/usr/bin/insert.sh $PKG/usr/bin/$PRGNAM-insert.sh + +# fix hardcoded /usr/local paths... +sed -i 's,/local,,' $PKG/usr/bin/$PRGNAM-*.sh + +# upstream's man page is missing, I made this from the homepage +# plus some of my own observations. +mkdir -p $PKG/usr/man/man1 +gzip -9c < $CWD/$PRGNAM.1 > $PKG/usr/man/man1/$PRGNAM.1.gz +ln -s $PRGNAM.1.gz $PKG/usr/man/man1/$PRGNAM-extract.1.gz +ln -s $PRGNAM.1.gz $PKG/usr/man/man1/$PRGNAM-insert.1.gz + +mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION +cp -a copying $PKG/usr/doc/$PRGNAM-$VERSION +cat $CWD/$PRGNAM.SlackBuild > $PKG/usr/doc/$PRGNAM-$VERSION/$PRGNAM.SlackBuild + +mkdir -p $PKG/install +cat $CWD/slack-desc > $PKG/install/slack-desc + +cd $PKG +/sbin/makepkg -l y -c n $OUTPUT/$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.${PKGTYPE:-tgz} diff --git a/system/franny/franny.info b/system/franny/franny.info new file mode 100644 index 0000000000..8e77e3f7a1 --- /dev/null +++ b/system/franny/franny.info @@ -0,0 +1,10 @@ +PRGNAM="franny" +VERSION="1.1.3" +HOMEPAGE="http://atari8.sourceforge.net/franny.html" +DOWNLOAD="http://downloads.sourceforge.net/project/atari8/franny/Franny-1.1.3/franny-1.1.3.tgz" +MD5SUM="8dc682ff61f7b2c4da7aee520f6c002c" +DOWNLOAD_x86_64="" +MD5SUM_x86_64="" +REQUIRES="" +MAINTAINER="B. Watson" +EMAIL="yalhcru@gmail.com" diff --git a/system/franny/franny.rst b/system/franny/franny.rst new file mode 100644 index 0000000000..65a5a3c798 --- /dev/null +++ b/system/franny/franny.rst @@ -0,0 +1,286 @@ +.. RST source for franny(1) man page. Convert with: +.. rst2man.py franny.rst > franny.1 +.. rst2man.py comes from the SBo development/docutils package. + +.. |version| replace:: 1.1.3 +.. |date| date:: + +====== +franny +====== + +----------------------------- +Atari 8-bit disk image editor +----------------------------- + +:Manual section: 1 +:Manual group: SlackBuilds.org +:Date: |date| +:Version: |version| + +SYNOPSIS +======== + +franny [*-options*] [*file.atr*] + +franny-extract.sh [*file.atr*] [*target_directory*] + +franny-insert.sh [*file.atr*] [*source_directory*] + +DESCRIPTION +=========== + +Franny is an ATR and XFD disk image editor. It supports AtariDOS II and +SpartaDOS 2 and 3 disk formats. Single, enhanced, double, and custom +formats are supported, though writing to AtariDOS images is limited to +the first 720 sectors. + +There are also two scripts: + +franny-extract.sh + dump all files from ATR or XFD to specified directory (works like atr2unix) + +franny-insert.sh + insert all files from specified directory to ATR (works like unix2atr) + +OPTIONS +======= + +All options that take an argument require a space between the option +and its argument, *except* the -L option, which doesn't allow a space. + +Generally, uppercase options can be thought of as commands, which edit +the given disk image, and lowercase options can be thought of as options +to the uppercase commands. + +-A + Add file to image. Paths must be given by using -i and -o. Writing past + sector 720 on an AtariDOS image is not supported. + +-C + Create new image. Will not be bootable. Use -d, -f, -m, -s, -t, -T options + to control the image type. Default is 256 bytes per sector, 720 sectors, + SpartaDOS filesystem, ATR image, normal (non-sio2ide) image type. + +-d [s|d] + Sector size for -C [single|double]; default: double. Single is 128 bytes/sector, double + is 256. + +-f [a|s] + File system type for -C [AtariDOS II|Sparta 2.0]; default: Sparta 2.0. + +-F + Format image. Ignores any -d, -f, -m, -s, -t, -T options. + +-h + Show help and exit. + +-i filename + Input filename (source file for -A and -S). When using the -S option, + the filename is treated case-insensitively, unless it contains a + directory path. + +-I + Image summary. Shows disk label, filesystem type, density, total + sectors, free sectors, image type (standard or sio2ide) and image + media (ATR for ATR images, RAW for XFD images). + +-l format + List format used by -L. Default is **"A F.E S B D T"**. The format specifiers + are: + + **A**: Attributes (R for locked files, D for directories, H for hidden files) + + **B**: Size in bytes + + **D**: Date. For AtariDOS images, this is always "00-00-2000". + + **E**: Filename extension + + **F**: Filename (minus the extension) + + **S**: Size in sectors + + **T**: Time. For AtariDOS images, this is always "00:00:00". + + Any other character represents itself. The list above is case-insensitive. + + For example, this gives a more AtariDOS-like display: + + franny -L -l "fe s" file.atr + +-Lmask + List directory. Mask is optional; default: \*.\* (all files). NOTE + that NO SPACE is allowed before the mask, unlike all the other franny + options! Also, the mask is case-sensitive (e.g. -L*.SYS, not -L*.sys). + Files using the DOS 2.5 extra sectors on enhanced density disks will + display, but without the < > around them like DOS 2.5 does. + +-m [a|r] + Media type for -C (atr|raw); default: atr. Raw images are also known as XFD images. + +-M dirname + Create directory. Only works for SpartaDOS images. + +-N name + Set volume name. Only works for SpartaDOS images. + +-o filename + Output filename (destination file for -A and -S). When using the -A option, + the filename is treated case-insensitively, unless it contains a directory path. + +-O [a|r] + New media type (BROKEN). This option is apparently supposed to convert + between ATR and XFD, but it doesn't appear to actually do anything. + +-R dirname + Remove dir. Only works for SpartaDOS images. + +-s sectors + Total sectors for -C. For standard single or double density, use 720. For 1050 enhanced + density (aka 'medium'), use 1040. + +-S + Save (extract) filename from image. Paths must be given with -i and -o. + +-t [s|m|d|f|F] + Image templates for -C [single|medium|double|full/Full(65535 sectors, 128/256 bytes each)]. + Used for -C option. 's' is equivalent to "-s 720 -d s", etc. + +-T [d|s] + change image type (default|sio2ide). Only applies to ATR images, not RAW/XFD. + +-U Filename + Unlink (remove) file. filename is case-sensitive. + +-v + Show version and exit. + +-V sector + view (dump) sector in hex and ASCII. Output is OK for ATR images but + badly formatted for raw/XFD. + +EXIT STATUS +=========== + +franny returns 0 for success and non-zero for failure. On failure, +a diagnostic message is printed to standard error. + +DIAGNOSTICS +=========== + +franny: You can specify only one command. + + Only one of the -A -C -I -L -M -N -O -R -S -T -U -V options may be given. + +franny: Cannot open image '[*image*]' + + This means the image is invalid. Either it's not actually an Atari + disk image, or it's a boot disk that doesn't contain a filesystem, + or it's a truncated image (see NOTES), or you don't have permission + to read the file. + +franny: Specified file is not regular file. + + Means the image file or the file given to the -i / -o options doesn't + exist, or is something other than a regular file or a symlink to a + regular file (e.g. a directory or a device node). + +franny: Command failed. + + Catch-all error message. Can be caused by: + + - attempting to access a nonexistant file in the image + + - a 'disk full' condition (trying to copy too much data into the image) + + - trying to create/delete a subdirectory on an AtariDOS image (currently not supported) + + - trying to delete or overwrite a locked file in the image (unfortunately franny has no way to unlock files) + +franny: Cannot change directory. + + For SpartaDOS images, the given subdirectory doesn't exist within the image. Remember to use > + as a path separator, and quote any arguments containing > to avoid the shell + interpreting it as a redirection. Also, directory names are case-sensitive. + + For AtariDOS images, any attempt to copy files to/from a subdirectory + will give this error, as subdirs aren't supported in AtariDOS images. + +NOTES +===== + +franny is intended for use only with disk images containing +AtariDOS/MyDOS-compatible or SpartaDOS 2/3 filesystems. Attempting to +edit non-filesystem-bearing images (such as boot disks) will fail and/or +have unpredictable results. + +Most emulators support truncated or 'short' disk images, where only the +sectors actually used are stored in the file. franny is unable to operate +properly with truncated images, even if the missing part of the image +contains no filesystem data (sectors containing all zeroes). This type +of image can be turned back into a full image with a dd command such as + + dd if=truncated.atr of=fixed.atr bs=92176 count=1 conv=sync + +92176 is for a single-density image. Replace with 184336 for double density +or 133120 for 1050 enhanced density. For ATR images, this is **(number_of_sectors * bytes_per_sector) + 16**. For XFD (raw) images, don't add the 16. + +The -I option will mis-identify most non-filesystem boot or data disks as +containing a Sparta 2 filesystem. The other options will (usually?) fail +with 'Cannot open image' for non-fs disks (see DIAGNOSTICS). + +Filenames within the image can be entered in lowercase with the -i or -o +options, but they're always converted to uppercase (and truncated to 8.3 +format, if they're not already). If the filename contains a directory +path, only the base filename gets converted, NOT the directory name(s). +Also, this ONLY applies to -i and -o. The other options that take Atari +filenames require them to match exactly (e.g. -U autorun.sys will fail, +use -U AUTORUN.SYS instead). + +There is no way to delete or overwrite a locked file within the image, as +franny has no Unlock option. There's also no Lock option. + +Also missing is a Rename option. To rename a file, do something like this: + + franny -S -i sxhand.sys -o sxhand.sys image.atr + + franny -U SXHAND.SYS image.atr + + franny -A -i sxhand.sys -o autorun.sys image.atr + +The above renames SXHAND.SYS to AUTORUN.SYS. Note that the -U option +required the filename in uppercase. + +The -O option doesn't work. You can convert an ATR image to a raw one +with dd: + + dd if=disk.atr of=disk.xfd bs=16 skip=1 + +BUGS +===== + +Some things are not implemented yet. Main disability is write support for +enhanced density in AtariDOS II disk format. Second problem is mydos's +subdirectories. An extra tool to develop is a gui. + +The -O (new media type) option doesn't work. + +The franny-insert.sh script will fail, if any of the files/directories +contain spaces or other shell metacharacters such as > or \|. + +Report bugs to ten.egrofecruos.stsil@leved-8irata. + +COPYRIGHT +========= + +See the file /usr/doc/franny-|version|/copying for license information. + +AUTHORS +======= + +Rafael 'Bob_er' Ciepiela - Coder and designer of the franny program itself. + +This man page written for the SlackBuilds.org project +by B. Watson, and is licensed under the WTFPL. + diff --git a/system/franny/slack-desc b/system/franny/slack-desc new file mode 100644 index 0000000000..6722429193 --- /dev/null +++ b/system/franny/slack-desc @@ -0,0 +1,19 @@ +# HOW TO EDIT THIS FILE: +# The "handy ruler" below makes it easier to edit a package description. +# Line up the first '|' above the ':' following the base package name, and +# the '|' on the right side marks the last column you can put a character in. +# You must make exactly 11 lines for the formatting to be correct. It's also +# customary to leave one space after the ':' except on otherwise blank lines. + + |-----handy-ruler------------------------------------------------------| +franny: franny (Atari 8-bit disk image utility) +franny: +franny: Franny is a command-line ATR disk image editor. It supports AtariDOS +franny: II and SpartaDOS 2 disk formats. +franny: +franny: +franny: +franny: +franny: +franny: +franny: -- cgit v1.2.3