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

Add missing closing tags and move some misplaced ones. Fix some

Browse source 
rendering issues.
This commit is contained in:
Marc Fonvieille 2008-02-24 19:27:21 +00:00
parent 60d667576f
commit 5005ae384e
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=31531
1 changed files with 30 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

69
en_US.ISO8859-1/articles/hubs/article.sgml
View file

@ -174,7 +174,7 @@
<para> <para>
There is a lot of software available which There is a lot of software available which
can be set up to allow anonymous FTP can be set up to allow anonymous FTP
(in alphabetical order). (in alphabetical order).</para>
<itemizedlist> <itemizedlist>
<listitem><para><command>/usr/libexec/ftpd</command>: FreeBSD's own ftpd <listitem><para><command>/usr/libexec/ftpd</command>: FreeBSD's own ftpd
can be used. Be sure to read &man.ftpd.8;.</para> can be used. Be sure to read &man.ftpd.8;.</para>
@ -205,7 +205,7 @@
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
FreeBSD's <application>ftpd</application>, <application>proftpd</application>, <para>FreeBSD's <application>ftpd</application>, <application>proftpd</application>,
<application>wu-ftpd</application> and maybe <application>ncftpd</application> <application>wu-ftpd</application> and maybe <application>ncftpd</application>
are among the most commonly used FTPds. are among the most commonly used FTPds.
The others do not have a large userbase among mirror sites. One The others do not have a large userbase among mirror sites. One
@ -232,11 +232,10 @@
(this is the preferred method for public rsync servers). (this is the preferred method for public rsync servers).
Authentication, connection limits, and other restrictions Authentication, connection limits, and other restrictions
may be applied. There is just one software package may be applied. There is just one software package
available: available:</para>
<itemizedlist> <itemizedlist>
<listitem><para><filename role="package">net/rsync</filename></para></listitem> <listitem><para><filename role="package">net/rsync</filename></para></listitem>
</itemizedlist> </itemizedlist>
</para>
</sect3> </sect3>
<sect3 id="mirror-serv-http"> <sect3 id="mirror-serv-http">
<title>HTTP (required for web pages, optional for FTP fileset)</title> <title>HTTP (required for web pages, optional for FTP fileset)</title>
@ -245,7 +244,7 @@
to install a web server. to install a web server.
You may optionally offer the FTP fileset via HTTP. You may optionally offer the FTP fileset via HTTP.
The choice of web server software is left up to the mirror administrator. The choice of web server software is left up to the mirror administrator.
Some of the most popular choices are: Some of the most popular choices are:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -279,7 +278,6 @@
are found in <application>thttpd</application>.</para> are found in <application>thttpd</application>.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para>
</sect3> </sect3>
<sect3 id="mirror-serv-cvsup"> <sect3 id="mirror-serv-cvsup">
<title>CVSup (desired for CVS repository)</title> <title>CVSup (desired for CVS repository)</title>
@ -299,7 +297,7 @@
stripped down version of M3 that is sufficient to stripped down version of M3 that is sufficient to
run <application>CVSup</application>, and can be installed much easier. run <application>CVSup</application>, and can be installed much easier.
See <ulink url="http://www.polstra.com/projects/freeware/ezm3/">Ezm3</ulink> See <ulink url="http://www.polstra.com/projects/freeware/ezm3/">Ezm3</ulink>
for details. Related ports are: for details. Related ports are:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -314,7 +312,7 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
There are a few more like <para>There are a few more like
<filename role="package">net/cvsup-without-gui</filename> you might want to have <filename role="package">net/cvsup-without-gui</filename> you might want to have
a look at. If you prefer a static binary package, take a look a look at. If you prefer a static binary package, take a look
<ulink url="http://people.FreeBSD.org/~jdp/s1g/">here</ulink>. <ulink url="http://people.FreeBSD.org/~jdp/s1g/">here</ulink>.
@ -359,11 +357,11 @@
software, since &man.cvs.1; comes with software, since &man.cvs.1; comes with
FreeBSD. You need to enable access via <command>inetd</command>, FreeBSD. You need to enable access via <command>inetd</command>,
so add an entry into your <filename>/etc/inetd.conf</filename> so add an entry into your <filename>/etc/inetd.conf</filename>
like this: like this:</para>
<programlisting> <programlisting>
cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --allow-root=/home/ncvs pserver cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --allow-root=/home/ncvs pserver
</programlisting> </programlisting>
See the manpage for details of the options. Also see the CVS <emphasis>info</emphasis> <para>See the manpage for details of the options. Also see the CVS <emphasis>info</emphasis>
page about additional ways to make sure access is read-only. page about additional ways to make sure access is read-only.
It is advised that you create an unprivileged account, It is advised that you create an unprivileged account,
preferably called <username>anoncvs</username>. preferably called <username>anoncvs</username>.
@ -377,11 +375,11 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
not used after the operation but slows things not used after the operation but slows things
dramatically if real disk operations are required. dramatically if real disk operations are required.
Here is an excerpt from <filename>/etc/fstab</filename>, Here is an excerpt from <filename>/etc/fstab</filename>,
how to set up such a MFS: how to set up such a MFS:</para>
<programlisting> <programlisting>
/dev/da0s1b /anoncvstmp mfs rw,-s=786432,-b=4096,-f=512,-i=560,-c=3,-m=0,nosuid 0 0 /dev/da0s1b /anoncvstmp mfs rw,-s=786432,-b=4096,-f=512,-i=560,-c=3,-m=0,nosuid 0 0
</programlisting> </programlisting>
This is (of course) tuned a lot, and was suggested by &a.jdp;. <para>This is (of course) tuned a lot, and was suggested by &a.jdp;.
</para> </para>
</sect3> </sect3>
</sect2> </sect2>
@ -413,7 +411,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
<title>With FTP mirror</title> <title>With FTP mirror</title>
<para> <para>
You can use a <application>FTP mirror</application> You can use a <application>FTP mirror</application>
program to get the files. Some of the most commonly used are: program to get the files. Some of the most commonly used are:</para>
<itemizedlist> <itemizedlist>
<listitem><para><filename role="package">ftp/mirror</filename></para></listitem> <listitem><para><filename role="package">ftp/mirror</filename></para></listitem>
<listitem><para><filename role="package">ftp/ftpmirror</filename></para></listitem> <listitem><para><filename role="package">ftp/ftpmirror</filename></para></listitem>
@ -423,7 +421,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
<listitem><para><filename role="package">ftp/wget</filename></para></listitem> <listitem><para><filename role="package">ftp/wget</filename></para></listitem>
</itemizedlist> </itemizedlist>
<filename role="package">ftp/mirror</filename> was very popular, but seemed <para><filename role="package">ftp/mirror</filename> was very popular, but seemed
to have some drawbacks, as it is written in &man.perl.1;, to have some drawbacks, as it is written in &man.perl.1;,
and had real problems with mirroring large and had real problems with mirroring large
directories like a FreeBSD site. There are rumors that directories like a FreeBSD site. There are rumors that
@ -449,7 +447,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
Since <application>rsync</application> access is not Since <application>rsync</application> access is not
required, your preferred upstream site may not allow it. required, your preferred upstream site may not allow it.
You may need to hunt around a little bit to find a site You may need to hunt around a little bit to find a site
that allows <application>rsync</application> access. that allows <application>rsync</application> access.</para>
<note> <note>
<para> <para>
Since the number of <application>rsync</application> Since the number of <application>rsync</application>
@ -460,10 +458,10 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
an exception for your host (since you are a mirror). an exception for your host (since you are a mirror).
</para> </para>
</note> </note>
A command line to mirror FreeBSD might look like: <para>A command line to mirror FreeBSD might look like:</para>
<screen>&prompt.user; <userinput>rsync -vaz --delete ftp4.de.FreeBSD.org::FreeBSD/ /pub/FreeBSD/</userinput> <screen>&prompt.user; <userinput>rsync -vaz --delete ftp4.de.FreeBSD.org::FreeBSD/ /pub/FreeBSD/</userinput>
</screen> </screen>
Consult the documentation for <application>rsync</application>, <para>Consult the documentation for <application>rsync</application>,
which is also available at which is also available at
<ulink url="http://rsync.samba.org/">http://rsync.samba.org/</ulink>, <ulink url="http://rsync.samba.org/">http://rsync.samba.org/</ulink>,
about the various options to be used with rsync. about the various options to be used with rsync.
@ -484,7 +482,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
client, preferably from the port <filename role="package">net/cvsup</filename>. client, preferably from the port <filename role="package">net/cvsup</filename>.
(Also reread <xref linkend="mirror-serv-cvsup">.) (Also reread <xref linkend="mirror-serv-cvsup">.)
A sample <filename>supfile</filename> suitable for <hostid role="fqdn">ftp-master.FreeBSD.org</hostid> A sample <filename>supfile</filename> suitable for <hostid role="fqdn">ftp-master.FreeBSD.org</hostid>
looks like this: looks like this:</para>
<programlisting> <programlisting>
# #
# FreeBSD archive supfile from master server # FreeBSD archive supfile from master server
@ -502,9 +500,9 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
FreeBSD-archive release=all preserve FreeBSD-archive release=all preserve
</programlisting> </programlisting>
It seems <application>CVSup</application> would be the best <para>It seems <application>CVSup</application> would be the best
way to mirror the archive in terms of efficiency, but way to mirror the archive in terms of efficiency, but
it is only available from few sites. it is only available from few sites.</para>
<note id="mirror-cvsup-s-option"> <note id="mirror-cvsup-s-option">
<para> <para>
Please have look at the <application>CVSup</application> documentation Please have look at the <application>CVSup</application> documentation
@ -512,7 +510,6 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
option. This reduces I/O operations by assuming the option. This reduces I/O operations by assuming the
recorded information about each file is correct.</para> recorded information about each file is correct.</para>
</note> </note>
</para>
</sect3> </sect3>
</sect2> </sect2>
<sect2 id="mirror-cvs"> <sect2 id="mirror-cvs">
@ -547,7 +544,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
anyway. Since most sites offer the CVS repository as anyway. Since most sites offer the CVS repository as
part of the FTP fileset under the path part of the FTP fileset under the path
<filename>/pub/FreeBSD/development/FreeBSD-CVS</filename>, <filename>/pub/FreeBSD/development/FreeBSD-CVS</filename>,
the following methods could be used. the following methods could be used.</para>
<itemizedlist> <itemizedlist>
<listitem><para><application>FTP</application></para></listitem> <listitem><para><application>FTP</application></para></listitem>
<listitem><para><application>Rsync</application></para></listitem> <listitem><para><application>Rsync</application></para></listitem>
@ -559,7 +556,6 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
since CVS does not allow you to access the repository since CVS does not allow you to access the repository
itself, only checked out versions of the modules.</para> itself, only checked out versions of the modules.</para>
</important> </important>
</para>
</sect3> </sect3>
</sect2> </sect2>
<sect2 id="mirror-www"> <sect2 id="mirror-www">
@ -567,9 +563,9 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
<para> <para>
The best way is to check out the <emphasis>www</emphasis> The best way is to check out the <emphasis>www</emphasis>
distribution from CVS. If you have a local mirror of the distribution from CVS. If you have a local mirror of the
CVS repository, it is as easy as: CVS repository, it is as easy as:</para>
<screen>&prompt.user; <userinput>cvs -d /home/ncvs co www</userinput></screen> <screen>&prompt.user; <userinput>cvs -d /home/ncvs co www</userinput></screen>
and a <emphasis>cronjob</emphasis>, that calls <command>cvs up -d -P</command> <para>and a <emphasis>cronjob</emphasis>, that calls <command>cvs up -d -P</command>
on a regular basis, maybe just after your repository was updated. on a regular basis, maybe just after your repository was updated.
Of course, the files need to remain in a directory available Of course, the files need to remain in a directory available
for public WWW access. The installation and configuration of a for public WWW access. The installation and configuration of a
@ -581,7 +577,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
<application>CVSup</application> to maintain an <quote>up to date copy</quote> <application>CVSup</application> to maintain an <quote>up to date copy</quote>
of the www pages. A sample supfile can be found in of the www pages. A sample supfile can be found in
<filename>/usr/share/examples/cvsup/www-supfile</filename> and <filename>/usr/share/examples/cvsup/www-supfile</filename> and
could look like this: could look like this:</para>
<programlisting> <programlisting>
# #
# WWW module supfile for FreeBSD # WWW module supfile for FreeBSD
@ -598,7 +594,6 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
# This collection retrieves the www/ tree of the FreeBSD repository # This collection retrieves the www/ tree of the FreeBSD repository
www www
</programlisting> </programlisting>
</para>
<para> <para>
Using <filename role="package">ftp/wget</filename> or other web-mirror tools is Using <filename role="package">ftp/wget</filename> or other web-mirror tools is
not recommended. not recommended.
@ -614,7 +609,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
<para> <para>
First of all, you should get the doc sources, First of all, you should get the doc sources,
again preferably via <application>CVSup</application>. again preferably via <application>CVSup</application>.
Here is a corresponding sample supfile: Here is a corresponding sample supfile:</para>
<programlisting> <programlisting>
# #
# FreeBSD documentation supfile # FreeBSD documentation supfile
@ -632,7 +627,6 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
# This includes the handbook, FAQ, and translations thereof. # This includes the handbook, FAQ, and translations thereof.
doc-all doc-all
</programlisting> </programlisting>
</para>
<para> <para>
Then you need to install a couple of ports. Then you need to install a couple of ports.
You are lucky, there is a meta-port: You are lucky, there is a meta-port:
@ -648,7 +642,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
in your doc directory (<filename>/usr/share/doc</filename> in your doc directory (<filename>/usr/share/doc</filename>
by default) and build the documentation. by default) and build the documentation.
Again you need to make it accessible for your web server Again you need to make it accessible for your web server
and make sure the links point to the right location. and make sure the links point to the right location.</para>
<important> <important>
<para> <para>
The building of the documentation, as well as lots The building of the documentation, as well as lots
@ -659,7 +653,6 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
have problems building the documentation. have problems building the documentation.
</para> </para>
</important> </important>
</para>
</sect3> </sect3>
</sect2> </sect2>
<sect2 id="mirror-how-often"> <sect2 id="mirror-how-often">
@ -706,13 +699,12 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
</step> </step>
</procedure> </procedure>
<para> <para>
Here are some recommended schedules: Here are some recommended schedules:</para>
<itemizedlist> <itemizedlist>
<listitem><para>FTP fileset: daily</para></listitem> <listitem><para>FTP fileset: daily</para></listitem>
<listitem><para>CVS repository: hourly</para></listitem> <listitem><para>CVS repository: hourly</para></listitem>
<listitem><para>WWW pages: daily</para></listitem> <listitem><para>WWW pages: daily</para></listitem>
</itemizedlist> </itemizedlist>
</para>
</sect2> </sect2>
</sect1> </sect1>
<sect1 id="mirror-where"> <sect1 id="mirror-where">
@ -902,7 +894,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
<sect1 id="mirror-official"> <sect1 id="mirror-official">
<title>Official Mirrors</title> <title>Official Mirrors</title>
<para> <para>
Official mirrors are mirrors that Official mirrors are mirrors that</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
@ -918,7 +910,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
</listitem> </listitem>
</itemizedlist> </itemizedlist>
So far to distinguish official mirrors. <para>So far to distinguish official mirrors.
Official mirrors are not necessarily <emphasis>Tier-1</emphasis>-mirrors. Official mirrors are not necessarily <emphasis>Tier-1</emphasis>-mirrors.
However you probably will not find a <emphasis>Tier-1</emphasis>-mirror, However you probably will not find a <emphasis>Tier-1</emphasis>-mirror,
that is not also official. that is not also official.
@ -931,7 +923,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
tolerant here. It is more easy to say, tolerant here. It is more easy to say,
what <emphasis>official tier-1 mirrors</emphasis> what <emphasis>official tier-1 mirrors</emphasis>
are required to. All other official mirrors are required to. All other official mirrors
can consider this a big <emphasis>should</emphasis>. can consider this a big <emphasis>should</emphasis>.</para>
<note> <note>
<para> <para>
The following applies mainly to the FTP fileset, The following applies mainly to the FTP fileset,
@ -940,9 +932,8 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
its own. its own.
</para> </para>
</note> </note>
</para>
<para> <para>
Tier-1 mirrors are required to: Tier-1 mirrors are required to:</para>
<itemizedlist> <itemizedlist>
<listitem><para>carry the complete fileset</para></listitem> <listitem><para>carry the complete fileset</para></listitem>
<listitem><para>allow access to other mirror sites</para></listitem> <listitem><para>allow access to other mirror sites</para></listitem>
@ -950,7 +941,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
<application>rsync</application> access</para></listitem> <application>rsync</application> access</para></listitem>
</itemizedlist> </itemizedlist>
Furthermore, admins should be subscribed to the &a.hubs;. <para>Furthermore, admins should be subscribed to the &a.hubs;.
See <ulink url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/eresources.html#ERESOURCES-MAIL">this link</ulink> for details, how to subscribe. See <ulink url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/eresources.html#ERESOURCES-MAIL">this link</ulink> for details, how to subscribe.
</para> </para>
<important> <important>