Date: Thu, 17 Oct 2013 15:42:26 +0000 (UTC) From: Dru Lavigne <dru@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42984 - head/en_US.ISO8859-1/books/handbook/serialcomms Message-ID: <201310171542.r9HFgQEI070678@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: dru Date: Thu Oct 17 15:42:25 2013 New Revision: 42984 URL: http://svnweb.freebsd.org/changeset/doc/42984 Log: Initial header tightening pass through this chapter, in prep for further work. Made sure not to create any orphaned links. Some headings were better suited as tables which were created. This is to be followed by a much needed white space fix. Modified: head/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml Modified: head/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml Thu Oct 17 15:15:58 2013 (r42983) +++ head/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml Thu Oct 17 15:42:25 2013 (r42984) @@ -57,13 +57,9 @@ </sect1> <sect1 id="serial"> - <title>Introduction</title> - - <!-- XXX Write me! --> - - <sect2 id="serial-terminology"> - <title>Terminology</title> + <title>Serial Terminology and Hardware</title> + <para>The following terms are often used in serial commnications:</para> <variablelist> <varlistentry> <term><acronym>bps</acronym></term> @@ -76,16 +72,18 @@ <varlistentry> <term><acronym>DTE</acronym></term> <listitem> - <para>An example of a Data Terminal Equipment<indexterm><primary>DTE</primary></indexterm> - (<acronym>DTE</acronym>) is a computer.</para> + <para>Data Terminal Equipment<indexterm><primary>DTE</primary></indexterm> + (<acronym>DTE</acronym>) is one of two endpoints in a + serial communication. An example would be a computer.</para> </listitem> </varlistentry> <varlistentry> <term><acronym>DCE</acronym></term> <listitem> - <para>An example of a Data Communications Equipment<indexterm><primary>DCE</primary></indexterm> - (<acronym>DTE</acronym>) is a modem.</para> + <para>Data Communications Equipment<indexterm><primary>DCE</primary></indexterm> + (<acronym>DTE</acronym>) is the other endpoint in a + serial communication. Typically, it is a modem.</para> </listitem> </varlistentry> @@ -93,8 +91,8 @@ <term>RS-232</term> <listitem> - <para>The original standard for hardware serial - communications. It is now usually referred to as + <para>The original standard which defined hardware serial + communications. It has since been renamed to <acronym>TIA</acronym>-232<indexterm><primary>RS-232C cables</primary></indexterm>.</para> </listitem> </varlistentry> @@ -105,10 +103,7 @@ number of electrical state transitions that may be made in a period of time, while <acronym>bps</acronym> is the <emphasis>correct</emphasis> term to use.</para> - </sect2> - <sect2 id="serial-cables-ports"> - <title>Cables and Ports</title> <para>To connect a modem or serial terminal to a &os; system, a serial port on the computer and the proper cable to connect to @@ -116,17 +111,14 @@ with serial hardware and cabling can safely skip this section.</para> - <sect3 id="term-cables"> - <title>Cables</title> + <sect2 id="term-cables-null"> + <title>Serial Cables and Ports</title> <para>There are several different kinds of serial cables. The two most common types are null-modem cables and standard RS-232 cables. The documentation for the hardware should describe the type of cable required.</para> - <sect4 id="term-cables-null"> - <title>Null-modem Cables</title> - <indexterm> <primary>null-modem cable</primary> </indexterm> @@ -431,10 +423,6 @@ another variation, SG connects to SG, TD connects to RD, RTS and CTS connect to DCD, DTR connects to DSR, and vice-versa.</para> - </sect4> - - <sect4 id="term-cables-std"> - <title>Standard RS-232C Cables</title> <indexterm><primary>RS-232C cables</primary></indexterm> @@ -445,20 +433,12 @@ This is the type of cable used to connect a modem to the &os; system, and is also appropriate for some terminals.</para> - </sect4> - </sect3> - - <sect3 id="term-ports"> - <title>Ports</title> <para>Serial ports are the devices through which data is transferred between the &os; host computer and the terminal. This section describes the kinds of ports that exist and how they are addressed in &os;.</para> - <sect4 id="term-portkinds"> - <title>Kinds of Ports</title> - <para>Several kinds of serial ports exist. Before purchasing or constructing a cable, make sure it will fit the ports on the terminal and on the &os; @@ -471,10 +451,6 @@ <para>See the documentation that accompanied the hardware for specifications on the kind of port or visually verify the type of port.</para> - </sect4> - - <sect4 id="term-portnames"> - <title>Port Names</title> <para>In &os;, each serial port is accessed through an entry in <filename class="directory">/dev</filename>. @@ -508,9 +484,6 @@ terminal. If the terminal is on the second serial port (<devicename>COM2</devicename>), use <filename>/dev/ttyu1</filename>, and so forth.</para> - - </sect4> - </sect3> </sect2> <sect2> @@ -642,16 +615,17 @@ </sect1> <sect1 id="term"> + <!-- <sect1info> <authorgroup> <author> <firstname>Sean</firstname> <surname>Kelly</surname> - <contrib>Contributed by </contrib> + <contrib>Contributed by in July 1996</contrib> </author> - <!-- 28 July 1996 --> </authorgroup> </sect1info> + --> <title>Terminals</title> <indexterm><primary>terminals</primary></indexterm> @@ -661,9 +635,6 @@ connected network. This section describes how to use terminals with &os;.</para> - <sect2 id="term-uses"> - <title>Uses and Types of Terminals</title> - <para>The original &unix; systems did not have consoles. Instead, users logged in and ran programs through terminals that were connected to the computer's serial ports.</para> @@ -681,13 +652,12 @@ otherwise be a single-user computer into a powerful multiple user system.</para> - <para>This section describes three kinds of terminals supported - by &os;: dumb terminals, computers acting as terminals, and X - terminals.</para> - - <sect3 id="term-dumb"> - <title>Dumb Terminals</title> + <para>&os; supports three types of terminals:</para> + <variablelist> + <varlistentry> + <term><acronym>Dumb terminals</acronym></term> + <listitem> <para>Dumb terminals are specialized hardware that connect to computers over serial lines. They are called <quote>dumb</quote> because they have only enough @@ -704,12 +674,13 @@ <para>Dumb terminals are popular in work environments where workers do not need access to graphical applications.</para> - </sect3> + </listitem> + </varlistentry> - <sect3 id="term-pcs"> - <title>Computers Acting as Terminals</title> - - <para>If a <link linkend="term-dumb">dumb terminal</link> has + <varlistentry> + <term>Computers Acting as Terminals</term> + <listitem> + <para>If a dumb terminal has just enough ability to display, send, and receive text, any spare computer can be a dumb terminal. All that is needed is the proper cable and some <emphasis>terminal @@ -750,11 +721,12 @@ through the Ports Collection, such as <filename role="package">comms/minicom</filename>.</para> </note> - </sect3> - - <sect3 id="term-x"> - <title>X Terminals</title> + </listitem> + </varlistentry> + <varlistentry> + <term>X Terminals</term> + <listitem> <para>X terminals are the most sophisticated kind of terminal available. Instead of connecting to a serial port, they usually connect to a network like Ethernet. Instead of @@ -763,8 +735,9 @@ <para>This chapter does <emphasis>not</emphasis> cover the setup, configuration, or use of X terminals.</para> - </sect3> - </sect2> + </listitem> + </varlistentry> + </variablelist> <sect2 id="term-config"> <title>Configuration</title> @@ -995,10 +968,7 @@ ttyu5 "/usr/libexec/getty std.19200" Here is a list of common symptoms and some suggested fixes.</para> - <sect3> - <title>No Login Prompt Appears</title> - - <para>Make sure the terminal is plugged in and powered up. If + <para>If no login prompt appears, make sure the terminal is plugged in and powered up. If it is a personal computer acting as a terminal, make sure it is running terminal emulation software on the correct serial port.</para> @@ -1050,33 +1020,22 @@ ttyu5 "/usr/libexec/getty std.19200" software flow control enabled when using <literal>3wire</literal> to prevent buffer overflows.</para> - </sect3> - - <sect3> - <title>If Garbage Appears Instead of a Login Prompt</title> - - <para>Make sure the terminal and &os; agree on the + <para>If garbage appears instead of a login prompt, make sure the terminal and &os; agree on the <acronym>bps</acronym> rate and parity settings. Check the <command>getty</command> processes to make sure the correct <replaceable>getty</replaceable> type is in use. If not, edit <filename>/etc/ttys</filename> and run <command>kill -HUP 1</command>.</para> - </sect3> - - <sect3> - <title>Characters Appear Doubled and the Password Appears When - Typed</title> - - <para>Switch the terminal, or the terminal emulation software, + <para>If characters appear doubled and the password appears when + typed, switch the terminal, or the terminal emulation software, from <quote>half duplex</quote> or <quote>local echo</quote> to <quote>full duplex.</quote></para> - - </sect3> </sect2> </sect1> <sect1 id="dialup"> + <!-- <sect1info> <authorgroup> <author> @@ -1093,16 +1052,14 @@ ttyu5 "/usr/libexec/getty std.19200" </author> </authorgroup> </sect1info> + --> <title>Dial-in Service</title> <indexterm><primary>dial-in service</primary></indexterm> <para>Configuring a &os; system for dial-in service is similar to connecting terminals except that modems are used instead of - terminal devices.</para> - - <sect2> - <title>External Versus Internal Modems</title> + terminal devices. &os; supports both external and internal modems.</para> <para>External modems are more convenient for dial-up because they often can be semi-permanently configured via parameters @@ -1115,9 +1072,6 @@ ttyu5 "/usr/libexec/getty std.19200" internal modem has any signal indicator lights, they are difficult to view when the system's cover is in place.</para> - <sect3> - <title>Modems and Cables</title> - <indexterm><primary>modem</primary></indexterm> <para>When using an external modem, a proper cable is needed. @@ -1196,8 +1150,6 @@ ttyu5 "/usr/libexec/getty std.19200" the modem after a call. &os; avoids sending commands to the modem or watching for status reports from the modem.</para> - </sect3> - </sect2> <sect2> <title>Serial Interface Considerations</title> @@ -1316,19 +1268,12 @@ ttyu5 "/usr/libexec/getty std.19200" information on the format of the file and the list of capabilities.</para> - <sect4> - <title>Locked-speed Config</title> - <para>When locking a modem's data communications rate at a particular speed, no changes to <filename>/etc/gettytab</filename> should be needed.</para> - </sect4> - <sect4> - <title>Matching-speed Config</title> - - <para>Set up an entry in + <para>However, a change is needed to create a matching-speed configuration. Create an entry in <filename>/etc/gettytab</filename> to give <command>getty</command> information about the speeds to use for the modem. For a 2400 bps modem, use the @@ -1402,7 +1347,6 @@ vq|VH57600|Very High Speed Modem at 5760 16550A-based serial ports, there may be <errorname>sio</errorname> <quote>silo</quote> errors at 57.6 Kbps.</para> - </sect4> </sect3> <sect3 id="dialup-ttys"> @@ -1456,9 +1400,6 @@ vq|VH57600|Very High Speed Modem at 5760 <para>Wait until the modem is properly configured and connected before signaling <command>init</command>.</para> - <sect4> - <title>Locked-speed Config</title> - <para>For a locked-speed configuration, the <filename>ttys</filename> entry needs to have a fixed-speed entry provided to <command>getty</command>. @@ -1474,10 +1415,6 @@ vq|VH57600|Very High Speed Modem at 5760 instead of <literal>std.19200</literal>. Make sure to use a valid type listed in <filename>/etc/gettytab</filename>.</para> - </sect4> - - <sect4> - <title>Matching-speed Config</title> <para>In a matching-speed configuration, the <filename>ttys</filename> entry needs to reference the @@ -1489,7 +1426,6 @@ vq|VH57600|Very High Speed Modem at 5760 this:</para> <programlisting>ttyu0 "/usr/libexec/getty V19200" dialup on</programlisting> - </sect4> </sect3> <sect3> @@ -1627,9 +1563,6 @@ AT&C1&D2&H1&I0&R2&am conversation between <command>getty</command> and the modem.</para> - <sect3> - <title>Locked-speed Config</title> - <para>For a locked-speed configuration, configure the modem to maintain a constant modem-to-computer data rate independent of the communications rate. On a &usrobotics; &sportster; @@ -1639,10 +1572,6 @@ AT&C1&D2&H1&I0&R2&am <programlisting>ATZ AT&B1&W</programlisting> - </sect3> - - <sect3> - <title>Matching-speed Config</title> <para>For a variable-speed configuration, configure the modem to adjust its serial port data rate to match the incoming @@ -1654,7 +1583,6 @@ AT&B1&W</programlisting> <programlisting>ATZ AT&B2&W</programlisting> - </sect3> <sect3> <title>Checking the Modem's Configuration</title> @@ -1680,9 +1608,6 @@ AT&B2&W</programlisting> <para>Here are a few steps for troubleshooting a dial-up modem on a &os; system.</para> - <sect3> - <title>Checking Out the &os; System</title> - <para>Hook up the modem to the &os; system, boot the system, and, if the modem has status indication lights, watch to see whether the modem's <acronym>DTR</acronym> @@ -1728,12 +1653,8 @@ AT&B2&W</programlisting> appropriate device special files, <filename>/dev/ttyuN</filename>, for any mistakes, missing entries, or missing device special files.</para> - </sect3> - - <sect3> - <title>Try Dialing In</title> - <para>Try dialing into the system. Be sure to use 8 bits, no + <para>Next, try dialing into the system. Be sure to use 8 bits, no parity, and 1 stop bit on the remote system. If a prompt does not appear right away, or the prompt shows garbage, try pressing <keycap>Enter</keycap> about once per second. If @@ -1776,9 +1697,7 @@ AT&B2&W</programlisting> it later. If it still does not work, try sending an email message to the &a.questions; describing the modem and the problem.</para> - </sect3> </sect2> - </sect1> <sect1 id="dialout"> @@ -2066,6 +1985,7 @@ raisechar=^^</programlisting> </sect1> <sect1 id="serialconsole-setup"> + <!-- <sect1info> <authorgroup> <author> @@ -2082,13 +2002,11 @@ raisechar=^^</programlisting> </author> </authorgroup> </sect1info> + --> <title>Setting Up the Serial Console</title> <indexterm><primary>serial console</primary></indexterm> - <sect2 id="serialconsole-intro"> - <title>Introduction</title> - <para>&os; has the ability to boot a system with a dumb terminal on a serial port as a console. This configuration is useful for system administrators who wish to install &os; on @@ -2106,8 +2024,6 @@ raisechar=^^</programlisting> boot block code, the boot loader code, and the kernel need to be configured.</para> - </sect2> - <sect2 id="serialconsole-howto-fast"> <title>Quick Serial Console Configuration</title> @@ -2160,7 +2076,7 @@ raisechar=^^</programlisting> <para>Use either a null-modem cable or a standard serial cable and a null-modem adapter. See <xref - linkend="serial-cables-ports"/> for a discussion + linkend="term-cables-null"/> for a discussion on serial cables.</para> </step> @@ -2482,16 +2398,12 @@ boot:</screen> <sect2 id="serialconsole-summary"> <title>Summary</title> - <para>Here is the summary of the various settings discussed in - this section:</para> + <para>The following tables provide a summary of the various settings discussed in + this section.</para> - <sect3> - <title>Case 1: Set the Flags to 0x10 for + <table frame="none" pgwide="1"> + <title>Case 1: Set the Flags to 0x10 for <devicename>sio0</devicename></title> - - <programlisting>device sio0 flags 0x10</programlisting> - - <informaltable frame="none" pgwide="1"> <tgroup cols="4"> <thead> <row> @@ -2546,16 +2458,11 @@ boot:</screen> </row> </tbody> </tgroup> - </informaltable> - </sect3> + </table> - <sect3> - <title>Case 2: Set the Flags to 0x30 for + <table frame="none" pgwide="1"> + <title>Case 2: Set the Flags to 0x30 for <devicename>sio0</devicename></title> - - <programlisting>device sio0 flags 0x30</programlisting> - - <informaltable frame="none" pgwide="1"> <tgroup cols="4"> <thead> <row> @@ -2610,8 +2517,7 @@ boot:</screen> </row> </tbody> </tgroup> - </informaltable> - </sect3> + </table> </sect2> <sect2 id="serialconsole-tips">
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201310171542.r9HFgQEI070678>