In Portsnap section, spell Portsnap (the system/application) and

portsnap(8) in a more consistent way.

Discussed with: cperciva
This commit is contained in:
Marc Fonvieille 2005-12-05 17:38:26 +00:00
parent c2d8aacffa
commit 238c88e96e
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=26524

View file

@ -2335,19 +2335,19 @@ doc/zh_*</screen>
</sect1> </sect1>
<sect1 id="portsnap"> <sect1 id="portsnap">
<title>Using portsnap</title> <title>Using Portsnap</title>
<sect2 id="portsnap-intro"> <sect2 id="portsnap-intro">
<title>Introduction</title> <title>Introduction</title>
<para>The <application>portsnap</application> utility is a system for securely <para><application>Portsnap</application> is a system for securely
distributing the &os; ports tree. Approximately once an hour, distributing the &os; ports tree. Approximately once an hour,
a <quote>snapshot</quote> of the ports tree is generated, a <quote>snapshot</quote> of the ports tree is generated,
repackaged, and cryptographically signed. The resulting files repackaged, and cryptographically signed. The resulting files
are then distributed via HTTP.</para> are then distributed via HTTP.</para>
<para>Like <application>CVSup</application>, <para>Like <application>CVSup</application>,
<application>portsnap</application> uses a <application>Portsnap</application> uses a
<emphasis>pull</emphasis> model of updating: The packaged and <emphasis>pull</emphasis> model of updating: The packaged and
signed ports trees are placed on a web server which waits signed ports trees are placed on a web server which waits
passively for clients to request files. Users must either run passively for clients to request files. Users must either run
@ -2355,7 +2355,7 @@ doc/zh_*</screen>
or set up a &man.cron.8; job to download updates or set up a &man.cron.8; job to download updates
automatically on a regular basis.</para> automatically on a regular basis.</para>
<para>For technical reasons, <application>portsnap</application> <para>For technical reasons, <application>Portsnap</application>
does not update the <quote>live</quote> ports tree in does not update the <quote>live</quote> ports tree in
<filename>/usr/ports/</filename> directly; instead, it works <filename>/usr/ports/</filename> directly; instead, it works
via a compressed copy of the ports tree stored in via a compressed copy of the ports tree stored in
@ -2363,7 +2363,7 @@ doc/zh_*</screen>
compressed copy is then used to update the live ports tree.</para> compressed copy is then used to update the live ports tree.</para>
<note> <note>
<para>If <application>portsnap</application> is installed from <para>If <application>Portsnap</application> is installed from
the &os; Ports Collection, then the default location for its the &os; Ports Collection, then the default location for its
compressed snapshot will be <filename>/usr/local/portsnap/</filename> compressed snapshot will be <filename>/usr/local/portsnap/</filename>
instead of <filename>/var/db/portsnap/</filename>.</para> instead of <filename>/var/db/portsnap/</filename>.</para>
@ -2374,7 +2374,7 @@ doc/zh_*</screen>
<title>Installation</title> <title>Installation</title>
<para>On &os; 6.0 and more recent versions, <para>On &os; 6.0 and more recent versions,
<application>portsnap</application> is contained in the &os; <application>Portsnap</application> is contained in the &os;
base system. On older versions of &os;, it can be installed base system. On older versions of &os;, it can be installed
using the <filename role="package">sysutils/portsnap</filename> using the <filename role="package">sysutils/portsnap</filename>
port.</para> port.</para>
@ -2390,7 +2390,7 @@ doc/zh_*</screen>
manual page.</para> manual page.</para>
<note> <note>
<para>If <application>portsnap</application> is installed from <para>If <application>Portsnap</application> is installed from
the &os; Ports Collection, it will use the configuration file the &os; Ports Collection, it will use the configuration file
<filename>/usr/local/etc/portsnap.conf</filename> instead of <filename>/usr/local/etc/portsnap.conf</filename> instead of
<filename>/etc/portsnap.conf</filename>. This configuration <filename>/etc/portsnap.conf</filename>. This configuration
@ -2406,11 +2406,11 @@ doc/zh_*</screen>
<title>Running <application>Portsnap</application> for the First <title>Running <application>Portsnap</application> for the First
Time</title> Time</title>
<para>The first time <application>portsnap</application> is run, <para>The first time &man.portsnap.8; is run,
it will need to download a compressed snapshot of the entire it will need to download a compressed snapshot of the entire
ports tree into <filename>/var/db/portsnap/</filename> (or ports tree into <filename>/var/db/portsnap/</filename> (or
<filename>/usr/local/portsnap/</filename> if <filename>/usr/local/portsnap/</filename> if
<application>portsnap</application> was installed from the <application>Portsnap</application> was installed from the
Ports Collection). This is approximately a 36&nbsp;MB Ports Collection). This is approximately a 36&nbsp;MB
download.</para> download.</para>
@ -2421,7 +2421,7 @@ doc/zh_*</screen>
<filename>/usr/ports/</filename>. This is necessary even if a <filename>/usr/ports/</filename>. This is necessary even if a
ports tree has already been created in that directory (e.g., by ports tree has already been created in that directory (e.g., by
using <application>CVSup</application>), since it establishes a using <application>CVSup</application>), since it establishes a
baseline from which <application>portsnap</application> can baseline from which <command>portsnap</command> can
determine which parts of the ports tree need to be updated determine which parts of the ports tree need to be updated
later.</para> later.</para>
@ -2437,12 +2437,12 @@ doc/zh_*</screen>
<emphasis>fetch</emphasis>ing updates to the compressed <emphasis>fetch</emphasis>ing updates to the compressed
snapshot, and using them to <emphasis>update</emphasis> the snapshot, and using them to <emphasis>update</emphasis> the
live ports tree. These two steps can be specified to live ports tree. These two steps can be specified to
<application>portsnap</application> as a single command:</para> <command>portsnap</command> as a single command:</para>
<screen>&prompt.root; <userinput>portsnap fetch update</userinput></screen> <screen>&prompt.root; <userinput>portsnap fetch update</userinput></screen>
<note> <note>
<para>Some older versions of <application>portsnap</application> <para>Some older versions of <command>portsnap</command>
do not support this syntax; if it fails, try instead the do not support this syntax; if it fails, try instead the
following:</para> following:</para>
@ -2452,10 +2452,10 @@ doc/zh_*</screen>
</sect2> </sect2>
<sect2> <sect2>
<title>Running portsnap from cron</title> <title>Running Portsnap from cron</title>
<para>In order to avoid problems with <quote>flash crowds</quote> <para>In order to avoid problems with <quote>flash crowds</quote>
accessing the <application>portsnap</application> servers, accessing the <application>Portsnap</application> servers,
<command>portsnap fetch</command> will not run from <command>portsnap fetch</command> will not run from
a &man.cron.8; job. Instead, a special a &man.cron.8; job. Instead, a special
<command>portsnap cron</command> command exists, which <command>portsnap cron</command> command exists, which
@ -2469,14 +2469,14 @@ doc/zh_*</screen>
is being built or installed. However, it is safe to update is being built or installed. However, it is safe to update
the ports INDEX files, and this can be done by passing the the ports INDEX files, and this can be done by passing the
<option>-I</option> flag to <option>-I</option> flag to
<application>portsnap</application>. (Obviously, if <command>portsnap</command>. (Obviously, if
<command>portsnap -I update</command> is run from <command>portsnap -I update</command> is run from
<command>cron</command>, then it will be necessary to run <command>cron</command>, then it will be necessary to run
<command>portsnap update</command> without the <option>-I</option> <command>portsnap update</command> without the <option>-I</option>
flag at a later time in order to update the rest of the tree.)</para> flag at a later time in order to update the rest of the tree.)</para>
<para>Adding the following line to <filename>/etc/crontab</filename> <para>Adding the following line to <filename>/etc/crontab</filename>
will cause <application>portsnap</application> to update its will cause <command>portsnap</command> to update its
compressed snapshot and the INDEX files in compressed snapshot and the INDEX files in
<filename>/usr/ports/</filename>, and will send an email if any <filename>/usr/ports/</filename>, and will send an email if any
installed ports are out of date:</para> installed ports are out of date:</para>
@ -2487,11 +2487,11 @@ doc/zh_*</screen>
<para>If the system clock is not set to the local time zone, <para>If the system clock is not set to the local time zone,
please replace <literal>3</literal> with a random please replace <literal>3</literal> with a random
value between 0 and 23, in order to spread the load on the value between 0 and 23, in order to spread the load on the
<application>portsnap</application> servers more evenly.</para> <application>Portsnap</application> servers more evenly.</para>
</note> </note>
<note> <note>
<para>Some older versions of <application>portsnap</application> <para>Some older versions of <command>portsnap</command>
do not support listing multiple commands (e.g., "cron update") do not support listing multiple commands (e.g., <literal>cron update</literal>)
in the same invocation of <command>portsnap</command>. If in the same invocation of <command>portsnap</command>. If
the line above fails, try replacing the line above fails, try replacing
<command>portsnap -I cron update</command> with <command>portsnap -I cron update</command> with