SourceForge VA Linux Systems
Copyright © 2000 Paul Sheer - Click here for copying permissions       Source by FTP

next up previous contents index
Next: UNIX Directory Layout Up: Rute Users Tutorial and Previous: Symbolic and Hard Links   Contents   Index

Subsections

Pre-installed Documentation

Add comments here 
This chapter describes where to find documentation on a common LINUX distribution. At the moment a RedHat distribution is assumed, but this is equally applicable to other distributions, although the exact locations might be different.
For many proprietary operating systems, the definitive reference for their operating system are printed texts. For LINUX, much of documentation is written by the authors themselves and is included with the source code. A typical LINUX distribution will package this along with the compiled binaries. Common distributions come with hundreds of megabytes of printable, hyper-linked, and plane text documentation. There is often no need to go the the World Web Wide unless something is outdated.
If you have not already tried this, run

 
 
ls -ld /usr/*/doc /usr/*/*/doc /usr/share/*/*/doc \
        /opt/*/doc /opt/*/*/doc

This is a somewhat unreliable way to search for potential documentation directories.

Kernal documentation: /usr/src/linux/Documentation/

This contains information on all hardware drivers except graphics cards. The kernel has built in drivers for networking cards, SCSI controllers, sound cards and so on. Hence if you need to find out if one of these is supported, this is the first place to look.

X Window System graphics hardware support: /usr/X11R6/lib/X11/doc/

X installs in a separate directory super structure, In here you will find documentation on all of the graphics hardware supported by X, how to configure X, tweak video modes, cope with incompatible graphics cards, and so on. See Section 45.5 for details.

TEX and Metafont reference: /usr/share/texmf/doc/

This is an enormous and comprehensive (and possibly exhaustive) reference to the TEX typesetting language and the Metafont font generation package.

LATEX HTML documentation: /usr/share/texmf/tex/latex/

This is a complete reference to the LATEX typesetting language. (This book itself was typeset using LATEX.)

Frequently Asked Questions: /usr/doc/FAQ

This contains some beginners documentation.

Howto's: /usr/doc/HOWTO

This is an excellent source of laymen tutorials for setting up almost any kind of service you can imagine. It is worth listing the contents here to emphasise diversity of topics covered:

 
 
 
 
5 
 
 
 
 
10 
 
 
 
 
15 
 
 
 
 
20 
 
 
 
3Dfx-HOWTO              Danish-HOWTO        Intranet-Server-HOWTO        PPP-HOWTO                  Software-Release-Practice-HOWTO
AX25-HOWTO              Distribution-HOWTO  Italian-HOWTO                PalmOS-HOWTO               Sound-HOWTO
Access-HOWTO            ELF-HOWTO           Java-CGI-HOWTO               Parallel-Processing-HOWTO  Sound-Playing-HOWTO
Alpha-HOWTO             Emacspeak-HOWTO     Kernel-HOWTO                 Pilot-HOWTO                Spanish-HOWTO
Assembly-HOWTO          Esperanto-HOWTO     Keyboard-and-Console-HOWTO   Plug-and-Play-HOWTO        TeTeX-HOWTO
Bash-Prompt-HOWTO       Ethernet-HOWTO      KickStart-HOWTO              Polish-HOWTO               Text-Terminal-HOWTO
Benchmarking-HOWTO      Finnish-HOWTO       LinuxDoc+Emacs+Ispell-HOWTO  Portuguese-HOWTO           Thai-HOWTO
Beowulf-HOWTO           Firewall-HOWTO      META-FAQ                     PostgreSQL-HOWTO           Tips-HOWTO
BootPrompt-HOWTO        French-HOWTO        MGR-HOWTO                    Printing-HOWTO             UMSDOS-HOWTO
Bootdisk-HOWTO          Ftape-HOWTO         MILO-HOWTO                   Printing-Usage-HOWTO       UPS-HOWTO
Busmouse-HOWTO          GCC-HOWTO           MIPS-HOWTO                   Quake-HOWTO                UUCP-HOWTO
CD-Writing-HOWTO        German-HOWTO        Mail-HOWTO                   README                     \unix{}-Internet-Fundamentals-HOWTO
CDROM-HOWTO             Glibc2-HOWTO        Modem-HOWTO                  RPM-HOWTO                  User-Group-HOWTO
COPYRIGHT               HAM-HOWTO           Multi-Disk-HOWTO             Reading-List-HOWTO         VAR-HOWTO
Chinese-HOWTO           Hardware-HOWTO      Multicast-HOWTO              Root-RAID-HOWTO            VME-HOWTO
Commercial-HOWTO        Hebrew-HOWTO        NET-3-HOWTO                  SCSI-Programming-HOWTO     VMS-to-Linux-HOWTO
Config-HOWTO            INDEX.html          NFS-HOWTO                    SMB-HOWTO                  Virtual-Services-HOWTO
Consultants-HOWTO       INFO-SHEET          NIS-HOWTO                    SRM-HOWTO                  WWW-HOWTO
Cyrillic-HOWTO          IPCHAINS-HOWTO      Networking-Overview-HOWTO    Security-HOWTO             WWW-mSQL-HOWTO
DNS-HOWTO               IPX-HOWTO           Optical-Disk-HOWTO           Serial-HOWTO               XFree86-HOWTO
DOS-Win-to-Linux-HOWTO  IR-HOWTO            Oracle-HOWTO                 Serial-Programming-HOWTO   XFree86-Video-Timings-HOWTO
DOS-to-Linux-HOWTO      ISP-Hookup-HOWTO    PCI-HOWTO                    Shadow-Password-HOWTO      XWindow-User-HOWTO
DOSEMU-HOWTO            Installation-HOWTO  PCMCIA-HOWTO                 Slovenian-HOWTO

