diff options
| author |   Daniel Robbins <drobbins@gentoo.org> | 2001-03-31 16:30:14 +0000 |
|---|---|---|
| committer | Daniel Robbins <drobbins@gentoo.org> | 2001-03-31 16:30:14 +0000 |
| commit | 04745ba53f4e049d31a84c14587d86eb63a32423 (patch) | |
| tree | 01fc5e4458cf9d03ab777e284de7a321b545ef83 /app-doc | |
| parent | css updates (diff) | |
| download | historical-04745ba53f4e049d31a84c14587d86eb63a32423.tar.gz historical-04745ba53f4e049d31a84c14587d86eb63a32423.tar.bz2 historical-04745ba53f4e049d31a84c14587d86eb63a32423.zip | |
the new guide format becomes the default
Diffstat (limited to 'app-doc')
| -rwxr-xr-x | app-doc/gentoo-web/files/xml/install-old.xml (renamed from app-doc/gentoo-web/files/xml/install-new.xml) | 297 | ||||
| -rwxr-xr-x | app-doc/gentoo-web/files/xml/install.xml | 297 | ||||
| -rw-r--r-- | app-doc/gentoo-web/files/xml/xml-guide.xml | 358 | ||||
| -rwxr-xr-x | app-doc/gentoo-web/files/xsl/guide-new.xsl | 213 | ||||
| -rwxr-xr-x | app-doc/gentoo-web/files/xsl/guide-old.xsl | 81 | ||||
| -rwxr-xr-x | app-doc/gentoo-web/files/xsl/guide.xsl | 177 |
6 files changed, 894 insertions, 529 deletions
diff --git a/app-doc/gentoo-web/files/xml/install-new.xml b/app-doc/gentoo-web/files/xml/install-old.xml index ebeb49a2ff84..5b890fd8d0bc 100755 --- a/app-doc/gentoo-web/files/xml/install-new.xml +++ b/app-doc/gentoo-web/files/xml/install-old.xml @@ -1,8 +1,11 @@ <?xml version='1.0'?> +<!DOCTYPE guide PUBLIC "-//Gentoo//DTD Guide XML V1.0//EN" +"/usr/share/sgml/gentoo/guide/guide.dtd"> + <guide> <title>Gentoo Linux Installation Guide</title> -<author title="Chief Architect"><mail link="drobbins@gentoo.org">Daniel Robbins</mail></author> -<author title="Editor"><mail link="thomasfl@gentoo.org">Thomas Flavel</mail></author> +<author title="Chief Architect" email="drobbins@gentoo.org">Daniel Robbins</author> +<author title="Editor" email="thomasfl@gentoo.org">Thomas Flavel</author> <abstract>This guide shows you how to install Gentoo Linux 1.0_rc4_pre2. Right now, Gentoo Linux installation is geared towards intermediate to advanced developers @@ -14,7 +17,7 @@ Gentoo Linux release candidate.</abstract> <version>1.0</version> <date>18 Feb 2001</date> -<chapter> +<chapter link="chap1"> <title>Getting started</title> <section> @@ -41,7 +44,7 @@ least three partitions: a swap partition, a root partition (to hold the bulk of partition. The boot partition is designed to hold GRUB boot loader information as well as your Linux kernel(s). The boot partition gives us a safe place to store everything related to booting Linux. During normal day-to-day Gentoo -Linux use, your boot partition should remain <e>unmounted</e>. This prevents +Linux use, your boot partition should remain <i>unmounted</i>. This prevents your kernel from being made unavailable to GRUB (due to filesystem corruption) in the event of a system crash, preventing the chicken-and-egg problem where GRUB can't read your kernel (since your filesystem is corrupted) but you can't @@ -62,27 +65,10 @@ filesystems, we support this as well. Support will likely be added for JFS in the near future, as well as XFS - as soon as it's ready. Here are our recommended filesystem sizes and types:</p> - <table> - <tr> - <th>Partition</th> - <th>Size</th> - <th>Type</th> - </tr> - <tr> - <ti>boot partition, containing kernel(s) and boot information</ti> - <ti>~100 Megabytes</ti> - <ti>ReiserFS recommended, ext2 ok</ti> - </tr> - <tr> - <ti>root partition, containing main filesystem (/usr, /home, etc)</ti> - <ti>>=1.5 Gigabytes</ti> - <ti>ReiserFS recommended, ext2 ok</ti> - </tr> - <tr> - <ti>swap partition (no longer a 128 Megabyte limit)</ti> - <ti>>=128 Megabytes</ti> - <ti>Linux swap</ti> - </tr> + <table border="1"><tr><td><b>Partition</b></td><td><b>Size</b></td><td><b>Type</b></td></tr> + <tr><td>boot partition, containing kernel(s) and boot information</td><td>~100 Megabytes</td><td>ReiserFS recommended, ext2 ok</td></tr> + <tr><td>root partition, containing main filesystem (/usr, /home, etc)</td><td>>=1.5 Gigabytes</td><td>ReiserFS recommended, ext2 ok</td></tr> + <tr><td>swap partition (no longer a 128 Megabyte limit)</td><td>>=128 Megabytes</td><td>Linux swap</td></tr> </table> </body> </section> @@ -92,12 +78,12 @@ filesystem sizes and types:</p> <body><p> In this install guide, I'm going to be stepping you through the Gentoo Linux CD-based installation process. To perform the CD install, you'll -need the Gentoo Linux 1.0_rc4_pre2 CD ISO image, available at <uri> -http://www.ibiblio.org/gentoo/gentoo-iso-images/</uri> (~550Mb download.) +need the Gentoo Linux 1.0_rc4_pre2 CD ISO image, available <a +href="http://www.ibiblio.org/gentoo/gentoo-iso-images/">here</a> (~550Mb download.) It's also possible to install Gentoo Linux from an existing Linux installation. If you'd like to do this instead, you'll need to -download the <path>1.0_rc4_pre2 sys.tbz2</path> file, available from <uri> -http://www.ibiblio.org/gentoo/gentoo-x86-distro/gentoo-1.0_rc4_pre2/packages/</uri> (~67Mb download.) +download the 1.0_rc4_pre2 sys.tbz2 file, available from <a +href="http://www.ibiblio.org/gentoo/gentoo-x86-distro/gentoo-1.0_rc4_pre2/packages">here</a> (~67Mb download.) If you choose to install Gentoo Linux from another Linux distribution, you'll need to have the tools to unpack a bzip'd tarball (nearly all distributions do.) However, at this time, most distributions don't have the ability to create and mount ReiserFS @@ -110,7 +96,7 @@ CD image, which has all the tools you need for ReiserFS. </section> </chapter> -<chapter> +<chapter link="chap2"> <title>Installation</title> <section> @@ -121,12 +107,14 @@ Once you've downloaded the ISO image and burned your own Gentoo Linux CD, go ahe and boot your system from the CD. You'll be presented with a GRUB menu that looks like this: </p> -<figure link="install-boot.gif" short="The boot screen" caption="When the CD boots, you'll see this screen"/> +<p> +<img src="install-boot.gif"/> +</p> <p> Go ahead and select the first option to continue the CD boot process. Linux will boot and the Gentoo Linux CD detector will start up and detect and mount a minimal Gentoo Linux system included on the CD. When the boot process is complete, you'll be presented with a login prompt. To -log in, go ahead and type <c>root</c> and hit Enter. You won't be prompted for a password. +log in, go ahead and type "<code>root</code>" and hit Enter. You won't be prompted for a password. </p> </body> </section> @@ -135,18 +123,19 @@ log in, go ahead and type <c>root</c> and hit Enter. You won't be prompted for <title>Step 1: Create and Format Your Partitions</title> <body> <p> -The first step is to create your boot, root (plus optional <path>/home</path>, <path>/usr</path>, <path>/var</path>) -and swap partitions using fdisk (type <c>fdisk /dev/hd?</c> to start it up.) Your +The first step is to create your boot, root (plus optional /home, /usr, /var) +and swap partitions using fdisk (type "<code>fdisk /dev/hd?</code>" to start it up.) Your boot and root partition should be tagged as a "Linux" partitions (type 83) even if you're using ReiserFS. Your swap partition should be tagged as "Linux swap" (type 82). Here's a screenshot of an example partition layout. In this -example, <path>/dev/hda1</path> is the boot partition (256Mb), <path>/dev/hda2</path> is the swap -partition (256Mb), and <path>/dev/hda3</path> is the root partition (1.5Mb). Notice that -<path>/dev/hda1</path> has the bootable flag set (you can set this with the <c>a</c> option.) -Once you've created your partitions, remember to write your changes using the -<c>w</c> option. -</p> -<figure link="install-fdisk.gif" short="Creating partitions" caption="Creating partitions using fdisk"/> +example, /dev/hda1 is the boot partition (256Mb), /dev/hda2 is the swap +partition (256Mb), and /dev/hda3 is the root partition (1.5Mb). Notice that +/dev/hda1 has the bootable flag set (you can set this with the "a" option.) +Once you've created your partitions, remember to write your changes with the +"w" option. +</p><p> +<img src="install-fdisk.gif"/> +</p> </body> </section> @@ -154,42 +143,39 @@ Once you've created your partitions, remember to write your changes using the <title>Step 2: Create and Mount Filesystems</title> <body> <p> -The second step is to create your filesystems. Use the commands <c>mke2fs</c>, <c>mkreiserfs</c> and <c>mkswap</c> for this. For example, to create +The second step is to create your filesystems. Use the commands <code>mke2fs</code>, <code>mkreiserfs</code> and <code>mkswap</code> for this. For example, to create a new ReiserFS filesystem on the partition /dev/hda1, type: </p><pre> -# <i>mkreiserfs /dev/hda1</i></pre> +# mkreiserfs /dev/hda1</pre> <p>For my example partition layout above, I typed in the following commands: </p> -<pre linkid="filesyscode" caption="Creating and mounting filesystems"> -# <i>mkreiserfs /dev/hda1</i> -# <i>mkswap /dev/hda2</i> -# <i>mkreiserfs /dev/hda3</i> +<pre> +# mkreiserfs /dev/hda1 +# mkswap /dev/hda2 +# mkreiserfs /dev/hda3 </pre><p> Now that the filesystems have been created, it's time to get your boot and root (and optionally your /var, /usr and /home partitions) mounted. For my example partition layout, I typed in the following: </p><pre> -# <i>mount /dev/hda3 /mnt/gentoo</i> -# <i>mkdir /mnt/gentoo/boot</i> -# <i>mount /dev/hda1 /mnt/gentoo/boot -o notail</i> -</pre> - -<note title="The notail option">The "notail" option is required if you're -installing GRUB as a secondary boot loader. It also doesn't hurt to include it -if you're not.</note> +# mount /dev/hda3 /mnt/gentoo +# mkdir /mnt/gentoo/boot +# mount /dev/hda1 /mnt/gentoo/boot -o notail +</pre><p>(note: the "notail" option is required if you're installing GRUB as a secondary boot loader. It also doesn't hurt to include it if you're not.) +</p> -<p>Notice that I had to create the <path>/mnt/gentoo/boot</path> filesystem before mounting <path>/dev/hda1</path>. If you've created -additional non-root filesystems (<path>/var</path>, <path>/usr</path>, <path>/home</path>, etc), you'll need to create the appropriate directories under <path>/mnt/gentoo</path> +<p>Notice that I had to create the /mnt/gentoo/boot filesystem before mounting /dev/hda1. If you've created +additional non-root filesystems (/var, /usr, /home, etc), you'll need to create the appropriate directories under /mnt/gentoo and then mount all your filesystems at the correct locations. Once all your filesystems are mounted, we're ready to extract -the <path>sys.tbz2</path> tarball - the file that contains the Gentoo Linux base system. +the sys.tbz2 tarball - the file that contains the Gentoo Linux base system. </p> -<note> -If you're installing Gentoo Linux direct from an existing Linux distribution, make sure that all your filesystems are mounted at the <path>/mnt/gentoo</path> +<p><b>Note for those installing from an existing Linux distro:</b><br/> +If you're installing from an existing Linux distribution, make sure that all your filesystems are mounted at the /mnt/gentoo mountpoint just like I described above. From this point on, you should be able to follow our install instructions word for word. -</note> +</p> </body> </section> @@ -198,16 +184,16 @@ word. <title>Step 3: Extract the sys.tbz2 Tarball</title> <body> <p> -Now, it's time to extract the <path>sys.tbz2</path> tarball to <path>/mnt/gentoo</path>. -You'll find the tarball at <path>/mnt/distcd/packages/sys.tbz2</path>. +Now, it's time to extract the sys.tbz2 tarball to /mnt/gentoo. +You'll find the tarball at /mnt/distcd/packages/sys.tbz2. Extract it by typing:</p> <pre> -# <i>tar xjvf /mnt/distcd/packages/sys.tbz2 -C /mnt/gentoo</i> +# tar xjvf /mnt/distcd/packages/sys.tbz2 -C /mnt/gentoo </pre><p> -If you're installing from another Linux distribution and your version of tar doesn't have the <c>-j</c> (bzip2) option, the following +If you're installing from another Linux distribution and your version of tar doesn't have the -j (bzip2) option, the following pipeline should do the exact same thing: </p><pre> -# <i>cat /path/to/sys.tbz2 | bzip2 -d | tar -xvf - -C /mnt/gentoo</i> +# cat /path/to/sys.tbz2 | bzip2 -d | tar -xvf - -C /mnt/gentoo </pre> </body> </section> @@ -215,49 +201,50 @@ pipeline should do the exact same thing: -<chapter> +<chapter link="chap3"> <title>Configuration</title> <section> <title>Configure the system</title> -<body><note>If you want to compile a custom kernel during the install process, them before proceeding with the -following instructions, copy the linux-sources tbz2 file from <path>/mnt/distcd/packages/All/linux-sources-???.tbz2</path> to <path>/mnt/gentoo/tmp</path>. -Then, proceed with these instructions. I'll let you know when it's time to merge it.</note> +<body><p><font color="#FF0000">Note: If you want to compile a custom kernel during the install process, them before proceeding with the +following instructions, copy the linux-sources tbz2 file from /mnt/distcd/packages/All/linux-sources-???.tbz2 to /mnt/gentoo/tmp. +Then, proceed with these instructions. I'll let you know when it's time to merge it.</font> +</p> <p>Now that the base system tarball has been extracted, we need to get the system ready for booting. Begin this process by typing: </p><pre> -# <i>chroot /mnt/gentoo</i> -</pre><p>The chroot command will start a new shell with the root filesystem set to <path>/mnt/gentoo</path>. +# chroot /mnt/gentoo +</pre><p>The chroot command will start a new shell with the root filesystem set to /mnt/gentoo. If you have a non-US keyboard, you've probably noticed that some keys aren't in the right place. This can be fixed by typing: </p><pre> -# <i>loadkeys [keymap]</i> +# loadkeys [keymap] </pre><p> Here are some popular non-English keymaps:</p> -<table><th>Language</th><th>Keymap</th> -<tr><ti>German</ti><ti>de-latin1-nodeadkeys</ti></tr> -<tr><ti>French</ti><ti>fr_latin1</ti></tr> +<table><tr><td><b>Language</b></td><td><b>Keymap</b></td></tr> +<tr><td>German</td><td>de-latin1-nodeadkeys</td></tr> +<tr><td>French</td><td>fr_latin1</td></tr> </table> <p> -Please <mail link="drobbins@gentoo.org">email me</mail> the keymaps that you use for your +Please <a href="mailto:drobbins@gentoo.org">email me</a> the keymaps that you use for your preferred language so that I can add them to this document. Now, type the following commands: </p><pre> -# <i>env-update</i> -# <i>/etc/rc.d/init.d/initscripts-install</i> -</pre><p>The first command, env-update, is a special Gentoo Linux command that auto-generates the <path>/etc/ld.so.conf</path> file and configures +# env-update +# /etc/rc.d/init.d/initscripts-install +</pre><p>The first command, env-update, is a special Gentoo Linux command that auto-generates the /etc/ld.so.conf file and configures the default shell environment variable and path settings. The second script will configure Gentoo Linux initialization scripts, -so that all the proper symlinks are in place in <path>/etc/rc.d</path> so that the system will boot. +so that all the proper symlinks are in place in /etc/rc.d so that the system will boot. </p> <p>There are just a few files that need to be configured before we're ready to install the Gentoo Linux boot loader (GRUB) and -start Gentoo Linux. Right now, the only editor included with the base system is <c>vi</c>. In the next release, we're also going -to include another text editor that's easier to use for those who don't know <c>vi</c>. If you don't know how to use vi, here are -some quick instructions. To edit a file, type <c>vi filename</c>. Immediately after <c>vi</c> loads the file, press the <c>i</c> key to enter +start Gentoo Linux. Right now, the only editor included with the base system is "vi". In the next release, we're also going +to include another text editor that's easier to use for those who don't know vi. If you don't know how to use vi, here are +some quick instructions. To edit a file, type "<code>vi filename</code>". Immediately after vi loads the file, press the "i" key to enter INSERT mode. In this mode, you'll be able to move around in the file by using the arrow keys, and you'll be able to insert text just by typing it and delete text with the backspace or delete key. If you need to delete an entire line, press escape -to leave INSERT mode (you're now in command mode), and hit <c>dd</c>. Then, hit <c>i</c> again to go back to INSERT mode. When you need -to save your changes, hit escape to leave INSERT mode and type <c>:x</c>. If you want to throw away your changes, type <c>:q!</c>. -Vim, the version of vi that's included with Gentoo Linux, also includes extensive help. You can type <c>:help</c> (in command mode) +to leave INSERT mode (you're now in command mode), and hit "dd". Then, hit "i" again to go back to insert mode. When you need +to save your changes, hit escape to leave INSERT mode and type "<code>:x</code>". If you want to throw away your changes, type "<code>:q!</code>". +Vim, the version of vi that's included with Gentoo Linux, also includes extensive help. You can type "<code>:help</code>" (in command mode) to access it.</p> </body> </section> @@ -278,9 +265,9 @@ first three configuration lines for my example system configuration: <section> <title>/etc/localtime</title> <body> -<p>Look for your timezone (or GMT if you using Greenwich Mean Time) in <path>/usr/share/zoneinfo</path>. Then, make a symbolic link by typing: +<p>Look for your timezone (or GMT if you using Greenwich Mean Time) in /usr/share/zoneinfo. Then, make a symbolic link by typing: </p><pre> -# <i>cd /etc; ln -sf /usr/share/zoneinfo/path/to/timezonefile localtime</i> +# cd /etc; ln -sf /usr/share/zoneinfo/path/to/timezonefile localtime </pre> </body> </section> @@ -288,7 +275,7 @@ first three configuration lines for my example system configuration: <section> <title>/etc/hostname</title> <body> -<p>Edit this file so that it contains your fully-qualified domain name on a single line, i.e. <c>mymachine.mydomain.com</c>. +<p>Edit this file so that it contains your fully-qualified domain name on a single line, i.e. "mymachine.mydomain.com" (without the quotes). </p> </body> </section> @@ -311,9 +298,9 @@ nameserver 10.0.0.2 <p>This file contains a list of ip addresses and their associated hostnames. It's used by the system to resolve the IP addresses of any hostnames that may not be in your nameservers. Here's a template for this file: </p><pre> -127.0.0.1 localhost -<comment># the next line contains your IP for your local LAN, and your associated machine name</comment> -192.168.1.1 mymachine.mydomain.com mymachine +127.0.0.1 localhost +# the next line contains your IP for your local LAN, and your associated machine name +192.168.1.1 mymachine.mydomain.com mymachine </pre> </body> </section> @@ -321,36 +308,23 @@ of any hostnames that may not be in your nameservers. Here's a template for thi <section> <title>Configure ethernet</title> <body> - -<p>Look in the <path>/etc/rc.d/config</path> directory; you'll see a file -called OFF_inet.eth0. Copy this file to inet.eth0, and edit the top part of it -so that it contains the IP address settings you want to use on your first -ethernet card. Look in <path>/lib/modules</path> for the ethernet module -specific to your particular ethernet card, and append it to the -<path>/etc/rc.d/config/modules</path> file (you can also add any options you -need to the same line.) Then, when Gentoo Linux boots, this module will be -automatically loaded from disk. If you have multiple network cards, copy -<path>inet.eth0</path> to <path>inet.eth1</path> and edit this file so that it -configures your second interface correctly. Repeat for eth2, etc as necessary. -If you have a static ppp link, you can copy the <path>inet.eth0</path> file to -<path>inet.ppp0</path>, and insert the appropriate commands in the -<c>netup()</c> and <c>netdown()</c> functions. All -<path>/etc/rc.d/config/inet.*</path> files will be started automatically at -boot time by the <path>/etc/rc.d/init.d/inet</path> rc script. </p> - +<p>Look in the /etc/rc.d/config directory; you'll see a file called OFF_inet.eth0. Copy this file to inet.eth0, and edit +the top part of it so that it contains the IP address settings you want to use on your first ethernet card. Look in /lib/modules for the ethernet module specific to your particular ethernet card, +and append it to the /etc/rc.d/config/modules file (you can also add any options you need to the same line.) Then, when Gentoo Linux boots, this module will be automatically loaded from disk. If you have multiple network cards, +copy inet.eth0 to inet.eth1 and edit this file so that it configures your second interface correctly. Repeat for eth2, etc as necessary. If you have a static ppp link, you can copy the inet.eth0 file to inet.ppp0, and insert the appropriate commands in the +netup() and netdown() functions. All /etc/rc.d/config/inet.* files will be started automatically at boot time by the /etc/rc.d/init.d/inet rc script. +</p> </body> </section> <section> <title>Configure basic settings</title> <body> - -<p>Take a look at the <path>/etc/rc.d/config/basic</path>, and make sure that it's set up properly. Important settings are GMT -(set to <c>yes</c> if your system clock is set to GMT, otherwise <c>no</c> if it's set to your local time) and KEYMAP (look in -<path>/usr/share/keymaps/i386</path> for available keymaps. To specify the keymap, set KEYMAP to the <e>prefix</e> -of the keymap filename (i.e. drop the <path>.kmap.gz</path> extension from the end.) +<p>Take a look at the /etc/rc.d/config/basic, and make sure that it's set up properly. Important settings are GMT +(set to "yes" if your system clock is set to GMT, otherwise "no" if it's set to your local time) and KEYMAP (look in +/usr/share/keymaps/i386/qwerty,dvorak,etc. for available keymaps. To specify the keymap, set KEYMAP to the *prefix* +of the keymap filename (i.e. drop the ".kmap.gz" extension from the end.) </p> - </body> </section> @@ -359,105 +333,94 @@ of the keymap filename (i.e. drop the <path>.kmap.gz</path> extension from the e <body> <p> The most critical part of understanding GRUB is getting comfortable with how GRUB refers to hard drives and partitions. -Your Linux partition <path>/dev/hda1</path> is called <path>(hd0,0)</path> under GRUB. Notice the parenthesis around the hd0,0 - they are required. -Hard drives count from zero rather than "a", and partitions start at zero rather than one. So, <path>/dev/hdb3</path> gets translated to <path>(hd1,2)</path>, and <path>/dev/hdd7</path> gets translated to <path>(hd3,6)</path>. After you've gotten the feel for that, convert your boot and root partition names to the GRUB format and write them down. Now, it's time to install GRUB. +Your Linux partition /dev/hda1 is called (hd0,0) under GRUB. Notice the parenthesis around the hd0,0 - they are required. +Hard drives count from zero rather than "a", and partitions start at zero rather than one. So, /dev/hdb3 gets translated to (hd1,2), and /dev/hdd7 gets translated to (hd3,6). After you've gotten the feel for that, convert your boot and root partition names to the GRUB format and write them down. Now, it's time to install GRUB. </p> -<p>The easiest way to install grub is to simply type <c>grub</c> at your chrooted shell prompt: +<p>The easiest way to install grub is to simply type "<code>grub</code>" at your chrooted shell prompt: </p><pre> -# <i>grub</i> -</pre><p>You'll be presented with the <c>grub></c> grub command-line prompt. Now, you need to type in the +# grub +</pre><p>You'll be presented with the "grub> " grub command-line prompt. Now, you need to type in the right commands to install the GRUB boot record onto your hard drive. In my example configuration, I want to install the GRUB boot record on my hard drive's MBR (master boot record), so that the first thing I see when I turn on the computer is the GRUB prompt. In my case, the commands -I want to type are:</p> -<pre>grub> <i>root (hd0,0)</i> -grub> <i>setup (hd0)</i> +I want to type are:</p><pre>grub> root (hd0,0) +grub> setup (hd0) </pre> -<p>Here's how the two commands work. The first <c>root ( )</c> command tells GRUB -the location of your boot partition (in my case, <path>/dev/hda1</path> or -<path>(hd0,0)</path> in GRUB terminology. Then, the second <c>setup ( )</c> command tells GRUB where to install the -boot record - it will be configure to look for its special files at the <c>root -( )</c> location that you specified. In my case, I want the boot record on the -MBR of the hard drive, so I simply specify <path>/dev/hda</path> (also known as <path>(hd0)</path>). If I were using +<p>Here's how the two commands work. The first "root ( )" command tells GRUB +the location of your boot partition (in my case, hda1 or in GRUB terminology +(hd0,0)). Then, the second "setup ( )" command tells GRUB where to install the +boot record - it will be configure to look for its special files at the "root +( )" location that you specified. In my case, I want the boot record on the +MBR of the hard drive, so I simply specify hda ((hd0)). If I were using another boot loader and wanted to set up GRUB as a secondary boot-loader, I could install GRUB to the boot record of a particular partition. In that case, I'd specify a particular partition rather than the entire disk. Once the GRUB boot record has been -successfully installed, you can type <c>quit</c> to quit GRUB. Gentoo Linux is -installed, but we need to create the <path>/boot/boot/grub/menu.lst</path> file so that +successfully installed, you can type "quit" to quit GRUB. Gentoo Linux is +installed, but we need to create the /boot/boot/grub/menu.lst file so that we get a nice GRUB boot menu when the system reboots. Here's how to do it.</p> -<p>Now, create the menu.lst file (<c>vi /boot/boot/grub/menu.lst</c>), and add the following to it:</p> +<p>Now, create the menu.lst file ("<code>vi /boot/boot/grub/menu.lst</code>"), and add the following to it:</p> <pre> default 0 timeout 30 title=My example Gentoo Linux -root (hd0,0) -kernel /boot/bzImage root=/dev/hda3 +root (hd0,0) <font color="#FF0000">(note: (hd0,0) should point to your "boot" partition (hda1 in my case)</font> +kernel /boot/bzImage root=/dev/hda3 <font color="#FF0000">(note: /dev/hda3 should point to your "root" filesystem)</font> title=Windows NT Workstation -root (hd0,2) +root (hd0,2) <font color="#FF0000">(note: (hd0,2) contains the NT boot loader)</font> </pre><p>After saving this file, Gentoo Linux installation is complete. Selecting the first option will tell GRUB to boot Gentoo Linux without a fuss. The second part of the menu.lst file is optional, and shows you how to use GRUB to boot a bootable Windows partition.</p> -<note>Above, <path>(hd0,0)</path> should point to your "boot" partition -(<path>/dev/hda1</path> in my case) and <path>/dev/hda3</path> should point to -your "root filesystem. <path>(hd0,2)</path> contains the NT boot -loader.</note> <p>Also, if you need to pass any options to the kernel, simply -add them to the end of the <c>kernel</c> command. We're already passing one option -(<c>root=/dev/hda3</c>), but you can pass others as well. There's one in particular -that you may be interested in. If you want to enable devfs (a special device -filesystem), you can add the <c>devfs=mount</c> option at the end of the <c>kernel</c> -line. </p> - +<p>Also, if you need to pass any options to the kernel, simply add them to the end of the "kernel" command. We're already +passing one option "root=/dev/hda3", but you can pass others as well. There's one in particular that you may be interested +in. If you want to enable devfs (a special device filesystem), you can add the "devfs=mount" option at the end of the kernel +line. +</p> </body> </section> <section> <title>One Last Step</title> <body> -<p>If you copied over the <path>linux-sources-???.tbz2</path> file, you can now install the package and compile a fresh new -kernel. To merge the linux-sources, type <c>pkgmerge /tmp/linux-sources-???.tbz2</c>. After the merge completes, -you can remove the .tbz2 from <path>/tmp</path> and continue with the kernel compile step. If you didn't copy over the +<p>If you copied over the linux-sources-???.tbz2 file, you can now install the package and compile a fresh new +kernel. To merge the linux-sources, type "<code>pkgmerge /tmp/linux-sources-???.tbz2</code>". After the merge completes, +you can remove the .tbz2 from /tmp and continue with the kernel compile step. If you didn't copy over the linux sources, you can skip the kernel compile step and proceed unmounting your filesystems below.</p> <p>To compile your own kernel, perform the following steps:</p><pre> -# <i>cd /usr/src/linux</i> -# <i>make menuconfig</i> -<codenote>make sure you compile-in support for ReiserFS as well as your boot drive controller</codenote> -# <i>make bzImage</i> -# <i>make modules</i> -# <i>make modules_install</i> -# <i>cp arch/i386/boot/bzImage /boot/boot</i> -<codenote>Above, "/boot/boot" is intentional and should not simply be "/boot"</codenote> +# cd /usr/src/linux +# make menuconfig <font color="#FF0000">(Note: make sure you compile-in support for ReiserFS as well as your boot drive controller)</font> +# make bzImage +# make modules +# make modules_install +# cp arch/i386/boot/bzImage /boot/boot <font color="#FF0000">(Note: the "/boot/boot" is intentional and should not simply be "/boot")</font> </pre> <p>Now, Gentoo Linux is installed. The only remaining step is to exit the chrooted shell, safely unmount your partitions and reboot the system:</p> <pre> -# <i>exit</i> -<codenote>This exits the chrooted shell; you can also type <c>^D</c></codenote> -# <i>umount /mnt/gentoo/boot</i> -# <i>umount /mnt/gentoo</i> -# <i>reboot</i> +# exit <font color="#FF0000">(note: this exits the chrooted shell; you can also type <code>^D)</code></font> +# umount /mnt/gentoo/boot +# umount /mnt/gentoo +# reboot </pre> </body> </section> </chapter> -<chapter> -<title>You're done!</title> +<chapter link="chap4"> +<title></title> <section> <title>Congratulations!</title> <body><p>If you have any questions or would like to get involved with Gentoo Linux development, -consider joining our gentoo-dev mailing list (there's a "click to subscribe" link on our <uri link="http://www.gentoo.org">main page</uri>). +consider joining our gentoo-dev mailing list (there's a "click to subscribe" link on our <a href="http://www.gentoo.org">main page</a>). </p> -<warn>This is a warning.</warn> -<impo>This is important.</impo> </body> </section> </chapter> diff --git a/app-doc/gentoo-web/files/xml/install.xml b/app-doc/gentoo-web/files/xml/install.xml index 5b890fd8d0bc..ebeb49a2ff84 100755 --- a/app-doc/gentoo-web/files/xml/install.xml +++ b/app-doc/gentoo-web/files/xml/install.xml @@ -1,11 +1,8 @@ <?xml version='1.0'?> -<!DOCTYPE guide PUBLIC "-//Gentoo//DTD Guide XML V1.0//EN" -"/usr/share/sgml/gentoo/guide/guide.dtd"> - <guide> <title>Gentoo Linux Installation Guide</title> -<author title="Chief Architect" email="drobbins@gentoo.org">Daniel Robbins</author> -<author title="Editor" email="thomasfl@gentoo.org">Thomas Flavel</author> +<author title="Chief Architect"><mail link="drobbins@gentoo.org">Daniel Robbins</mail></author> +<author title="Editor"><mail link="thomasfl@gentoo.org">Thomas Flavel</mail></author> <abstract>This guide shows you how to install Gentoo Linux 1.0_rc4_pre2. Right now, Gentoo Linux installation is geared towards intermediate to advanced developers @@ -17,7 +14,7 @@ Gentoo Linux release candidate.</abstract> <version>1.0</version> <date>18 Feb 2001</date> -<chapter link="chap1"> +<chapter> <title>Getting started</title> <section> @@ -44,7 +41,7 @@ least three partitions: a swap partition, a root partition (to hold the bulk of partition. The boot partition is designed to hold GRUB boot loader information as well as your Linux kernel(s). The boot partition gives us a safe place to store everything related to booting Linux. During normal day-to-day Gentoo -Linux use, your boot partition should remain <i>unmounted</i>. This prevents +Linux use, your boot partition should remain <e>unmounted</e>. This prevents your kernel from being made unavailable to GRUB (due to filesystem corruption) in the event of a system crash, preventing the chicken-and-egg problem where GRUB can't read your kernel (since your filesystem is corrupted) but you can't @@ -65,10 +62,27 @@ filesystems, we support this as well. Support will likely be added for JFS in the near future, as well as XFS - as soon as it's ready. Here are our recommended filesystem sizes and types:</p> - <table border="1"><tr><td><b>Partition</b></td><td><b>Size</b></td><td><b>Type</b></td></tr> - <tr><td>boot partition, containing kernel(s) and boot information</td><td>~100 Megabytes</td><td>ReiserFS recommended, ext2 ok</td></tr> - <tr><td>root partition, containing main filesystem (/usr, /home, etc)</td><td>>=1.5 Gigabytes</td><td>ReiserFS recommended, ext2 ok</td></tr> - <tr><td>swap partition (no longer a 128 Megabyte limit)</td><td>>=128 Megabytes</td><td>Linux swap</td></tr> + <table> + <tr> + <th>Partition</th> + <th>Size</th> + <th>Type</th> + </tr> + <tr> + <ti>boot partition, containing kernel(s) and boot information</ti> + <ti>~100 Megabytes</ti> + <ti>ReiserFS recommended, ext2 ok</ti> + </tr> + <tr> + <ti>root partition, containing main filesystem (/usr, /home, etc)</ti> + <ti>>=1.5 Gigabytes</ti> + <ti>ReiserFS recommended, ext2 ok</ti> + </tr> + <tr> + <ti>swap partition (no longer a 128 Megabyte limit)</ti> + <ti>>=128 Megabytes</ti> + <ti>Linux swap</ti> + </tr> </table> </body> </section> @@ -78,12 +92,12 @@ filesystem sizes and types:</p> <body><p> In this install guide, I'm going to be stepping you through the Gentoo Linux CD-based installation process. To perform the CD install, you'll -need the Gentoo Linux 1.0_rc4_pre2 CD ISO image, available <a -href="http://www.ibiblio.org/gentoo/gentoo-iso-images/">here</a> (~550Mb download.) +need the Gentoo Linux 1.0_rc4_pre2 CD ISO image, available at <uri> +http://www.ibiblio.org/gentoo/gentoo-iso-images/</uri> (~550Mb download.) It's also possible to install Gentoo Linux from an existing Linux installation. If you'd like to do this instead, you'll need to -download the 1.0_rc4_pre2 sys.tbz2 file, available from <a -href="http://www.ibiblio.org/gentoo/gentoo-x86-distro/gentoo-1.0_rc4_pre2/packages">here</a> (~67Mb download.) +download the <path>1.0_rc4_pre2 sys.tbz2</path> file, available from <uri> +http://www.ibiblio.org/gentoo/gentoo-x86-distro/gentoo-1.0_rc4_pre2/packages/</uri> (~67Mb download.) If you choose to install Gentoo Linux from another Linux distribution, you'll need to have the tools to unpack a bzip'd tarball (nearly all distributions do.) However, at this time, most distributions don't have the ability to create and mount ReiserFS @@ -96,7 +110,7 @@ CD image, which has all the tools you need for ReiserFS. </section> </chapter> -<chapter link="chap2"> +<chapter> <title>Installation</title> <section> @@ -107,14 +121,12 @@ Once you've downloaded the ISO image and burned your own Gentoo Linux CD, go ahe and boot your system from the CD. You'll be presented with a GRUB menu that looks like this: </p> -<p> -<img src="install-boot.gif"/> -</p> +<figure link="install-boot.gif" short="The boot screen" caption="When the CD boots, you'll see this screen"/> <p> Go ahead and select the first option to continue the CD boot process. Linux will boot and the Gentoo Linux CD detector will start up and detect and mount a minimal Gentoo Linux system included on the CD. When the boot process is complete, you'll be presented with a login prompt. To -log in, go ahead and type "<code>root</code>" and hit Enter. You won't be prompted for a password. +log in, go ahead and type <c>root</c> and hit Enter. You won't be prompted for a password. </p> </body> </section> @@ -123,19 +135,18 @@ log in, go ahead and type "<code>root</code>" and hit Enter. You won't be promp <title>Step 1: Create and Format Your Partitions</title> <body> <p> -The first step is to create your boot, root (plus optional /home, /usr, /var) -and swap partitions using fdisk (type "<code>fdisk /dev/hd?</code>" to start it up.) Your +The first step is to create your boot, root (plus optional <path>/home</path>, <path>/usr</path>, <path>/var</path>) +and swap partitions using fdisk (type <c>fdisk /dev/hd?</c> to start it up.) Your boot and root partition should be tagged as a "Linux" partitions (type 83) even if you're using ReiserFS. Your swap partition should be tagged as "Linux swap" (type 82). Here's a screenshot of an example partition layout. In this -example, /dev/hda1 is the boot partition (256Mb), /dev/hda2 is the swap -partition (256Mb), and /dev/hda3 is the root partition (1.5Mb). Notice that -/dev/hda1 has the bootable flag set (you can set this with the "a" option.) -Once you've created your partitions, remember to write your changes with the -"w" option. -</p><p> -<img src="install-fdisk.gif"/> -</p> +example, <path>/dev/hda1</path> is the boot partition (256Mb), <path>/dev/hda2</path> is the swap +partition (256Mb), and <path>/dev/hda3</path> is the root partition (1.5Mb). Notice that +<path>/dev/hda1</path> has the bootable flag set (you can set this with the <c>a</c> option.) +Once you've created your partitions, remember to write your changes using the +<c>w</c> option. +</p> +<figure link="install-fdisk.gif" short="Creating partitions" caption="Creating partitions using fdisk"/> </body> </section> @@ -143,39 +154,42 @@ Once you've created your partitions, remember to write your changes with the <title>Step 2: Create and Mount Filesystems</title> <body> <p> -The second step is to create your filesystems. Use the commands <code>mke2fs</code>, <code>mkreiserfs</code> and <code>mkswap</code> for this. For example, to create +The second step is to create your filesystems. Use the commands <c>mke2fs</c>, <c>mkreiserfs</c> and <c>mkswap</c> for this. For example, to create a new ReiserFS filesystem on the partition /dev/hda1, type: </p><pre> -# mkreiserfs /dev/hda1</pre> +# <i>mkreiserfs /dev/hda1</i></pre> <p>For my example partition layout above, I typed in the following commands: </p> -<pre> -# mkreiserfs /dev/hda1 -# mkswap /dev/hda2 -# mkreiserfs /dev/hda3 +<pre linkid="filesyscode" caption="Creating and mounting filesystems"> +# <i>mkreiserfs /dev/hda1</i> +# <i>mkswap /dev/hda2</i> +# <i>mkreiserfs /dev/hda3</i> </pre><p> Now that the filesystems have been created, it's time to get your boot and root (and optionally your /var, /usr and /home partitions) mounted. For my example partition layout, I typed in the following: </p><pre> -# mount /dev/hda3 /mnt/gentoo -# mkdir /mnt/gentoo/boot -# mount /dev/hda1 /mnt/gentoo/boot -o notail -</pre><p>(note: the "notail" option is required if you're installing GRUB as a secondary boot loader. It also doesn't hurt to include it if you're not.) -</p> +# <i>mount /dev/hda3 /mnt/gentoo</i> +# <i>mkdir /mnt/gentoo/boot</i> +# <i>mount /dev/hda1 /mnt/gentoo/boot -o notail</i> +</pre> + +<note title="The notail option">The "notail" option is required if you're +installing GRUB as a secondary boot loader. It also doesn't hurt to include it +if you're not.</note> -<p>Notice that I had to create the /mnt/gentoo/boot filesystem before mounting /dev/hda1. If you've created -additional non-root filesystems (/var, /usr, /home, etc), you'll need to create the appropriate directories under /mnt/gentoo +<p>Notice that I had to create the <path>/mnt/gentoo/boot</path> filesystem before mounting <path>/dev/hda1</path>. If you've created +additional non-root filesystems (<path>/var</path>, <path>/usr</path>, <path>/home</path>, etc), you'll need to create the appropriate directories under <path>/mnt/gentoo</path> and then mount all your filesystems at the correct locations. Once all your filesystems are mounted, we're ready to extract -the sys.tbz2 tarball - the file that contains the Gentoo Linux base system. +the <path>sys.tbz2</path> tarball - the file that contains the Gentoo Linux base system. </p> -<p><b>Note for those installing from an existing Linux distro:</b><br/> -If you're installing from an existing Linux distribution, make sure that all your filesystems are mounted at the /mnt/gentoo +<note> +If you're installing Gentoo Linux direct from an existing Linux distribution, make sure that all your filesystems are mounted at the <path>/mnt/gentoo</path> mountpoint just like I described above. From this point on, you should be able to follow our install instructions word for word. -</p> +</note> </body> </section> @@ -184,16 +198,16 @@ word. <title>Step 3: Extract the sys.tbz2 Tarball</title> <body> <p> -Now, it's time to extract the sys.tbz2 tarball to /mnt/gentoo. -You'll find the tarball at /mnt/distcd/packages/sys.tbz2. +Now, it's time to extract the <path>sys.tbz2</path> tarball to <path>/mnt/gentoo</path>. +You'll find the tarball at <path>/mnt/distcd/packages/sys.tbz2</path>. Extract it by typing:</p> <pre> -# tar xjvf /mnt/distcd/packages/sys.tbz2 -C /mnt/gentoo +# <i>tar xjvf /mnt/distcd/packages/sys.tbz2 -C /mnt/gentoo</i> </pre><p> -If you're installing from another Linux distribution and your version of tar doesn't have the -j (bzip2) option, the following +If you're installing from another Linux distribution and your version of tar doesn't have the <c>-j</c> (bzip2) option, the following pipeline should do the exact same thing: </p><pre> -# cat /path/to/sys.tbz2 | bzip2 -d | tar -xvf - -C /mnt/gentoo +# <i>cat /path/to/sys.tbz2 | bzip2 -d | tar -xvf - -C /mnt/gentoo</i> </pre> </body> </section> @@ -201,50 +215,49 @@ pipeline should do the exact same thing: -<chapter link="chap3"> +<chapter> <title>Configuration</title> <section> <title>Configure the system</title> -<body><p><font color="#FF0000">Note: If you want to compile a custom kernel during the install process, them before proceeding with the -following instructions, copy the linux-sources tbz2 file from /mnt/distcd/packages/All/linux-sources-???.tbz2 to /mnt/gentoo/tmp. -Then, proceed with these instructions. I'll let you know when it's time to merge it.</font> -</p> +<body><note>If you want to compile a custom kernel during the install process, them before proceeding with the +following instructions, copy the linux-sources tbz2 file from <path>/mnt/distcd/packages/All/linux-sources-???.tbz2</path> to <path>/mnt/gentoo/tmp</path>. +Then, proceed with these instructions. I'll let you know when it's time to merge it.</note> <p>Now that the base system tarball has been extracted, we need to get the system ready for booting. Begin this process by typing: </p><pre> -# chroot /mnt/gentoo -</pre><p>The chroot command will start a new shell with the root filesystem set to /mnt/gentoo. +# <i>chroot /mnt/gentoo</i> +</pre><p>The chroot command will start a new shell with the root filesystem set to <path>/mnt/gentoo</path>. If you have a non-US keyboard, you've probably noticed that some keys aren't in the right place. This can be fixed by typing: </p><pre> -# loadkeys [keymap] +# <i>loadkeys [keymap]</i> </pre><p> Here are some popular non-English keymaps:</p> -<table><tr><td><b>Language</b></td><td><b>Keymap</b></td></tr> -<tr><td>German</td><td>de-latin1-nodeadkeys</td></tr> -<tr><td>French</td><td>fr_latin1</td></tr> +<table><th>Language</th><th>Keymap</th> +<tr><ti>German</ti><ti>de-latin1-nodeadkeys</ti></tr> +<tr><ti>French</ti><ti>fr_latin1</ti></tr> </table> <p> -Please <a href="mailto:drobbins@gentoo.org">email me</a> the keymaps that you use for your +Please <mail link="drobbins@gentoo.org">email me</mail> the keymaps that you use for your preferred language so that I can add them to this document. Now, type the following commands: </p><pre> -# env-update -# /etc/rc.d/init.d/initscripts-install -</pre><p>The first command, env-update, is a special Gentoo Linux command that auto-generates the /etc/ld.so.conf file and configures +# <i>env-update</i> +# <i>/etc/rc.d/init.d/initscripts-install</i> +</pre><p>The first command, env-update, is a special Gentoo Linux command that auto-generates the <path>/etc/ld.so.conf</path> file and configures the default shell environment variable and path settings. The second script will configure Gentoo Linux initialization scripts, -so that all the proper symlinks are in place in /etc/rc.d so that the system will boot. +so that all the proper symlinks are in place in <path>/etc/rc.d</path> so that the system will boot. </p> <p>There are just a few files that need to be configured before we're ready to install the Gentoo Linux boot loader (GRUB) and -start Gentoo Linux. Right now, the only editor included with the base system is "vi". In the next release, we're also going -to include another text editor that's easier to use for those who don't know vi. If you don't know how to use vi, here are -some quick instructions. To edit a file, type "<code>vi filename</code>". Immediately after vi loads the file, press the "i" key to enter +start Gentoo Linux. Right now, the only editor included with the base system is <c>vi</c>. In the next release, we're also going +to include another text editor that's easier to use for those who don't know <c>vi</c>. If you don't know how to use vi, here are +some quick instructions. To edit a file, type <c>vi filename</c>. Immediately after <c>vi</c> loads the file, press the <c>i</c> key to enter INSERT mode. In this mode, you'll be able to move around in the file by using the arrow keys, and you'll be able to insert text just by typing it and delete text with the backspace or delete key. If you need to delete an entire line, press escape -to leave INSERT mode (you're now in command mode), and hit "dd". Then, hit "i" again to go back to insert mode. When you need -to save your changes, hit escape to leave INSERT mode and type "<code>:x</code>". If you want to throw away your changes, type "<code>:q!</code>". -Vim, the version of vi that's included with Gentoo Linux, also includes extensive help. You can type "<code>:help</code>" (in command mode) +to leave INSERT mode (you're now in command mode), and hit <c>dd</c>. Then, hit <c>i</c> again to go back to INSERT mode. When you need +to save your changes, hit escape to leave INSERT mode and type <c>:x</c>. If you want to throw away your changes, type <c>:q!</c>. +Vim, the version of vi that's included with Gentoo Linux, also includes extensive help. You can type <c>:help</c> (in command mode) to access it.</p> </body> </section> @@ -265,9 +278,9 @@ first three configuration lines for my example system configuration: <section> <title>/etc/localtime</title> <body> -<p>Look for your timezone (or GMT if you using Greenwich Mean Time) in /usr/share/zoneinfo. Then, make a symbolic link by typing: +<p>Look for your timezone (or GMT if you using Greenwich Mean Time) in <path>/usr/share/zoneinfo</path>. Then, make a symbolic link by typing: </p><pre> -# cd /etc; ln -sf /usr/share/zoneinfo/path/to/timezonefile localtime +# <i>cd /etc; ln -sf /usr/share/zoneinfo/path/to/timezonefile localtime</i> </pre> </body> </section> @@ -275,7 +288,7 @@ first three configuration lines for my example system configuration: <section> <title>/etc/hostname</title> <body> -<p>Edit this file so that it contains your fully-qualified domain name on a single line, i.e. "mymachine.mydomain.com" (without the quotes). +<p>Edit this file so that it contains your fully-qualified domain name on a single line, i.e. <c>mymachine.mydomain.com</c>. </p> </body> </section> @@ -298,9 +311,9 @@ nameserver 10.0.0.2 <p>This file contains a list of ip addresses and their associated hostnames. It's used by the system to resolve the IP addresses of any hostnames that may not be in your nameservers. Here's a template for this file: </p><pre> -127.0.0.1 localhost -# the next line contains your IP for your local LAN, and your associated machine name -192.168.1.1 mymachine.mydomain.com mymachine +127.0.0.1 localhost +<comment># the next line contains your IP for your local LAN, and your associated machine name</comment> +192.168.1.1 mymachine.mydomain.com mymachine </pre> </body> </section> @@ -308,23 +321,36 @@ of any hostnames that may not be in your nameservers. Here's a template for thi <section> <title>Configure ethernet</title> <body> -<p>Look in the /etc/rc.d/config directory; you'll see a file called OFF_inet.eth0. Copy this file to inet.eth0, and edit -the top part of it so that it contains the IP address settings you want to use on your first ethernet card. Look in /lib/modules for the ethernet module specific to your particular ethernet card, -and append it to the /etc/rc.d/config/modules file (you can also add any options you need to the same line.) Then, when Gentoo Linux boots, this module will be automatically loaded from disk. If you have multiple network cards, -copy inet.eth0 to inet.eth1 and edit this file so that it configures your second interface correctly. Repeat for eth2, etc as necessary. If you have a static ppp link, you can copy the inet.eth0 file to inet.ppp0, and insert the appropriate commands in the -netup() and netdown() functions. All /etc/rc.d/config/inet.* files will be started automatically at boot time by the /etc/rc.d/init.d/inet rc script. -</p> + +<p>Look in the <path>/etc/rc.d/config</path> directory; you'll see a file +called OFF_inet.eth0. Copy this file to inet.eth0, and edit the top part of it +so that it contains the IP address settings you want to use on your first +ethernet card. Look in <path>/lib/modules</path> for the ethernet module +specific to your particular ethernet card, and append it to the +<path>/etc/rc.d/config/modules</path> file (you can also add any options you +need to the same line.) Then, when Gentoo Linux boots, this module will be +automatically loaded from disk. If you have multiple network cards, copy +<path>inet.eth0</path> to <path>inet.eth1</path> and edit this file so that it +configures your second interface correctly. Repeat for eth2, etc as necessary. +If you have a static ppp link, you can copy the <path>inet.eth0</path> file to +<path>inet.ppp0</path>, and insert the appropriate commands in the +<c>netup()</c> and <c>netdown()</c> functions. All +<path>/etc/rc.d/config/inet.*</path> files will be started automatically at +boot time by the <path>/etc/rc.d/init.d/inet</path> rc script. </p> + </body> </section> <section> <title>Configure basic settings</title> <body> -<p>Take a look at the /etc/rc.d/config/basic, and make sure that it's set up properly. Important settings are GMT -(set to "yes" if your system clock is set to GMT, otherwise "no" if it's set to your local time) and KEYMAP (look in -/usr/share/keymaps/i386/qwerty,dvorak,etc. for available keymaps. To specify the keymap, set KEYMAP to the *prefix* -of the keymap filename (i.e. drop the ".kmap.gz" extension from the end.) + +<p>Take a look at the <path>/etc/rc.d/config/basic</path>, and make sure that it's set up properly. Important settings are GMT +(set to <c>yes</c> if your system clock is set to GMT, otherwise <c>no</c> if it's set to your local time) and KEYMAP (look in +<path>/usr/share/keymaps/i386</path> for available keymaps. To specify the keymap, set KEYMAP to the <e>prefix</e> +of the keymap filename (i.e. drop the <path>.kmap.gz</path> extension from the end.) </p> + </body> </section> @@ -333,94 +359,105 @@ of the keymap filename (i.e. drop the ".kmap.gz" extension from the end.) <body> <p> The most critical part of understanding GRUB is getting comfortable with how GRUB refers to hard drives and partitions. -Your Linux partition /dev/hda1 is called (hd0,0) under GRUB. Notice the parenthesis around the hd0,0 - they are required. -Hard drives count from zero rather than "a", and partitions start at zero rather than one. So, /dev/hdb3 gets translated to (hd1,2), and /dev/hdd7 gets translated to (hd3,6). After you've gotten the feel for that, convert your boot and root partition names to the GRUB format and write them down. Now, it's time to install GRUB. +Your Linux partition <path>/dev/hda1</path> is called <path>(hd0,0)</path> under GRUB. Notice the parenthesis around the hd0,0 - they are required. +Hard drives count from zero rather than "a", and partitions start at zero rather than one. So, <path>/dev/hdb3</path> gets translated to <path>(hd1,2)</path>, and <path>/dev/hdd7</path> gets translated to <path>(hd3,6)</path>. After you've gotten the feel for that, convert your boot and root partition names to the GRUB format and write them down. Now, it's time to install GRUB. </p> -<p>The easiest way to install grub is to simply type "<code>grub</code>" at your chrooted shell prompt: +<p>The easiest way to install grub is to simply type <c>grub</c> at your chrooted shell prompt: </p><pre> -# grub -</pre><p>You'll be presented with the "grub> " grub command-line prompt. Now, you need to type in the +# <i>grub</i> +</pre><p>You'll be presented with the <c>grub></c> grub command-line prompt. Now, you need to type in the right commands to install the GRUB boot record onto your hard drive. In my example configuration, I want to install the GRUB boot record on my hard drive's MBR (master boot record), so that the first thing I see when I turn on the computer is the GRUB prompt. In my case, the commands -I want to type are:</p><pre>grub> root (hd0,0) -grub> setup (hd0) +I want to type are:</p> +<pre>grub> <i>root (hd0,0)</i> +grub> <i>setup (hd0)</i> </pre> -<p>Here's how the two commands work. The first "root ( )" command tells GRUB -the location of your boot partition (in my case, hda1 or in GRUB terminology -(hd0,0)). Then, the second "setup ( )" command tells GRUB where to install the -boot record - it will be configure to look for its special files at the "root -( )" location that you specified. In my case, I want the boot record on the -MBR of the hard drive, so I simply specify hda ((hd0)). If I were using +<p>Here's how the two commands work. The first <c>root ( )</c> command tells GRUB +the location of your boot partition (in my case, <path>/dev/hda1</path> or +<path>(hd0,0)</path> in GRUB terminology. Then, the second <c>setup ( )</c> command tells GRUB where to install the +boot record - it will be configure to look for its special files at the <c>root +( )</c> location that you specified. In my case, I want the boot record on the +MBR of the hard drive, so I simply specify <path>/dev/hda</path> (also known as <path>(hd0)</path>). If I were using another boot loader and wanted to set up GRUB as a secondary boot-loader, I could install GRUB to the boot record of a particular partition. In that case, I'd specify a particular partition rather than the entire disk. Once the GRUB boot record has been -successfully installed, you can type "quit" to quit GRUB. Gentoo Linux is -installed, but we need to create the /boot/boot/grub/menu.lst file so that +successfully installed, you can type <c>quit</c> to quit GRUB. Gentoo Linux is +installed, but we need to create the <path>/boot/boot/grub/menu.lst</path> file so that we get a nice GRUB boot menu when the system reboots. Here's how to do it.</p> -<p>Now, create the menu.lst file ("<code>vi /boot/boot/grub/menu.lst</code>"), and add the following to it:</p> +<p>Now, create the menu.lst file (<c>vi /boot/boot/grub/menu.lst</c>), and add the following to it:</p> <pre> default 0 timeout 30 title=My example Gentoo Linux -root (hd0,0) <font color="#FF0000">(note: (hd0,0) should point to your "boot" partition (hda1 in my case)</font> -kernel /boot/bzImage root=/dev/hda3 <font color="#FF0000">(note: /dev/hda3 should point to your "root" filesystem)</font> +root (hd0,0) +kernel /boot/bzImage root=/dev/hda3 title=Windows NT Workstation -root (hd0,2) <font color="#FF0000">(note: (hd0,2) contains the NT boot loader)</font> +root (hd0,2) </pre><p>After saving this file, Gentoo Linux installation is complete. Selecting the first option will tell GRUB to boot Gentoo Linux without a fuss. The second part of the menu.lst file is optional, and shows you how to use GRUB to boot a bootable Windows partition.</p> -<p>Also, if you need to pass any options to the kernel, simply add them to the end of the "kernel" command. We're already -passing one option "root=/dev/hda3", but you can pass others as well. There's one in particular that you may be interested -in. If you want to enable devfs (a special device filesystem), you can add the "devfs=mount" option at the end of the kernel -line. -</p> +<note>Above, <path>(hd0,0)</path> should point to your "boot" partition +(<path>/dev/hda1</path> in my case) and <path>/dev/hda3</path> should point to +your "root filesystem. <path>(hd0,2)</path> contains the NT boot +loader.</note> <p>Also, if you need to pass any options to the kernel, simply +add them to the end of the <c>kernel</c> command. We're already passing one option +(<c>root=/dev/hda3</c>), but you can pass others as well. There's one in particular +that you may be interested in. If you want to enable devfs (a special device +filesystem), you can add the <c>devfs=mount</c> option at the end of the <c>kernel</c> +line. </p> + </body> </section> <section> <title>One Last Step</title> <body> -<p>If you copied over the linux-sources-???.tbz2 file, you can now install the package and compile a fresh new -kernel. To merge the linux-sources, type "<code>pkgmerge /tmp/linux-sources-???.tbz2</code>". After the merge completes, -you can remove the .tbz2 from /tmp and continue with the kernel compile step. If you didn't copy over the +<p>If you copied over the <path>linux-sources-???.tbz2</path> file, you can now install the package and compile a fresh new +kernel. To merge the linux-sources, type <c>pkgmerge /tmp/linux-sources-???.tbz2</c>. After the merge completes, +you can remove the .tbz2 from <path>/tmp</path> and continue with the kernel compile step. If you didn't copy over the linux sources, you can skip the kernel compile step and proceed unmounting your filesystems below.</p> <p>To compile your own kernel, perform the following steps:</p><pre> -# cd /usr/src/linux -# make menuconfig <font color="#FF0000">(Note: make sure you compile-in support for ReiserFS as well as your boot drive controller)</font> -# make bzImage -# make modules -# make modules_install -# cp arch/i386/boot/bzImage /boot/boot <font color="#FF0000">(Note: the "/boot/boot" is intentional and should not simply be "/boot")</font> +# <i>cd /usr/src/linux</i> +# <i>make menuconfig</i> +<codenote>make sure you compile-in support for ReiserFS as well as your boot drive controller</codenote> +# <i>make bzImage</i> +# <i>make modules</i> +# <i>make modules_install</i> +# <i>cp arch/i386/boot/bzImage /boot/boot</i> +<codenote>Above, "/boot/boot" is intentional and should not simply be "/boot"</codenote> </pre> <p>Now, Gentoo Linux is installed. The only remaining step is to exit the chrooted shell, safely unmount your partitions and reboot the system:</p> <pre> -# exit <font color="#FF0000">(note: this exits the chrooted shell; you can also type <code>^D)</code></font> -# umount /mnt/gentoo/boot -# umount /mnt/gentoo -# reboot +# <i>exit</i> +<codenote>This exits the chrooted shell; you can also type <c>^D</c></codenote> +# <i>umount /mnt/gentoo/boot</i> +# <i>umount /mnt/gentoo</i> +# <i>reboot</i> </pre> </body> </section> </chapter> -<chapter link="chap4"> -<title></title> +<chapter> +<title>You're done!</title> <section> <title>Congratulations!</title> <body><p>If you have any questions or would like to get involved with Gentoo Linux development, -consider joining our gentoo-dev mailing list (there's a "click to subscribe" link on our <a href="http://www.gentoo.org">main page</a>). +consider joining our gentoo-dev mailing list (there's a "click to subscribe" link on our <uri link="http://www.gentoo.org">main page</uri>). </p> +<warn>This is a warning.</warn> +<impo>This is important.</impo> </body> </section> </chapter> diff --git a/app-doc/gentoo-web/files/xml/xml-guide.xml b/app-doc/gentoo-web/files/xml/xml-guide.xml new file mode 100644 index 000000000000..cd24ef039159 --- /dev/null +++ b/app-doc/gentoo-web/files/xml/xml-guide.xml @@ -0,0 +1,358 @@ +<?xml version='1.0'?> +<guide> +<title>Gentoo Linux Documentation Guide</title> +<author title="Chief Architect"><mail link="drobbins@gentoo.org">Daniel Robbins</mail></author> +<author title="Editor"><mail link="thomasfl@gentoo.org">Thomas Flavel</mail></author> + +<abstract>This guide shows you how to compose web documentation using the new lightweight Gentoo guide +XML syntax. This syntax is the official format for Gentoo Linux documentation, and this document +itself was created using guide XML. This guide assumes a basic working knowledge of XML and HTML. +</abstract> + +<version>1.0</version> +<date>29 Mar 2001</date> + +<chapter> +<title>Guide basics</title> + +<section> +<title>Guide XML design goals</title> +<body> + +<p> The guide XML syntax is lightweight yet expressive, so that it is easy to +learn yet also provides all the features we need for the creation of web +documentation. The number of tags is kept to a minimum -- just those we need. +This makes it easy to transform guide into other formats, such as DocBook +XML/SGML or web-ready HTML. </p> + +<p>The goal is to make it easy to <e>create</e> and <e>transform</e> guide XML +documents.</p> + +</body> +</section> + +<section> +<title>How to transform guide XML into HTML</title> +<body> + +<p> Before we take a look at the guide syntax itself, it's helpful to know how +guide XML is transformed into web-ready HTML. To do this, we use a special +file called <path>guide.xsl</path>, along with a command-line XSLT processing +tool (also called an "engine"). The <path>guide.xsl</path> file describes +exactly how to transform the contents of the source guide XML document to +create the target HTML file. Two popular XSLT processors are <c>sabcmd</c> +(included in the <path>app-text/sablotron</path> package) and <c>xsltproc</c> +(found in the <path>gnome-libs/libxslt</path> package). From experience, we've +found that <c>xsltproc</c> is the higher-quality and more feature-rich XSLT +processor. </p> + +<p> Once you have either <c>xsltproc</c> or <c>sabcmd</c> installed, you're +ready to convert guide XML into web-ready HTML. Here's how it works. First, +select a sample document from +<path>/usr/portage/app-doc/gentoo-web/files/xml</path>, such as +<path>install.xml</path> (The new user installation guide). This will be our +source XML guide document. The easiest way to perform the transformation is to +change directories to the location of the <path>guide.xsl</path> file. Then, +execute <c>xsltproc</c> as follows: </p> + +<pre> +# <i>cd /usr/portage/app-doc/gentoo-web/files/xsl</i> +# <i>xsltproc guide.xsl ../xml/install.xml > /tmp/install.html</i> +</pre> + +<p> If all went well, you should have a web-ready version of +<path>install.xml</path> at <path>/tmp/install.html</path>. For this document +to display properly in a web browser, you may have to copy some files from +<path>/usr/portage/app-doc/gentoo-web/files</path> to <path>/tmp</path>, such +as <path>css/gentoo-dcc.css</path> and <path>images/gentoo-doc.gif</path>. +</p> + +</body> +</section> +</chapter> +<chapter> + <title>Guide XML</title> +<section> +<title>Basic structure</title> +<body> + +<p>Now that you know how to transform guide XML, you're ready to start learning +the guide XML syntax. We'll start with the the initial tags used in a guide +XML document: </p> + +<pre caption="The initial part of a guide XML document"> +<?xml version='1.0'?> +<guide> +<title><i>Gentoo Linux Documentation Guide</i></title> +<author title="<i>Chief Architect</i>"><mail link="<i>drobbins@gentoo.org</i>"><i>Daniel Robbins</i></mail></author> +<author title="<i>Editor</i>"><mail link="<i>thomasfl@gentoo.org</i>"><i>Thomas Flavel</i></mail></author> + +<abstract><i>This guide shows you how to compose web documentation using our new lightweight Gentoo guide +XML syntax. This syntax is the official format for Gentoo Linux web documentation, and this document +itself was created using guide XML.</i> +</abstract> + +<version><i>1.0</i></version> +<date><i>29 Mar 2001</i></date> +</pre> + +<p>On the first, line, we see the requisite tag that identifies this as an XML +document. Following it, there's a <c><guide></c> tag -- the entire +guide document is enclosed within a <c><guide> </guide></c> pair. +Next, there's a <c><title></c> tag, used to set the title for the entire +guide document. </p> + +<p>Then, we come to the <c><author></c> tags, which contain information +about the various authors of the document. Each <c><author></c> tag +allows for an optional <c>title=</c> element, used to specify the author's +relationship to the document (author, co-author, editor, etc.). In this +particular example, the authors' names are enclosed in another tag -- a +<c><mail></c> tag, used to specify an email address for this particular +person. The <c><mail></c> tag is optional and can be omitted, and no +more than one <c><author></c> element is required per guide document. +</p> + +<p>Next, we come to the <c><abstract></c>, <c><version></c> and +<c><date></c> tags, used to specify a summary of the document, the +current version number, and the current version date (in DD MMM YYYY format) +respectively. This rounds out the tags that should appear at the beginning of +a guide document. Besides the <c><title></c> and <c><mail></c> +tags, these tags shouldn't appear anywhere else except immediately inside the +<c><guide></c> tag, and for consistency it's recommended (but not +required) that these tags appear before the content of the document. </p> + +</body> +</section> + +<section> +<title>Chapters and sections</title> +<body> +<p>Once the initial tags have been specified, you're ready to start adding +the structural elements of the document. Guide documents are divided into +chapters, and each chapter can hold one or more sections. Every chapter +and section has a title. Here's an example chapter with a single section, +consisting of a paragraph. If you append this XML to the XML in the <uri link="#doc_pre2">previous +excerpt</uri> and append a <c></guide></c> to the end of the file, you'll have a valid +(if minimal) guide document: +</p> + +<pre> +<chapter> +<title><i>This is my chapter</i></title> +<section> + <title><i>This is section one of my chapter</i></title> + <body> + <p><i>This is the actual text content of my section.</i></p> + </body> +</section> +</chapter> +</pre> + +<p>Above, I set the chapter title by adding a child <c><title></c> +element to the <c><chapter></c> element. Then, I created a section by +adding a <c><section></c> element. If you look inside the +<c><section></c> element, you'll see that it has two child elements -- a +<c><title></c> and a <c><body></c>. While the <c><title></c> +is nothing new, the <c><body></c> is -- it contains the actual text +content of this particular section. We'll look at the tags that are allowed +inside a <c><body></c> element in a bit. </p> + +<note>A <c><guide></c> element can contain multiple +<c><chapter></c> elements, and a <c><chapter></c> can contain +multiple <c><section></c> elements. However, a <c><section></c> +element can only contain one <c><body></c> element. </note> + +</body> +</section> + +<section> +<title>An example <body></title> +<body> +<p> +Now, it's time to learn how to mark up actual content. Here's the XML code for an example <c><body></c> element: +</p> +<pre> +<p> +This is a paragraph. <path>/etc/passwd</path> is a file. +<uri>http://www.gentoo.org</uri> is my favorite website. +Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now. +</p> + +<pre> +This is text output or code. +# <i>this is user input</i> + +Make HTML/XML easier to read by using selective emphasis: +<foo><i>bar</i></foo> + +<codenote>This is how to insert an inline note into the code block</codenote> +</pre> +<note>This is a note.</note> +<warn>This is a warning.</warn> +<impo>This is important.</impo> +</pre> +<p>Now, here's how this <c><body></c> element is rendered:</p> + +<p> +This is a paragraph. <path>/etc/passwd</path> is a file. +<uri>http://www.gentoo.org</uri> is my favorite website. +Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now. +</p> + +<pre> +This is text output or code. +# <i>this is user input</i> + +Make HTML/XML easier to read by using selective emphasis: +<foo><i>bar</i></foo> + +<codenote>This is how to insert an inline note into the code block</codenote> +</pre> +<note>This is a note.</note> +<warn>This is a warning.</warn> +<impo>This is important.</impo> +</body> +</section> + +<section> +<title>The <body> tags</title> +<body> + +<p> We introduced a lot of new tags in the previous section -- here's what you +need to know. The <c><p></c> (paragraph), <c><pre></c> (code +block), <c><note></c>, <c><warn></c> (warning) and +<c><impo></c> (important) tags all can contain one or more lines of text. +Besides the <c><table></c> element (which we'll cover in just a bit), +these are the only tags that should appear immediately inside a +<c><body></c> element. Another thing -- these tags <e>should not</e> be +stacked -- in other words, don't put a <c><note></c> element inside a +<c><p></c> element. As you might guess, the <c><pre></c> element +preserves its whitespacing formatting, making it well-suited for code excerpts.</p> + +</body> +</section> +<section> +<title><path>, <c> and <e></title> +<body> + +<p>The <c><path></c>, <c><c></c> and <c><e></c> elements can +be used inside any child <c><body></c> tag, except for +<c><pre></c>. </p> + +<p>The <c><path></c> element is used to mark text that refers to an +<e>on-disk file</e> -- either an <e>absolute or relative path</e>, or a <e>simple filename</e>. +This element is generally rendered with a monospaced font to offset it from the +standard paragraph type. </p> + +<p>The <c><c></c> element is used to mark up a <e>command</e> or <e>user +input</e>. Think of <c><c></c> as a way to alert the reader to something +that they can type in that will perform some kind of action. For example, all +the XML tags displayed in this document are enclosed in a <c><c></c> +element because they represent something that the user could type in that is +not a path. By using <c><c></c> elements, you'll help your readers +quickly identify commands that they need to type in. Also, because +<c><c></c> elements are already offset from regular text, <e>it is rarely +necessary to surround user input with double-quotes</e>. For example, don't +refer to a "<c><c></c>" element like I did in this sentence. Avoiding +the use of unnecessary double-quotes makes a document more readable -- and adorable!</p> + +<p><c><e></c> is used to apply emphasis to a word or phrase; for example: +I <e>really</e> should use semicolons more often. As you can see, this text is +offset from the regular paragraph type for emphasis. This helps to give your +prose more <e>punch</e>!</p> + +</body> +</section> + +<section> +<title><mail> and <uri></title> +<body> + +<p>We've taken a look at the <c><mail></c> tag earlier; it's used to link some text +with a particular email address, and takes the form <c><mail link="foo@bar.com">Mr. Foo Bar</mail></c>.</p> + +<p>The <c><uri></c> tag is used to point to files/locations on the +Internet. It has two forms -- the first can be used when you want to have the +actual URI displayed in the body text, such as this link to +<uri>http://www.gentoo.org</uri>. To create this link, I typed +<c><uri>http://www.gentoo.org</uri></c>. The alternate form is +when you want to associate a URI with some other text -- for example, <uri +link="http://www.gentoo.org">the Gentoo Linux website</uri>. To create <e>this</e> +link, I typed <c><uri link="http://www.gentoo.org">the Gentoo Linux website</uri></c>. +</p> + +</body> +</section> + +<section> +<title>Figures</title> + +<body> + +<p>Here's how to insert a figure into a document -- <c><figure +link="mygfx.png" short="my picture" caption="my favorite picture of all +time"/></c>. The <c>link=</c> attribute points to the actual graphic image, +the <c>short=</c> attribute specifies a short description (currently used for +the image's HTML <c>alt=</c> attribute), and a caption. Not too difficult +:)</p> + +</body> +</section> +<section> +<title>Tables and lists</title> +<body> + +<p>Guide supports a simplified table syntax similar to that of HTML. To start +a table, use a <c><table></c> tag. Start a row with a <c><tr></c> +tag. However, for inserting actual table data, we <e>don't</e> support the +HTML <td> tag; instead, use the <c><th></c> if you are inserting a +header, and <c><ti></c> if you are inserting a normal informational +block. You can use a <c><th></c> anywhere you can use a <c><ti></c> -- +there's no requirement that <c><th></c> elements appear only in the +first row. Currently, these tags don't support any attributes, but some will +be added (such as a <c>caption=</c> attribute for <c><table></c>) soon. +</p> + +<p> To create ordered or unordered lists, simply use the HTML-style +<c><ol></c>, <c><ul></c> and <c><li></c> tags. List tags +should only appear inside a <c><p></c>, <c><ti></c>, +<c><note></c>, <c><warn></c> or <c><impo></c> tag. </p> + +</body> +</section> + +<section> +<title>Intra-document references</title> +<body> + +<p>Guide makes it really easy to reference other parts of the document using +hyperlinks. You can create a link pointing to <uri link="#doc_chap1">Chapter +One</uri> by typing <c><uri link="#doc_chap1">Chapter +One</uri></c>. To point to <uri link="#doc_chap1_sect2">section two of +Chapter One</uri>, type <c><uri link="#doc_chap1_sect2">section two of +Chapter One</uri></c>. To refer to figure 3, type <c><uri +link="doc_fig3">figure 3</uri></c>. Or, to refer to <uri link="#doc_pre2">code listing 2</uri>, +type <c><uri link="doc_pre2">code listing 2</uri></c>. We'll be +adding other auto-link abilities (such as table support) soon.</p> + +</body> +</section> +</chapter> +<chapter> +<title>Resources</title> +<section> + <title>Start writing</title> + <body> + <p>Guide has been specially designed to be "lean and mean" so that developers + can spend more time writing documentation and less time learning the actual XML + syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy" + to start writing quality Gentoo Linux documentation. If you'd like to help (or have any questions about guide), please + post a message to <mail link="gentoo-dev@gentoo.org">the gentoo-dev mailing list</mail> + stating what you'd like to tackle.</p> + <p>If you'd like to explore guide further, you can find the necessary files in our + Portage tree -- <path>/usr/portage/app-doc/gentoo-web/files</path>. Have fun!</p> + </body> +</section> +</chapter> +</guide> + diff --git a/app-doc/gentoo-web/files/xsl/guide-new.xsl b/app-doc/gentoo-web/files/xsl/guide-new.xsl deleted file mode 100755 index 7947513016b7..000000000000 --- a/app-doc/gentoo-web/files/xsl/guide-new.xsl +++ /dev/null @@ -1,213 +0,0 @@ -<?xml version='1.0'?> -<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> -<xsl:output method="html" indent="yes"/> -<xsl:preserve-space elements="pre"/> - -<xsl:template match="/guide"> - <html> - <head> - <title><xsl:value-of select="title"/></title> - <link rel="stylesheet" href="gentoo-doc.css" type="text/css"/> - </head> - <body bgcolor="#ffffff" topmargin="0" leftmargin="0" marginwidth="0" marginheight="0"> - <table class="toptable" width="100%" cellspacing="0" cellpadding="0" border="0" bgcolor="#000000"> - <tr><td width="160" height="129" align="left" valign="top"><a href="/"><img border="0" src="gentoo-doc.gif"/></a></td> - <td>&nbsp;</td></tr> - <tr> - <td colspan="2" class="doclink"> - <a href="/doc" style="color: #33ff00">documentation</a> :: <xsl:value-of select="title"/> - </td> - </tr> -</table> - <table class="secondtable" width="95%" cellspacing="0" cellpadding="2" border="0"> - <tr><td valign="top"> - <p class="dochead"><xsl:value-of select="title"/></p> - </td><td valign="top"> - <p class="info"> - <xsl:apply-templates select="author"/> - Version <xsl:value-of select="version"/>, <xsl:value-of select="date"/></p> - </td></tr> - <tr><td> - <p class="tochead">Summary</p> - <p class="abstract"> - <xsl:value-of select="abstract"/> - </p> - </td><td width="25%" valign="top"> - <p class="tochead">Table of contents:</p> - <p class="tocitem"> - <xsl:for-each select="chapter"> - <xsl:variable name="chapid">doc_chap<xsl:number/></xsl:variable> - <a href="#{$chapid}"><xsl:number/>. <xsl:value-of select="title"/></a> - <br/> - </xsl:for-each> - </p> - </td> - </tr> -</table> - <xsl:apply-templates select="chapter"/> - <br/> - <br/> - <table class="tochead" width="100%" border="0"><tr><td align="right">Copyright 2001 Gentoo Technologies, Inc.<br/> - Questions, Comments, Corrections? Email <a href="mailto:gentoo-dev@gentoo.org">gentoo-dev@gentoo.org</a>.</td></tr></table> - </body> - </html> -</xsl:template> - -<xsl:template match="mail"> - <a href="mailto:{@link}"><xsl:value-of select="."/></a> -</xsl:template> - -<xsl:template match="author"> - <xsl:apply-templates /> - <xsl:if test="@title">, <i><xsl:value-of select="@title"/></i> - </xsl:if> - <br/> -</xsl:template> - -<xsl:template match="chapter"> - <xsl:variable name="chapid">doc_chap<xsl:number/></xsl:variable> - <a name="#{$chapid}"><p class="chaphead"><span class="chapnum"><xsl:number/>.</span> <xsl:value-of select="title"/></p></a> - <xsl:apply-templates select="section"/> -</xsl:template> - -<xsl:template match="section"> - <xsl:variable name="sectid"><xsl:value-of select="$chapid"/>_sec<xsl:number/></xsl:variable> - <a name="#{$sectid}"><p class="secthead"><xsl:value-of select="title"/></p></a> - <xsl:apply-templates select="body"/> -</xsl:template> - -<xsl:template match="figure"> - <table border="0"><tr><td> - <xsl:variable name="fignum"><xsl:number level="any"/></xsl:variable> - <xsl:variable name="figid">doc_fig<xsl:number/></xsl:variable> - <a href="#{$figid}"/> - <xsl:choose> - <xsl:when test="@short"> - <img src="{@link}" alt="Fig. {$fignum}: {@short}"/> - </xsl:when> - <xsl:otherwise> - <img src="{@link}" alt="Fig. {$fignum}"/> - </xsl:otherwise> - </xsl:choose> - </td></tr><tr><td class="tochead"> - <xsl:choose> - <xsl:when test="@caption"> - Figure <xsl:value-of select="$fignum"/>: <xsl:value-of select="@caption" /> - </xsl:when> - <xsl:otherwise> - Figure <xsl:value-of select="$fignum"/> - </xsl:otherwise> - </xsl:choose> - </td></tr></table> -</xsl:template> - -<xsl:template match="note"> - <p class="note"><b>Note: </b> - <xsl:apply-templates /> - </p> -</xsl:template> - -<xsl:template match="impo"> - <p class="impo"><b>Important: </b> - <xsl:apply-templates /> - </p> -</xsl:template> - -<xsl:template match="warn"> - <p class="warn"><b>Warning: </b> - <xsl:apply-templates /> - </p> -</xsl:template> - -<xsl:template match="codenote"> - <span class="comment">// <xsl:value-of select="." /></span> -</xsl:template> - -<xsl:template match="comment"> - <span class="comment"><xsl:apply-templates /></span> -</xsl:template> - -<xsl:template match="i"> - <span class="input"><xsl:apply-templates /></span> -</xsl:template> - -<xsl:template match="body"> - <xsl:apply-templates /> -</xsl:template> - -<xsl:template match="c"> - <span class="code"><xsl:apply-templates /></span> -</xsl:template> - -<xsl:template match="pre"> - <xsl:if test="@id"> - <a href="#{@id}"/> - </xsl:if> - <xsl:if test="@caption"> - <p class="caption"><xsl:value-of select="@caption" /></p> - </xsl:if> - <pre> - <xsl:apply-templates /> - </pre> -</xsl:template> - -<!-- path is used for specifying files and URLs; if you are linking -part of a sentence rather than a path, then don't use this, use span instead--> -<xsl:template match="path"> - <span class="path"><xsl:value-of select="."/></span> -</xsl:template> - -<xsl:template match="uri"> - <xsl:choose> - <xsl:when test="@link"> - <a href="{@link}"><xsl:value-of select="."/></a> - </xsl:when> - <xsl:otherwise> - <xsl:variable name="loc" select="."/> - <a href="{$loc}"><xsl:value-of select="."/></a> - </xsl:otherwise> - </xsl:choose> -</xsl:template> - -<xsl:template match="p"> - <p class="para"><xsl:apply-templates /></p> -</xsl:template> - -<xsl:template match="e"> - <span class="emphasis"><xsl:apply-templates /></span> -</xsl:template> - -<xsl:template match="mail"> - <a href="mailto:{@link}"><xsl:value-of select="."/></a> -</xsl:template> - -<xsl:template match="table"> - <table><xsl:apply-templates /></table> -</xsl:template> - -<xsl:template match="tr"> - <tr><xsl:apply-templates /></tr> -</xsl:template> - -<xsl:template match="ti"> - <td class="tableinfo"><xsl:apply-templates /></td> -</xsl:template> - -<xsl:template match="th"> - <td class="tochead"><b><xsl:apply-templates /></b></td> -</xsl:template> - -<xsl:template match="ul"> - <ul><xsl:apply-templates /></ul> -</xsl:template> - -<xsl:template match="ol"> - <ol><xsl:apply-templates /></ol> -</xsl:template> - -<xsl:template match="li"> - <li><xsl:apply-templates /></li> -</xsl:template> - -</xsl:stylesheet> - diff --git a/app-doc/gentoo-web/files/xsl/guide-old.xsl b/app-doc/gentoo-web/files/xsl/guide-old.xsl new file mode 100755 index 000000000000..36454b15a36a --- /dev/null +++ b/app-doc/gentoo-web/files/xsl/guide-old.xsl @@ -0,0 +1,81 @@ +<?xml version='1.0'?> +<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> +<xsl:output method="xml" indent="yes"/> + +<xsl:template match="/guide"> + <html> + <head> + <title><xsl:value-of select="title"/></title> + <link rel="stylesheet" href="gentoo-doc.css" type="text/css"/> + </head> + <body bgcolor="#ffffff" topmargin="0" leftmargin="0" marginwidth="0" marginheight="0"> + <table class="toptable" width="100%" cellspacing="0" cellpadding="0" border="0" bgcolor="#000000"> + <tr><td width="160" height="129" align="left" valign="top"><a href="/"><img border="0" src="gentoo-doc.gif"/></a></td> + <td>&nbsp;</td></tr> + <tr> + <td colspan="2" class="doclink"> + <a href="/doc" style="color: #33ff00">documentation</a> :: <xsl:value-of select="title"/> + </td> + </tr> +</table> + <table class="secondtable" width="95%" cellspacing="0" cellpadding="2" border="0"> + <tr><td valign="top"> + <p class="dochead"><xsl:value-of select="title"/></p> + </td><td valign="top"> + <p class="info"> + <xsl:apply-templates select="author"/> + Version <xsl:value-of select="version"/>, <xsl:value-of select="date"/></p> + </td></tr> + <tr><td> + <p class="tochead">Summary</p> + <p class="abstract"> + <xsl:value-of select="abstract"/> + </p> + </td><td width="25%" valign="top"> + <p class="tochead">Table of contents:</p> + <p class="tocitem"> + <xsl:for-each select="chapter"> + <a href="#<xsl:value-of select="./@link"/>"> + <xsl:value-of select="title"/></a> + <br/> + </xsl:for-each> + </p> + </td> + </tr> +</table> + <xsl:apply-templates select="chapter"/> + </body> + </html> +</xsl:template> + +<xsl:template match="author"> +<xsl:choose> + <xsl:when test="@email"> + <![CDATA[<a href="mailto:]]><xsl:value-of select="@email"/><![CDATA[">]]> + <xsl:value-of select="."/><![CDATA[</a>]]> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="."/> + </xsl:otherwise> +</xsl:choose> +<xsl:if test="@title">, <i><xsl:value-of select="@title"/></i> +</xsl:if> +<br/> +</xsl:template> + +<xsl:template match="chapter"> + <a name="<xsl:value-of select="./@link"/>"> + <p class="chaphead"><xsl:value-of select="title"/></p></a> + <xsl:apply-templates select="section"/> +</xsl:template> + +<xsl:template match="section"> + <p class="secthead"><xsl:value-of select="title"/></p> + <xsl:apply-templates select="body"/> +</xsl:template> + +<xsl:template match="body"> + <xsl:copy-of select="./node()"/> +</xsl:template> + +</xsl:stylesheet> diff --git a/app-doc/gentoo-web/files/xsl/guide.xsl b/app-doc/gentoo-web/files/xsl/guide.xsl index 36454b15a36a..ac47ed20a658 100755 --- a/app-doc/gentoo-web/files/xsl/guide.xsl +++ b/app-doc/gentoo-web/files/xsl/guide.xsl @@ -1,6 +1,7 @@ <?xml version='1.0'?> <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> -<xsl:output method="xml" indent="yes"/> +<xsl:output method="html" indent="yes"/> +<xsl:preserve-space elements="pre"/> <xsl:template match="/guide"> <html> @@ -35,8 +36,8 @@ <p class="tochead">Table of contents:</p> <p class="tocitem"> <xsl:for-each select="chapter"> - <a href="#<xsl:value-of select="./@link"/>"> - <xsl:value-of select="title"/></a> + <xsl:variable name="chapid">doc_chap<xsl:number/></xsl:variable> + <a href="#{$chapid}"><xsl:number/>. <xsl:value-of select="title"/></a> <br/> </xsl:for-each> </p> @@ -44,38 +45,176 @@ </tr> </table> <xsl:apply-templates select="chapter"/> + <br/> + <br/> + <table class="tochead" width="100%" border="0"><tr><td align="right">Copyright 2001 Gentoo Technologies, Inc.<br/> + Questions, Comments, Corrections? Email <a href="mailto:gentoo-dev@gentoo.org">gentoo-dev@gentoo.org</a>.</td></tr></table> </body> </html> </xsl:template> +<xsl:template match="mail"> + <a href="mailto:{@link}"><xsl:value-of select="."/></a> +</xsl:template> + <xsl:template match="author"> -<xsl:choose> - <xsl:when test="@email"> - <![CDATA[<a href="mailto:]]><xsl:value-of select="@email"/><![CDATA[">]]> - <xsl:value-of select="."/><![CDATA[</a>]]> - </xsl:when> - <xsl:otherwise> - <xsl:value-of select="."/> - </xsl:otherwise> -</xsl:choose> -<xsl:if test="@title">, <i><xsl:value-of select="@title"/></i> -</xsl:if> -<br/> + <xsl:apply-templates /> + <xsl:if test="@title">, <i><xsl:value-of select="@title"/></i> + </xsl:if> + <br/> </xsl:template> <xsl:template match="chapter"> - <a name="<xsl:value-of select="./@link"/>"> - <p class="chaphead"><xsl:value-of select="title"/></p></a> + <xsl:variable name="chapid">doc_chap<xsl:number/></xsl:variable> + <a name="#{$chapid}"><p class="chaphead"><span class="chapnum"><xsl:number/>.</span> <xsl:value-of select="title"/></p></a> <xsl:apply-templates select="section"/> </xsl:template> <xsl:template match="section"> - <p class="secthead"><xsl:value-of select="title"/></p> + <xsl:variable name="sectid"><xsl:value-of select="$chapid"/>_sect<xsl:number/></xsl:variable> + <a name="#{$sectid}"><p class="secthead"><xsl:value-of select="title"/></p></a> <xsl:apply-templates select="body"/> </xsl:template> +<xsl:template match="figure"> + <table border="0"><tr><td> + <xsl:variable name="fignum"><xsl:number level="any"/></xsl:variable> + <xsl:variable name="figid">doc_fig<xsl:number/></xsl:variable> + <a name="#{$figid}"/> + <xsl:choose> + <xsl:when test="@short"> + <img src="{@link}" alt="Fig. {$fignum}: {@short}"/> + </xsl:when> + <xsl:otherwise> + <img src="{@link}" alt="Fig. {$fignum}"/> + </xsl:otherwise> + </xsl:choose> + </td></tr><tr><td class="tochead"> + <xsl:choose> + <xsl:when test="@caption"> + Figure <xsl:value-of select="$fignum"/>: <xsl:value-of select="@caption" /> + </xsl:when> + <xsl:otherwise> + Figure <xsl:value-of select="$fignum"/> + </xsl:otherwise> + </xsl:choose> + </td></tr></table> +</xsl:template> + +<xsl:template match="note"> + <p class="note"><b>Note: </b> + <xsl:apply-templates /> + </p> +</xsl:template> + +<xsl:template match="impo"> + <p class="impo"><b>Important: </b> + <xsl:apply-templates /> + </p> +</xsl:template> + +<xsl:template match="warn"> + <p class="warn"><b>Warning: </b> + <xsl:apply-templates /> + </p> +</xsl:template> + +<xsl:template match="codenote"> + <span class="comment">// <xsl:value-of select="." /></span> +</xsl:template> + +<xsl:template match="comment"> + <span class="comment"><xsl:apply-templates /></span> +</xsl:template> + +<xsl:template match="i"> + <span class="input"><xsl:apply-templates /></span> +</xsl:template> + <xsl:template match="body"> - <xsl:copy-of select="./node()"/> + <xsl:apply-templates /> +</xsl:template> + +<xsl:template match="c"> + <span class="code"><xsl:apply-templates /></span> +</xsl:template> + +<xsl:template match="pre"> + <xsl:variable name="prenum"><xsl:number level="any" /></xsl:variable> + <xsl:variable name="preid">doc_pre<xsl:number level="any" /></xsl:variable> + <a name="#{$preid}"/> + <p class="caption"> + <xsl:choose> + <xsl:when test="@caption"> + Code listing <xsl:value-of select="$prenum"/>: <xsl:value-of select="@caption" /> + </xsl:when> + <xsl:otherwise> + Code listing <xsl:value-of select="$prenum"/> + </xsl:otherwise> + </xsl:choose> + </p> + <pre> + <xsl:apply-templates /> + </pre> + </xsl:template> + +<!-- path is used for specifying files and URLs; if you are linking +part of a sentence rather than a path, then don't use this, use span instead--> +<xsl:template match="path"> + <span class="path"><xsl:value-of select="."/></span> +</xsl:template> + +<xsl:template match="uri"> + <xsl:choose> + <xsl:when test="@link"> + <a href="{@link}"><xsl:value-of select="."/></a> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="loc" select="."/> + <a href="{$loc}"><xsl:value-of select="."/></a> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + +<xsl:template match="p"> + <p class="para"><xsl:apply-templates /></p> +</xsl:template> + +<xsl:template match="e"> + <span class="emphasis"><xsl:apply-templates /></span> +</xsl:template> + +<xsl:template match="mail"> + <a href="mailto:{@link}"><xsl:value-of select="."/></a> +</xsl:template> + +<xsl:template match="table"> + <table><xsl:apply-templates /></table> +</xsl:template> + +<xsl:template match="tr"> + <tr><xsl:apply-templates /></tr> +</xsl:template> + +<xsl:template match="ti"> + <td class="tableinfo"><xsl:apply-templates /></td> +</xsl:template> + +<xsl:template match="th"> + <td class="tochead"><b><xsl:apply-templates /></b></td> +</xsl:template> + +<xsl:template match="ul"> + <ul><xsl:apply-templates /></ul> +</xsl:template> + +<xsl:template match="ol"> + <ol><xsl:apply-templates /></ol> +</xsl:template> + +<xsl:template match="li"> + <li><xsl:apply-templates /></li> </xsl:template> </xsl:stylesheet> + |