Return to rmt.8 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / usr.sbin / rmt

Annotation of 43BSDReno/usr.sbin/rmt/rmt.8, revision 1.1

1.1     ! root        1: .\" Copyright (c) 1983 The Regents of the University of California.
        !             2: .\" All rights reserved.
        !             3: .\"
        !             4: .\" Redistribution and use in source and binary forms are permitted provided
        !             5: .\" that: (1) source distributions retain this entire copyright notice and
        !             6: .\" comment, and (2) distributions including binaries display the following
        !             7: .\" acknowledgement:  ``This product includes software developed by the
        !             8: .\" University of California, Berkeley and its contributors'' in the
        !             9: .\" documentation or other materials provided with the distribution and in
        !            10: .\" all advertising materials mentioning features or use of this software.
        !            11: .\" Neither the name of the University nor the names of its contributors may
        !            12: .\" be used to endorse or promote products derived from this software without
        !            13: .\" specific prior written permission.
        !            14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
        !            15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
        !            16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
        !            17: .\"
        !            18: .\"    @(#)rmt.8       6.4 (Berkeley) 6/24/90
        !            19: .\"
        !            20: .TH RMT 8 "June 24, 1990"
        !            21: .UC 5
        !            22: .SH NAME
        !            23: rmt \- remote magtape protocol module
        !            24: .SH SYNOPSIS
        !            25: .B /etc/rmt
        !            26: .SH DESCRIPTION
        !            27: .I Rmt
        !            28: is a program used by the remote dump and restore programs
        !            29: in manipulating a magnetic tape drive through an interprocess
        !            30: communication connection.
        !            31: .I Rmt
        !            32: is normally started up with an
        !            33: .IR rexec (3X)
        !            34: or
        !            35: .IR rcmd (3X)
        !            36: call.
        !            37: .PP
        !            38: The 
        !            39: .I rmt
        !            40: program accepts requests specific to the manipulation of
        !            41: magnetic tapes, performs the commands, then responds with
        !            42: a status indication.  All responses are in ASCII and in
        !            43: one of two forms. 
        !            44: Successful commands have responses of
        !            45: .IP
        !            46: .BI A number \en
        !            47: .PP
        !            48: where 
        !            49: .I number
        !            50: is an ASCII representation of a decimal number.
        !            51: Unsuccessful commands are responded to with
        !            52: .PP
        !            53: .IP
        !            54: .BI E error-number \en error-message \en
        !            55: .PP
        !            56: where
        !            57: .I error-number
        !            58: is one of the possible error
        !            59: numbers described in
        !            60: .IR intro (2)
        !            61: and
        !            62: .I error-message
        !            63: is the corresponding error string as printed
        !            64: from a call to
        !            65: .IR perror (3).
        !            66: The protocol is comprised of the
        !            67: following commands, which are sent as indicated - no spaces are supplied
        !            68: between the command and its arguments, or between its arguments, and
        !            69: .B \en
        !            70: indicates that a newline should be supplied:
        !            71: .TP 15
        !            72: .BI O device \en mode \en
        !            73: Open the specified 
        !            74: .I device
        !            75: using the indicated
        !            76: .IR mode .
        !            77: .I Device
        !            78: is a full pathname and
        !            79: .I mode
        !            80: is an ASCII representation of a decimal
        !            81: number suitable for passing to
        !            82: .IR open (2).
        !            83: If a device had already been opened, it is
        !            84: closed before a new open is performed.
        !            85: .TP 15
        !            86: .BI C device \en
        !            87: Close the currently open device.  The
        !            88: .I device
        !            89: specified is ignored.
        !            90: .TP 15
        !            91: .BI L whence \en offset \en
        !            92: Perform an
        !            93: .IR lseek (2)
        !            94: operation using the specified parameters.
        !            95: The response value is that returned from the
        !            96: .I lseek
        !            97: call.
        !            98: .TP 15
        !            99: .BI W count \en
        !           100: Write data onto the open device.
        !           101: .I Rmt
        !           102: reads
        !           103: .I count
        !           104: bytes from the connection, aborting if
        !           105: a premature end-of-file is encountered.
        !           106: The response value is that returned from
        !           107: the
        !           108: .IR write (2)
        !           109: call.
        !           110: .TP 15
        !           111: .BI R count \en
        !           112: Read
        !           113: .I count
        !           114: bytes of data from the open device.
        !           115: If
        !           116: .I count
        !           117: exceeds the size of the data buffer (10 kilobytes), it is
        !           118: truncated to the data buffer size.
        !           119: .I Rmt
        !           120: then performs the requested 
        !           121: .IR read (2)
        !           122: and responds with 
        !           123: .BI A count-read \en
        !           124: if the read was
        !           125: successful; otherwise an error in the
        !           126: standard format is returned.  If the read
        !           127: was successful, the data read is then sent.
        !           128: .TP 15
        !           129: .BI I operation \en count \en
        !           130: Perform a MTIOCOP 
        !           131: .IR ioctl (2)
        !           132: command using the specified parameters.
        !           133: The parameters are interpreted as the
        !           134: ASCII representations of the decimal values
        !           135: to place in the 
        !           136: .I mt_op
        !           137: and
        !           138: .I mt_count
        !           139: fields of the structure used in the
        !           140: .I ioctl
        !           141: call.  The return value is the
        !           142: .I count
        !           143: parameter when the operation is successful.
        !           144: .TP 15
        !           145: .B S
        !           146: Return the status of the open device, as
        !           147: obtained with a MTIOCGET 
        !           148: .I ioctl
        !           149: call.  If the operation was successful,
        !           150: an ``ack'' is sent with the size of the
        !           151: status buffer, then the status buffer is
        !           152: sent (in binary).
        !           153: .PP
        !           154: Any other command causes 
        !           155: .I rmt
        !           156: to exit.
        !           157: .SH DIAGNOSTICS
        !           158: All responses are of the form described above.
        !           159: .SH "SEE ALSO"
        !           160: rcmd(3), rexec(3), mtio(4), rdump(8), rrestore(8)
        !           161: .SH BUGS
        !           162: People tempted to use this for a remote file access protocol
        !           163: are discouraged.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.