[Lunar-commits] r15693 - lunar-doc/trunk/lunar-manual

ca3sar ca3sar at lunar-linux.org
Mon Jul 11 22:33:43 UTC 2005


Author: ca3sar
Date: 2005-07-11 22:33:38 +0000 (Mon, 11 Jul 2005)
New Revision: 15693

Modified:
   lunar-doc/trunk/lunar-manual/1installation.tex
   lunar-doc/trunk/lunar-manual/2using_lunar.tex
   lunar-doc/trunk/lunar-manual/3troubleshooting.tex
   lunar-doc/trunk/lunar-manual/4inside_lunar.tex
   lunar-doc/trunk/lunar-manual/5getting_to_work.tex
   lunar-doc/trunk/lunar-manual/6development.tex
Log:
fixed minor things, added docu for lunar tool and some module description

Modified: lunar-doc/trunk/lunar-manual/1installation.tex
===================================================================
--- lunar-doc/trunk/lunar-manual/1installation.tex	2005-07-11 20:36:12 UTC (rev 15692)
+++ lunar-doc/trunk/lunar-manual/1installation.tex	2005-07-11 22:33:38 UTC (rev 15693)
@@ -61,21 +61,19 @@
 
 When u made a selection the menu point will change its color to green. In the keyboard map choose the one apropriate for you. Most americans will need \textit{us} while germans may need \textit{de} and danish people \textit{dk}.  The language setting should explain itself ;) %console font ?? wtf should one choose ? this is really cryptic for me. 
 
-You will also need to choose an editor, as you are going to need one later on in the installation for setting up your lilo or grub configuration. The six choices available are vi, joe, nano, e3, emacs and zile. If you have never used a text editor in linux before, nano is the best choice for you. If you skip the Native Language Support option, the system will install the default editor, nano  for you. Now press \textit{F} to get one step forward. \par
+You will also need to choose an editor, as you are going to need one later on in the installation for setting up your lilo or grub configuration. The six choices available are \lstinline{vi}, \lstinline{joe}, \lstinline{nano}, \lstinline{e3}, \lstinline{emacs} and \lstinline{zile}. If you have never used a text editor in linux before, \lstinline{nano} is the best choice for you. If you skip the Native Language Support option, the system will install the default editor, \lstinline{nano}  for you. Now press \textit{F} to get one step forward. \par
 
 \section{Setting Up Partitions}
 
+The next step is to set up partitions on your hard drive. Upon selecting the \lstinline"Partition Drive" option, you will be shown a list of all the discs the kernel has detected. If we assume that you have one hard drive connected via an IDE channel, which will show up in the menu as \lstinline"disc0". After selecting the disc to partition, you are given the option of using one of three partitioning programs. They are:
 
-
-The next step is to set up partitions on your hard drive. Upon selecting the "Partition Drive" option, you will be shown a list of all the discs the kernel has detected. If we assume that you have one hard drive connected via an IDE channel, which will show up in the menu as "disc0". After selecting the disc to partition, you are given the option of using one of three partitioning programs. They are:
-
 \begin{itemize}
-\item     cfdisk -- A menu driven partitioner, and very easy to use. If you are unfamiliar with various partitioning programs, this is the best option for you.
-\item      fdisk -- Text based partitioner that requires a little more know-how than cfdisk. More experienced users will probably use this program. However new users should not be daunted, as it does have help offered at every step. You can leave by pressing \textit{q }and \textit{enter}
-\item     parted -- Text based partitioner that is good for advanced users. Parted is excellent for resizing current partitions on your hard disk, however be forewarned that resizing partitions is an excellent way to hose your entire disc.
+\item     \lstinline{cfdisk} -- A menu driven partitioner, and very easy to use. If you are unfamiliar with various partitioning programs, this is the best option for you.
+\item      \lstinline{fdisk} -- Text based partitioner that requires a little more know-how than cfdisk. More experienced users will probably use this program. However new users should not be daunted, as it does have help offered at every step. You can leave by pressing \textit{q }and \textit{enter}
+\item     \lstinline{parted} -- Text based partitioner that is good for advanced users. Parted is excellent for resizing current partitions on your hard disk, however be forewarned that resizing partitions is an excellent way to hose your entire disc.
 \end{itemize}
 
