aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml
diff options
context:
space:
mode:
authorNik Clayton <nik@FreeBSD.org>1999-03-07 16:32:22 +0000
committerNik Clayton <nik@FreeBSD.org>1999-03-07 16:32:22 +0000
commit62a7d13816f413cce21284b3d88c82bbc0fd020f (patch)
treeecfdebef4da2fa2512d53416241b7f41c26dac09 /en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml
parent1c05a644f3586540e1690e93a49e0f2af66b4473 (diff)
downloaddoc-62a7d13816f413cce21284b3d88c82bbc0fd020f.tar.gz
doc-62a7d13816f413cce21284b3d88c82bbc0fd020f.zip
Created a new set of entities for manual pages.
The construct: <citerefentry> <refentrytitle>foobar</refentrytitle> <manvolnum>1</manvolnum> </citerefentry> is a pain to type, and messes up the pretty-printing of the source code. Replace every occurence of a entry like that with: &man.foobar.1; Adjusting the manual page name and section number appropriately. The definitions for these entities are stored in man-refs.ent. This file is in doc/share/sgml because it is not just specific to the Handbook. I expect the DocBook'd FAQ and Tutorials (coming RSN) to use them as well. A new PUBLIC identifier has been created for these entities, and added to the catalog file.
Notes
Notes: svn path=/head/; revision=4471
Diffstat (limited to 'en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml')
-rw-r--r--en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml17
1 files changed, 7 insertions, 10 deletions
diff --git a/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml b/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml
index c7e43305ab..bcb864feaa 100644
--- a/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml
+++ b/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml
@@ -13,10 +13,7 @@
is too small to hold the dump, you can configure your kernel to use
an alternate dump device (in the <literal>config
kernel</literal> line), or you can specify an alternate using the
- <citerefentry><refentrytitle>dumpon</refentrytitle><manvolnum>8</manvolnum></citerefentry> command. The best way to use <citerefentry>
- <refentrytitle>dumpon</refentrytitle>
- <manvolnum>8</manvolnum>
- </citerefentry> is to set the <literal>dumpdev</literal> variable in
+ &man.dumpon.8; command. The best way to use &man.dumpon.8; is to set the <literal>dumpdev</literal> variable in
<filename>/etc/rc.conf</filename>. Typically you want to specify one of
the swap devices specified in <filename>/etc/fstab</filename>.
Dumps to non-swap devices, tapes for example,
@@ -25,10 +22,10 @@ Dumps to non-swap devices, tapes for example,
Configuration</link> for
details on configuring the FreeBSD kernel.</para>
- <para>Use the <citerefentry><refentrytitle>dumpon</refentrytitle><manvolnum>8</manvolnum></citerefentry> command to tell the kernel
+ <para>Use the &man.dumpon.8; command to tell the kernel
where to dump to (note that this will have to be done after
configuring the partition in question as swap space via
- <citerefentry><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry>). This is normally arranged via
+ &man.swapon.8;). This is normally arranged via
<filename>/etc/rc.conf</filename> and <filename>/etc/rc</filename>.
Alternatively, you can hard-code the dump device via the <literal>dump</literal>
clause in the <literal>config</literal> line of your kernel config file. This is
@@ -68,7 +65,7 @@ Dumps to non-swap devices, tapes for example,
&prompt.root; <userinput>exit</userinput> # ...to multi-user</screen>
- <para>This instructs <citerefentry><refentrytitle>savecore</refentrytitle><manvolnum>8</manvolnum></citerefentry> to
+ <para>This instructs &man.savecore.8; to
use another kernel for symbol name extraction. It would otherwise
default to the currently running kernel and most likely not do
anything at all since the crash dump and the kernel symbols
@@ -279,7 +276,7 @@ Dumps to non-swap devices, tapes for example,
generated code, so you will finally get a new kernel with similar
code to the faulting one but some debugging symbols. You should at
least verify the old and new sizes with the
- <citerefentry><refentrytitle>size</refentrytitle><manvolnum>1</manvolnum></citerefentry> command. If there is a mismatch, you
+ &man.size.1; command. If there is a mismatch, you
probably need to give up here.</para>
<para>Go and examine the dump as described above. The debugging
@@ -479,7 +476,7 @@ options DDB</programlisting> to your config file, and rebuild. (See <link
<para>The return value will be printed.</para>
- <para>For a <citerefentry><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry> style summary of all running
+ <para>For a &man.ps.1; style summary of all running
processes, use:</para>
@@ -525,7 +522,7 @@ options DDB</programlisting> to your config file, and rebuild. (See <link
<para>However, it is highly recommended to have a
- printed copy of the <citerefentry><refentrytitle>ddb</refentrytitle><manvolnum>4</manvolnum></citerefentry> manual page
+ printed copy of the &man.ddb.4; manual page
ready for a debugging session. Remember that it is hard to read the
on-line manual while single-stepping the kernel.</para>