Only small changes and fixes. I also removed all the samples and
[fspm_howto] / big-howto-template.sgml
1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">\r
2 \r
3 <article>\r
4 \r
5 <!-- Header -->\r
6 \r
7  <artheader>\r
8   <title>HOWTO-template for big HOWTOs</title>\r
9 \r
10   <author>\r
11      <firstname>Stein</firstname>\r
12      <surname>Gjoen</surname>\r
13      <affiliation>\r
14         <address>\r
15            <email>sgjoen@nyx.net</email>\r
16         </address>\r
17      </affiliation>\r
18   </author>\r
19 \r
20   <author>\r
21      <firstname>Gregory</firstname>\r
22      <surname>Leblanc</surname>\r
23      <affiliation>\r
24         <address>\r
25            <email>gleblanc@cu-portland.edu</email>\r
26         </address>\r
27      </affiliation>\r
28   </author>\r
29 \r
30   <author>\r
31      <firstname>Greg</firstname>\r
32      <surname>Ferguson</surname>\r
33      <affiliation>\r
34         <address>\r
35            <email>gferg@sgi.com</email>\r
36         </address>\r
37      </affiliation>\r
38   </author>\r
39 \r
40    <revhistory>\r
41       <revision>\r
42          <revnumber>v0.05</revnumber>\r
43          <date>8 June 2000</date>\r
44          <authorinitials>gjf</authorinitials>\r
45           <revremark>\r
46             Fixed ids and comments\r
47          </revremark>\r
48       </revision>\r
49 \r
50       <revision>\r
51          <revnumber>v0.04</revnumber>\r
52          <date>1 June 2000</date>\r
53          <authorinitials>gjf</authorinitials>\r
54           <revremark>\r
55             Additional spacing, layout changes, added new sections\r
56          </revremark>\r
57       </revision>\r
58    </revhistory>\r
59 \r
60   <abstract>\r
61     <indexterm>\r
62       <primary>template</primary>\r
63     </indexterm>\r
64 \r
65     <para>\r
66      This is a fully working template for big HOWTOs. The source\r
67      contains fully described slots to make a convenient framework for\r
68      you to fill in for making your own HOWTO; suggesting some names,\r
69      conventions and contents for the chapters.\r
70     </para>\r
71 \r
72     <para><ulink url="big-howto-template.sgml">SGML source</ulink>\r
73     for this document is available and should be consulted while reading.\r
74     </para>\r
75   </abstract>\r
76 \r
77  </artheader>\r
78 \r
79 \r
80 <!-- Section1: intro -->\r
81 \r
82  <sect1 id="intro">\r
83    <title>Introduction</title>\r
84 \r
85    <indexterm>\r
86     <primary>disk!introduction</primary>\r
87    </indexterm>\r
88 \r
89   <para>\r
90    For various reasons this brand new release is codenamed the\r
91    <emphasis>release</emphasis> release.\r
92   </para>\r
93 \r
94   <para>\r
95    New code names will appear as per industry standard\r
96    guidelines to emphasize the state-of-the-art-ness of this\r
97    document.\r
98   </para>\r
99 \r
100   <para>\r
101    This document was written when I read a feedback asking for a\r
102    template to fill in to make new HOWTOs. This template was\r
103    initially made by extracting the skeletal structure of the Multi\r
104    Disk HOWTO which is a rather large HOWTO. It then went through\r
105    extensive editing.\r
106   </para>\r
107 \r
108   <para>\r
109    Stating the background is a simple way to getting started\r
110    writing the intro.\r
111   </para>\r
112 \r
113   <para>\r
114    First of all we need a bit of legalese. Recent development\r
115    shows it is quite important.\r
116   </para>\r
117 \r
118 <!-- Section2: copyright -->\r
119 \r
120   <sect2 id="copyright">\r
121    <title>Copyright Information</title>\r
122 \r
123    <para>\r
124     This document is copyrighted (c) 2000 Stein Gjoen and is\r
125     distributed under the terms of the Linux Documentation Project\r
126     (LDP) license, stated below.  <emphasis>Replace with your name,\r
127     or supply a new license, when you use this skeleton for a new\r
128     HOWTO.</emphasis>\r
129    </para>\r
130 \r
131    <para>\r
132     Unless otherwise stated, Linux HOWTO documents are\r
133     copyrighted by their respective authors. Linux HOWTO documents may\r
134     be reproduced and distributed in whole or in part, in any medium\r
135     physical or electronic, as long as this copyright notice is\r
136     retained on all copies. Commercial redistribution is allowed and\r
137     encouraged; however, the author would like to be notified of any\r
138     such distributions.\r
139    </para>\r
140 \r
141    <para>\r
142     All translations, derivative works, or aggregate works\r
143     incorporating any Linux HOWTO documents must be covered under this\r
144     copyright notice. That is, you may not produce a derivative work\r
145     from a HOWTO and impose additional restrictions on its\r
146     distribution. Exceptions to these rules may be granted under\r
147     certain conditions; please contact the Linux HOWTO coordinator at\r
148     the address given below.\r
149    </para>\r
150 \r
151    <para>\r
152     In short, we wish to promote dissemination of this\r
153     information through as many channels as possible. However, we do\r
154     wish to retain copyright on the HOWTO documents, and would like to\r
155     be notified of any plans to redistribute the HOWTOs.\r
156    </para>\r
157 \r
158    <para>\r
159     If you have any questions, please contact \r
160     <email>linux-howto@metalab.unc.edu</email>\r
161    </para>\r
162   </sect2>\r
163 \r
164 <!-- Section2: disclaimer -->\r
165 \r
166   <sect2 id="disclaimer">\r
167    <title>Disclaimer</title>\r
168 \r
169    <para>\r
170     No liability for the contents of this documents can be accepted.\r
171     Use the concepts, examples and other content at your own risk.\r
172     As this is a new edition of this document, there may be errors\r
173     and inaccuracies, that may of course be damaging to your system.\r
174     Proceed with caution, and although this is highly unlikely,\r
175     the author(s) do not take any responsibility for that.\r
176    </para>\r
177 \r
178    <para>\r
179     All copyrights are held by their by their respective owners, unless\r
180     specifically noted otherwise.  Use of a term in this document\r
181     should not be regarded as affecting the validity of any trademark\r
182     or service mark.\r
183    </para>\r
184 \r
185    <para>\r
186     Naming of particular products or brands should not be seen \r
187     as endorsements.\r
188    </para>\r
189 \r
190    <para>\r
191     You are strongly recommended to take a backup of your system \r
192     before major installation and backups at regular intervals.\r
193    </para>\r
194   </sect2>\r
195 \r
196 <!-- Section2: newversions-->\r
197 \r
198   <sect2 id="newversions">\r
199    <title>New Versions</title>\r
200 \r
201     <indexterm>\r
202      <primary>(your index root)!news on</primary>\r
203     </indexterm>\r
204 \r
205    <para>\r
206     This is where you make a summary of what is new. When a\r
207     HOWTO exceeds 20 pages it takes more than a casual read to find\r
208     the updates. This is where you help your readers with that,\r
209     alerting them to specific and important updates to the document.\r
210    </para>\r
211 \r
212    <para>\r
213     This is the initial release.\r
214    </para>\r
215 \r
216    <para>\r
217     Tell people where the document home page is so the very\r
218     newest release could be found in case of problems with the main\r
219     <ulink url="http://www.linuxdoc.org/">Linux Documentation\r
220     Project</ulink> homepage.\r
221    </para>\r
222 \r
223    <para>\r
224     The following is a sample from the Multi Disk HOWTO:\r
225    </para>\r
226 \r
227    <para>\r
228     The latest version number of this document can be \r
229     gleaned from my plan entry if you \r
230     <ulink url="http://www.cs.indiana.edu/finger/nox.nyx.net/sgjoen">\r
231     finger</ulink> my Nyx account.\r
232    </para>\r
233 \r
234    <para>\r
235     <emphasis>If you have the capability, it would be nice to \r
236     make the HOWTO available in a number of formats.</emphasis>\r
237    </para>\r
238 \r
239    <para>\r
240     The newest version of this HOWTO will always be made available on\r
241     my website, in a variety of formats:\r
242    </para>\r
243 \r
244    <para>\r
245    <itemizedlist>\r
246     <listitem>\r
247      <para>\r
248       <ulink url="http://www.nyx.net/~sgjoen/disk.html">HTML</ulink>.\r
249      </para>\r
250     </listitem>\r
251 \r
252     <listitem>\r
253      <para>\r
254        <ulink URL="http://www.nyx.net/~sgjoen/disk.txt">plain text</ulink>.\r
255      </para>\r
256     </listitem>\r
257 \r
258     <listitem>\r
259      <para>\r
260       <ulink url="http://www.nyx.net/~sgjoen/disk-US.ps.gz">compressed \r
261        postscript (US letter format)</ulink>.\r
262      </para>\r
263     </listitem>\r
264 \r
265     <listitem>\r
266      <para>\r
267       <ulink url="http://www.nyx.net/~sgjoen/disk.sgml">SGML source</ulink>.\r
268      </para>\r
269     </listitem>\r
270    </itemizedlist>\r
271    </para>\r
272 \r
273    <para>\r
274     Note that paper sizes vary in the world, A4 and US letter differ \r
275     significantly. You might also wish to consider using the \r
276     <emphasis>universal format</emphasis> (8.27x11in; 210x279mm). \r
277    </para>\r
278   </sect2>\r
279 \r
280 <!-- Section2: credits -->\r
281 \r
282   <sect2 id="credits">\r
283    <title>Credits</title>\r
284 \r
285    <para>\r
286     <emphasis>It is always nice to acknowledge people who help you\r
287     with input; it is also regarded by many as important in the\r
288     Linux world new economy.</emphasis>\r
289    </para>\r
290 \r
291    <para>\r
292     In this version I have the pleasure of acknowledging:\r
293    </para>\r
294 \r
295    <para>\r
296     <email>name (at) site.org</email>\r
297    </para>\r
298 \r
299    <para>\r
300     <emphasis>Please scramble the addresses so email harvesters\r
301     cannot get addresses from your HOWTO and then spam people. That\r
302     has happened in the past.</emphasis>\r
303    </para>\r
304 \r
305    <para>\r
306     <emphasis>Somecompany</emphasis> is acknowledged for sending me\r
307     documentation on their gizmos as well as permission to quote from\r
308     the material.  These quotes have been approved before appearing\r
309     here and will be clearly labeled.\r
310    </para>\r
311   </sect2>\r
312 \r
313 <!-- Section2: feedback -->\r
314 \r
315   <sect2 id="feedback">\r
316    <title>Feedback</title>\r
317 \r
318    <para>\r
319     Feedback is most certainly welcome for this document. Without\r
320     your submissions and input, this document wouldn't exist. Please\r
321     send your additions, comments and criticisms to the following\r
322     email address : <email>sgjoen@nyx.net</email>.\r
323    </para>\r
324    </sect2>\r
325 \r
326 <!-- Section2: translations -->\r
327 \r
328   <sect2 id="translations">\r
329    <title>Translations</title>\r
330 \r
331    <para>\r
332     Not everyone speaks English, pointers to translations are nice.\r
333     Also your translators tend to give very important inputs.\r
334    </para>\r
335 \r
336    <para>\r
337     <itemizedlist>\r
338 \r
339      <listitem>\r
340       <para>\r
341         <ulink url="http://linuxdoc.org/">German Translation</ulink>\r
342         by <email>someone (at) somewhere.de</email>\r
343       </para>\r
344      </listitem>\r
345 \r
346      <listitem>\r
347       <para>\r
348         <ulink url="http://linuxdoc.org/">French Translation</ulink>\r
349         by <email>someone (at) somewhere.fr</email>\r
350       </para>\r
351      </listitem>\r
352 \r
353      <listitem>\r
354       <para>\r
355         <ulink url="http://linuxdoc.org/">Italian Translation</ulink>\r
356         by <email>someone (at) somewhere.it</email>\r
357       </para>\r
358      </listitem>\r
359     </itemizedlist>\r
360    </para>\r
361    </sect2>\r
362 \r
363  </sect1>\r
364 \r
365 <!-- Section1: intro: END -->\r
366 \r
367 \r
368 <!-- Section1: samples  -->\r
369 \r
370  <sect1 id="samples">\r
371   <title>Samples</title>\r
372 \r
373   <para>\r
374    <emphasis>This section gives some simple SGML examples you could\r
375    use. Read the SGML source to see how it was done.</emphasis>\r
376   </para>\r
377 \r
378   <para>\r
379    Further information and examples can be obtained from the publication\r
380    <ulink url="http://docbook.org/tdg/html/">DocBook: The Definitive \r
381    Guide</ulink>. Written by <emphasis>Norman Walsh</emphasis>\r
382    and <emphasis>Leonard Muellner</emphasis>; 1st Edition, October 1999.\r
383   </para>\r
384   \r
385 <!-- Section2: lists -->\r
386 \r
387   <sect2 id="lists">\r
388    <title>Lists</title>\r
389 \r
390    <para>\r
391     <emphasis>Lists are used frequently, and are available in a number\r
392     of formats shown below.</emphasis>\r
393    </para>\r
394 \r
395    <para>\r
396     A list in which each entry is marked with a bullet or other dingbat:\r
397    </para>\r
398 \r
399    <para>\r
400     <itemizedlist>\r
401 \r
402      <listitem>\r
403       <para>Apples</para>\r
404      </listitem>\r
405 \r
406      <listitem>\r
407       <para>Oranges</para>\r
408      </listitem>\r
409 \r
410      <listitem>\r
411       <para>Bananas</para>\r
412      </listitem>\r
413 \r
414     </itemizedlist>\r
415    </para>\r
416 \r
417    <para>\r
418     A list in which each entry is composed of a set of one or more\r
419     terms and an associated description:\r
420    </para>\r
421 \r
422    <para>\r
423     <variablelist>\r
424 \r
425      <varlistentry>\r
426       <term>Fruits</term>\r
427       <listitem>\r
428        <para>such as apples, oranges, and more.</para>\r
429       </listitem>\r
430      </varlistentry>\r
431 \r
432      <varlistentry>\r
433       <term>Nuts</term>\r
434       <listitem>\r
435        <para>Don't eat too many; you are what you eat.</para>\r
436       </listitem>\r
437      </varlistentry>\r
438 \r
439      <varlistentry>\r
440       <term>Vegetables</term>\r
441       <listitem>\r
442        <para>Potatos are spelled with care.</para>\r
443       </listitem>\r
444      </varlistentry>\r
445 \r
446     </variablelist>\r
447    </para>\r
448 \r
449    <para>\r
450     A list in which each entry is marked with a sequentially \r
451     incremented label:\r
452    </para>\r
453 \r
454    <para>\r
455      <orderedlist>\r
456 \r
457       <listitem>\r
458        <para>Step one</para>\r
459       </listitem>\r
460 \r
461       <listitem>\r
462        <para>Step two</para>\r
463       </listitem>\r
464 \r
465      </orderedlist>\r
466    </para>\r
467   </sect2>\r
468 \r
469 <!-- Section2: links -->\r
470 \r
471   <sect2 id="links">\r
472    <title>Links</title>\r
473 \r
474    <para>\r
475     <emphasis>Links can be used within your documents to refer to\r
476     different sections and chapters or to refer to documents external\r
477     to yours.</emphasis>\r
478    </para>\r
479 \r
480    <sect3 id="int-links">\r
481     <title>Internal links</title>\r
482 \r
483     <para>\r
484      Click on the <xref LinkEnd="samples"> link to jump to the top of\r
485      this chapter. Note the anchor at the section tag.\r
486     </para>\r
487    </sect3>\r
488 \r
489    <sect3 id="ext-links">\r
490     <title>External links</title>\r
491 \r
492     <para>\r
493      Click on <ulink url="http://www.linuxdoc.org/">this</ulink> link\r
494      to jump to the LDP site. Note you can use http, ftp, news and\r
495      other protocols in the locator if required.\r
496     </para>\r
497    </sect3>\r
498 \r
499   </sect2>\r
500 \r
501 <!-- Section2: images -->\r
502 \r
503   <sect2 id="images">\r
504    <title>Images</title>\r
505 \r
506    <para>\r
507     <emphasis>Avoid diagrams if possible as this cannot be rendered\r
508     in the ASCII outputs which are still needed by many around the\r
509     world.</emphasis>\r
510    </para>\r
511 \r
512    <para>\r
513      <figure>\r
514       <title>Graphics Test Image</title>\r
515       <graphic FileRef="red.gif"></graphic>\r
516      </figure>\r
517    </para>\r
518 \r
519    <para>\r
520     Here is another variation which allows for ALT text:\r
521    </para>\r
522 \r
523    <para>\r
524      <mediaobject>\r
525 \r
526       <imageobject>\r
527        <imagedata fileref="green.gif" format="gif">\r
528       </imageobject>\r
529 \r
530       <textobject>\r
531        <phrase>\r
532         ALT text to be used: Green Ball\r
533        </phrase>\r
534       </textobject>\r
535 \r
536       <caption>\r
537        <para>\r
538         Caption for the graphic goes here: This is a Green Ball.\r
539        </para>\r
540       </caption>\r
541      </mediaobject>\r
542    </para>\r
543   </sect2>\r
544 \r
545  </sect1>\r
546 \r
547 <!-- Section1: samples: END -->\r
548 \r
549 \r
550 <!-- Section1: structure -->\r
551 \r
552  <sect1 id="structure">\r
553   <title>Structure</title>\r
554 \r
555   <para>\r
556    <emphasis>A quick overview on how all parts fit together in the overall\r
557    structure. An example from the Multi Disk HOWTO is used.</emphasis>\r
558  </para>\r
559 \r
560   <para>\r
561    As this type of document is supposed to be as much for learning as\r
562    a technical reference document I have rearranged the structure to\r
563    this end. For the designer of a system it is more useful to have\r
564    the information presented in terms of the goals of this exercise\r
565    than from the point of view of the logical layer structure of the\r
566    devices themselves. Nevertheless this document would not be\r
567    complete without such a layer structure the computer field is so\r
568    full of, so I will include it here as an introduction to how it\r
569    works.\r
570   </para>\r
571 \r
572 <!-- Section2: logical-struct -->\r
573 \r
574   <sect2 id="logical-struct">\r
575    <title>Logical structure</title>\r
576 \r
577     <indexterm>\r
578      <primary>disk!structure, I/O subsystem</primary>\r
579     </indexterm>\r
580 \r
581    <para>\r
582     This is based on how each layer access each other, traditionally\r
583     with the application on top and the physical layer on the bottom.\r
584     It is quite useful to show the interrelationship between each of\r
585     the layers used in controlling drives.\r
586 \r
587     <screen>\r
588         ___________________________________________________________\r
589         |__     File structure          ( /usr /tmp etc)        __|\r
590         |__     File system             (ext2fs, vfat etc)      __|\r
591         |__     Volume management       (AFS)                   __|\r
592         |__     RAID, concatenation     (md)                    __|\r
593         |__     Device driver           (SCSI, IDE etc)         __|\r
594         |__     Controller              (chip, card)            __|\r
595         |__     Connection              (cable, network)        __|\r
596         |__     Drive                   (magnetic, optical etc) __|\r
597         -----------------------------------------------------------\r
598     </screen>\r
599    </para>\r
600 \r
601    <para>\r
602     In the above diagram both volume management and RAID and\r
603     concatenation are optional layers. The 3 lower layers are in\r
604     hardware. All parts are discussed at length later on in this\r
605     document.\r
606    </para>\r
607   </sect2>\r
608 \r
609 <!-- Section2: doc-struct -->\r
610 \r
611   <sect2 id="doc-struct">\r
612    <title>Document structure</title>\r
613 \r
614    <para>\r
615     Most users start out with a given set of hardware and some plans\r
616     on what they wish to achieve and how big the system should be.\r
617     This is the point of view I will adopt in this document in\r
618     presenting the material, starting out with hardware, continuing\r
619     with design constraints before detailing the design strategy that\r
620     I have found to work well. I have used this both for my own\r
621     personal computer at home, a multi purpose server at work and\r
622     found it worked quite well. In addition my Japanese co-worker in\r
623     this project have applied the same strategy on a server in an\r
624     academic setting with similar success.\r
625    </para>\r
626 \r
627    <para>\r
628     Finally at the end I have detailed some configuration tables for\r
629     use in your own design. If you have any comments regarding this\r
630     or notes from your own design work I would like to hear from you\r
631     so this document can be upgraded.\r
632    </para>\r
633   </sect2>\r
634 \r
635 <!-- Section2: reading-plan -->\r
636 \r
637   <sect2 id="reading-plan">\r
638    <title>Reading plan</title>\r
639 \r
640    <para>\r
641     <emphasis>As you go beyond 50 pages or so there will be a lot of\r
642     text that experts and even the experienced do not need to read.\r
643     Keeping in mind that we wish to care for all kinds of people in\r
644     the Linux world we might have to make a reading plan. Again,\r
645     an example follows from the Multi Disk HOWTO.</emphasis>\r
646    </para>\r
647 \r
648    <para>\r
649     Although not the biggest HOWTO it is nevertheless rather big\r
650     already and I have been requested to make a reading plan to make\r
651     it possible to cut down on the volume.\r
652    </para>\r
653 \r
654    <para>\r
655     <variablelist>\r
656 \r
657      <varlistentry>\r
658       <term>Expert</term>\r
659       <listitem>\r
660        <para>\r
661         (aka the elite). If you are familiar with Linux as well as\r
662         disk drive technologies you will find most of what you need in\r
663         the appendices. Additionally you are recommended to read the\r
664         FAQ and the <XRef LinkEnd="bits-n-pieces">chapter.\r
665        </para>\r
666       </listitem>\r
667      </varlistentry>\r
668 \r
669      <varlistentry>\r
670       <term>Experienced</term>\r
671       <listitem>\r
672        <para>\r
673         (aka Competent). If you are familiar with computers in\r
674         general you can go straight to the chapters on \r
675         <XRef LinkEnd="technologies"> and continue from there on.\r
676        </para>\r
677       </listitem>\r
678      </varlistentry>\r
679 \r
680      <varlistentry>\r
681       <term>Newbie</term>\r
682       <listitem>\r
683        <para>\r
684         (mostly harmless). You just have to read the whole thing.\r
685         Sorry. In addition you are also recommended to read all the\r
686         other disk related HOWTOs.\r
687        </para>\r
688       </listitem>\r
689      </varlistentry>\r
690 \r
691     </variablelist>\r
692    </para>\r
693   </sect2>\r
694 \r
695  </sect1>\r
696 \r
697 <!-- Section1: structure: END -->\r
698 \r
699 \r
700 <!-- Section1: technologies -->\r
701 \r
702  <sect1 id="technologies">\r
703   <title>Technologies</title>\r
704 \r
705    <indexterm>\r
706     <primary>(your index root)!technologies</primary>\r
707    </indexterm>\r
708 \r
709   <para>\r
710    <emphasis>Introduction of technology for the newbie with a few\r
711    references to detailed works. Remember that not everyone has\r
712    Internet access so you have to explain in sufficient details so\r
713    even the newbie can get by.</emphasis>\r
714   </para>\r
715 \r
716  </sect1>\r
717 \r
718 <!-- Section1: technologies: END -->\r
719 \r
720 \r
721 <!-- Section1: implement -->\r
722 \r
723  <sect1 id="implement">\r
724   <title>Implementation</title>\r
725 \r
726    <indexterm>\r
727     <primary>(your index root)!implementation</primary>\r
728    </indexterm>\r
729 \r
730   <para>\r
731    <emphasis>Now your readers should have a sufficient knowledge of\r
732    what this is about and now we come to the hands on of implementing\r
733    your clever scheme.</emphasis>\r
734   </para>\r
735 \r
736  </sect1>\r
737 \r
738 <!-- Section1: implement: END -->\r
739 \r
740 \r
741 <!-- Section1: maint -->\r
742 \r
743  <sect1 id="maint">\r
744   <title>Maintenance</title>\r
745 \r
746    <indexterm>\r
747     <primary>(your index root)!maintenance</primary>\r
748    </indexterm>\r
749 \r
750   <para>\r
751    <emphasis>Few systems and designs are maintenance free, here you\r
752    explain how to keep the system running.</emphasis>\r
753   </para>\r
754 \r
755  </sect1>\r
756 \r
757 <!-- Section1: maint: END -->\r
758 \r
759 \r
760 <!-- Section1: adv-issues -->\r
761 \r
762  <sect1 id="adv-issues">\r
763   <title>Advanced Issues</title>\r
764 \r
765    <indexterm>\r
766     <primary>(your index root)!advanced topics</primary>\r
767    </indexterm>\r
768 \r
769   <para>\r
770    <emphasis>You can get most things up and running in a quick and\r
771    dirty fashion, useful for testing and getting used to how things\r
772    work. For more serious use you would need to be a little more\r
773    advanced. This is the place to explain it all, if applicable.</emphasis>\r
774   </para>\r
775 \r
776  </sect1>\r
777 \r
778 <!-- Section1: adv-issues: END -->\r
779 \r
780 \r
781 <!-- Section1: moreinfo -->\r
782 \r
783  <sect1 id="moreinfo">\r
784   <title>Further Information</title>\r
785 \r
786    <indexterm>\r
787     <primary>(your index root)!information resources</primary>\r
788    </indexterm>\r
789 \r
790   <para>\r
791    <emphasis>A HOWTO cannot describe everything, some times the user\r
792    has to venture out on th enet to get more information or just\r
793    updates. Here is the place to tell where and how. Again examples\r
794    from the Multi Disk HOWTO, replace as needed.</emphasis> There is wealth\r
795    of information one should go through when setting up a major system,\r
796    for instance for a news or general Internet service provider.  The\r
797    FAQs in the following groups are useful:\r
798   </para>\r
799 \r
800 <!-- Section2: newsgroups -->\r
801 \r
802   <sect2 id="newsgroups">\r
803    <title>News groups</title>\r
804 \r
805     <indexterm>\r
806      <primary>disk!information resources!news groups</primary>\r
807     </indexterm>\r
808 \r
809    <para>Some of the most interesting news groups are:\r
810 \r
811     <itemizedlist>\r
812 \r
813      <listitem>\r
814       <para>\r
815        <ulink url="news:comp.arch.storage">Storage</ulink>.\r
816       </para>\r
817      </listitem>\r
818 \r
819      <listitem>\r
820       <para>\r
821        <ulink url="news:comp.sys.ibm.pc.hardware.storage">PC storage</ulink>.\r
822       </para>\r
823      </listitem>\r
824 \r
825      <listitem>\r
826       <para>\r
827        <ulink url="news:alt.filesystems.afs">AFS</ulink>.\r
828       </para>\r
829      </listitem>\r
830 \r
831      <listitem>\r
832       <para>\r
833        <ulink url="news:comp.periphs.scsi">SCSI</ulink>.\r
834       </para>\r
835      </listitem>\r
836 \r
837      <listitem>\r
838       <para>\r
839        <ulink url="news:comp.os.linux.setup">Linux setup</ulink>.\r
840       </para>\r
841      </listitem>\r
842 \r
843     </itemizedlist>\r
844    </para>\r
845 \r
846    <para>\r
847     Most newsgroups have their own FAQ that are designed to answer most\r
848     of your questions, as the name Frequently Asked Questions indicate.\r
849     Fresh versions should be posted regularly to the relevant newsgroups.\r
850     If you cannot find it in your news spool you could go directly to the\r
851     <ulink url="ftp://rtfm.mit.edu/">FAQ main archive FTP site</ulink>.\r
852     The WWW versions can be browsed at the \r
853     <ulink url="http://www.cis.ohio-state.edu/hypertext/faq/usenet/FAQ-List.html">FAQ\r
854     main archive WWW site</ulink>.\r
855    </para>\r
856 \r
857    <para>\r
858     Some FAQs have their own home site, of particular interest:\r
859 \r
860     <itemizedlist>\r
861 \r
862      <listitem>\r
863       <para>\r
864        <ulink url="http://www.paranoia.com/~filipg/HTML/LINK/F_SCSI.html">SCSI FAQ</ulink> \r
865        and\r
866       </para>\r
867      </listitem>\r
868 \r
869      <listitem>\r
870       <para>\r
871        <ulink url="http://alumni.caltech.edu/~rdv/comp_arch_storage/FAQ-1.html">comp.arch.storage FAQ</ulink>.\r
872       </para>\r
873      </listitem>\r
874 \r
875     </itemizedlist>\r
876    </para>\r
877   </sect2>\r
878 \r
879 <!-- Section2: maillists -->\r
880 \r
881   <sect2 id="maillists">\r
882    <title>Mailing Lists</title>\r
883 \r
884     <indexterm>\r
885      <primary>disk!information resources!mailing lists</primary>\r
886     </indexterm>\r
887 \r
888    <para>\r
889     These are low-noise channels mainly for developers. Think twice\r
890     before asking questions there as noise delays the development.\r
891     Some relevant lists are <email>linux-raid</email>,\r
892     <email>linux-scsi</email> and <email>linux-ext2fs</email>.  Many\r
893     of the most useful mailing lists run on the <Literal\r
894     remap="tt">vger.rutgers.edu</Literal> server but this is\r
895     notoriously overloaded, so try to find a mirror. There are some\r
896     lists mirrored at <ulink url="http://www.redhat.com">The Redhat\r
897     Home Page</ulink>. Many lists are also accessible at <ulink\r
898     url="http://www.linuxhq.com/lnxlists">linuxhq</ulink>, and the\r
899     rest of the web site contains useful information as well.\r
900    </para>\r
901 \r
902    <para>\r
903     If you want to find out more about the lists available you can send\r
904     a message with the line <command>lists</command> to the list server\r
905     at <email>majordomo@vger.rutgers.edu</email>.\r
906     If you need help on how to use the mail server just send the line\r
907     <command>help</command> to the same address.  Due to the\r
908     popularity of this server it is likely it takes a bit to time before\r
909     you get a reply or even get messages after you send a\r
910     <command>subscribe</command> command.\r
911    </para>\r
912 \r
913    <para>\r
914     There is also a number of other majordomo list servers that can\r
915     be of interest such as the EATA driver list\r
916     (<email>linux-eata@mail.uni-mainz.de</email>)\r
917     and the Intelligent IO list <email>linux-i2o@dpt.com</email>.\r
918    </para>\r
919 \r
920    <para>\r
921     Mailing lists are in a state of flux but you can find links to a\r
922     number of interesting lists from the \r
923     <ulink url="http://www.linuxdoc.org/">Linux Documentation\r
924     Homepage</ulink>.\r
925    </para>\r
926   </sect2>\r
927 \r
928 <!-- Section2: howto -->\r
929 \r
930   <sect2 id="howto">\r
931    <title>HOWTO</title>\r
932 \r
933     <indexterm>\r
934      <primary>disk!information resources!HOWTOs</primary>\r
935     </indexterm>\r
936 \r
937    <para>\r
938     These are intended as the primary starting points to get the\r
939     background information as well as show you how to solve a\r
940     specific problem. Some relevant HOWTOs are\r
941     <Literal remap="tt">Bootdisk</Literal>, \r
942     <Literal remap="tt">Installation</Literal>,\r
943     <Literal remap="tt">SCSI</Literal> and \r
944     <Literal remap="tt">UMSDOS</Literal>.  The main site for these is the\r
945     <ulink url="http://www.linuxdoc.org/">LDP archive</ulink>at\r
946     Metalab (formerly known as Sunsite).\r
947    </para>\r
948 \r
949    <para>\r
950     There is a a new HOWTO out that deals with setting up a DPT RAID\r
951     system, check out the\r
952     <ulink url="http://www.ram.org/computing/linux/dpt_raid.html">DPT RAID\r
953     HOWTO homepage</ulink>.\r
954    </para>\r
955   </sect2>\r
956 \r
957 <!-- Section2: local-res -->\r
958 \r
959   <sect2 id="local-res">\r
960    <title>Local Resources</title>\r
961 \r
962     <indexterm>\r
963      <primary>disk!information resources!local</primary>\r
964     </indexterm>\r
965 \r
966    <para>\r
967     In most distributions of Linux there is a document directory\r
968     installed, have a look in the <filename>/usr/doc</filename>\r
969     directory. where most packages store their main documentation and\r
970     README files etc.  Also you will here find the HOWTO archive \r
971     (<filename>/usr/doc/HOWTO</filename>) of ready formatted HOWTOs\r
972     and also the mini-HOWTO archive \r
973     (<filename>/usr/doc/HOWTO/mini</filename>) of plain text\r
974     documents.\r
975    </para>\r
976 \r
977    <para>\r
978     Many of the configuration files mentioned earlier can be found in\r
979     the <filename>/etc</filename> directory. In particular you will\r
980     want to work with the <filename>/etc/fstab</filename> file that\r
981     sets up the mounting of partitions and possibly also\r
982     <filename>/etc/raidtab</filename> file that is used for the\r
983     <Literal remap="tt">md</Literal> system to set up RAID.\r
984    </para>\r
985 \r
986    <para>\r
987     The kernel source in <filename>/usr/src/linux</filename> is, of\r
988     course, the ultimate documentation. In other words, <quote>use\r
989     the source, Luke</quote>. It should also be pointed out that the\r
990     kernel comes not only with source code which is even commented\r
991     (well, partially at least) but also an informative\r
992     <filename>/usr/src/linux/Documentation</filename>. If you are\r
993     about to ask any questions about the kernel you should read this\r
994     first, it will save you and many others a lot of time and\r
995     possibly embarrassment.\r
996    </para>\r
997 \r
998    <para>\r
999     Also have a look in your system log file\r
1000     (<filename>/var/log/messages</filename>) to see what is going on\r
1001     and in particular how the booting went if too much scrolled off\r
1002     your screen. Using <command>tail -f /var/log/messages</command>\r
1003     in a separate window or screen will give you a continuous update\r
1004     of what is going on in your system.\r
1005    </para>\r
1006 \r
1007    <para>\r
1008     You can also take advantage of the  <filename>/proc</filename>\r
1009     file system that is a window into the inner workings of your\r
1010     system. Use <command>cat</command> rather than\r
1011     <command>more</command> to view the files as they are reported as\r
1012     being zero length. Reports are that <command>less</command> works\r
1013     well here.\r
1014    </para>\r
1015   </sect2>\r
1016 \r
1017 <!-- Section2: web -->\r
1018 \r
1019   <sect2 id="web">\r
1020    <title>Web Sites</title>\r
1021 \r
1022     <indexterm>\r
1023      <primary>disk!information resources!WWW</primary>\r
1024     </indexterm>\r
1025     <indexterm>\r
1026      <primary>disk!information resources!web pages</primary>\r
1027     </indexterm>\r
1028 \r
1029    <para>\r
1030     There are a huge number of informative web sites available. By\r
1031     their very nature they change quickly so do not be surprised\r
1032     if these links become quickly outdated.\r
1033    </para>\r
1034 \r
1035    <para>\r
1036     A good starting point is of course the \r
1037     <ulink url="http://www.linuxdoc.org/">Linux Documentation\r
1038     Project</ulink> home page, an information central for\r
1039     documentation, project pages and much more.\r
1040    </para>\r
1041 \r
1042    <para>\r
1043     Please let me know if you have any other leads that can be \r
1044     of interest.\r
1045    </para>\r
1046   </sect2>\r
1047 \r
1048  </sect1>\r
1049 \r
1050 <!-- Section1: moreinfo: END -->\r
1051 \r
1052 \r
1053 <!-- Section1: help -->\r
1054 \r
1055  <sect1 id="help">\r
1056   <title>Getting Help</title>\r
1057 \r
1058    <indexterm>\r
1059     <primary>(your index root)!assistance, obtaining</primary>\r
1060    </indexterm>\r
1061 \r
1062   <para>\r
1063    In the end you might find yourself unable to solve your problems\r
1064    and need help from someone else. The most efficient way is either\r
1065    to ask someone local or in your nearest Linux user group, search\r
1066    the web for the nearest one.\r
1067   </para>\r
1068 \r
1069   <para>\r
1070    Another possibility is to ask on Usenet News in one of the many,\r
1071    many newsgroups available. The problem is that these have such a\r
1072    high volume and noise (called low signal-to-noise ratio) that your\r
1073    question can easily fall through unanswered.\r
1074   </para>\r
1075 \r
1076   <para>\r
1077    No matter where you ask it is important to ask well or you will\r
1078    not be taken seriously. Saying just <emphasis remap="it">my disk\r
1079    does not work</emphasis> is not going to help you and instead the\r
1080    noise level is increased even further and if you are lucky someone\r
1081    will ask you to clarify.\r
1082   </para>\r
1083 \r
1084   <para>\r
1085    Instead describe your problems in some detail that will enable\r
1086    people to help you. The problem could lie somewhere you did not\r
1087    expect. Therefore you are advised to list the following information\r
1088    about your system:\r
1089   </para>\r
1090 \r
1091   <para>\r
1092    <variablelist>\r
1093 \r
1094     <varlistentry>\r
1095      <term>Hardware</Term>\r
1096      <listitem>\r
1097       <para>\r
1098        <itemizedlist>\r
1099         <listitem>\r
1100          <para>Processor</para>\r
1101         </listitem>\r
1102 \r
1103         <listitem>\r
1104          <para>DMA</para>\r
1105         </listitem>\r
1106 \r
1107         <listitem>\r
1108          <para>IRQ</para>\r
1109         </listitem>\r
1110 \r
1111         <listitem>\r
1112          <para>Chip set (LX, BX etc)</para>\r
1113         </listitem>\r
1114 \r
1115         <listitem>\r
1116          <para>Bus (ISA, VESA, PCI etc)</para>\r
1117         </listitem>\r
1118 \r
1119         <listitem>\r
1120          <para>\r
1121           Expansion cards used (Disk controllers, video, IO \r
1122           etc.)\r
1123          </para>\r
1124         </listitem>\r
1125 \r
1126        </itemizedlist>\r
1127       </para>\r
1128      </listitem>\r
1129     </varlistentry>\r
1130 \r
1131     <varlistentry>\r
1132      <term>Software</term>\r
1133      <listitem>\r
1134       <para>\r
1135        <itemizedlist>\r
1136 \r
1137         <listitem>\r
1138          <para>BIOS (On motherboard and possibly SCSI host adapters)</para>\r
1139         </listitem>\r
1140 \r
1141         <listitem>\r
1142          <para>LILO, if used</para>\r
1143         </listitem>\r
1144 \r
1145         <listitem>\r
1146          <para>\r
1147           Linux kernel version as well as possible modifications \r
1148           and patches\r
1149          </para>\r
1150         </listitem>\r
1151 \r
1152         <listitem>\r
1153          <para>Kernel parameters, if any</para>\r
1154         </listitem>\r
1155 \r
1156         <listitem>\r
1157          <para>\r
1158           Software that shows the error (with version number \r
1159           or date)\r
1160          </para>\r
1161         </listitem>\r
1162 \r
1163        </itemizedlist>\r
1164       </para>\r
1165 \r
1166      </listitem>\r
1167     </varlistentry>\r
1168 \r
1169     <varlistentry>\r
1170      <term>Peripherals</term>\r
1171      <listitem>\r
1172       <para>\r
1173        <itemizedlist>\r
1174 \r
1175         <listitem>\r
1176          <para>\r
1177           Type of disk drives with manufacturer name, version and type\r
1178          </para>\r
1179         </listitem>\r
1180 \r
1181         <listitem>\r
1182          <para>Other relevant peripherals</para>\r
1183         </listitem>\r
1184 \r
1185        </itemizedlist>\r
1186       </para>\r
1187      </listitem>\r
1188     </varlistentry>\r
1189 \r
1190    </variablelist>\r
1191   </para>\r
1192 \r
1193   <para>\r
1194    Remember that booting text is logged to\r
1195    <filename>/var/log/messages</filename> which can answer most of\r
1196    the questions above. Obviously if the drives fail you might not be\r
1197    able to get  the log saved to disk but you can at least scroll\r
1198    back up the screen using the <keycap>SHIFT</keycap> and\r
1199    <keycap>PAGE UP</keycap> keys. It may also be useful to include\r
1200    part of this in your request for help but do not go overboard,\r
1201    keep it <emphasis>brief</emphasis> as a complete log file dumped\r
1202    to Usenet News is more than a little annoying.\r
1203   </para>\r
1204 \r
1205  </sect1>\r
1206 \r
1207 <!-- Section1: help: END -->\r
1208 \r
1209 \r
1210 <!-- Section1: remarks -->\r
1211 \r
1212  <sect1 id="remarks">\r
1213   <title>Concluding Remarks</title>\r
1214 \r
1215    <indexterm>\r
1216     <primary>(your index root)!conclusion</primary>\r
1217    </indexterm>\r
1218 \r
1219   <para>\r
1220    <emphasis>Just summing up... Also a place for general\r
1221    recommendations.</emphasis>\r
1222   </para>\r
1223 \r
1224  </sect1>\r
1225 \r
1226 <!-- Section1: remarks: END -->\r
1227 \r
1228 \r
1229 <!-- Section1: faq -->\r
1230 \r
1231  <sect1 id="faq">\r
1232   <title>Questions and Answers</title>\r
1233 \r
1234    <indexterm>\r
1235     <primary>(your index root)!FAQ</primary>\r
1236    </indexterm>\r
1237    <indexterm>\r
1238     <primary>(your index root)!frequently asked questions</primary>\r
1239    </indexterm>\r
1240 \r
1241   <para>\r
1242    <emphasis>Check the newsgroups and try to determine some frequent\r
1243    problems and cover them here. Again an example from the Multi Disk\r
1244    HOWTO.</emphasis>\r
1245   </para>\r
1246 \r
1247   <para>\r
1248    This is just a collection of what I believe are the most common\r
1249    questions people might have. Give me more feedback and I will turn\r
1250    this section into a proper FAQ.\r
1251   </para>\r
1252 \r
1253   <para>\r
1254    <itemizedlist>\r
1255     <listitem>\r
1256      <para>\r
1257       Q:How many physical disk drives (spindles) does a Linux system need?\r
1258      </para>\r
1259 \r
1260      <para>\r
1261       A: Linux can run just fine on one drive (spindle).  Having\r
1262       enough  RAM (around 32 MB, and up to 64 MB) to support swapping\r
1263       is a  better price/performance choice than getting a second\r
1264       disk. (E)IDE disk is usually cheaper (but a little slower) than\r
1265       SCSI.\r
1266      </para>\r
1267     </listitem>\r
1268 \r
1269     <listitem>\r
1270      <para>\r
1271       Q: Are there any disadvantages in this scheme?\r
1272      </para>\r
1273 \r
1274      <para>\r
1275       A: There is only a minor snag: if even a single partition\r
1276       overflows the system might stop working properly. The severity\r
1277       depends of course on what partition is affected. Still this is\r
1278       not hard to monitor, the command <command>df</command> gives\r
1279       you a good overview of the situation. Also check the swap\r
1280       partition(s) using <command>free</command> to make sure you are\r
1281       not about to run out of virtual memory.\r
1282      </para>\r
1283     </listitem>\r
1284 \r
1285     <listitem>\r
1286      <para>\r
1287       Q: OK, so should I split the system into as many partitions as \r
1288       possible for a single drive?\r
1289      </para>\r
1290 \r
1291      <para>\r
1292       A: No, there are several disadvantages to that. First of all\r
1293       maintenance becomes needlessly complex and you gain very little\r
1294       in this. In fact if your partitions are too big you will seek\r
1295       across larger areas than needed. This is a balance and\r
1296       dependent on the number of physical drives you have.\r
1297      </para>\r
1298     </listitem>\r
1299 \r
1300    </itemizedlist>\r
1301 \r
1302    <comment>\r
1303     Greg Leblanc:  Depending on how big this FAQ gets, perhaps it\r
1304     would be worthwhile to have, say, the 5 most FAQ, and put the\r
1305     rest into an external FAQ.  Dunno.  Comments?\r
1306    </comment>\r
1307 \r
1308    <emphasis>(rest deleted.)</emphasis>\r
1309   </para>\r
1310 \r
1311  </sect1>\r
1312 \r
1313 <!-- Section1: faq: END -->\r
1314 \r
1315 \r
1316 <!-- Section1: bits-n-pieces -->\r
1317 \r
1318  <sect1 id="bits-n-pieces">\r
1319   <title>Bits and Pieces </title>\r
1320 \r
1321    <indexterm>\r
1322     <primary>disk!miscellaneous</primary>\r
1323    </indexterm>\r
1324 \r
1325   <para>\r
1326    This is basically a section where I stuff all the bits I have not\r
1327    yet decided where should go, yet that I feel is worth knowing\r
1328    about. It is a kind of transient area.\r
1329   </para>\r
1330 \r
1331  </sect1>\r
1332 \r
1333 <!-- Section1: bits-n-pieces: END -->\r
1334 \r
1335 \r
1336 <!-- Section1: examples -->\r
1337 \r
1338  <sect1 id="examples">\r
1339   <title>Examples</title>\r
1340 \r
1341    <indexterm>\r
1342     <primary>(your index root)!examples</primary>\r
1343    </indexterm>\r
1344 \r
1345   <para>\r
1346    <emphasis>Example designs and sample configuration files and other\r
1347    relevant details is always handy</emphasis>\r
1348   </para>\r
1349 \r
1350  </sect1>\r
1351 \r
1352 <!-- Section1: examples: END -->\r
1353 \r
1354 </article>\r
1355 \r
1356 <!-- Keep this comment at the end of the file\r
1357 Local variables:\r
1358 mode: sgml\r
1359 sgml-omittag:t\r
1360 sgml-shorttag:t\r
1361 sgml-namecase-general:t\r
1362 sgml-general-insert-case:lower\r
1363 sgml-minimize-attributes:nil\r
1364 sgml-always-quote-attributes:t\r
1365 sgml-indent-step:1\r
1366 sgml-indent-data:nil\r
1367 sgml-parent-document:nil\r
1368 sgml-exposed-tags:nil\r
1369 sgml-local-catalogs:nil\r
1370 sgml-local-ecat-files:nil\r
1371 End:\r
1372 -->\r

Benjamin Mako Hill || Want to submit a patch?