ftp.nice.ch/pub/next/tools/disk/sdformat.1.3.README

This is the README for sdformat.1.3.NIHS.b.tar.gz [Download] [Browse] [Up]

sdformat
--------

INTRO
-----

sdformat is an enhanced replacement for the sdform utility shipped with
NEXTSTEP.  It allows selection of the SCSI device's block size for improved
performance - both in access speed and available free space.


REVISION HISTORY
----------------

This is the third major release version of sdformat (Version 1.3), and the
first to support NEXTSTEP on NeXT/Motorola, Intel, HP-PA RISC and Sparc
processors.

There was only one reported problem with Version 0.9, so version 1.1 was
released to address problems with very large hard drives (about 3 GB or more).
It has since been proven to work with drives as large as 9 GB (The Seagate
ELITE), even though NeXT's sdform would not work on that drive.  Version 1.2
added more verbose error message text from the ANSI SCSI specification, in
addition to HP-PA support.  Now, version 1.3 is friendlier to other SCSI
programs and has improved error reporting.


BACKGROUND
----------

One of the most popular performance enhancements for NEXTSTEP workstations is
to do a low-level format of all capable SCSI drives at a block size of 1024
bytes.  If you have a new drive, or if you have backed up all data on your
current drive, then you might consider wiping the slate clean and starting over
with a faster, larger drive (for free!)


sdformat does what you cannot do with the utilities supplied by NeXT.  I
believe it is easier to use than the "formatter" utility on the archives - and
compatible with more drives.

For some strange reason, the formatting utilities included in NEXTSTEP are not
orthogonal in features.  Specifically, fdform allows specification of the block
size as 512 or 1024 bytes, but sdform has no such option.  sdform is also
limited to working with SCSI devices which were attached when the system was
started, simply because it takes a raw device name instead of a SCSI id.

Hence the need for sdformat.

sdformat, which is available as a FAT binary, is capable of formatting any SCSI
device selected by its target ID (and logical unit number, if applicable).  The
utility can also be used to examine the current settings for a particular
device's block size.  You will only need root access for drives which were
attached and powered up when NEXTSTEP was booted, otherwise any user can just
power up a new drive, format, and reboot to initialize the drive with the file
system of your choice (sdformat does not handle the step of file system
initialization, but neither does sdform or fdform).  Drive cables should only
be attached while the computer is halted or powered off, but the drive may be
powered up and down while NEXTSTEP is running so long as you do not power off
a mounted drive.


Need further convincing?

If you aren't already convinced that you want to back up your drive and execute
a low-level reformat, read on!

For space increase, you can expect numbers like the following:

Original    Reformat    Increase    Drive
406.5 MB    419.9 MB    13.39 MB    Seagate ST1480N (NeXT supplied 400 MB)
1.156 GB    1.227 GB    73.30 MB    Maxtor MXT-1240S
                        5.407%      Seagate ST41650N (Wren VIII)

I have not personally measured the inherent increases in throughput
performance, but figures ranging from 20% to 25% have been reported by users of
sdformat.


LEGAL STUFF
-----------

I am tired of legalese, so I will word the following in plain english.  The
language should be precise enough to avoid misunderstanding in the event that
legal action is necessary.

I cannot be responsible for data loss.  This program is designed to do a
low-level format of a SCSI device under user control.  "Format" implies data
loss by definition.  If you ask for this operation with the right options, you
WILL erase your drive.  I can say that I highly doubt that there is any way to
permanently damage a SCSI device when using sdformat, other than data loss.
Note: There was one report from the Internet by someone who knew of an IBM
drive which would destroy its factory formatting if the SCSI format command was
issued, but I would consider that a firmware bug.

Please do not charge money for this utility or for any service you provide
using this utility.  Please do not remove my name from this README, the
accompanying man page, or the executable.  Please do not distribute modified
versions of these files.  I hold the copyrights for this utility and do not
give permission for it to be distributed on CD-ROM without my prior written
permission.  For those of you who are compiling CD-ROM archives of software
available freely via ftp, these restrictions are aimed directly at you -
especially if you are planning to charge for the CD-ROM, but even if you are
not.  For those of you who make a living formatting SCSI drives for others, you
will have to find some other program if the standard NEXTSTEP tools are not
sufficient.  Exceptions will be made only for those who contact me for
licensing information.  I would suggest keeping a copy of this README around to
remind you not to forget about the restrictions I have placed on this free
software.  Future versions are not guaranteed to be free.

Apart from the explicit warnings about inherent data loss, there are no other
guarantees or warranties associated with this free software.  You must accept
it as is or do without.


INSTALLATION INSTRUCTIONS
-------------------------

Two packages are available:

1) sdformat.FAT.tar.gz  is FAT (as the name implies), and includes a man page.
Anyone who can execute FAT binaries should have gzip available in their version
of NEXTSTEP in order to uncompress this package using the following commands:

3.2> gnutar zxf sdformat_1.3.MIHS.tar.gz
3.1> gzcat sdformat_1.3.MIHS.tar.gz | gnutar xvf -

2) sdformat.tar.Z  is for Motorola (true Black NeXT hardware) systems, and also
includes the same man page.  It has not been tested under 3.0 or earlier, but
it should work.  Note: At this time, only the beta version, 0.9, is available
for 3.0 or earlier.  Use the following command to uncompress:

zcat sdformat.tar.Z | tar xf -


Both packages have the following recommended installation points:

/usr/local/bin/sdformat
/usr/local/man/man8/sdformat.8

or you can use ~/Unix/bin and ~/Unix/man/man8


As an exercise for the reader, I leave the process for adding new man page
directories (hint, take a look in /etc/login.std and /etc/cshrc.std after
searching for MANPATH in the ManPages target of Digital Librarian).


PARTING NOTE
------------

sdformat does not Initialize the SCSI device.  In this respect it is just like
NeXT's own sdform.  When sdformat is finished, you must decide whether to
create a BFFS, DOS (not very useful), or Macintosh (probably impossible)
volume.  I usually just let Workspace.app handle the Initialization, since it
tends to want to do so automatically.  Please do not contact me for help in
initializing your disk, and especially not if you need to partition your large
(greater than 2 GB) disk.  For these tasks, I would suggest becoming an expert
on the /etc/disk utility shipped with NEXTSTEP - or perhaps you can consult the
NEXTSTEP FAQ as posted to comp.sys.next.announce


    Brian Willoughby    Software Design Engineer, BSEE from NCSU
NeXTmail welcome        Sound Consulting: Software Design and Development
BrianW@SoundS.WA.com    Bellevue, WA

These are the contents of the former NiCE NeXT User Group NeXTSTEP/OpenStep software archive, currently hosted by Netfuture.ch.