-For our example, we have one 40GB IDE drive and we'll set up six partitions; /, /boot, /home, /usr, /var, and a swap partition. It's a good idea to keep certain directories, such as /var and /usr on separate partitions, as this can save you a lot of headache in the future incase your disk ever completely fails on you and you need to recover data (god forbid!). Also, when you have a separate /boot partition as we have in our example, you need to have your partitioning program mark that partion as active or bootable. In our example, if we were using fdisk, you would press "a" at the command line, and then select part1 as the active partition.\par
+For our example, we have one 40GB IDE drive and we'll set up six partitions; /, /boot, /home, /usr, /var, and a swap partition. It's a good idea to keep certain directories, such as /var and /usr on separate partitions, as this can save you a lot of headache in the future incase your disk ever completely fails on you and you need to recover data (god forbid!). Also, when you have a separate /boot partition as we have in our example, you need to have your partitioning program mark that partion as active or bootable. In our example, if we were using \lstinline{fdisk}, you would press "a" at the command line, and then select part1 as the active partition.\par
 
 If you are installing on a machine together with an other OS you perform these steps in the unpartitioned space and leave the other partitions untouched. For installation on different disks just choose the other disk (disc1 ... )  \par
 
@@ -119,7 +117,7 @@
 
 After setting up your partitions, you need to mount them and create file systems. Select the menu option "Select Target Partitions" and verify that you are indeed done creating partitions.\par
 
-The installer will warn you at this point that the root partition (as in "/", not "/root") needs to be mounted first. Select the disc that the root partition should be on. In our example, we are going to use disc0. Our root partition is going to be on disc0/part2 then we select which filesystem we would like to use.\par
+The installer will warn you at this point that the root partition (as in "/", not "/root") needs to be mounted first. Select the disc that the root partition should be on. In our example, we are going to use \lstinline{disc0}. Our root partition is going to be on \lstinline{disc0/part2} then we select which filesystem we would like to use.\par
 
 \begin{itemize}
   \item     ext2 (Second Extended File System) -- Version 2 of the Extended File System, which was designed for linux as a replacement for the Minix Filesystem. Ext2 is not a journaled filesystem, which means that you'll need to perform disc recovery operations after a power failure or other such system crash. This filesystem is available with all kernels on the ISO.
@@ -143,7 +141,7 @@
 \caption{Transfering Lunar Linux}
 \end{figure}
 
-Next, we need to transfer the core Lunar system to the partitions that you now have created. Select "Install Lunar", and the system will proceed to tansfer all of the neccessary files for you. Be forewarned that the /usr transfer can take some time, espescially on older or slower systems, so don't panic and think that your system has frozen. It's just doing its thing.\par
+Next, we need to transfer the core Lunar system to the partitions that you now have created. Select \lstinline"Install Lunar", and the system will proceed to tansfer all of the neccessary files for you. Be forewarned that the /usr transfer can take some time, espescially on older or slower systems, so don't panic and think that your system has frozen. It's just doing its thing.\par
 
 
 
@@ -165,7 +163,7 @@
 
 Next we have the platform selection. This question would seem to be rather silly, since our ISO only boots up on x86 systems, but we like to plan for the future. You'll want to say x86 here.\par
 
-Now we move onto the basic optimizations . As you can see, the options speak for themselves. Your choice depends on what your needs are. Most folks will want to use -O2 / faster here, as it is the wisest choice. More advanced users may want to use the -O3 / fastest option, but it's not for everyone. If you're short on disk space, you would take the -Os /  Small option. \footnote{As an example, we used -Os for the ISO since we were working within a confined amount of disc space.} Those of you with older or slower systems that wouldn't be able to take advantage of faster optimizations may choose a more conservative setting like -O1 / fast . For our example system, we will choose -O2.\par
+Now we move onto the basic optimizations . As you can see, the options speak for themselves. Your choice depends on what your needs are. Most folks will want to use -O2 / faster here, as it is the wisest choice. More advanced users may want to use the -O3 / fastest option, but it's not for everyone. If you're short on disk space, you would take the -Os /  Small option. \footnote{For example, we used -Os for the ISO as we were working within a fixed amount of disc space.} Those of you with older or slower systems that wouldn't be able to take advantage of faster optimizations may choose a more conservative setting like -O1 / fast . For our example system, we will choose -O2.\par
 
 After choosing your basic optimization level, you'll need to tell the compiler what type of processor you have. This may seem unimportant, however the GCC 3.x compiler has ways of optimizing code for certain processors, even though they all may be x86 based. For example, GCC 3.x has certain optimizations it can perform on code for Pentium 4 machines, but not for Pentium 3. Our example machine is a Pentium 3, so we are going to select that.\par
 
