summaryrefslogtreecommitdiff
path: root/static/freebsd/man5/remote.5 3.html
diff options
context:
space:
mode:
Diffstat (limited to 'static/freebsd/man5/remote.5 3.html')
-rw-r--r--static/freebsd/man5/remote.5 3.html148
1 files changed, 148 insertions, 0 deletions
diff --git a/static/freebsd/man5/remote.5 3.html b/static/freebsd/man5/remote.5 3.html
new file mode 100644
index 00000000..1af768cb
--- /dev/null
+++ b/static/freebsd/man5/remote.5 3.html
@@ -0,0 +1,148 @@
+<table class="head">
+ <tr>
+ <td class="head-ltitle">REMOTE(5)</td>
+ <td class="head-vol">File Formats Manual</td>
+ <td class="head-rtitle">REMOTE(5)</td>
+ </tr>
+</table>
+<div class="manual-text">
+<section class="Sh">
+<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
+<p class="Pp"><code class="Nm">remote</code> &#x2014; <span class="Nd">remote
+ host description file</span></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
+<p class="Pp">The systems known by <a class="Xr">tip(1)</a> and their attributes
+ are stored in an ASCII file which is structured somewhat like the
+ <a class="Xr">termcap(5)</a> file. Each line in the file provides a
+ description for a single
+ <a class="permalink" href="#system"><i class="Em" id="system">system</i></a>.
+ Fields are separated by a colon (``:''). Lines ending in a \ character with
+ an immediately following newline are continued on the next line.</p>
+<p class="Pp">The first entry is the name(s) of the host system. If there is
+ more than one name for a system, the names are separated by vertical bars.
+ After the name of the system comes the fields of the description. A field
+ name followed by an `=' sign indicates a string value. A field name followed
+ by a `#' sign indicates a numeric value.</p>
+<p class="Pp">Entries named ``tip*'' and ``cu*'' are used as default entries by
+ <a class="Xr">tip(1)</a>, and the <a class="Xr">cu(1)</a> interface to
+ <code class="Nm">tip</code>, as follows. When <code class="Nm">tip</code> is
+ invoked with only a phone number, it looks for an entry of the form
+ ``tip300'', where 300 is the data rate with which the connection is to be
+ made. When the <code class="Nm">cu</code> interface is used, entries of the
+ form ``cu300'' are used.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="CAPABILITIES"><a class="permalink" href="#CAPABILITIES">CAPABILITIES</a></h1>
+<p class="Pp">Capabilities are either strings (str), numbers (num), or boolean
+ flags (bool). A string capability is specified by
+ <i class="Em">capability</i><var class="Ar">=</var><i class="Em">value</i>;
+ for example, ``dv=/dev/harris''. A numeric capability is specified by
+ <i class="Em">capability</i><var class="Ar">#</var><i class="Em">value</i>;
+ for example, ``xa#99''. A boolean capability is specified by simply listing
+ the capability.</p>
+<dl class="Bl-tag">
+ <dt id="at"><a class="permalink" href="#at"><code class="Cm">at</code></a></dt>
+ <dd>(str) Auto call unit type.</dd>
+ <dt id="br"><a class="permalink" href="#br"><code class="Cm">br</code></a></dt>
+ <dd>(num) The data rate (bits per second) used for communications on the
+ serial port. When a modem is used, the data rate used to communicate with
+ the remote modem may be different than this rate. This is a decimal
+ number. The default rate is 115200 bits per second.</dd>
+ <dt id="cm"><a class="permalink" href="#cm"><code class="Cm">cm</code></a></dt>
+ <dd>(str) An initial connection message to be sent to the remote host. For
+ example, if a host is reached through a port selector, this might be set
+ to the appropriate sequence required to switch to the host.</dd>
+ <dt id="cu"><a class="permalink" href="#cu"><code class="Cm">cu</code></a></dt>
+ <dd>(str) Call unit if making a phone call. Default is the same as the `dv'
+ field.</dd>
+ <dt id="di"><a class="permalink" href="#di"><code class="Cm">di</code></a></dt>
+ <dd>(str) Disconnect message sent to the host when a disconnect is requested
+ by the user.</dd>
+ <dt id="du"><a class="permalink" href="#du"><code class="Cm">du</code></a></dt>
+ <dd>(bool) This host is on a dial-up line.</dd>
+ <dt id="dv"><a class="permalink" href="#dv"><code class="Cm">dv</code></a></dt>
+ <dd>(str) <span class="Ux">UNIX</span> device(s) to open to establish a
+ connection. If this file refers to a terminal line,
+ <a class="Xr">tip(1)</a> attempts to perform an exclusive open on the
+ device to ensure only one user at a time has access to the port.</dd>
+ <dt id="el"><a class="permalink" href="#el"><code class="Cm">el</code></a></dt>
+ <dd>(str) Characters marking an end-of-line. The default is
+ <code class="Dv">NULL</code>. `~' escapes are only recognized by
+ <code class="Nm">tip</code> after one of the characters in `el', or after
+ a carriage-return.</dd>
+ <dt id="fs"><a class="permalink" href="#fs"><code class="Cm">fs</code></a></dt>
+ <dd>(str) Frame size for transfers. The default frame size is equal to
+ <code class="Dv">BUFSIZ</code>.</dd>
+ <dt id="hd"><a class="permalink" href="#hd"><code class="Cm">hd</code></a></dt>
+ <dd>(bool) The host uses half-duplex communication, local echo should be
+ performed.</dd>
+ <dt id="ie"><a class="permalink" href="#ie"><code class="Cm">ie</code></a></dt>
+ <dd>(str) Input end-of-file marks. The default is
+ <code class="Dv">NULL</code>.</dd>
+ <dt id="oe"><a class="permalink" href="#oe"><code class="Cm">oe</code></a></dt>
+ <dd>(str) Output end-of-file string. The default is
+ <code class="Dv">NULL</code>. When <code class="Nm">tip</code> is
+ transferring a file, this string is sent at end-of-file.</dd>
+ <dt id="pa"><a class="permalink" href="#pa"><code class="Cm">pa</code></a></dt>
+ <dd>(str) The type of parity to use when sending data to the host. This may be
+ one of ``even'', ``odd'', ``none'', ``zero'' (always set bit 8 to zero),
+ ``one'' (always set bit 8 to 1). The default is even parity.</dd>
+ <dt id="pn"><a class="permalink" href="#pn"><code class="Cm">pn</code></a></dt>
+ <dd>(str) Telephone number(s) for this host. If the telephone number field
+ contains an @ sign, <code class="Nm">tip</code> searches the file
+ <span class="Pa">/etc/phones</span> file for a list of telephone numbers
+ (see <a class="Xr">phones(5)</a>).</dd>
+ <dt id="tc"><a class="permalink" href="#tc"><code class="Cm">tc</code></a></dt>
+ <dd>(str) Indicates that the list of capabilities is continued in the named
+ description. This is used primarily to share common capability
+ information.</dd>
+</dl>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
+<dl class="Bl-tag Bl-compact">
+ <dt><span class="Pa">/etc/remote</span></dt>
+ <dd>The <code class="Nm">remote</code> host description file resides in
+ <span class="Pa">/etc</span>.</dd>
+</dl>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
+<p class="Pp">Here is a short example showing the use of the capability
+ continuation feature. It defines a 56k modem connection on the first serial
+ port at 115200 bits per second, no parity using the Hayes command set with
+ standard line editing and end of file characters. The arpavax entry includes
+ everything in the UNIX-57600 entry plus the phone number for arpavax (in
+ this case an @ character so that it is retrieved from the environment).</p>
+<div class="Bd Pp Li">
+<pre>UNIX-57600:\
+:dv=/dev/cuau0:el=^D^U^C^S^Q^O@:oe=^D:du:at=hayes:br#115200:pa=none:
+arpavax|ax:\
+:pn=\@:tc=UNIX-57600</pre>
+</div>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
+ ALSO</a></h1>
+<p class="Pp"><a class="Xr">cu(1)</a>, <a class="Xr">tip(1)</a>,
+ <a class="Xr">phones(5)</a></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
+<p class="Pp">The <code class="Nm">remote</code> file format appeared in
+ <span class="Ux">4.2BSD</span>.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
+<p class="Pp">The <a class="Xr">tip(1)</a> utility uses its own notion of the
+ serial ports data rate rather than the system default for a serial port.</p>
+</section>
+</div>
+<table class="foot">
+ <tr>
+ <td class="foot-date">October 20, 2003</td>
+ <td class="foot-os">FreeBSD 15.0</td>
+ </tr>
+</table>