usr.sbin/fdwrite/fdwrite.1

   1 .\"
   2 .\" ----------------------------------------------------------------------------
   3 .\" "THE BEER-WARE LICENSE" (Revision 42):
   4 .\" <phk@FreeBSD.org> wrote this file.  As long as you retain this notice you
   5 .\" can do whatever you want with this stuff. If we meet some day, and you think
   6 .\" this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
   7 .\" ----------------------------------------------------------------------------
   8 .\"
   9 .\" $FreeBSD$
  10 .\"
  11 .\"
  12 .Dd September 16, 1993
  13 .Dt FDWRITE 1
  14 .Os
  15 .Sh NAME
  16 .Nm fdwrite
  17 .Nd format and write floppy disks
  18 .Sh SYNOPSIS
  19 .Nm
  20 .Op Fl v
  21 .Op Fl y
  22 .Op Fl f Ar inputfile
  23 .Op Fl d Ar device
  24 .Sh DESCRIPTION
  25 The
  26 .Nm
  27 utility formats and writes one and more floppy disks.
  28 Any floppy disk device capable of formatting can be used.
  29 .Pp
  30 The
  31 .Nm
  32 utility will ask the user
  33 (on
  34 .Pa /dev/tty )
  35 to insert a new floppy and press return.
  36 The device will then be opened, and queried for its parameters,
  37 then each track will be formatted, written with data from the
  38 .Ar inputfile ,
  39 read back and compared.
  40 When the floppy disk is filled, the process is repeated, with the next disk.
  41 This continues until the program is interrupted or EOF is encountered on the
  42 .Ar inputfile .
  43 .Pp
  44 The options are as follows:
  45 .Bl -tag -width 10n -offset indent
  46 .It Fl v
  47 Toggle verbosity on stdout.
  48 Default is ``on''.
  49 After
  50 .Ar device
  51 is opened first time the format will be printed.
  52 During operation progress will be reported with the number of tracks
  53 remaining on the current floppy disk, and the letters I, Z, F, W,
  54 R and C, which indicates completion of Input, Zero-fill, Format
  55 Write, Read and Compare of current track respectively.
  56 .It Fl y
  57 Do not ask for presence of a floppy disk in the drive.
  58 This non-interactive flag
  59 is useful for shell scripts.
  60 .It Fl f Ar inputfile
  61 Input file to read.
  62 If none is given, stdin is assumed.
  63 .It Fl d Ar device
  64 The name of the floppy device to write to.
  65 Default is
  66 .Pa /dev/fd0 .
  67 .El
  68 .Pp
  69 The
  70 .Nm
  71 utility actually closes the
  72 .Ar device
  73 while it waits for the user to press return,
  74 it is thus quite possible to use the drive for other purposes at this
  75 time and later resume writing with the next floppy.
  76 .Pp
  77 The parameters returned from
  78 .Ar device
  79 are used for formatting.
  80 If custom formatting is needed, please use
  81 .Xr fdformat 1
  82 instead.
  83 .Sh EXAMPLES
  84 The
  85 .Nm
  86 utility
  87 was planned as a tool to make life easier when writing a set of floppies,
  88 one such use could be to write a tar-archive:
  89 .Pp
  90 .Dl "tar cf - . | gzip -9 | fdwrite -d /dev/fd0.1720 -v
  91 .Pp
  92 The main difference from using
  93 .Xr tar 1 Ns 's
  94 multivolume facility is of course the formatting of the floppies, which
  95 here is done on the fly,
  96 thus reducing the amount of work for the floppy-jockey.
  97 .Sh SEE ALSO
  98 .Xr fdformat 1
  99 .Sh HISTORY
 100 The
 101 .Nm
 102 utility was written while waiting for ``make world'' to complete.
 103 Some of the code was taken from
 104 .Xr fdformat 1 .
 105 .Sh AUTHORS
 106 The program has been contributed by
 107 .An Poul-Henning Kamp Aq phk@FreeBSD.org .
 108 .Sh BUGS
 109 Diagnostics are less than complete at present.
 110 .Pp
 111 If a floppy is sick, and the
 112 .Ar inputfile
 113 is seekable, it should ask the user to frisbee the disk, insert
 114 another, and rewind to the right spot and continue.
 115 .Pp
 116 This concept could be extended to cover non-seekable input also
 117 by employing a temporary file.
 118 .Pp
 119 An option (defaulting to zero) should allow the user to ask for
 120 retries in case of failure.
 121 .Pp
 122 At present a suitable tool for reading back a multivolume set
 123 of floppies is missing.
 124 Programs like
 125 .Xr tar 1
 126 for instance, will do the job, if the data has not been compressed.
 127 One can always trust
 128 .Xr dd 1
 129 to help out in this situation of course.