@@ -190,7 +188,7 @@
 
 Some options involves setting up the number of concurrent makes and stack parameters. As the hint mentions on the "Concurrent Makes" screen, you'll want to enter in the number of cpu's your machine has. Unless you have a machine with more than one processor, you'll want to leave this field blank. The stack parameters is also fairly straightforward. The warning on that screen says that this field is best left empty, and so that is exactly what we will do with our example. \par
 
-We are now finished setting up our GCC optimizations! When you have you lunar system up and running, you can always change and tweak these GCC settings by typing "lunar" at the commandline prompt, and going to "Optimization Settings". In addition, if you aren't that familiar with what your processor is capable of using for optimizations, you can go to the shell out option on the ISO and type
+We are now finished setting up our GCC optimizations! When you have you lunar system up and running, you can always change and tweak these GCC settings by typing \lstinline"lunar" at the commandline prompt, and going to \lstinline"Optimization Settings". In addition, if you aren't that familiar with what your processor is capable of using for optimizations, you can go to the shell out option on the ISO and type
 
 
 \begin{lstlisting}
@@ -199,7 +197,8 @@
 
 
 at the prompt and the system will show you all the optimizations that the processor reports it can handle.\par 
-Now we can install the bootloader Package. Lunar offers you three choices: Lilo, Grub and None. Most people would want to choose Lilo, as it is easy to install, the configuration will take place after the kernel installation.
+Now we can install the bootloader Package. Lunar offers you three choices: Lilo, Grub and None. Most people would want to choose Lilo, as it is easy to install, the configuration will take place after the kernel installation. \par
+\textbf{Note}:  At the moment, lilo fails to build on 2.6 kernels. That mean, if you consider to switch to Kernel 2.6 later, its wise to choose grub. See Section \ref{lilo2grub} to get a introduction, if you are familiar only with lilo. 
 
 \section{Building Your Customized Linux Kernel}
 
@@ -234,16 +233,14 @@
 The final question before you begin is which type of configuration method you would like to use.\par
 
 \begin{itemize}  
-\item     config -- The original way to configure the linux kernel. It is completely text based, and assumes you know what everything is. Unless you've been using linux since its inception, you probably don't want to use this method.
-\item   menuconfig -- As the name implies, a menu driven version of the kernel configuration. This is the easiest, and by far the most popular way of configurating your kernel.
-\item   xconfig -- If you have an X server running, you can use this option to configure your kernel using a nifty GUI interface. You won't be able to use this on the ISO, but once your system is up and running with X, you can use this option. If you do choose this option while installing from the ISO, the system will fall back to next available configuration method, in this case menuconfig, so there is no harm in selecting it if you do.
+\item     \lstinline{config} -- The original way to configure the linux kernel. It is completely text based, and assumes you know what everything is. Unless you've been using linux since its inception, you probably don't want to use this method.
+\item   \lstinline{menuconfig} -- As the name implies, a menu driven version of the kernel configuration. This is the easiest, and by far the most popular way of configurating your kernel.
+\item   \lstinline{xconfig} -- If you have an X server running, you can use this option to configure your kernel using a nifty GUI interface. You won't be able to use this on the ISO, but once your system is up and running with X, you can use this option. If you do choose this option while installing from the ISO, the system will fall back to next available configuration method, in this case menuconfig, so there is no harm in selecting it if you do.
 \end{itemize}
 
-For our example, we are going to use menuconfig. Once Lunar is finished applying the patches for the kernel, which can take a minute or two, you'll be brought to the configuration screen for the linux kernel. Once you have completed configuring your kernel, you'll get one more prompt from the installer asking if you want to go back to the configuration in case you exited by mistake or forgot something. If everything is good to go, say no here and sit back for a few minutes while your kernel compiles.\par
+For our example, we are going to use \lstinline{menuconfig}. Once Lunar is finished applying the patches for the kernel, which can take a minute or two, you'll be brought to the configuration screen for the linux kernel. Once you have completed configuring your kernel, you'll get one more prompt from the installer asking if you want to go back to the configuration in case you exited by mistake or forgot something. If everything is good to go, say no here and sit back for a few minutes while your kernel compiles.\par
 
 
-
-
 \section{Configuring Your Bootloader} \label{bootl}
 
 \subsection{Lilo}
@@ -277,12 +274,11 @@
 \end{lstlisting}
 
 as you see in this configuration Windows is installed on /dev/hda1, which is the first partition on your hdd. It will appear as "Windows" in the boot menu.  \par
