Browse Source

Update documentation to openrc/baselayout-2

master
Sven Vermeulen 11 years ago
parent
commit
316c4e1c05
  1. 3
      ChangeLog
  2. 6
      src/linux_sea.xml
  3. 30
      src/linux_sea/11-networkmanagement.xml
  4. 106
      src/linux_sea/12-servicemanagement.xml

3
ChangeLog

@ -1,3 +1,6 @@
** (2011-05-10) Sven Vermeulen <sven.vermeulen@siphos.be>
- Update to openrc / baselayout-2
** (2011-05-03) Sven Vermeulen <sven.vermeulen@siphos.be>
- Mention grub-static for x86_64 installations

6
src/linux_sea.xml

@ -66,12 +66,12 @@
probably need to know to continue working with Gentoo Linux.
</para>
<para>
The version you are reading currently is v1.4 and has been generated
on 2011/02/13.
The version you are reading currently is v1.5 and has been generated
on 2011/05/10.
</para>
</abstract>
<edition>Linux Sea v1.4</edition> <!-- Update above paragraph too!! -->
<edition>Linux Sea v1.5</edition> <!-- Update above paragraph too!! -->
<copyright>
<year>2009, 2010, 2011</year>

30
src/linux_sea/11-networkmanagement.xml

@ -259,17 +259,17 @@ nameserver 10.2.3.5</programlisting>
192.168.0.100, gateway 192.168.0.1 and netmask 255.255.255.0 and the
name servers are 10.2.3.4 and 10.2.3.5):</para>
<programlisting>config_eth0=( "192.168.0.100 netmask 255.255.255.0" )
dns_servers_eth0=( "10.2.3.4 10.2.3.5" )</programlisting>
<programlisting>config_eth0="192.168.0.100 netmask 255.255.255.0"
dns_servers_eth0="10.2.3.4 10.2.3.5"</programlisting>
<para>If you want to configure the interface to use DHCP
(automatically obtain IP address):</para>
<programlisting>config_eth0=( "dhcp" )</programlisting>
<programlisting>config_eth0="dhcp"</programlisting>
<para>For more examples on the Gentoo Linux network configuration
(with more advanced features), check out the
<filename>/etc/conf.d/net.example</filename> file.</para>
<filename>/usr/share/doc/openrc-*/net.example</filename> file.</para>
<para>To enable this support, you need to add the net.eth0 service to
the default runlevel and start the net.eth0 service.</para>
@ -302,11 +302,11 @@ dns_servers_eth0=( "10.2.3.4 10.2.3.5" )</programlisting>
... get ... it ... working. Yet.</para>
<para>However, development of wireless card support is - like I said -
actively being developed. Chances are that an unsupported card (or
chip set) now will be supported within 6 months.</para>
actively being developed. Chances are that an unsupported card (or chip
set) now will be supported within 6 months.</para>
<para>Generally speaking though, 80% to 90% of the wireless cards/chip sets
are supported under Linux.</para>
<para>Generally speaking though, 80% to 90% of the wireless cards/chip
sets are supported under Linux.</para>
<section>
<title>Supporting your Network Card</title>
@ -458,10 +458,10 @@ eth1 Scan completed :
the two networks (aaa and USR8022) are supported where aaa is the
preferred network.</para>
<programlisting>modules=( "iwconfig" )
<programlisting>modules="iwconfig"
key_aaa="key off"
key_USR8022="s:MyPassPhraze enc open"
preferred_aps=( "aaa" "USR8022" )</programlisting>
preferred_aps="'aaa' 'USR8022'"</programlisting>
<para>Once your wireless interface is connected to a wireless network,
you can use the IP configuration commands as shown earlier for wired
@ -714,7 +714,7 @@ network={
Gentoo's networking scripts as well. First, edit
<filename>/etc/conf.d/net</filename> to use wpa_supplicant:</para>
<programlisting>modules=( "wpa_supplicant" )
<programlisting>modules="wpa_supplicant"
wpa_supplicant_wlan0="-Dwext"</programlisting>
<para>To have the wireless support active when you boot up your
@ -765,10 +765,10 @@ wpa_supplicant_wlan0="-Dwext"</programlisting>
<programlisting># <command>rc-update add wicd default</command></programlisting>
<para>Next, make sure Gentoo doesn't start its own network configuration
by editing <filename>/etc/conf.d/rc</filename>, setting the
by editing <filename>/etc/rc.conf</filename>, setting the
following:</para>
<programlisting>RC_PLUG_SERVICES="!net.*"</programlisting>
<programlisting>rc_hotplug="!net.*"</programlisting>
<para>Now, start the wicd service (and shut down the services you are
currently using):</para>
@ -985,8 +985,8 @@ subnet 192.168.20.0 netmask 255.255.255.0 {
<primary>scp</primary>
</indexterm> (secure copy) you can copy files between systems. If
your source or destination (or both) are on a remote system, prepend
the source/destination folder with the host name or IP address followed
by a colon, like so:</para>
the source/destination folder with the host name or IP address
followed by a colon, like so:</para>
<programlisting>$ <command>scp thesis.tar.gz 192.168.2.1:/mnt/usb-stick</command></programlisting>

106
src/linux_sea/12-servicemanagement.xml

@ -218,7 +218,8 @@ Runlevel: default
<primary>alsasound</primary>
</indexterm> service is responsible for loading the appropriate
sound kernel modules (if they are known as modules) and
saving/restoring the sound configuration at boot-up / shut down.</para>
saving/restoring the sound configuration at boot-up / shut
down.</para>
<para>When the service is started, you might see kernel modules being
loaded in memory. However, no other processes are started as part of
@ -275,9 +276,10 @@ Runlevel: default
<programlisting># <command>touch /forcefsck</command></programlisting>
<para>On the other hand, if you want to ignore the file system checks,
create the <filename>/fastboot</filename><indexterm><primary>fastboot</primary></indexterm>
file. It too will be automatically
removed, this time when the system has booted.</para>
create the <filename>/fastboot</filename><indexterm>
<primary>fastboot</primary>
</indexterm> file. It too will be automatically removed, this time
when the system has booted.</para>
<para>Once the service has finished starting, no additional processes
will be running.</para>
@ -290,7 +292,7 @@ Runlevel: default
<primary>checkroot</primary>
</indexterm> service is responsible for checking the consistency of
the root file system. This service uses the same boot parameters
(forcefsck or fastboot) as the checkfs service. </para>
(forcefsck or fastboot) as the checkfs service.</para>
<para>The service is also responsible for remounting the root file
system read-write (by default it gets mounted read-only by the Linux
@ -349,8 +351,8 @@ Runlevel: default
<primary>host name</primary>
<secondary>service</secondary>
</indexterm> service is responsible for setting your systems'
host name based on the input of
</indexterm> service is responsible for setting your systems' host
name based on the input of
<filename>/etc/conf.d/hostname</filename>.</para>
<para>Once the service has finished starting, no additional processes
@ -456,8 +458,8 @@ Runlevel: default
<secondary>service</secondary>
</indexterm> service is responsible for launching the secure shell
daemon, which allows you to access your system from a remote location
(as long as the network / firewalls permit it) in a secure manner.
</para>
(as long as the network / firewalls permit it) in a secure
manner.</para>
<para>Once the service has finished starting, you will find the sshd
process running.</para>
@ -517,92 +519,20 @@ Runlevel: default
<title>General Service Configuration</title>
<para>Gentoo's general configuration file for the start-up service
behaviour is <filename>/etc/rc.conf</filename> and
<filename>/etc/conf.d/rc</filename>.</para>
behaviour is <filename>/etc/rc.conf</filename>.</para>
<section>
<title>/etc/rc.conf</title>
<para>Inside the <filename>rc.conf</filename> file, generic settings
which are (or might be) needed by several services can be configured.
The syntax is, as usual, "key=value".</para>
The syntax is, as usual, "key=value". Since openrc (new init system
for Gentoo), all settings are bundled in this file. Earlier systems
spread the configuration across <filename>/etc/rc.conf</filename> and
<filename>/etc/conf.d/rc</filename>. The latter is now
deprecated.</para>
<itemizedlist>
<listitem>
<para>UNICODE="yes" (or "no"), which specifies if you want to use
Unicode support at the console</para>
</listitem>
<listitem>
<para>EDITOR="/bin/nano" (or any other text editor), which
specifies the default text editor you want to use</para>
</listitem>
<listitem>
<para>XSESSION="Xfce4" (or any other supported graphical session
manager), which specifies the default graphical environment to
launch</para>
</listitem>
</itemizedlist>
</section>
<section>
<title>/etc/conf.d/rc</title>
<para>In the /etc/conf.d/rc file, you specify configuration settings
that affect or influence the system service handling behaviour. The
file contains lots of comments which should make it a bit easier to
work with. So consider the list below more of a small introduction
rather than a complete list. As usual, the syntax uses a key=value
set.</para>
<itemizedlist>
<listitem>
<para><parameter>RC_PARALLEL_STARTUP</parameter><indexterm>
<primary>RC_PARALLEL_STARTUP</primary>
</indexterm> ("yes" or "no") informs the system service handling
to attempt to start services in parallel as much as
possible.</para>
</listitem>
<listitem>
<para><parameter>RC_NET_STRICT_CHECKING</parameter><indexterm>
<primary>RC_NET_STRICT_CHECKING</primary>
</indexterm> ("none", "lo", "no", "yes") informs the system when
it should consider networking to be available:</para>
<itemizedlist>
<listitem>
<para>none = networking is always available</para>
</listitem>
<listitem>
<para>lo = networking is available the moment the loopback
interface (lo) is available</para>
</listitem>
<listitem>
<para>no = networking is available the moment at least one
non-loopback interface is available</para>
</listitem>
<listitem>
<para>yes = networking is available when all non-loopback
interfaces are available</para>
</listitem>
</itemizedlist>
<para>The <emphasis>loopback interface</emphasis><indexterm>
<primary>loopback interface</primary>
</indexterm> is a surreal interface which only supports local
traffic (localhost, 127.0.0.1). Linux by default enables this
interface (it is a kernel configuration) so that one can work with
networking tools even if the system isn't on any network. It also
makes the development of certain applications a lot easier once
they can assume some networking is available (even if it is "just"
localhost).</para>
</listitem>
</itemizedlist>
<para>The file is pretty well documented.</para>
</section>
</section>