Mini Howto's: /usr/doc/HOWTO/mini

These are smaller quickstart tutorials in the same vein:

 
 
 
 
5 
 
 
 
 
10 
 
 
 
 
15 
 
 
 
3-Button-Mouse     Coffee               IP-Masquerade             Mail2News                   Proxy-ARP-Subnet          StarOffice
ADSL               Colour-ls            IP-Subnetworking          Man-Page                    Public-Web-Browser        Term-Firewall
ADSM-Backup        Cyrus-IMAP           ISP-Connectivity          Modules                     Qmail+MH                  TkRat
AI-Alife           DHCP                 Install-From-ZIP          Multiboot-with-LILO         Quota                     Token-Ring
Advocacy           DHCPcd               Kerneld                   NCD-X-Terminal              RCS                       Ultra-DMA
Alsa-sound         DPT-Hardware-RAID    LBX                       NFS-Root                    README                    Update
Apache+SSL+PHP+fp  Diald                LILO                      NFS-Root-Client             RPM+Slackware             Upgrade
Automount          Diskless             Large-Disk                Netrom-Node                 RedHat-CD                 VAIO+Linux
Backup-With-MSDOS  Ext2fs-Undeletion    Leased-Line               Netscape+Proxy              Remote-Boot               VPN
Battery-Powered    Fax-Server           Linux+DOS+Win95+OS2       Netstation                  Remote-X-Apps             Vesafb
Boca               Firewall-Piercing    Linux+FreeBSD             News-Leafsite               SLIP-PPP-Emulator         Visual-Bell
BogoMips           GIS-GRASS            Linux+FreeBSD-mini-HOWTO  Offline-Mailing             Secure-POP+SSH            Windows-Modem-Sharing
Bridge             GTEK-BBS-550         Linux+NT-Loader           PLIP                        Sendmail+UUCP             WordPerfect
Bridge+Firewall    Hard-Disk-Upgrade    Linux+Win95               Partition                   Sendmail-Address-Rewrite  X-Big-Cursor
Bzip2              INDEX                Loadlin+Win95             Partition-Rescue            Small-Memory              XFree86-XInside
Cable-Modem        INDEX.html           Loopback-Root-FS          Path                        Software-Building         Xterm-Title
Cipe+Masq          IO-Port-Programming  Mac-Terminal              Pre-Installation-Checklist  Software-RAID             ZIP-Drive
Clock              IP-Alias             Mail-Queue                Process-Accounting          Soundblaster-AWE          ZIP-Install

