os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Created a new set of entities for manual pages.

Browse source 
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.
This commit is contained in:
Nik Clayton 1999-03-07 16:32:22 +00:00
parent 1c05a644f3
commit 62a7d13816
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=4471
64 changed files with 1392 additions and 2015 deletions
Download patch file Download diff file Expand all files Collapse all files

26
en/handbook/kernelconfig/chapter.sgml
View file

@ -122,7 +122,7 @@
<note>
<para>If you are trying to upgrade your kernel from an older version
of FreeBSD, you will probably have to get a new version of
<citerefentry><refentrytitle>config</refentrytitle><manvolnum>8</manvolnum></citerefentry> from the same place you got the new
&man.config.8; from the same place you got the new
kernel sources. It is located in
<filename>/usr/src/usr.sbin</filename>, so you will need to
download those sources as well. Re-build and install it before
@ -430,7 +430,7 @@
hundred bytes to the kernel.</para>
<note>
<para>The <citerefentry><refentrytitle>ipcs</refentrytitle><manvolnum>1</manvolnum></citerefentry> command will tell
<para>The &man.ipcs.1; command will tell
will list any processes using each of these System V
facilities.</para>
</note>
@ -503,7 +503,7 @@
<listitem>
<para>Process filesystem. This is a pretend filesystem
mounted on <filename>/proc</filename> which allows
programs like <citerefentry><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry> to give you more
programs like &man.ps.1; to give you more
information on what processes are running.</para>
</listitem>
</varlistentry>
@ -609,7 +609,7 @@
<note>
<para>QIC-80 tape support requires a separate filter
program called <citerefentry><refentrytitle>ft</refentrytitle><manvolnum>8</manvolnum></citerefentry>, see the manual
program called &man.ft.8;, see the manual
page for details.</para>
</note>
</listitem>
@ -975,7 +975,7 @@
modem to 2 (for obscure technical reasons IRQ 2 = IRQ 9)
in order to access it from FreeBSD. If you have a
multiport serial card, check the manual page for
<citerefentry><refentrytitle>sio</refentrytitle><manvolnum>4</manvolnum></citerefentry> for more information on the
&man.sio.4; for more information on the
proper values for these lines. Some video cards (notably
those based on S3 chips) use IO addresses of the form
<literal>0x*2e8</literal>, and since many cheap serial
@ -1250,7 +1250,7 @@
network interfaces to be placed in promiscuous mode,
capturing every packet on a broadcast network (e.g. an
ethernet). These packets can be captured to disk and/or
examined with the <citerefentry><refentrytitle>tcpdump</refentrytitle><manvolnum>1</manvolnum></citerefentry> program.
examined with the &man.tcpdump.1; program.
Note that implementation of this capability can seriously
compromise your overall network security. The
<replaceable>number</replaceable> after bpfilter is the number
@ -1445,7 +1445,7 @@
<listitem>
<para>Snoop device. This pseudo-device allows one terminal
session to watch another using the
<citerefentry><refentrytitle>watch</refentrytitle><manvolnum>8</manvolnum></citerefentry> command. Note that
&man.watch.8; command. Note that
implementation of this capability has important security
and privacy implications. The <replaceable>number</replaceable>
after snp is the total number of simultaneous snoop
@ -1457,7 +1457,7 @@
<listitem>
<para>Vnode driver. Allows a file to be treated as a device
after being set up with the <citerefentry><refentrytitle>vnconfig</refentrytitle><manvolnum>8</manvolnum></citerefentry>
after being set up with the &man.vnconfig.8;
command. This driver can be useful for manipulating
floppy disk images and using a file as a swap device (e.g.
an MS Windows swap file). Optional.</para>
@ -1473,8 +1473,8 @@
&ldquo;meta&rdquo;-disk. The <replaceable>number</replaceable> after ccd
is the total number of concatenated disks (not total
number of disks that can be concatenated) that can be
created. (See <citerefentry><refentrytitle>ccd</refentrytitle><manvolnum>4</manvolnum></citerefentry> and
<citerefentry><refentrytitle>ccdconfig</refentrytitle><manvolnum>8</manvolnum></citerefentry> man pages for more
created. (See &man.ccd.4; and
&man.ccdconfig.8; man pages for more
details.) Optional.</para>
</listitem>
</varlistentry>
@ -1642,7 +1642,7 @@ controller wcd0</programlisting>
resource is the <filename>/var/log/messages</filename> file
which records, among other things, all of the kernel
messages from every successful boot. Also, the
<citerefentry><refentrytitle>dmesg</refentrytitle><manvolnum>8</manvolnum></citerefentry> command will print the kernel
&man.dmesg.8; command will print the kernel
messages from the current boot.</para>
<note>
@ -1655,7 +1655,7 @@ controller wcd0</programlisting>
with the last installed kernel which may be
non-functional. Also, as soon as possible, move the
working kernel to the proper <filename>kernel</filename> location or
commands such as <citerefentry><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry> will not work
commands such as &man.ps.1; will not work
properly. The proper command to &ldquo;unlock&rdquo; the
kernel file that <command>make</command> installs (in
order to move another kernel back permanently) is:</para>
@ -1683,7 +1683,7 @@ controller wcd0</programlisting>
from the one that the system utilities have been built with,
for example, an experimental &ldquo;2.2.0&rdquo; kernel on a
2.1.0-RELEASE system, many system-status commands like
<citerefentry><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry> and <citerefentry><refentrytitle>vmstat</refentrytitle><manvolnum>8</manvolnum></citerefentry>
&man.ps.1; and &man.vmstat.8;
will not work any more. You must recompile the <filename>libkvm</filename> library as well as these
utilities. This is one reason it is not normally a good
idea to use a different version of the kernel from the rest