Whitespace-only fixes. Translators, please ignore.
This commit is contained in:
parent
4cb2106334
commit
5a65e42679
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=42054
1 changed files with 62 additions and 67 deletions
|
@ -39,24 +39,23 @@
|
|||
|
||||
<para>Use a disk with sufficient free space. A full copy of
|
||||
the documentation and web site files takes over 700 MB.
|
||||
Allowing a full gigabyte provides some breathing room.
|
||||
This space will hold the XML tools, the
|
||||
documentation tree, temporary
|
||||
Allowing a full gigabyte provides some breathing room. This
|
||||
space will hold the XML tools, the documentation tree, temporary
|
||||
build space and the installed web pages.</para>
|
||||
|
||||
<note>
|
||||
<para>Make sure the documentation ports are updated to the
|
||||
latest version. See <ulink
|
||||
url="&url.books.handbook;/ports.html#ports-using">the
|
||||
Handbook section on ports</ulink>
|
||||
for more information.</para>
|
||||
latest version. See
|
||||
<ulink url="&url.books.handbook;/ports.html#ports-using">the
|
||||
Handbook section on ports</ulink> for more
|
||||
information.</para>
|
||||
</note>
|
||||
|
||||
<sect2 id="the-website-svn">
|
||||
<title>Using <command>svn</command></title>
|
||||
|
||||
<para><command>svn</command> is needed to check
|
||||
out the documentation and web site files from the
|
||||
<para><command>svn</command> is needed to check out the
|
||||
documentation and web site files from the
|
||||
<literal>doc</literal> Subversion repository.
|
||||
<command>svn</command> can be installed with &man.pkg.add.1;
|
||||
or from the &os; Ports Collection by running:</para>
|
||||
|
@ -64,80 +63,79 @@
|
|||
<screen>&prompt.root; <userinput><command>cd /usr/ports/devel/subversion</command></userinput>
|
||||
&prompt.root; <userinput><command>make</command> <maketarget>install clean</maketarget></userinput></screen>
|
||||
|
||||
<para>To check out the source files for the &os; web site and the rest of the documentation,
|
||||
run:</para>
|
||||
<para>To check out the source files for the &os; web site and
|
||||
the rest of the documentation, run:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput><command>svn checkout <replaceable>https://svn0.us-east.FreeBSD.org</replaceable>/doc/head/ <replaceable>~/doc</replaceable></command></userinput></screen>
|
||||
|
||||
<para><ulink
|
||||
url="https://svn0.us-east.FreeBSD.org/">svn0.us-east.FreeBSD.org</ulink>
|
||||
is a public <literal>SVN</literal> server.
|
||||
Select the closest mirror and verify the mirror server
|
||||
certificate from the list of <ulink
|
||||
url="&url.books.handbook;/svn-mirrors.html">Subversion
|
||||
is a public <literal>SVN</literal> server. Select the closest
|
||||
mirror and verify the mirror server certificate from the list
|
||||
of
|
||||
<ulink url="&url.books.handbook;/svn-mirrors.html">Subversion
|
||||
mirror sites</ulink>.</para>
|
||||
|
||||
<para>After the checkout completes, the current version
|
||||
of the &os; documentation, including the web site files, will be present in <filename
|
||||
class="directory">~/doc</filename>.</para>
|
||||
<para>After the checkout completes, the current version of the
|
||||
&os; documentation, including the web site files, will be
|
||||
present in
|
||||
<filename class="directory">~/doc</filename>.</para>
|
||||
</sect2>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="the-website-build">
|
||||
<title>Build the Web Pages</title>
|
||||
|
||||
<para>Having obtained the documentation and web site
|
||||
source files, the web site can be built. In this example, the
|
||||
build directory is <filename
|
||||
<para>Having obtained the documentation and web site source files,
|
||||
the web site can be built. In this example, the build directory
|
||||
is <filename
|
||||
class="directory"><replaceable>~/doc</replaceable></filename>
|
||||
and all the required files are already in place.</para>
|
||||
|
||||
<para>The web site is built from the <filename
|
||||
class="directory">en_US.ISO8859-1/htdocs</filename>
|
||||
subdirectory of the document tree directory,
|
||||
<filename class="directory">~/doc</filename> in this example.
|
||||
Change to the build directory and start the build by executing <command>make all</command>.</para>
|
||||
<para>The web site is built from the
|
||||
<filename class="directory">en_US.ISO8859-1/htdocs</filename>
|
||||
subdirectory of the document tree directory,
|
||||
<filename class="directory">~/doc</filename> in this example.
|
||||
Change to the build directory and start the build by executing
|
||||
<command>make all</command>.</para>
|
||||
|
||||
<screen>&prompt.user; <userinput><command>cd</command> ~/doc/en_US.ISO8859-1/htdocs</userinput>
|
||||
&prompt.user; <userinput><command>make</command> <maketarget>all</maketarget></userinput></screen>
|
||||
|
||||
<tip>
|
||||
<para>The web site build uses the <filename>INDEX</filename> from the Ports Collection
|
||||
and may fail if that file or <filename class="directory">/usr/ports</filename>
|
||||
is not present. The simplest approach is to install the
|
||||
<ulink
|
||||
url="&url.books.handbook;/ports.html#ports-tree">Ports Collection</ulink>.</para>
|
||||
<para>The web site build uses the <filename>INDEX</filename>
|
||||
from the Ports Collection and may fail if that file or
|
||||
<filename class="directory">/usr/ports</filename> is not
|
||||
present. The simplest approach is to install the <ulink
|
||||
url="&url.books.handbook;/ports.html#ports-tree">Ports
|
||||
Collection</ulink>.</para>
|
||||
</tip>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="the-website-install">
|
||||
<title>Install the Web Pages</title>
|
||||
|
||||
<para>Run <command>make install</command>,
|
||||
setting <makevar>DESTDIR</makevar> to
|
||||
the target directory for the web site files.
|
||||
The files will be installed in <filename
|
||||
class="directory">$DESTDIR/data</filename>,
|
||||
which is expected to be the web server's document
|
||||
root.</para>
|
||||
<para>Run <command>make install</command>, setting
|
||||
<makevar>DESTDIR</makevar> to the target directory for the web
|
||||
site files. The files will be installed in
|
||||
<filename class="directory">$DESTDIR/data</filename>, which is
|
||||
expected to be the web server's document root.</para>
|
||||
|
||||
<para>This installation is run as the
|
||||
<username>root</username> user because the permissions on
|
||||
the web server directory will not allow files to be
|
||||
installed by an unprivileged user. In this example, the web site
|
||||
files were built by user <username>jru</username> in their
|
||||
home directory, <filename
|
||||
class="directory">/usr/home/jru/doc</filename>.</para>
|
||||
<para>This installation is run as the <username>root</username>
|
||||
user because the permissions on the web server directory will
|
||||
not allow files to be installed by an unprivileged user. In
|
||||
this example, the web site files were built by user
|
||||
<username>jru</username> in their home directory, <filename
|
||||
class="directory">/usr/home/jru/doc</filename>.</para>
|
||||
|
||||
<screen>&prompt.root; <userinput><command>cd</command> /home/jru/doc/en_US.ISO8859-1/htdocs</userinput>
|
||||
&prompt.root; <userinput><command>env</command> <makevar>DESTDIR</makevar>=<replaceable>/usr/local/www</replaceable> <command>make</command> <maketarget>install</maketarget></userinput></screen>
|
||||
|
||||
<para>The install process will not delete any old or outdated files
|
||||
that existed previously in the same directory.
|
||||
If a new copy of the site is built and
|
||||
installed every day, this command will
|
||||
find and delete all files that have not been updated in
|
||||
three days.</para>
|
||||
<para>The install process will not delete any old or outdated
|
||||
files that existed previously in the same directory. If a new
|
||||
copy of the site is built and installed every day, this command
|
||||
will find and delete all files that have not been updated in
|
||||
three days.</para>
|
||||
|
||||
<screen>&prompt.root; <userinput><command>find</command> <replaceable>/usr/local/www</replaceable> <option>-ctime</option> 3 <option>-delete</option></userinput></screen>
|
||||
</sect1>
|
||||
|
@ -151,15 +149,14 @@
|
|||
|
||||
<listitem>
|
||||
<para>If set and not empty, only the English documents will
|
||||
be built or installed. All translations will
|
||||
be ignored. E.g.:</para>
|
||||
be built or installed. All translations will be ignored.
|
||||
E.g.:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput><command>make</command> <makevar>ENGLISH_ONLY=YES</makevar> <maketarget>all</maketarget> <maketarget>install</maketarget></userinput></screen>
|
||||
|
||||
<para>To unset the variable
|
||||
and build all pages,
|
||||
including translations, set
|
||||
<makevar>ENGLISH_ONLY</makevar> to an empty value:</para>
|
||||
<para>To unset the variable and build all pages, including
|
||||
translations, set <makevar>ENGLISH_ONLY</makevar> to an
|
||||
empty value:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput><command>make</command> <makevar>ENGLISH_ONLY=""</makevar> <maketarget>all</maketarget> <maketarget>install</maketarget> <maketarget>clean</maketarget></userinput></screen>
|
||||
</listitem>
|
||||
|
@ -172,10 +169,10 @@
|
|||
<para>If set and not empty, only the <acronym>HTML</acronym>
|
||||
pages from the <filename
|
||||
class="directory">en_US.ISO8859-1/htdocs</filename>
|
||||
directory will be built or installed. All other directories within <filename
|
||||
class="directory">en_US.ISO8859-1</filename>
|
||||
(Handbook, FAQ, Tutorials) will be ignored.
|
||||
E.g.:</para>
|
||||
directory will be built or installed. All other
|
||||
directories within
|
||||
<filename class="directory">en_US.ISO8859-1</filename>
|
||||
(Handbook, FAQ, Tutorials) will be ignored. E.g.:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput><command>make</command> <makevar>WEB_ONLY=YES</makevar> <maketarget>all</maketarget> <maketarget>install</maketarget></userinput></screen>
|
||||
</listitem>
|
||||
|
@ -185,9 +182,8 @@
|
|||
<term><makevar>WEB_LANG</makevar></term>
|
||||
|
||||
<listitem>
|
||||
<para>If set, build or install only for
|
||||
the languages specified by this variable inside the
|
||||
<filename
|
||||
<para>If set, build or install only for the languages
|
||||
specified by this variable inside the <filename
|
||||
class="directory"><replaceable>~/doc</replaceable></filename>
|
||||
directory. All other languages except English will be
|
||||
ignored. E.g.:</para>
|
||||
|
@ -198,9 +194,8 @@
|
|||
</variablelist>
|
||||
|
||||
<para><makevar>WEB_ONLY</makevar>, <makevar>WEB_LANG</makevar>,
|
||||
and <makevar>ENGLISH_ONLY</makevar>
|
||||
are &man.make.1; variables and
|
||||
can be set in <filename>/etc/make.conf</filename>,
|
||||
and <makevar>ENGLISH_ONLY</makevar> are &man.make.1; variables
|
||||
and can be set in <filename>/etc/make.conf</filename>,
|
||||
<filename>Makefile.inc</filename>, as environment variables on
|
||||
the command line, or in dot files.</para>
|
||||
</sect1>
|
||||
|
|
Loading…
Reference in a new issue