LINUX Documentation Project: /usr/doc/LDP

These are several online books in HTML format, such as the System Administrators Guide, SAG, the Network Administrators Guide, NAG, the Linux Programmers Guide, LPG.

Web documentation: /home/httpd/html

Some packages may install documentation here so that it goes online automatically if your web server is running.

Apache Reference: /home/httpd/html/manual

Apache keeps this reference material online, so that it is the default web page shown when you install Apache for the first time. Apache is the most popular web server.

Individual package documentation

All packages installed on the system have their own individual documentation directory. A package foo will most probably have a documentation directory /usr/doc/foo. This most often contains documentation released with the sources of the package, such as release information, feature news, example code, FAQ's that are not part of the FAQ package, etc. If you have a particular interest in a package, you should always scan its directory in /usr/doc or, better still, download its source distribution.
These are the /usr/doc directories that contained more than a trivial amount of documentation for that package. In some cases, the package had complete references. (For example, the complete Python references were contained nowhere else.)

 
 
 
 
5 
 
 
 
 
10 
 
 
 
 
15 
BitchX                    expect-5.24        guile-1.3               lout                  pmake-2.1.33                     svgalib-1.3.1
ImageMagick-4.2.2         ext2ed-0.1         gv-3.5.8                lsof-4.42             python-docs-1.5.1                taper-6.9
SVGATextMode-1.8          f2c-19970805       ical-2.2                lynx-2.8.1            rhl-alpha-install-addend-en-6.0  texinfo-3.12f
SoundStudio-0.9.1         fetchmail-5.0.0    icewm-0.9.33            mars-nwe-0.99pl15     rhl-install-guide-en-6.0         tin-1.4_990216
TkStep-8.0.4              fileutils-4.0      inn-2.2                 mgetty-1.1.14         rpm-3.0                          ucd-snmp-3.6.1
abuse-1.10-5              freetype-1.2       ipchains-1.3.8          mod_php-2.0.1         rxvt-2.6.PRE2                    uucp-1.06.1
am-utils-6.0              gated-3.5.10       isapnptools-1.18        mod_php3-3.0.7        samba-2.0.3                      vim-common-5.3
bind-8.2                  gawk-3.0.3         kaffe-1.0.b4            mtools-3.9.1          sendmail                         wu-ftpd-2.4.2vr17
blt-2.4g                  gd-1.3             kernel-pcmcia-cs-2.2.5  ncurses-devel-4.2     sgml-tools                       xanim-27070
bzip2-0.9.0c              ghostscript-5.10   lesstif-0.88.1          netscape-common-4.51  shadow-utils-980403              xbanner-1.31
console-tools-19990302    gimp-1.0.1         lesstif-devel-0.88.1    p2c-1.22              slang-devel-1.2.2                xlispstat-3.52.9
cooledit-3.11.6           gimp-manual-1.0.0  libtiff-devel-3.4       pam-0.66              slrn-0.9.5.4                     xntp3-5.93
cvs-1.10.5                glib-1.2.1         libtool-1.2f            pgp-2.6.3i-1          spice-2g6                        xpm-devel-3.4j
docbook-stylesheets-1.39  glibc-2.1.1        libungif-devel-4.1.0    pine-4.10             squid-2.2.STABLE1                xv-3.10a
dosemu-0.99.10            gtk+-1.2.1         lilo-0.21               pinfocom-3.0          ssh-1.2.26                       zsh-3.0.5

Manual Pages -- man: /usr/man/

Manual pages were discussed in Section 7.7. There may be other directory super structures that contain man pages -- on some other UNIX's man pages are littered everywhere.
To convert a man page to PostScript (for printing or viewing), use for example (for the cp command),

 
groff -Tps -mandoc /usr/man/man1/cp.1 > cp.ps ; gv cp.ps

info pages: /usr/info/

Info pages were discussed in Section 7.8.

next up previous contents index
Next: UNIX Directory Layout Up: Rute Users Tutorial and Previous: Symbolic and Hard Links   Contents   Index
Paul Sheer 2000-10-07