-\textbf{Note} The partition needs to be marked as "bootable". 
+%\textbf{Note} The partition needs to be marked as "bootable".    really ?????
 
 \subsection{Grub}
 
-%there is something from nestu in svn about this... put it in here pal !
-If you chose grub as your bootloader, you will need to set up the configuration file entirely on your own. An example would be: \\
+If you chose grub as your bootloader, you will need to set up the configuration file. An example would be: \\
 
 \begin{lstlisting}
 default   0 
@@ -291,10 +287,11 @@
 title    linux-2.4.20 
 root    (hd0,0) 
 kernel  /vmlinubz-2.4.25-r5.0.0 root=/dev/hda2 devfs=nomount  
- \end{lstlisting}
+\end{lstlisting}
 
 
 As we mentioned earlier in the partitioning section, you would want to mark your /boot partition as active. With grub it is imperative that you mark your /boot partition as active, otherwise grub will not work at all when you are finished with the installation and reboot to your new system.\par
+\textbf{Note}: For further information regarding \lstinline{grub} see section \ref{lilo2grub}
 
 
 \section{Installing The MBR}
@@ -313,7 +310,7 @@
 
 After the kernel is finished you will end up at the kernel choosing screen. You need to choose exit and can now set the passwort for the root account. Choose a good password, like G49dN448e . A not so good password would be your name, your birthday or some other word that actually makes sense.\par
 
-\textbf{Note:} Never choose this account as your default user. This would be a great security risk, as root can do everything with your system. \textbf{Always} use an other user that is even not in the root group and has no other privileged rights. Other popular OS are in to deep trouble because of an other default setting in this place ... \par
+\textbf{Note:} Never choose this account as your default user. This would be a great security risk, as root can do everything with your system. \textbf{Always} use an other user that is even not in the root group and has no other privileged rights. Other popular OS are in to deep trouble, because of an other default setting in this place. \par
 
 \section{Setting Up Networking, Services and other bits}
 

Modified: lunar-doc/trunk/lunar-manual/2using_lunar.tex
===================================================================
--- lunar-doc/trunk/lunar-manual/2using_lunar.tex	2005-07-11 20:36:12 UTC (rev 15692)
+++ lunar-doc/trunk/lunar-manual/2using_lunar.tex	2005-07-11 22:33:38 UTC (rev 15693)
@@ -4,7 +4,8 @@
 \section{First Steps}
 %update of lunar and moonbase etc
 
-After the successful installation the whole world of Lunar Linux awaits you. You will see the advice to read man \lstinline{lfirsttime}, which will give a good introduction to the handling of Lunar. In many points its quite redundant to whats presented in this chapter. Further you are reminded of the tools the developers wrote for you, to make configuration easier. For example \lstinline{lnet} and \lstinline{lservices}. See chapter \ref{tlhelp} for more details about them.
+After the successful installation the whole world of Lunar Linux awaits you. You will see the advice to read  \lstinline{man lfirsttime}, which will give a good introduction to the handling of Lunar. In many points its quite redundant to whats presented in this chapter. Further you are reminded of the tools the developers wrote for you, to make configuration easier. For example \lstinline{lnet} and \lstinline{lservices}. See chapter \ref{tlhelp} for more details about them. \par
+In Lunar, software packages are called \textbf{modules} and are listed in the \textbf{moonbase}\footnote{More details in \ref{mbase}}. When you install a module,  the source code is downloaded and compiled. You can see a list with \lstinline{lvu moonbase} and on the website. If a module has optional components, it will ask you, if they are needed. \par
 
 \subsection{Setting up and testing the network}
 
@@ -18,10 +19,10 @@
 ping google.com
 \end{lstlisting}
 
-       If it doesn't work you may be having a name resolution problem, try pinging to the IP address instead of the name.
+If it doesn't work you may be having a name resolution problem, try pinging to the IP address instead of the name.
 
 \begin{lstlisting} 
- ping 216.239.57.99
+ping 216.239.57.99
 \end{lstlisting}
 
  If pinging to IP is working but pinging to name fails, check the /etc/resolv.conf file and see if the nameserver entries are there. You  may also want to check the man page, \lstinline{man resolv.conf} if you are not familiar with the entries which should be in that file.
@@ -114,7 +115,7 @@
 
 \paragraph{Optimizations}
 
