aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/books/fdp-primer/the-website
diff options
context:
space:
mode:
authorGabor Kovesdan <gabor@FreeBSD.org>2013-11-07 15:39:28 +0000
committerGabor Kovesdan <gabor@FreeBSD.org>2013-11-07 15:39:28 +0000
commit24d129e8d1984a0b46a543bc523b63d216813bb0 (patch)
tree7dd0501c857c6f2139f4a71191c93bf19136412a /en_US.ISO8859-1/books/fdp-primer/the-website
parent35f1d6c78be90eb13320d655cd68f94333a0ab26 (diff)
downloaddoc-24d129e8d1984a0b46a543bc523b63d216813bb0.tar.gz
doc-24d129e8d1984a0b46a543bc523b63d216813bb0.zip
- Definitively upgrade to DocBook 5.0
Notes
Notes: svn path=/projects/db5/; revision=43125
Diffstat (limited to 'en_US.ISO8859-1/books/fdp-primer/the-website')
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml68
1 files changed, 31 insertions, 37 deletions
diff --git a/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml
index e95a3ca560..a62fdbd2c0 100644
--- a/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml
@@ -30,57 +30,53 @@
$FreeBSD$
-->
-
-<chapter id="the-website">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="the-website">
<title>The Website</title>
- <sect1 id="the-website-build">
+ <sect1 xml: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
- class="directory"><replaceable>~/doc</replaceable></filename>
+ is <filename>~/doc</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>
+ <filename>en_US.ISO8859-1/htdocs</filename>
subdirectory of the document tree directory,
- <filename class="directory">~/doc</filename> in this example.
+ <filename>~/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>
+ <screen>&prompt.user; <userinput>cd ~/doc/en_US.ISO8859-1/htdocs</userinput>
+&prompt.user; <userinput>make all</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>
+ <filename>/usr/ports</filename> is not
+ present. The simplest approach is to install the <link xlink:href="&url.books.handbook;/ports.html#ports-tree">Ports
+ Collection</link>.</para>
</tip>
</sect1>
- <sect1 id="the-website-install">
+ <sect1 xml: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
+ <varname>DESTDIR</varname> to the target directory for the web
site files. The files will be installed in
- <filename class="directory">$DESTDIR/data</filename>, which is
+ <filename>$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>
+ <para>This installation is run as the <systemitem class="username">root</systemitem>
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>
+ <systemitem class="username">jru</systemitem> in their home directory, <filename>/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>
+ <screen>&prompt.root; <userinput>cd /home/jru/doc/en_US.ISO8859-1/htdocs</userinput>
+&prompt.root; <userinput>env DESTDIR=/usr/local/www make install</userinput></screen>
<para>The install process will not delete any old or outdated
files that existed previously in the same directory. If a new
@@ -88,54 +84,52 @@
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>
+ <screen>&prompt.root; <userinput>find /usr/local/www -ctime 3 -delete</userinput></screen>
</sect1>
- <sect1 id="the-website-env">
+ <sect1 xml:id="the-website-env">
<title>Environment Variables</title>
<variablelist>
<varlistentry>
- <term><makevar>ENGLISH_ONLY</makevar></term>
+ <term><varname>ENGLISH_ONLY</varname></term>
<listitem>
<para>If set and not empty, only the English documents will
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>
+ <screen>&prompt.root; <userinput>make ENGLISH_ONLY=YES all install</userinput></screen>
<para>To unset the variable and build all pages, including
- translations, set <makevar>ENGLISH_ONLY</makevar> to an
+ translations, set <varname>ENGLISH_ONLY</varname> 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>
+ <screen>&prompt.root; <userinput>make ENGLISH_ONLY="" all install clean</userinput></screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><makevar>WEB_ONLY</makevar></term>
+ <term><varname>WEB_ONLY</varname></term>
<listitem>
<para>If set and not empty, only the <acronym>HTML</acronym>
- pages from the <filename
- class="directory">en_US.ISO8859-1/htdocs</filename>
+ pages from the <filename>en_US.ISO8859-1/htdocs</filename>
directory will be built or installed. All other
directories within
- <filename class="directory">en_US.ISO8859-1</filename>
+ <filename>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>
+ <screen>&prompt.root; <userinput>make WEB_ONLY=YES all install</userinput></screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><makevar>WEB_LANG</makevar></term>
+ <term><varname>WEB_LANG</varname></term>
<listitem>
<para>If set, build or install only for the languages
- specified by this variable inside the <filename
- class="directory"><replaceable>~/doc</replaceable></filename>
+ specified by this variable inside the <filename>~/doc</filename>
directory. All other languages except English will be
ignored. E.g.:</para>
@@ -144,8 +138,8 @@
</varlistentry>
</variablelist>
- <para><makevar>WEB_ONLY</makevar>, <makevar>WEB_LANG</makevar>,
- and <makevar>ENGLISH_ONLY</makevar> are &man.make.1; variables
+ <para><varname>WEB_ONLY</varname>, <varname>WEB_LANG</varname>,
+ and <varname>ENGLISH_ONLY</varname> 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>