share/man/man5/remote.5

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)remote.5    8.1 (Berkeley) 6/5/93
  33 .\" $FreeBSD: src/share/man/man5/remote.5,v 1.5.2.4 2001/08/17 13:08:47 ru Exp $
  34 .\"
  35 .Dd June 5, 1993
  36 .Dt REMOTE 5
  37 .Os
  38 .Sh NAME
  39 .Nm remote
  40 .Nd remote host description file
  41 .Sh DESCRIPTION
  42 The systems known by
  43 .Xr tip 1
  44 and their attributes are stored in an
  45 .Tn ASCII
  46 file which
  47 is structured somewhat like the
  48 .Xr termcap 5
  49 file.  Each line in the file provides a description for a single
  50 .Em system .
  51 Fields are separated by a colon (``:'').
  52 Lines ending in a \e character with an immediately following newline are
  53 continued on the next line.
  54 .Pp
  55 The first entry is the name(s) of the host system.  If there is more
  56 than one name for a system, the names are separated by vertical bars.
  57 After the name of the system comes the fields of the description.  A
  58 field name followed by an `=' sign indicates a string value.
  59 A field name followed by a `#' sign indicates a numeric value.
  60 .Pp
  61 Entries named ``tip*'' and ``cu*''
  62 are used as default entries by
  63 .Xr tip 1 ,
  64 and the
  65 .Xr cu 1
  66 interface to
  67 .Nm tip ,
  68 as follows.  When
  69 .Nm tip
  70 is invoked with only a phone number, it looks for an entry
  71 of the form ``tip300'', where 300 is the baud rate with
  72 which the connection is to be made.  When the
  73 .Nm cu
  74 interface is used, entries of the form ``cu300'' are used.
  75 .Sh CAPABILITIES
  76 Capabilities are either strings (str), numbers (num), or boolean
  77 flags (bool).  A string capability is specified by
  78 .Em capability Ns Ar = Ns Em value ;
  79 for example, ``dv=/dev/harris''.  A numeric capability is specified by
  80 .Em capability Ns Ar # Ns Em value ;
  81 for example, ``xa#99''.  A boolean capability is specified by simply listing
  82 the capability.
  83 .Bl -tag -width indent
  84 .It Cm \&at
  85 (str)
  86 Auto call unit type.
  87 .It Cm \&br
  88 (num)
  89 The baud rate used in establishing
  90 a connection to the remote host.
  91 This is a decimal number.
  92 The default baud rate is 300 baud.
  93 .It Cm \&cm
  94 (str)
  95 An initial connection message to be sent
  96 to the remote host.  For example, if a
  97 host is reached through a port selector, this
  98 might be set to the appropriate sequence
  99 required to switch to the host.
 100 .It Cm \&cu
 101 (str)
 102 Call unit if making a phone call.
 103 Default is the same as the `dv' field.
 104 .It Cm \&di
 105 (str)
 106 Disconnect message sent to the host when a
 107 disconnect is requested by the user.
 108 .It Cm \&du
 109 (bool)
 110 This host is on a dial-up line.
 111 .It Cm \&dv
 112 (str)
 113 .Tn UNIX
 114 device(s) to open to establish a connection.
 115 If this file refers to a terminal line,
 116 .Xr tip 1
 117 attempts to perform an exclusive open on the device to ensure only
 118 one user at a time has access to the port.
 119 .It Cm \&el
 120 (str)
 121 Characters marking an end-of-line.
 122 The default is
 123 .Dv NULL .
 124 `~' escapes are only
 125 recognized by
 126 .Nm tip
 127 after one of the characters in `el',
 128 or after a carriage-return.
 129 .It Cm \&fs
 130 (str)
 131 Frame size for transfers.
 132 The default frame size is equal to
 133 .Dv BUFSIZ .
 134 .It Cm \&hd
 135 (bool)
 136 The host uses half-duplex communication, local
 137 echo should be performed.
 138 .It Cm \&ie
 139 (str)
 140 Input end-of-file marks.
 141 The default is
 142 .Dv NULL .
 143 .It Cm \&oe
 144 (str)
 145 Output end-of-file string.
 146 The default is
 147 .Dv NULL .
 148 When
 149 .Nm tip
 150 is transferring a file, this
 151 string is sent at end-of-file.
 152 .It Cm \&pa
 153 (str)
 154 The type of parity to use when sending data
 155 to the host.  This may be one of ``even'',
 156 ``odd'', ``none'', ``zero'' (always set bit 8 to zero),
 157 ``one'' (always set bit 8 to 1).  The default
 158 is even parity.
 159 .It Cm \&pn
 160 (str)
 161 Telephone number(s) for this host.
 162 If the telephone number field contains
 163 an @ sign,
 164 .Nm tip
 165 searches the file
 166 .Pa /etc/phones
 167 file for a list of telephone numbers
 168 (see
 169 .Xr phones 5 ) .
 170 .It Cm \&tc
 171 (str)
 172 Indicates that the list of capabilities is continued
 173 in the named description.  This is used
 174 primarily to share common capability information.
 175 .El
 176 .Pp
 177 Here is a short example showing the use of the capability continuation
 178 feature:
 179 .Bd -literal
 180 UNIX-1200:\e
 181 :dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200:
 182 arpavax|ax:\e
 183 :pn=7654321%:tc=UNIX-1200
 184 .Ed
 185 .Sh FILES
 186 .Bl -tag -width /etc/remote -compact
 187 .It Pa /etc/remote
 188 The
 189 .Nm
 190 host description file
 191 resides in
 192 .Pa /etc .
 193 .El
 194 .Sh SEE ALSO
 195 .Xr tip 1 ,
 196 .Xr phones 5
 197 .Sh HISTORY
 198 The
 199 .Nm
 200 file format appeared in
 201 .Bx 4.2 .