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 .\" $DragonFly: src/share/man/man5/remote.5,v 1.2 2003/06/17 04:37:00 dillon Exp $
  35 .\"
  36 .Dd June 5, 1993
  37 .Dt REMOTE 5
  38 .Os
  39 .Sh NAME
  40 .Nm remote
  41 .Nd remote host description file
  42 .Sh DESCRIPTION
  43 The systems known by
  44 .Xr tip 1
  45 and their attributes are stored in an
  46 .Tn ASCII
  47 file which
  48 is structured somewhat like the
  49 .Xr termcap 5
  50 file.  Each line in the file provides a description for a single
  51 .Em system .
  52 Fields are separated by a colon (``:'').
  53 Lines ending in a \e character with an immediately following newline are
  54 continued on the next line.
  55 .Pp
  56 The first entry is the name(s) of the host system.  If there is more
  57 than one name for a system, the names are separated by vertical bars.
  58 After the name of the system comes the fields of the description.  A
  59 field name followed by an `=' sign indicates a string value.
  60 A field name followed by a `#' sign indicates a numeric value.
  61 .Pp
  62 Entries named ``tip*'' and ``cu*''
  63 are used as default entries by
  64 .Xr tip 1 ,
  65 and the
  66 .Xr cu 1
  67 interface to
  68 .Nm tip ,
  69 as follows.  When
  70 .Nm tip
  71 is invoked with only a phone number, it looks for an entry
  72 of the form ``tip300'', where 300 is the baud rate with
  73 which the connection is to be made.  When the
  74 .Nm cu
  75 interface is used, entries of the form ``cu300'' are used.
  76 .Sh CAPABILITIES
  77 Capabilities are either strings (str), numbers (num), or boolean
  78 flags (bool).  A string capability is specified by
  79 .Em capability Ns Ar = Ns Em value ;
  80 for example, ``dv=/dev/harris''.  A numeric capability is specified by
  81 .Em capability Ns Ar # Ns Em value ;
  82 for example, ``xa#99''.  A boolean capability is specified by simply listing
  83 the capability.
  84 .Bl -tag -width indent
  85 .It Cm \&at
  86 (str)
  87 Auto call unit type.
  88 .It Cm \&br
  89 (num)
  90 The baud rate used in establishing
  91 a connection to the remote host.
  92 This is a decimal number.
  93 The default baud rate is 300 baud.
  94 .It Cm \&cm
  95 (str)
  96 An initial connection message to be sent
  97 to the remote host.  For example, if a
  98 host is reached through a port selector, this
  99 might be set to the appropriate sequence
 100 required to switch to the host.
 101 .It Cm \&cu
 102 (str)
 103 Call unit if making a phone call.
 104 Default is the same as the `dv' field.
 105 .It Cm \&di
 106 (str)
 107 Disconnect message sent to the host when a
 108 disconnect is requested by the user.
 109 .It Cm \&du
 110 (bool)
 111 This host is on a dial-up line.
 112 .It Cm \&dv
 113 (str)
 114 .Tn UNIX
 115 device(s) to open to establish a connection.
 116 If this file refers to a terminal line,
 117 .Xr tip 1
 118 attempts to perform an exclusive open on the device to ensure only
 119 one user at a time has access to the port.
 120 .It Cm \&el
 121 (str)
 122 Characters marking an end-of-line.
 123 The default is
 124 .Dv NULL .
 125 `~' escapes are only
 126 recognized by
 127 .Nm tip
 128 after one of the characters in `el',
 129 or after a carriage-return.
 130 .It Cm \&fs
 131 (str)
 132 Frame size for transfers.
 133 The default frame size is equal to
 134 .Dv BUFSIZ .
 135 .It Cm \&hd
 136 (bool)
 137 The host uses half-duplex communication, local
 138 echo should be performed.
 139 .It Cm \&ie
 140 (str)
 141 Input end-of-file marks.
 142 The default is
 143 .Dv NULL .
 144 .It Cm \&oe
 145 (str)
 146 Output end-of-file string.
 147 The default is
 148 .Dv NULL .
 149 When
 150 .Nm tip
 151 is transferring a file, this
 152 string is sent at end-of-file.
 153 .It Cm \&pa
 154 (str)
 155 The type of parity to use when sending data
 156 to the host.  This may be one of ``even'',
 157 ``odd'', ``none'', ``zero'' (always set bit 8 to zero),
 158 ``one'' (always set bit 8 to 1).  The default
 159 is even parity.
 160 .It Cm \&pn
 161 (str)
 162 Telephone number(s) for this host.
 163 If the telephone number field contains
 164 an @ sign,
 165 .Nm tip
 166 searches the file
 167 .Pa /etc/phones
 168 file for a list of telephone numbers
 169 (see
 170 .Xr phones 5 ) .
 171 .It Cm \&tc
 172 (str)
 173 Indicates that the list of capabilities is continued
 174 in the named description.  This is used
 175 primarily to share common capability information.
 176 .El
 177 .Pp
 178 Here is a short example showing the use of the capability continuation
 179 feature:
 180 .Bd -literal
 181 UNIX-1200:\e
 182 :dv=/dev/cau0:el=^D^U^C^S^Q^O@:du:at=ventel:ie=#$%:oe=^D:br#1200:
 183 arpavax|ax:\e
 184 :pn=7654321%:tc=UNIX-1200
 185 .Ed
 186 .Sh FILES
 187 .Bl -tag -width /etc/remote -compact
 188 .It Pa /etc/remote
 189 The
 190 .Nm
 191 host description file
 192 resides in
 193 .Pa /etc .
 194 .El
 195 .Sh SEE ALSO
 196 .Xr tip 1 ,
 197 .Xr phones 5
 198 .Sh HISTORY
 199 The
 200 .Nm
 201 file format appeared in
 202 .Bx 4.2 .