BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.sbin / rmt / rmt.8

diff --git a/usr/src/usr.sbin/rmt/rmt.8 b/usr/src/usr.sbin/rmt/rmt.8
index 7b6b057..86d2cf9 100644 (file)
--- a/usr/src/usr.sbin/rmt/rmt.8
+++ b/usr/src/usr.sbin/rmt/rmt.8
@@ -1,151 +1,217 @@
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)rmt.8       6.1 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.TH RMT 8C ""
-.UC 5
-.SH NAME
-rmt \- remote magtape protocol module
-.SH SYNOPSIS
-.B /etc/rmt
-.SH DESCRIPTION
-.I Rmt
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)rmt.8      6.5 (Berkeley) 3/16/91
+.\"
+.Dd March 16, 1991
+.Dt RMT 8
+.Os BSD 4.2
+.Sh NAME
+.Nm rmt
+.Nd remote magtape protocol module
+.Sh SYNOPSIS
+.Nm rmt
+.Sh DESCRIPTION
+.Nm Rmt

 is a program used by the remote dump and restore programs
 in manipulating a magnetic tape drive through an interprocess
 communication connection.
 is a program used by the remote dump and restore programs
 in manipulating a magnetic tape drive through an interprocess
 communication connection.

-.I Rmt
+.Nm Rmt

 is normally started up with an
 is normally started up with an

-.IR rexec (3X)
+.Xr rexec 3

 or
 or

-.IR rcmd (3X)
+.Xr rcmd 3

 call.
 call.

-.PP
+.Pp

 The 
 The 

-.I rmt
+.Nm rmt

 program accepts requests specific to the manipulation of
 magnetic tapes, performs the commands, then responds with
 program accepts requests specific to the manipulation of
 magnetic tapes, performs the commands, then responds with

-a status indication.  All responses are in ASCII and in
+a status indication.  All responses are in
+.Tn ASCII
+and in

 one of two forms. 
 one of two forms. 

-Successful commands have responses of
-.PP
-.ti +0.5i
-\fBA\fInumber\fR\en
-.PP
-where 
-.I number
-is an ASCII representation of a decimal number.
-Unsuccessful commands are responded to with
-.PP
-.ti +0.5i
-\fBE\fIerror-number\fR\en\fIerror-message\fR\en,
-.PP
-where
-.I error-number
+Successful commands have responses of:
+.Bd -filled -offset indent
+.Sm off
+.Sy A Ar number No \en
+.Sm on
+.Ed
+.Pp
+.Ar Number
+is an
+.Tn ASCII
+representation of a decimal number.
+Unsuccessful commands are responded to with:
+.Bd -filled -offset indent
+.Sm off
+.Xo Sy E Ar error-number
+.No \en Ar error-message
+.No \en
+.Xc
+.Sm on
+.Ed
+.Pp
+.Ar Error-number

 is one of the possible error
 numbers described in
 is one of the possible error
 numbers described in

-.IR intro (2)
+.Xr intro 2

 and
 and

-.I error-message
+.Ar error-message

 is the corresponding error string as printed
 from a call to
 is the corresponding error string as printed
 from a call to

-.IR perror (3).
+.Xr perror 3 .

 The protocol is comprised of the
 The protocol is comprised of the

-following commands (a space is present between each token).
-.TP 15
-.B O device mode
+following commands, which are sent as indicated - no spaces are supplied
+between the command and its arguments, or between its arguments, and
+.Ql \en
+indicates that a newline should be supplied:
+.Bl -tag -width Ds
+.Sm off
+.It Xo Sy \&O Ar device
+.No \en Ar mode No \en
+.Xc

 Open the specified 
 Open the specified 

-.I device
+.Ar device

 using the indicated
 using the indicated

-.IR mode .
-.I Device
+.Ar mode .
+.Ar Device

 is a full pathname and
 is a full pathname and

-.I mode
-is an ASCII representation of a decimal
+.Ar mode
+is an
+.Tn ASCII
+representation of a decimal

 number suitable for passing to
 number suitable for passing to

-.IR open (2).
+.Xr open 2 .

 If a device had already been opened, it is
 closed before a new open is performed.
 If a device had already been opened, it is
 closed before a new open is performed.

-.TP 15
-.B C device
+.It Xo Sy C Ar device No \en
+.Xc

 Close the currently open device.  The
 Close the currently open device.  The