-Set the right optimizations for your computer. Beware that changing your optimizations to the wrongly values might actually break your whole installations so be really carefull about what you're chosing. The ISO has been built with a minimum of available optimizations to ensure the highest amount of flexibility. To see wether or not your processor supports a certain feature try a cat /proc/cpu. It usually shows the available settings that suit your machine.
+Set the right optimizations for your computer. Beware that changing your optimizations to the wrongly values might actually break your whole installations so be really carefull about what you're chosing. The ISO has been built with a minimum of available optimizations to ensure the highest amount of flexibility. To see wether or not your processor supports a certain feature try a \lstinline{cat /proc/cpu}. It usually shows the available settings that suit your machine.
 
 \paragraph{Integrity checking}
 

Modified: lunar-doc/trunk/lunar-manual/3troubleshooting.tex
===================================================================
--- lunar-doc/trunk/lunar-manual/3troubleshooting.tex	2005-07-11 20:36:12 UTC (rev 15692)
+++ lunar-doc/trunk/lunar-manual/3troubleshooting.tex	2005-07-11 22:33:38 UTC (rev 15693)
@@ -2,7 +2,7 @@
 
 \section{Solving Linux Problems}
 
-Lunar Linux is a community project. As the community is rather small compared to other distributions, we don't have an all in one solution for everything.  This has the advantage that in many aspects you are dealing with a more pure Linux,  which means Lunar doesn't hide the complexity of the system from you with an "easy to click" setup tool; Its ideal suited to learn a lot of things about Linux. But what to do if things doesn't work ?
+Lunar Linux is a community project. As the community is rather small compared to other distributions, we don't have an all in one solution for everything.  This gives the advantage that in many aspects you are dealing with a more "pure" Linux,  which means Lunar doesn't hide the complexity of the system from you with an "easy to click" setup tool; Its ideal suited to learn a lot of things about Linux. But what to do if things doesn't work ?
 
 \subsection{RTFM: \textbf{R}ead \textbf{T}he \textbf{F}riendly \textbf{ M}anual}
 
@@ -32,7 +32,7 @@
 
 \begin{itemize}    
 \item Write to the forum. It is located at \textit{lunar-linux.org} under "feedback"
