Add class="directory" to <filename> elements that need it.

Reviewed by:	manolis, rene, trhodes
This commit is contained in:
Giorgos Keramidas 2009-05-06 13:34:56 +00:00
parent 63947bee93
commit 923fda1d51
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=34219

View file

@ -53,7 +53,7 @@
</listitem> </listitem>
<listitem> <listitem>
<para>The basics of <filename>rc.conf</filename> configuration and <para>The basics of <filename>rc.conf</filename> configuration and
<filename>/usr/local/etc/rc.d</filename> startup systems.</para> <filename class="directory">/usr/local/etc/rc.d</filename> startup systems.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>How to configure and test a network card.</para> <para>How to configure and test a network card.</para>
@ -63,7 +63,7 @@
</listitem> </listitem>
<listitem> <listitem>
<para>How to use the various configuration files in <para>How to use the various configuration files in
<filename>/etc</filename>.</para> <filename class="directory">/etc</filename>.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>How to tune &os; using <command>sysctl</command> <para>How to tune &os; using <command>sysctl</command>
@ -97,13 +97,13 @@
<indexterm><primary>partition layout</primary></indexterm> <indexterm><primary>partition layout</primary></indexterm>
<indexterm> <indexterm>
<primary><filename>/etc</filename></primary> <primary><filename class="directory">/etc</filename></primary>
</indexterm> </indexterm>
<indexterm> <indexterm>
<primary><filename>/var</filename></primary> <primary><filename class="directory">/var</filename></primary>
</indexterm> </indexterm>
<indexterm> <indexterm>
<primary><filename>/usr</filename></primary> <primary><filename class="directory">/usr</filename></primary>
</indexterm> </indexterm>
<sect3> <sect3>
@ -115,32 +115,32 @@
tracks to the inner. tracks to the inner.
Thus smaller and heavier-accessed file systems Thus smaller and heavier-accessed file systems
should be closer to the outside of the drive, while should be closer to the outside of the drive, while
larger partitions like <filename>/usr</filename> should be placed larger partitions like <filename class="directory">/usr</filename> should be placed
toward the inner parts of the disk. It is a good idea to create toward the inner parts of the disk. It is a good idea to create
partitions in an order similar to: root, swap, partitions in an order similar to: root, swap,
<filename>/var</filename>, <filename>/usr</filename>.</para> <filename class="directory">/var</filename>, <filename class="directory">/usr</filename>.</para>
<para>The size of the <filename>/var</filename> partition <para>The size of the <filename class="directory">/var</filename> partition
reflects the intended machine usage. reflects the intended machine usage.
The <filename>/var</filename> file system is used to hold The <filename class="directory">/var</filename> file system is used to hold
mailboxes, log files, and printer spools. Mailboxes and log mailboxes, log files, and printer spools. Mailboxes and log
files can grow to unexpected sizes depending files can grow to unexpected sizes depending
on how many users exist and how long log on how many users exist and how long log
files are kept. Most users will rarely need more than about a files are kept. Most users will rarely need more than about a
gigabyte of free disk space in <filename>/var</filename>.</para> gigabyte of free disk space in <filename class="directory">/var</filename>.</para>
<note> <note>
<para>There are a few times that a lot of disk space is required <para>There are a few times that a lot of disk space is required
in <filename>/var/tmp</filename>. When new software is installed in <filename class="directory">/var/tmp</filename>. When new software is installed
with &man.pkg.add.1; the packaging tools extract a temporary copy with &man.pkg.add.1; the packaging tools extract a temporary copy
of the packages under <filename>/var/tmp</filename>. Large of the packages under <filename class="directory">/var/tmp</filename>. Large
software packages, like <application>Firefox</application>, software packages, like <application>Firefox</application>,
or <application>OpenOffice</application> may be tricky to install or <application>OpenOffice</application> may be tricky to install
if there is not enough disk space if there is not enough disk space
under <filename>/var/tmp</filename>.</para> under <filename class="directory">/var/tmp</filename>.</para>
</note> </note>
<para>The <filename>/usr</filename> partition holds many <para>The <filename class="directory">/usr</filename> partition holds many
of the files required to support the system, including the &man.ports.7; of the files required to support the system, including the &man.ports.7;
collection (recommended) and the source code (optional). Both the collection (recommended) and the source code (optional). Both the
ports and the sources of the base system are optional at install ports and the sources of the base system are optional at install
@ -154,8 +154,8 @@
<note><para>Some users have found that &man.sysinstall.8;'s <note><para>Some users have found that &man.sysinstall.8;'s
<literal>Auto-defaults</literal> partition sizer will <literal>Auto-defaults</literal> partition sizer will
sometimes select smaller than adequate <filename>/var</filename> sometimes select smaller than adequate <filename class="directory">/var</filename>
and <filename>/</filename> partitions. Partition wisely and and <filename class="directory">/</filename> partitions. Partition wisely and
generously.</para></note> generously.</para></note>
</sect3> </sect3>
@ -200,10 +200,10 @@
First, each partition has different operational First, each partition has different operational
characteristics and separating them allows the file system to characteristics and separating them allows the file system to
tune accordingly. For example, the root tune accordingly. For example, the root
and <filename>/usr</filename> partitions are read-mostly, without and <filename class="directory">/usr</filename> partitions are read-mostly, without
much writing. While a lot of reading and writing could much writing. While a lot of reading and writing could
occur in <filename>/var</filename> and occur in <filename class="directory">/var</filename> and
<filename>/var/tmp</filename>.</para> <filename class="directory">/var/tmp</filename>.</para>
<para>By properly partitioning a system, fragmentation <para>By properly partitioning a system, fragmentation
introduced in the smaller write heavy partitions introduced in the smaller write heavy partitions
@ -216,7 +216,7 @@
performance in the larger partitions may be needed, performance in the larger partitions may be needed,
shifting them more toward the edge of the disk will not shifting them more toward the edge of the disk will not
lead to a significant performance improvement over moving lead to a significant performance improvement over moving
<filename>/var</filename> to the edge. <filename class="directory">/var</filename> to the edge.
Finally, there are safety concerns. A smaller, neater root Finally, there are safety concerns. A smaller, neater root
partition which is mostly read-only has a greater partition which is mostly read-only has a greater
chance of surviving a bad crash.</para> chance of surviving a bad crash.</para>
@ -244,7 +244,7 @@
<filename>rc.conf</filename> file to <filename>rc.conf</filename> file to
override the default settings from override the default settings from
<filename>/etc/defaults/rc.conf</filename>. The defaults file <filename>/etc/defaults/rc.conf</filename>. The defaults file
should not be copied verbatim to <filename>/etc</filename> - it should not be copied verbatim to <filename class="directory">/etc</filename> - it
contains default values, not examples. All system-specific contains default values, not examples. All system-specific
changes should be made in the <filename>rc.conf</filename> changes should be made in the <filename>rc.conf</filename>
file itself.</para> file itself.</para>
@ -297,7 +297,7 @@
<indexterm><primary>/usr/local/etc</primary></indexterm> <indexterm><primary>/usr/local/etc</primary></indexterm>
<para>Typically, these files are installed in <para>Typically, these files are installed in
<filename>/usr/local/etc</filename>. In the case where an <filename class="directory">/usr/local/etc</filename>. In the case where an
application has a large number of configuration files, a application has a large number of configuration files, a
subdirectory will be created to hold them.</para> subdirectory will be created to hold them.</para>
@ -309,7 +309,7 @@
copying the <filename>.default</filename> files.</para> copying the <filename>.default</filename> files.</para>
<para>For example, consider the contents of the directory <para>For example, consider the contents of the directory
<filename>/usr/local/etc/apache</filename>:</para> <filename class="directory">/usr/local/etc/apache</filename>:</para>
<literallayout class="monospaced">-rw-r--r-- 1 root wheel 2184 May 20 1998 access.conf <literallayout class="monospaced">-rw-r--r-- 1 root wheel 2184 May 20 1998 access.conf
-rw-r--r-- 1 root wheel 2184 May 20 1998 access.conf.default -rw-r--r-- 1 root wheel 2184 May 20 1998 access.conf.default
@ -527,7 +527,7 @@ run_rc_command "$1"</programlisting>
<para>One of the most useful utilities in &os; is &man.cron.8;. The <para>One of the most useful utilities in &os; is &man.cron.8;. The
<command>cron</command> utility runs in the background and constantly <command>cron</command> utility runs in the background and constantly
checks the <filename>/etc/crontab</filename> file. The <command>cron</command> checks the <filename>/etc/crontab</filename> file. The <command>cron</command>
utility also checks the <filename>/var/cron/tabs</filename> directory, in utility also checks the <filename class="directory">/var/cron/tabs</filename> directory, in
search of new <filename>crontab</filename> files. These search of new <filename>crontab</filename> files. These
<filename>crontab</filename> files store information about specific <filename>crontab</filename> files store information about specific
functions which <command>cron</command> is supposed to perform at functions which <command>cron</command> is supposed to perform at
@ -702,7 +702,7 @@ HOME=/var/log
<para>In 2002 &os; integrated the NetBSD <para>In 2002 &os; integrated the NetBSD
<filename>rc.d</filename> system for system initialization. <filename>rc.d</filename> system for system initialization.
Users should notice the files listed in the Users should notice the files listed in the
<filename>/etc/rc.d</filename> directory. Many of these files <filename class="directory">/etc/rc.d</filename> directory. Many of these files
are for basic services which can be controlled with the are for basic services which can be controlled with the
<option>start</option>, <option>stop</option>, <option>start</option>, <option>stop</option>,
and <option>restart</option> options. and <option>restart</option> options.
@ -1418,7 +1418,7 @@ ifconfig_fxp0_alias7="inet 202.0.75.20 netmask 255.255.255.255"</programlisting>
<title>Configuration Files</title> <title>Configuration Files</title>
<sect2> <sect2>
<title><filename>/etc</filename> Layout</title> <title><filename class="directory">/etc</filename> Layout</title>
<para>There are a number of directories in which configuration <para>There are a number of directories in which configuration
information is kept. These include:</para> information is kept. These include:</para>
@ -1429,42 +1429,42 @@ ifconfig_fxp0_alias7="inet 202.0.75.20 netmask 255.255.255.255"</programlisting>
<tbody> <tbody>
<row> <row>
<entry><filename>/etc</filename></entry> <entry><filename class="directory">/etc</filename></entry>
<entry>Generic system configuration information; data here is <entry>Generic system configuration information; data here is
system-specific.</entry> system-specific.</entry>
</row> </row>
<row> <row>
<entry><filename>/etc/defaults</filename></entry> <entry><filename class="directory">/etc/defaults</filename></entry>
<entry>Default versions of system configuration files.</entry> <entry>Default versions of system configuration files.</entry>
</row> </row>
<row> <row>
<entry><filename>/etc/mail</filename></entry> <entry><filename class="directory">/etc/mail</filename></entry>
<entry>Extra &man.sendmail.8; configuration, other <entry>Extra &man.sendmail.8; configuration, other
MTA configuration files. MTA configuration files.
</entry> </entry>
</row> </row>
<row> <row>
<entry><filename>/etc/ppp</filename></entry> <entry><filename class="directory">/etc/ppp</filename></entry>
<entry>Configuration for both user- and kernel-ppp programs. <entry>Configuration for both user- and kernel-ppp programs.
</entry> </entry>
</row> </row>
<row> <row>
<entry><filename>/etc/namedb</filename></entry> <entry><filename class="directory">/etc/namedb</filename></entry>
<entry>Default location for &man.named.8; data. Normally <entry>Default location for &man.named.8; data. Normally
<filename>named.conf</filename> and zone files are stored <filename>named.conf</filename> and zone files are stored
here.</entry> here.</entry>
</row> </row>
<row> <row>
<entry><filename>/usr/local/etc</filename></entry> <entry><filename class="directory">/usr/local/etc</filename></entry>
<entry>Configuration files for installed applications. <entry>Configuration files for installed applications.
May contain per-application subdirectories.</entry> May contain per-application subdirectories.</entry>
</row> </row>
<row> <row>
<entry><filename>/usr/local/etc/rc.d</filename></entry> <entry><filename class="directory">/usr/local/etc/rc.d</filename></entry>
<entry>Start/stop scripts for installed applications.</entry> <entry>Start/stop scripts for installed applications.</entry>
</row> </row>
<row> <row>
<entry><filename>/var/db</filename></entry> <entry><filename class="directory">/var/db</filename></entry>
<entry>Automatically generated system-specific database files, <entry>Automatically generated system-specific database files,
such as the package database, the locate database, and so such as the package database, the locate database, and so
on</entry> on</entry>