diff options
Diffstat (limited to 'en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml')
-rw-r--r-- | en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml | 262 |
1 files changed, 124 insertions, 138 deletions
diff --git a/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml b/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml index 9e9f31ba5b..2ec77639c7 100644 --- a/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml +++ b/en_US.ISO8859-1/books/handbook/serialcomms/chapter.xml @@ -4,11 +4,10 @@ $FreeBSD$ --> - -<chapter id="serialcomms"> +<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="serialcomms"> <title>Serial Communications</title> - <sect1 id="serial-synopsis"> + <sect1 xml:id="serial-synopsis"> <title>Synopsis</title> <indexterm><primary>serial communications</primary></indexterm> @@ -56,7 +55,7 @@ </itemizedlist> </sect1> - <sect1 id="serial"> + <sect1 xml:id="serial"> <title>Serial Terminology and Hardware</title> <para>The following terms are often used in serial @@ -117,7 +116,7 @@ with serial hardware and cabling can safely skip this section.</para> - <sect2 id="term-cables-null"> + <sect2 xml:id="term-cables-null"> <title>Serial Cables and Ports</title> <para>There are several different kinds of serial cables. The @@ -136,8 +135,7 @@ <quote>Received Data</quote> pin on the other end.</para> <para>A null-modem cable can be constructed for use with - terminals. The following table shows the RS-232C <link - linkend="serialcomms-signal-names">signal names</link> + terminals. The following table shows the RS-232C <link linkend="serialcomms-signal-names">signal names</link> and the pin numbers on a DB-25 connector. While the standard calls for a straight-through pin 1 to pin 1 <emphasis>Protective Ground</emphasis> line, it is often @@ -153,7 +151,7 @@ <row> <entry align="left">Signal</entry> <entry align="left">Pin #</entry> - <entry></entry> + <entry/> <entry align="left">Pin #</entry> <entry align="left">Signal</entry> </row> @@ -246,7 +244,7 @@ <row> <entry align="left">Signal</entry> <entry align="left">Pin #</entry> - <entry></entry> + <entry/> <entry align="left">Pin #</entry> <entry align="left">Signal</entry> </row> @@ -336,7 +334,7 @@ <row> <entry align="left">Signal</entry> <entry align="left">Pin #</entry> - <entry></entry> + <entry/> <entry align="left">Pin #</entry> <entry align="left">Signal</entry> </row> @@ -459,13 +457,13 @@ the type of port.</para> <para>In &os;, each serial port is accessed through an - entry in <filename class="directory">/dev</filename>. + entry in <filename>/dev</filename>. There are two different kinds of entries:</para> <itemizedlist> <listitem> <para>Call-in ports are named - <filename>/dev/ttyu<replaceable>N</replaceable></filename> + <filename>/dev/ttyuN</filename> where <replaceable>N</replaceable> is the port number, starting from zero. Generally, the call-in port is used for terminals. Call-in ports require that the @@ -476,7 +474,7 @@ <listitem> <para>Call-out ports are named - <filename>/dev/cuau<replaceable>N</replaceable></filename>. + <filename>/dev/cuauN</filename>. Call-out ports are usually not used for terminals, but are used for modems. The call-out port can be used if the serial cable or the terminal does not support the @@ -485,10 +483,10 @@ </itemizedlist> <para>If a terminal is connected to the first serial - port(<devicename>COM1</devicename>), use + port(<filename>COM1</filename>), use <filename>/dev/ttyu0</filename> to refer to the terminal. If the terminal is on the second serial port - (<devicename>COM2</devicename>), use + (<filename>COM2</filename>), use <filename>/dev/ttyu1</filename>, and so forth.</para> </sect2> @@ -497,10 +495,10 @@ <para>&os; supports four serial ports by default. In the &ms-dos; world, these are known as - <devicename>COM1</devicename>, - <devicename>COM2</devicename>, - <devicename>COM3</devicename>, and - <devicename>COM4</devicename>. &os; currently supports + <filename>COM1</filename>, + <filename>COM2</filename>, + <filename>COM3</filename>, and + <filename>COM4</filename>. &os; currently supports <quote>dumb</quote> multiport serial interface cards, such as the BocaBoard 1008 and 2016, as well as more intelligent multi-port cards such as those made by Digiboard and Stallion @@ -542,20 +540,20 @@ <para>Most devices in the kernel are accessed through <quote>device special files</quote> which are located in - <filename class="directory">/dev</filename>. The - <devicename>sio</devicename> devices are accessed through the - <filename>/dev/ttyu<replaceable>N</replaceable></filename> + <filename>/dev</filename>. The + <filename>sio</filename> devices are accessed through the + <filename>/dev/ttyuN</filename> (dial-in) and - <filename>/dev/cuau<replaceable>N</replaceable></filename> + <filename>/dev/cuauN</filename> (call-out) devices. &os; also provides initialization devices - (<filename>/dev/ttyu<replaceable>N</replaceable>.init</filename> + (<filename>/dev/ttyuN.init</filename> and - <filename>/dev/cuau<replaceable>N</replaceable>.init</filename>) + <filename>/dev/cuauN.init</filename>) and locking devices - (<filename>/dev/ttyu<replaceable>N</replaceable>.lock</filename> + (<filename>/dev/ttyuN.lock</filename> and - <filename>/dev/cuau<replaceable>N</replaceable>.lock</filename>). + <filename>/dev/cuauN.lock</filename>). The initialization devices are used to initialize communications port parameters each time a port is opened, such as <literal>crtscts</literal> for modems which use @@ -568,15 +566,15 @@ </sect2> - <sect2 id="serial-hw-config"> + <sect2 xml:id="serial-hw-config"> <title>Serial Port Configuration</title> - <indexterm><primary><devicename>ttyu</devicename></primary></indexterm> - <indexterm><primary><devicename>cuau</devicename></primary></indexterm> + <indexterm><primary><filename>ttyu</filename></primary></indexterm> + <indexterm><primary><filename>cuau</filename></primary></indexterm> <para>The - <devicename>ttyu<replaceable>N</replaceable></devicename> (or - <devicename>cuau<replaceable>N</replaceable></devicename>) + <filename>ttyuN</filename> (or + <filename>cuauN</filename>) is the regular device to open for applications. When a process opens the device, it will have a default set of terminal I/O settings. These settings can be viewed with the @@ -591,7 +589,7 @@ <quote>initial state</quote> device. For example, to turn on <option>CLOCAL</option> mode, 8 bit communication, and <option>XON/XOFF</option> flow control for - <devicename>ttyu5</devicename>, type:</para> + <filename>ttyu5</filename>, type:</para> <screen>&prompt.root; <userinput>stty -f /dev/ttyu5.init clocal cs8 ixon ixoff</userinput></screen> @@ -607,20 +605,20 @@ <para>To prevent certain settings from being changed by an application, make adjustments to the <quote>lock state</quote> device. For example, to lock the speed of - <devicename>ttyu5</devicename> to 57600 bps, type:</para> + <filename>ttyu5</filename> to 57600 bps, type:</para> <screen>&prompt.root; <userinput>stty -f /dev/ttyu5.lock 57600</userinput></screen> <para>Now, an application that opens - <devicename>ttyu5</devicename> and tries to change the speed + <filename>ttyu5</filename> and tries to change the speed of the port will be stuck with 57600 bps.</para> <para>The initial state and lock state devices should only be - writable by <username>root</username>.</para> + writable by <systemitem class="username">root</systemitem>.</para> </sect2> </sect1> - <sect1 id="term"> + <sect1 xml:id="term"> <!-- <sect1info> <authorgroup> @@ -707,26 +705,25 @@ <para>To connect from a client system that runs &os; to the serial connection of another system, use:</para> - <screen>&prompt.root; <userinput>cu -l <replaceable>serial-port-device</replaceable></userinput></screen> + <screen>&prompt.root; <userinput>cu -l serial-port-device</userinput></screen> <para>Where <quote>serial-port-device</quote> is the name of a special device file denoting a serial port on the system. These device files are called - <devicename>/dev/cuau<replaceable>N</replaceable></devicename>.</para> + <filename>/dev/cuauN</filename>.</para> <para>The <quote>N</quote>-part of a device name is the serial port number.</para> <note> <para>Note that device numbers in &os; start from zero and - not one. This means that <devicename>COM1</devicename> + not one. This means that <filename>COM1</filename> is <filename>/dev/cuau0</filename> in &os;.</para> </note> <note> <para>Some people prefer to use other programs available - through the Ports Collection, such as <filename - role="package">comms/minicom</filename>.</para> + through the Ports Collection, such as <package>comms/minicom</package>.</para> </note> </listitem> </varlistentry> @@ -746,7 +743,7 @@ </varlistentry> </variablelist> - <sect2 id="term-config"> + <sect2 xml:id="term-config"> <title>Configuration</title> <para>This section describes how to configure a &os; system to @@ -765,12 +762,12 @@ program.</para> <para>To configure terminals for a &os; system, the following - steps should be taken as <username>root</username>:</para> + steps should be taken as <systemitem class="username">root</systemitem>:</para> <procedure> <step> <para>Add a line to <filename>/etc/ttys</filename> for the - entry in <filename class="directory">/dev</filename> for + entry in <filename>/dev</filename> for the serial port if it is not already there.</para> </step> @@ -806,31 +803,30 @@ more information, refer to &man.gettytab.5; and &man.getty.8;.</para> - <sect3 id="term-etcttys"> + <sect3 xml:id="term-etcttys"> <title>Adding an Entry to <filename>/etc/ttys</filename></title> <para><filename>/etc/ttys</filename> lists all of the ports on the &os; system which allow logins. For example, the first virtual console, - <devicename>ttyv0</devicename>, has an entry in this file, + <filename>ttyv0</filename>, has an entry in this file, allowing logins on the console. This file also contains entries for the other virtual consoles, serial ports, and pseudo-ttys. For a hardwired terminal, - list the serial port's <filename - class="directory">/dev</filename> entry without the + list the serial port's <filename>/dev</filename> entry without the <literal>/dev</literal> part. For example, <filename>/dev/ttyv0</filename> would be listed as <literal>ttyv0</literal>.</para> <para>A default &os; install includes an <filename>/etc/ttys</filename> with support for the - first four serial ports: <devicename>ttyu0</devicename> - through <devicename>ttyu3</devicename>. When + first four serial ports: <filename>ttyu0</filename> + through <filename>ttyu3</filename>. When attaching a terminal to one of those ports, this file does not need to be edited.</para> - <example id="ex-etc-ttys"> + <example xml:id="ex-etc-ttys"> <title>Adding Terminal Entries to <filename>/etc/ttys</filename></title> @@ -843,19 +839,14 @@ <filename>/etc/ttys</filename> would look like this:</para> - <programlisting>ttyu1<co - id="co-ttys-line1col1"/> "/usr/libexec/getty std.38400"<co - id="co-ttys-line1col2"/> wy50<co - id="co-ttys-line1col3"/> on<co - id="co-ttys-line1col4"/> insecure<co - id="co-ttys-line1col5"/> + <programlisting>ttyu1<co xml:id="co-ttys-line1col1"/> "/usr/libexec/getty std.38400"<co xml:id="co-ttys-line1col2"/> wy50<co xml:id="co-ttys-line1col3"/> on<co xml:id="co-ttys-line1col4"/> insecure<co xml:id="co-ttys-line1col5"/> ttyu5 "/usr/libexec/getty std.19200" vt100 on insecure</programlisting> <calloutlist> <callout arearefs="co-ttys-line1col1"> <para>The first field normally specifies the name of the terminal special file as it is found in - <filename class="directory">/dev</filename>.</para> + <filename>/dev</filename>.</para> </callout> <callout arearefs="co-ttys-line1col2"> @@ -924,10 +915,10 @@ ttyu5 "/usr/libexec/getty std.19200" vt100 on insecure</programlisting> <para>The final field is used to specify whether the port is secure. Marking a port as <literal>secure</literal> means that it is trusted - enough to allow <username>root</username>, or any + enough to allow <systemitem class="username">root</systemitem>, or any account with a <acronym>UID</acronym> of 0, to login from that port. Insecure ports do not allow - <username>root</username> logins. On an insecure + <systemitem class="username">root</systemitem> logins. On an insecure port, users must login from unprivileged accounts and then use &man.su.1; or a similar mechanism to gain superuser privileges.</para> @@ -942,7 +933,7 @@ ttyu5 "/usr/libexec/getty std.19200" vt100 on insecure</programlisting> </example> </sect3> - <sect3 id="term-hup"> + <sect3 xml:id="term-hup"> <title>Force <command>init</command> to Reread <filename>/etc/ttys</filename></title> @@ -967,7 +958,7 @@ ttyu5 "/usr/libexec/getty std.19200" vt100 on insecure</programlisting> </sect3> </sect2> - <sect2 id="term-debug"> + <sect2 xml:id="term-debug"> <title>Troubleshooting the Connection</title> <para>Even with the most meticulous attention to detail, @@ -1000,7 +991,7 @@ ttyu5 "/usr/libexec/getty std.19200" vt100 on insecure</programlisting> <para>There should be an entry for the terminal. For example, the following display shows that a <command>getty</command> is running on the second serial - port, <devicename>ttyu1</devicename>, and is using the + port, <filename>ttyu1</filename>, and is using the <literal>std.38400</literal> entry in <filename>/etc/gettytab</filename>:</para> @@ -1042,7 +1033,7 @@ ttyu5 "/usr/libexec/getty std.19200" vt100 on insecure</programlisting> </sect2> </sect1> - <sect1 id="dialup"> + <sect1 xml:id="dialup"> <!-- <sect1info> <authorgroup> @@ -1087,7 +1078,7 @@ ttyu5 "/usr/libexec/getty std.19200" vt100 on insecure</programlisting> standard RS-232C serial cable should suffice as long as all of the normal signals are wired:</para> - <table frame="none" pgwide="1" id="serialcomms-signal-names"> + <table frame="none" pgwide="1" xml:id="serialcomms-signal-names"> <title>Signal Names</title> <tgroup cols="2"> @@ -1216,13 +1207,13 @@ ttyu5 "/usr/libexec/getty std.19200" vt100 on insecure</programlisting> <title>Configuration Files</title> <para>There are three system configuration files in - <filename class="directory">/etc</filename> that probably + <filename>/etc</filename> that probably need to be edited to allow dial-up access to the &os; system. <filename>/etc/gettytab</filename> contains configuration information for the <filename>/usr/libexec/getty</filename> daemon. <filename>/etc/ttys</filename> holds information that tells <command>init</command> which - <devicename>tty</devicename>s should have + <filename>tty</filename>s should have <command>getty</command> processes running on them. Lastly, port initialization commands can be placed in <filename>/etc/rc.d/serial</filename>.</para> @@ -1356,7 +1347,7 @@ vq|VH57600|Very High Speed Modem at 57600,8-bit:\ <quote>silo</quote> errors at 57.6 Kbps.</para> </sect3> - <sect3 id="dialup-ttys"> + <sect3 xml:id="dialup-ttys"> <title><filename>/etc/ttys</filename></title> <indexterm> @@ -1376,7 +1367,7 @@ vq|VH57600|Very High Speed Modem at 57600,8-bit:\ <para>The first item in the above line is the device special file for this entry. <literal>ttyu0</literal> indicates that <command>getty</command> is watching - <devicename>/dev/ttyu0</devicename>. The + <filename>/dev/ttyu0</filename>. The <replaceable>xxx</replaceable> will replace the initial <filename>gettytab</filename> capability and is the process <command>init</command> will run on the device. The third @@ -1418,7 +1409,7 @@ vq|VH57600|Very High Speed Modem at 57600,8-bit:\ <para>If the modem is locked at a different data rate, substitute the appropriate value for - <literal>std.<replaceable>speed</replaceable></literal> + <literal>std.speed</literal> instead of <literal>std.19200</literal>. Make sure to use a valid type listed in <filename>/etc/gettytab</filename>.</para> @@ -1451,7 +1442,7 @@ vq|VH57600|Very High Speed Modem at 57600,8-bit:\ <para>For example, to set the <literal>termios</literal> flag <varname>crtscts</varname> on - <devicename>COM2</devicename>'s dial-in and dial-out + <filename>COM2</filename>'s dial-in and dial-out initialization devices, the following lines could be added to <filename>/etc/rc.d/serial</filename>:</para> @@ -1646,7 +1637,7 @@ AT&B2&W</programlisting> <para>If no <command>getty</command> processes are waiting to open the desired - <devicename>ttyu<replaceable>N</replaceable></devicename> + <filename>ttyuN</filename> port, double-check the entries in <filename>/etc/ttys</filename> to see if there are any mistakes. Also, check @@ -1704,7 +1695,7 @@ AT&B2&W</programlisting> </sect2> </sect1> - <sect1 id="dialout"> + <sect1 xml:id="dialout"> <title>Dial-out Service</title> <indexterm><primary>dial-out service</primary></indexterm> @@ -1718,7 +1709,7 @@ AT&B2&W</programlisting> working, use the terminal session to FTP the needed file. Then use zmodem to transfer it to the machine.</para> - <sect2 id="hayes-unsupported"> + <sect2 xml:id="hayes-unsupported"> <title>Using a Stock Hayes Modem</title> <para>A generic Hayes dialer is built into @@ -1738,7 +1729,7 @@ AT&B2&W</programlisting> problem. Try <command>ATS7=45&W</command>.</para> </sect2> - <sect2 id="direct-at"> + <sect2 xml:id="direct-at"> <title>Using <literal>AT</literal> Commands</title> <indexterm> @@ -1756,10 +1747,10 @@ AT&B2&W</programlisting> supports in the <literal>br</literal> capability. Then, type <command>tip cuau0</command> to connect to the modem.</para> - <para>Or, use <command>cu</command> as <username>root</username> + <para>Or, use <command>cu</command> as <systemitem class="username">root</systemitem> with the following command:</para> - <screen>&prompt.root; <userinput>cu -l<replaceable>line</replaceable> -s<replaceable>speed</replaceable></userinput></screen> + <screen>&prompt.root; <userinput>cu -lline -sspeed</userinput></screen> <para><replaceable>line</replaceable> is the serial port, such as <filename>/dev/cuau0</filename>, and @@ -1768,7 +1759,7 @@ AT&B2&W</programlisting> commands, type <command>~.</command> to exit.</para> </sect2> - <sect2 id="gt-failure"> + <sect2 xml:id="gt-failure"> <title>The <literal>@</literal> Sign Does Not Work</title> <para>The <literal>@</literal> sign in the phone number @@ -1781,7 +1772,7 @@ AT&B2&W</programlisting> <programlisting>pn=\@</programlisting> </sect2> - <sect2 id="dial-command-line"> + <sect2 xml:id="dial-command-line"> <title>Dialing from the Command Line</title> <para>Put a <quote>generic</quote> entry in @@ -1808,7 +1799,7 @@ tip57600|Dial any phone number at 57600 bps:\ <screen>&prompt.root; <userinput>cu 5551234 -s 115200</userinput></screen> </sect2> - <sect2 id="set-bps"> + <sect2 xml:id="set-bps"> <title>Setting the <acronym>bps</acronym> Rate</title> <para>Put in an entry for <literal>tip1200</literal> or @@ -1820,18 +1811,18 @@ tip57600|Dial any phone number at 57600 bps:\ 1200 bps does not have to be used, though.</para> </sect2> - <sect2 id="terminal-server"> + <sect2 xml:id="terminal-server"> <title>Accessing a Number of Hosts Through a Terminal Server</title> <para>Rather than waiting until connected and typing - <command>CONNECT <replaceable>host</replaceable></command> + <command>CONNECT host</command> each time, use <command>tip</command>'s <literal>cm</literal> capability. For example, these entries in <filename>/etc/remote</filename> will let you type <command>tip pain</command> or <command>tip muffin</command> to connect to the hosts - <hostid>pain</hostid> or <hostid>muffin</hostid>, and + <systemitem>pain</systemitem> or <systemitem>muffin</systemitem>, and <command>tip deep13</command> to connect to the terminal server.</para> @@ -1844,7 +1835,7 @@ deep13:Gizmonics Institute terminal server:\ </sect2> - <sect2 id="tip-multiline"> + <sect2 xml:id="tip-multiline"> <title>Using More Than One Line with <command>tip</command></title> @@ -1875,7 +1866,7 @@ big-university 5551114</programlisting> loop.</para> </sect2> - <sect2 id="multi-controlp"> + <sect2 xml:id="multi-controlp"> <title>Using the Force Character</title> <para><keycombo action="simul"> @@ -1888,7 +1879,7 @@ big-university 5551114</programlisting> <quote>set a variable.</quote></para> <para>Type - <command>~sforce=<replaceable>single-char</replaceable></command> + <command>~sforce=single-char</command> followed by a newline. <replaceable>single-char</replaceable> is any single character. If <replaceable>single-char</replaceable> is left out, then the @@ -1914,7 +1905,7 @@ big-university 5551114</programlisting> <programlisting>force=<replaceable>single-char</replaceable></programlisting> </sect2> - <sect2 id="uppercase"> + <sect2 xml:id="uppercase"> <title>Upper Case Characters</title> <para>This happens when @@ -1948,7 +1939,7 @@ raisechar=^^</programlisting> </sect2> - <sect2 id="tip-filetransfer"> + <sect2 xml:id="tip-filetransfer"> <title>File Transfers with <command>tip</command></title> <para>When talking to another &unix;-like operating system, @@ -1973,7 +1964,7 @@ raisechar=^^</programlisting> zmodem, should probably be used.</para> </sect2> - <sect2 id="zmodem-tip"> + <sect2 xml:id="zmodem-tip"> <title>Using <application>zmodem</application> with <command>tip</command>?</title> @@ -1983,12 +1974,12 @@ raisechar=^^</programlisting> <para>To send files, start the receiving program on the remote end. Then, type <command>~C sz - <replaceable>files</replaceable></command> to send them to the + files</command> to send them to the remote system.</para> </sect2> </sect1> - <sect1 id="serialconsole-setup"> + <sect1 xml:id="serialconsole-setup"> <!-- <sect1info> <authorgroup> @@ -2028,7 +2019,7 @@ raisechar=^^</programlisting> block code, the boot loader code, and the kernel need to be configured.</para> - <sect2 id="serialconsole-howto-fast"> + <sect2 xml:id="serialconsole-howto-fast"> <title>Quick Serial Console Configuration</title> <para>This section assumes the default setup and provides a fast @@ -2038,7 +2029,7 @@ raisechar=^^</programlisting> <step> <para>Connect the serial cable to - <devicename>COM1</devicename> and the controlling + <filename>COM1</filename> and the controlling terminal.</para> </step> @@ -2053,7 +2044,7 @@ raisechar=^^</programlisting> <para>Edit <filename>/etc/ttys</filename> and change <literal>off</literal> to <literal>on</literal> and <literal>dialup</literal> to <literal>vt100</literal> for - the <devicename>ttyu0</devicename> entry. Otherwise, a + the <filename>ttyu0</filename> entry. Otherwise, a password will not be required to connect via the serial console, resulting in a potential security hole.</para> </step> @@ -2069,7 +2060,7 @@ raisechar=^^</programlisting> section for a more in-depth configuration explanation.</para> </sect2> - <sect2 id="serialconsole-howto"> + <sect2 xml:id="serialconsole-howto"> <title>In-Depth Serial Console Configuration</title> <procedure> @@ -2079,8 +2070,7 @@ raisechar=^^</programlisting> <indexterm><primary>null-modem cable</primary></indexterm> <para>Use either a null-modem cable or a standard serial - cable and a null-modem adapter. See <xref - linkend="term-cables-null"/> for a discussion + cable and a null-modem adapter. See <xref linkend="term-cables-null"/> for a discussion on serial cables.</para> </step> @@ -2128,18 +2118,18 @@ raisechar=^^</programlisting> <step> <para>Plug a dumb terminal into - <devicename>COM1</devicename> - (<devicename>sio0</devicename>).</para> + <filename>COM1</filename> + (<filename>sio0</filename>).</para> <para>If a dumb terminal is not available, use an old computer with a modem program, or the serial port on another &unix; box. If there is no - <devicename>COM1</devicename> - (<devicename>sio0</devicename>), get one. At this time, + <filename>COM1</filename> + (<filename>sio0</filename>), get one. At this time, there is no way to select a port other than - <devicename>COM1</devicename> for the boot blocks without + <filename>COM1</filename> for the boot blocks without recompiling the boot blocks. If - <devicename>COM1</devicename> is being used by another + <filename>COM1</filename> is being used by another device, temporarily remove that device and install a new boot block and kernel once &os; is up and running.</para> </step> @@ -2147,8 +2137,8 @@ raisechar=^^</programlisting> <step> <para>Make sure the configuration file of the custom kernel has appropriate flags set for - <devicename>COM1</devicename> - (<devicename>sio0</devicename>).</para> + <filename>COM1</filename> + (<filename>sio0</filename>).</para> <para>Relevant flags are:</para> @@ -2189,9 +2179,8 @@ raisechar=^^</programlisting> unavailable for normal access. This flag should not be set to the serial port to use as the serial console. The only use of this flag is to designate - the unit for kernel remote debugging. See <ulink - url="&url.books.developers-handbook;/index.html">The - Developer's Handbook</ulink> for more information on + the unit for kernel remote debugging. See <link xlink:href="&url.books.developers-handbook;/index.html">The + Developer's Handbook</link> for more information on remote debugging.</para> </listitem> </varlistentry> @@ -2399,7 +2388,7 @@ boot:</screen> information.</para> </sect2> - <sect2 id="serialconsole-summary"> + <sect2 xml:id="serialconsole-summary"> <title>Summary</title> <para>The following tables provide a summary of the various @@ -2407,7 +2396,7 @@ boot:</screen> <table frame="none" pgwide="1"> <title>Case 1: Set the Flags to 0x10 for - <devicename>sio0</devicename></title> + <filename>sio0</filename></title> <tgroup cols="4"> <thead> @@ -2467,7 +2456,7 @@ boot:</screen> <table frame="none" pgwide="1"> <title>Case 2: Set the Flags to 0x30 for - <devicename>sio0</devicename></title> + <filename>sio0</filename></title> <tgroup cols="4"> <thead> @@ -2526,7 +2515,7 @@ boot:</screen> </table> </sect2> - <sect2 id="serialconsole-tips"> + <sect2 xml:id="serialconsole-tips"> <title>Tips for the Serial Console</title> <sect3> @@ -2539,9 +2528,8 @@ boot:</screen> <itemizedlist> <listitem> <para>Recompile the boot blocks with - <makevar>BOOT_COMCONSOLE_SPEED</makevar> set to the - new console speed. See <xref - linkend="serialconsole-com2"/> for detailed + <varname>BOOT_COMCONSOLE_SPEED</varname> set to the + new console speed. See <xref linkend="serialconsole-com2"/> for detailed instructions about building and installing new boot blocks.</para> @@ -2581,28 +2569,27 @@ console="comconsole,vidconsole"</programlisting> </itemizedlist> </sect3> - <sect3 id="serialconsole-com2"> + <sect3 xml:id="serialconsole-com2"> <title>Using a Serial Port Other Than - <devicename>sio0</devicename> for the Console</title> + <filename>sio0</filename> for the Console</title> - <para>Using a port other than <devicename>sio0</devicename> as + <para>Using a port other than <filename>sio0</filename> as the console requires the boot blocks, the boot loader, and the kernel to be recompiled as follows.</para> <procedure> <step> - <para>Get the kernel source as described in <xref - linkend="updating-upgrading"/>.</para> + <para>Get the kernel source as described in <xref linkend="updating-upgrading"/>.</para> </step> <step> <para>Edit <filename>/etc/make.conf</filename> and set <literal>BOOT_COMCONSOLE_PORT</literal> to the address of the port to use: 0x3F8, 0x2F8, 0x3E8 or 0x2E8. Only - <devicename>sio0</devicename> through - <devicename>sio3</devicename> - (<devicename>COM1</devicename> through - <devicename>COM4</devicename>) can be used as multiport + <filename>sio0</filename> through + <filename>sio3</filename> + (<filename>COM1</filename> through + <filename>COM4</filename>) can be used as multiport serial cards will not work. No interrupt setting is needed.</para> </step> @@ -2610,8 +2597,8 @@ console="comconsole,vidconsole"</programlisting> <step> <para>Create a custom kernel configuration file and add appropriate flags for the serial port to use. For - example, to make <devicename>sio1</devicename> - (<devicename>COM2</devicename>) the console:</para> + example, to make <filename>sio1</filename> + (<filename>COM2</filename>) the console:</para> <programlisting>device sio1 flags 0x10</programlisting> @@ -2644,7 +2631,7 @@ console="comconsole,vidconsole"</programlisting> </procedure> </sect3> - <sect3 id="serialconsole-ddb"> + <sect3 xml:id="serialconsole-ddb"> <title>Entering the DDB Debugger from the Serial Line</title> <para>To drop into the kernel debugger from the serial @@ -2674,10 +2661,10 @@ ttyu1 "/usr/libexec/getty std.9600" unknown off secure ttyu2 "/usr/libexec/getty std.9600" unknown off secure ttyu3 "/usr/libexec/getty std.9600" unknown off secure</programlisting> - <para><devicename>ttyu0</devicename> through - <devicename>ttyu3</devicename> correspond to - <devicename>COM1</devicename> through - <devicename>COM4</devicename>. Change + <para><filename>ttyu0</filename> through + <filename>ttyu3</filename> correspond to + <filename>COM1</filename> through + <filename>COM4</filename>. Change <literal>off</literal> to <literal>on</literal> for the desired port. If the speed of the serial port has been changed, change <literal>std.9600</literal> to match the @@ -2692,7 +2679,7 @@ ttyu3 "/usr/libexec/getty std.9600" unknown off secure</programlisting> </sect3> </sect2> - <sect2 id="serialconsole-loader"> + <sect2 xml:id="serialconsole-loader"> <title>Changing Console from the Boot Loader</title> <para>Previous sections described how to set up the serial @@ -2745,16 +2732,15 @@ ttyu3 "/usr/libexec/getty std.9600" unknown off secure</programlisting> <sect3> <title>Using a Serial Port Other Than - <devicename>sio0</devicename> for the Console</title> + <filename>sio0</filename> for the Console</title> <para>The boot loader needs to be compiled in order to use a - serial port other than <devicename>sio0</devicename> for the - serial console. Follow the procedure described in <xref - linkend="serialconsole-com2"/>.</para> + serial port other than <filename>sio0</filename> for the + serial console. Follow the procedure described in <xref linkend="serialconsole-com2"/>.</para> </sect3> </sect2> - <sect2 id="serialconsole-caveats"> + <sect2 xml:id="serialconsole-caveats"> <title>Caveats</title> <para>While most systems will boot without a keyboard, quite a |