-.I device
+.Ar device

 specified is ignored.
 specified is ignored.

-.TP 15
-.B L whence offset
+.It Xo Sy L
+.Ar whence No \en
+.Ar offset No \en
+.Xc
+.Sm on

 Perform an
 Perform an

-.IR lseek (2)
+.Xr lseek 2

 operation using the specified parameters.
 The response value is that returned from the
 operation using the specified parameters.
 The response value is that returned from the

-.I lseek
+.Xr lseek

 call.
 call.

-.TP 15
-.B W count
+.Sm off
+.It Sy W Ar count No \en
+.Sm on

 Write data onto the open device.
 Write data onto the open device.

-.I Rmt
+.Nm Rmt

 reads
 reads

-.I count
+.Ar count

 bytes from the connection, aborting if
 a premature end-of-file is encountered.
 The response value is that returned from
 the
 bytes from the connection, aborting if
 a premature end-of-file is encountered.
 The response value is that returned from
 the

-.IR write (2)
+.Xr write 2

 call.
 call.

-.TP 15
-.B R count
+.Sm off
+.It Sy R Ar count No \en
+.Sm on

 Read
 Read

-.I count
+.Ar count

 bytes of data from the open device.
 If
 bytes of data from the open device.
 If

-.I count
+.Ar count

 exceeds the size of the data buffer (10 kilobytes), it is
 truncated to the data buffer size.
 exceeds the size of the data buffer (10 kilobytes), it is
 truncated to the data buffer size.

-.I Rmt
+.Nm rmt

 then performs the requested 
 then performs the requested 

-.IR read (2)
+.Xr read 2

 and responds with 
 and responds with 

-\fBA\fIcount-read\fR\en if the read was
+.Sm off
+.Sy A Ar count-read No \en
+.Sm on
+if the read was

 successful; otherwise an error in the
 standard format is returned.  If the read
 was successful, the data read is then sent.
 successful; otherwise an error in the
 standard format is returned.  If the read
 was successful, the data read is then sent.

-.TP 15
-.B I operation count 
-Perform a MTIOCOP 
-.IR ioctl (2)
+.Sm off
+.It Xo Sy I Ar operation
+.No \en Ar count No \en
+.Xc
+.Sm on
+Perform a
+.Dv MTIOCOP
+.Xr ioctl 2

 command using the specified parameters.
 The parameters are interpreted as the
 command using the specified parameters.
 The parameters are interpreted as the

-ASCII representations of the decimal values
+.Tn ASCII
+representations of the decimal values

 to place in the 
 to place in the 

-.I mt_op
+.Ar mt_op

 and
 and

-.I mt_count
+.Ar mt_count

 fields of the structure used in the
 fields of the structure used in the

-.I ioctl
+.Xr ioctl

 call.  The return value is the
 call.  The return value is the

-.I count
+.Ar count

 parameter when the operation is successful.
 parameter when the operation is successful.

-.TP 15
-.B S
+.It Sy S

 Return the status of the open device, as
 Return the status of the open device, as

-obtained with a MTIOCGET 
-.I ioctl
+obtained with a
+.Dv MTIOCGET
+.Xr ioctl

 call.  If the operation was successful,
 an ``ack'' is sent with the size of the
 status buffer, then the status buffer is
 sent (in binary).
 call.  If the operation was successful,
 an ``ack'' is sent with the size of the
 status buffer, then the status buffer is
 sent (in binary).

-.PP
+.El
+.Sm on
+.Pp

 Any other command causes 
 Any other command causes 

-.I rmt
+.Nm rmt

 to exit.
 to exit.

-.SH DIAGNOSTICS
+.Sh DIAGNOSTICS

 All responses are of the form described above.
 All responses are of the form described above.

-.SH "SEE ALSO"
-rcmd(3X),
-rexec(3X),
-mtio(4),
-rdump(8C),
-rrestore(8C)
-.SH BUGS
+.Sh SEE ALSO
+.Xr rcmd 3 ,
+.Xr rexec 3 ,
+.Xr mtio 4 ,
+.Xr rdump 8 ,
+.Xr rrestore 8
+.Sh BUGS

 People tempted to use this for a remote file access protocol
 are discouraged.
 People tempted to use this for a remote file access protocol
 are discouraged.

+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.2 .