-\item You can ask the Lunar Linux mailinglist. Subscribers are welcome under \textit{http://foo-projects.org/mail-man/listinfo/lunar }
+\item You can ask the Lunar Linux mailinglist. Subscribers are welcome under \\ \textit{http://foo-projects.org/mail-man/listinfo/lunar }
 \item Ask the Lunar Linux developers in \textit{\#lunar} on a freenode irc server. You can use the modules \lstinline{xchat }or \lstinline{bitchx }for this.
 \end{itemize}
 
@@ -64,7 +64,7 @@
 \item Addon program support: CCache (make sure to install it first).
 \end{itemize}
 
-\textbf{ Note}: These settings should work for almost everyone, and there is a lot room for pushing these optimizations more (at the risk of problems with apps). Read "info gcc" and make sure you understand a given optimization \textbf{before}  you enable it!
+\textbf{ Note}: These settings should work for almost everyone, and there is a lot room for pushing these optimizations more (at the risk of problems with apps). Read \lstinline"info gcc" and make sure you understand a given optimization \textbf{before}  you enable it!
 
 \paragraph{Q: What optimizations are known to cause problems?} \par
 
@@ -94,7 +94,7 @@
 \item -fbranching-probabilities
  \end{itemize}
 
-Note:Read \lstinline{info gcc} and make sure you understand a given optimization \textbf{ before} you enable it! The Lunar-Devs have no sympathy for bug-reports of the nature "Why can't I compile a given module, when my optimizations are: (long list of \textbf{unsafe} optimizations!)"
+\textbf{Note}:Read \lstinline{info gcc} and make sure you understand a given optimization \textbf{ before} you enable it! The Lunar-Devs have no sympathy for bug-reports of the nature "Why can't I compile a given module, when my optimizations are: (long list of \textbf{unsafe} optimizations!)"
 
 
 \subsection{Installing modules}
@@ -126,7 +126,7 @@
 
  you would then get a softlink to nowhere under /usr/include/.
 
-\item   Last, you can always try to unpack the kernel tarball you have into /usr/src/linux and manaully link or copy the headers over yourself.
+\item   Last, you can always try to unpack the kernel tarball you have into /usr/src/linux and manually link or copy the headers over yourself.
 \end{enumerate}
 
  \paragraph{Q: how do i add other window managers to the sessions on gdm i'd like to get kde and xfce setup} \par

Modified: lunar-doc/trunk/lunar-manual/4inside_lunar.tex
===================================================================
--- lunar-doc/trunk/lunar-manual/4inside_lunar.tex	2005-07-11 20:36:12 UTC (rev 15692)
+++ lunar-doc/trunk/lunar-manual/4inside_lunar.tex	2005-07-11 22:33:38 UTC (rev 15693)
@@ -1,17 +1,136 @@
 \chapter{Inside Lunar Linux} \label{inside}
-more detailed
+In this chapter we describe the way lunar works in more detail. You will learn, more about the core tools and the way Lunar manages and installes its packages\footnote{Called modules}. For even more detail refer to \ref{devel}.
 \section{Core Tools}
-docu of lin lvu lunar etc etc
-much more detail than above.
-\subsection{$lin$}
-\subsection{$lvu$}
+Here you find the reference of the core tools. You can also get help by typing \lstinline{man COMMAND}. \lstinline{lunar} has a graphical interface, while the others  are console based, but more flexible. 
+\subsection{\lstinline{lunar}}
 
-\subsection{Admins Tiny Little Helpers}\label{tlhelp}
+This is somewhat the "GUI" of Lunar linux. Most tasks you will need to do at the beginning can be comfortably made from here. 
+
+\begin{lstlisting}
+root at myshinybox / # lunar 
+\end{lstlisting}
+
+What you will get is: 
+
+When selecting an option you will always be presented a helpfull hint in the bottom line.\par
+\begin{itemize}
+\item The whole Module management lies in the first option (module). There you can add modules to the queue, to \textit{install} and \textit{uninstall} packages. Further you can initate an \textit{update} and a \textit{rebuild}. Sometimes it usefull to set modules on hold. For example: \lstinline{lilo} does not build on systems with kernel 2.6. So you would not want it to be update or recompiled when running this kernel. Set it on hold, and Lunar will leave it alone. When using the \textit{install} option you will see a long module description on selction. If you dont need take a look at the \textit{select} option for a faster method to do your module management.\\
+\textbf{Note}: To install a module you need to select foreground or background execute in the main menu after selecting coosing it here. \\
+\textbf{Note}: Be carefull with the rebuild option. If you are not sure what you are doin, leave it alone. It will most likely break the box.\\
+\textbf{Note}: If you want to recompile a module via \lstinline{lunar} or \lstinline{lin -rc} and it exits without a message, look if the module is on hold\par
+
+\item Under \textit{Options} you can configure Lunar's behaviour.\\
+\begin{itemize}
+\item You can choose the "Default Lunar Module", where theedge ist the unstable and lunar is the unstable version. Don't let confuse yourself, they are both called via the \lstinline{lunar} command. For a production environment lunar ist strongly recommended.\\
+\item \textit{Prompt Delay} refers to the time to wait for user input, when a optional function of module can be installed. Default is 150 seconds.\\
+\item Under \textit{Download Options} you handle active/passive ftp downloads\footnote{important for people behind a firewall or NAT}, resuming aka \textit{Partial Downloads}, \textit{Cache Usage} (lunar saves copies of the source code and the compiled files), the \textit{Number Of Retries} if a mirror doesn't provide a tarball, the \textit{Proxies} you need for download, the maximum \textit{Download Rate} lunar shall use, the \textit{Exhausive} use of all mirror available and time after which the CVS is updated.\\
+\item One menu up, you can change the \textit{Admins Email} where for example reports are mailed to.\\
+\item The \textit{Features Menu} lets you set various kinds of options,  the hints are self explaining, we think ;) \\
+ \item In \textit{Integrity Checking} you can choose the amount of checks made when \lstinline{lunar fix} is run. More option provide higher security, but checking takes time. \\
+\item \textit{Software Mirrors} give the mirrors Lunar looks for certain packages. For example sourceforge or kde or gnome mirrors. select the one nearest to you, so you get a good download rate. In "LRESORT" you find fall back mirrors, if a file just can't be found.\\
+\item \textit{Optimize Architecture} lets you change the compiler options. \\
+\textbf{Note}: Be carefull with thos compiler options. Only deactivate the safe option, if you really really know what you are doing. Unsafe options are not supported by the community. Use them at your own risk ! \par
+\end{itemize}
+\item \textit{Log}s can be viewed, edited and removed in the next menu point. You can even search (grep) them for certain keywords.\par
+
+\item The \textit{ Queue} menu manages the install and remove queue of modules, you have chosen before. \par
+
+\item The \textit{Maintaince} Menu point provides Lunar's self checking algorithms. The checks can take a time, so grab yourself a tea, when executing them. \par
+
+\item\textit{Foreground} and \textit{Background Execute} lets you run the install/remove queue as foreground process or as background process.
+\end{itemize}
+
+\subsection{Moonbase}
+
+\subsection{\lstinline{lin}}
+
+This is the installation command, which tells Lunar to install a package from the moonbase.
+
+\subsection{\lstinline{lrm}}
+\subsection{\lstinline{lvu}}
+\subsection{\lstinline{lget}}
+\section{Admins Tiny Little Helpers}\label{tlhelp}
 \paragraph{lservices}\label{lserv}
 \paragraph{lnet}\label{lnet}
+\paragraph{luser}
 
- lsevices, luser  etc etc ?
+\section{Inside the Components}
+\subsubsection{Moonbase}\label{mbase}
+\subsubsection{Module Compilation}
+\subsubsection{Filesystem}
+\section{Modules}
 
+As Lunar works with a set of bash scripts, modules are basically bash scripts. If you want to play around with module, we recommend you the \lstinline{lvu edit $MODULE}.
+It copies the module to the zlocal section of the moonbase, so can edit it with keeping the original unchanged. If you enable \lstinline{lunar} $\rightarrow$ option menu $\rightarrow$ feature menu $\rightarrow$ \lstinline{ZLOCAL_OVERRIDES} value, you install your own version like the default moonbase version.\\
+The \lstinline{lvu submit} command lets you send a changed or new module to the mailing list, where the devs take a look at it\footnote{Be sure to subscribe before doing so. See Chapter \ref{comty}}. If its good enough to be signed of it will be placed in the moonbase. See Chapter \ref{devel} for a more detailed discussion of module bullding. \par
+In \lstinline{/usr/share/doc/lunar} you can find a "skeleton" module to take a look at. \par
+
+\subsection{DETAILS}
+
+Required for any module. This file contains the data needed to obtain, describe and update a package. In here vital information like download URL's, version numbers and package description is put.
+
+\subsection{DEPENDS}
+
+This file lists packages that need to be installed before you can install this package. It doesn not necessary have to be a library, but can also be include files or anything that you would need to compile, install and run the module. \par
+
+In here you can als list optional depends, being packages that do not necessary have to be installed, for instance packages that add extra features (e.g. fonts, plugins etc.).
+
+\subsection{CONFLICTS}
+
+Modules listed in here must not be present when installing this module. Use this to separate your module from incompatible other ones. For instance the \lstinline{BitchX} module is incompatible with the gtk version \lstinline{gtkBitchX}, so these 2 modules have eachother listed in their \lstinline{CONFLICTS} file. Another good example is conflicting daemons like \lstinline{sendmail} vs. \lstinline{exim}, \lstinline{cron} vs. \lstinline{hc-cron} etc. 
+
+\subsection{BUILD}
+
+This script will configure, make and install the package. You can virtually control everything in here, like adding patches (kernel), changing build options (xfree86) or asking the user for configuration options (sendmail). This script does not have to exist for programs that \lstinline{./configure && make && make install} (lin will automatically \lstinline{--prefix=/usr} for you), but a lot of modules need adjusting. 
+
+\subsection{CONFIGURE}
+
+This file serves as an alternative way to customize the configuring of the package. 
+
+\subsection{PRE\_BUILD}
+
+This file is used if you need to apply patches or modifications before the package is built. 
+
+\subsection{POST\_BUILD}
+
+Use this file if you need to tweak the compiles sources before it is installed.
+
+\subsection{PRE\_INSTALL}
+
+This file lets you prepare the installation process for the package. 
+
+\subsection{POST\_INSTALL}
+
+When you need to additionally tweak things after installation, this is the place. Actions in this file are not logged in the install log, so you can e.g. create machine dependant configuration options that need to be kept in case of module removal. \par
+
+This is also the place to install and run daemons, reconfigure LILO etc..
+
+\subsection{PRE\_REMOVE}
+
+This script will be called before a module is lrm'ed. You can use it to back up configuration, stop daemons or similar stuff.
+
+\subsection{POST\_REMOVE}
+
+Use this file to clean stuff up after removing a module, or place configuration files in a backup location, etc..
+
+\subsection{other files and directories}
+
+Nothing withholds you from putting much more stuff in your module directory, think of patches, small scripts, init.d scripts, xinetd or pam.d configuration files, or funky ascii art to make your module install look nice. \par 
+
+As a general rule you must try to keep the module as small as possible however. For instance, if you were to put a 100K patch in the module directory, every lunar update requires that people download those 100K, whether they use your patch or not. If you must, try to provide the patch or extra source code in a way that we can put it on our source mirror, or insert it as a secondary source URL in case someone has already provided it on the internet. This will save us from a lot of frustration. \par
+
+Some contents of subdirs are automatically handled, here's a list:
+
+\begin{itemize}
+\item  pam.d         - for pam settings
+\item   xinetd.d      - for xinetd service definitions
+\item  init.d        - for init.d startup scripts
+\item  profile.d     - for bash shell settings
+\end{itemize}
+
+The file 'services' can be used to add tcp/ip or udp service port definitions automatically in coherence with xinetd.d to the /etc/services global file
+
+
 \section{Handling /dev Devices}\label{devnode}
 
 \subsection{A little background}
@@ -20,7 +139,7 @@
 
 \subsection{Static device nodes}
 
-/dev content is permanent, on a real permanent filesystem (like ext3, XFS, reiser...). All the needed nodes are present, or are created with a mknod command. You can also create nodes with the makedev utility. \par
+/dev content is permanent, on a real permanent filesystem (like ext3, XFS, reiser...). All the needed nodes are present, or are created with a \lstinline{mknod} command. You can also create nodes with the \lstinline{makedev} utility. You can find the list of device nodes with major and minor number at: \textit{/usr/src/linux/Documentation/devices.txt} \par
 
 \subsection{Dynamic device nodes}
 
@@ -84,7 +203,7 @@
 To add a commandline param in lilo, you have to use the append label. Taking dev=udev as an example:
 
 \begin{lstlisting} 
-image=/boot/vmlinuz	label=awesomekernel	root=/dev/hda2	append="dev=udev video=radeonfb:1152x864-16 at 60"
+image=/boot/vmlinuz	label=awesomekernel	root=/dev/hda2	append="dev=udev 
 \end{lstlisting}
 
 If you have prompt set in your lilo.conf, you can even write the option just before the kernel you want loads.
@@ -96,7 +215,7 @@
 \begin{lstlisting}
 title awesomekernel
 root (hd0,1)
-kernel /boot/vmlinuz root=/dev/hda1 dev=udev video=radeonfb:1152x864-16 at 60 
+kernel /boot/vmlinuz root=/dev/hda1 dev=udev 
 \end{lstlisting}
 
 Don't forget that in grub you can edit the kernel label line on boot.
\ No newline at end of file

Modified: lunar-doc/trunk/lunar-manual/5getting_to_work.tex
===================================================================
--- lunar-doc/trunk/lunar-manual/5getting_to_work.tex	2005-07-11 20:36:12 UTC (rev 15692)
+++ lunar-doc/trunk/lunar-manual/5getting_to_work.tex	2005-07-11 22:33:38 UTC (rev 15693)
@@ -223,11 +223,11 @@
 
 \subsection{Usefull Links}
 
-"Is Linux Kernel 2.6 Primed for the Enterprise?", 
-http://www.enterpriseitplanet.com/networking/features/article.php/3321801
+"Is Linux Kernel 2.6 Primed for the Enterprise?", \\
+\lstinline{http://www.enterpriseitplanet.com/networking/features/article.php/3321801}
 
-"Linux 2.6.0: What's New"
-http://www.osdl.org/newsroom/press\_releases/2003/2003\_12\_18\_beaverton\_2\_6\_new.html
+"Linux 2.6.0: What's New" \\
+\lstinline{http://www.osdl.org/newsroom/press\_releases/2003/2003\_12\_18\_beaverton\_2\_6\_new.html}
 
 \section{Grub}\label{lilo2grub}
 %from nestu lilo to grub howto in svn ...

Modified: lunar-doc/trunk/lunar-manual/6development.tex
===================================================================
--- lunar-doc/trunk/lunar-manual/6development.tex	2005-07-11 20:36:12 UTC (rev 15692)
+++ lunar-doc/trunk/lunar-manual/6development.tex	2005-07-11 22:33:38 UTC (rev 15693)
@@ -1,4 +1,4 @@
-\chapter{Development for Lunar Linux}
+\chapter{Development for Lunar Linux} \label{devel}
 most detailed. can only be writen by devs ... best : sofar; resources in svn for this ...
 
 \section{Development with Subversion}



More information about the Lunar-commits mailing list