Home | History | Annotate | Line # | Download | only in makemandb 
      1  1.1  joerg There are three tables in the database at present:
      2  1.1  joerg 
      3  1.1  joerg (1) mandb:
      4  1.1  joerg     This is the main FTS table which contains all the content from 
      5  1.1  joerg     man pages
      6  1.1  joerg 
      7  1.1  joerg   COLUMN NAME       DESCRIPTION
      8  1.1  joerg   1. section        Section number of the page  
      9  1.1  joerg   2. name           The name of the page  
     10  1.1  joerg   3. name_desc      The one line description from the NAME section  
     11  1.1  joerg   4. desc           Contains the content from DESCRIPTION 
     12  1.1  joerg                     section and any other section which 
     13  1.1  joerg                     is not indexed in a separate column.
     14  1.1  joerg   5. lib            The LIBRARY section
     15  1.1  joerg   6. return_vals    RETURN VALUES section
     16  1.1  joerg   7. env            ENVIRONMENT section
     17  1.1  joerg   8. files          FILES section
     18  1.1  joerg   9. exit_status    EXIT STATUS section
     19  1.1  joerg   10. diagnostics   DIAGNOSTICS section
     20  1.1  joerg   11. errors        ERRORS section
     21  1.1  joerg   12. md5_hash      md5 hash of the man page (UNIQUE)
     22  1.1  joerg   13. machine       The machine architecture (if any) for which this page is
     23  1.1  joerg                     relevant.
     24  1.1  joerg 
     25  1.1  joerg (2) mandb_meta:
     26  1.1  joerg     This table contains md5 hashes of all the indexed man 
     27  1.1  joerg     pages. This is there to make sure we do not index 
     28  1.1  joerg     the same man page twice, i.e. to prevent indexing 
     29  1.1  joerg     hardlinks.
     30  1.1  joerg 
     31  1.1  joerg   COLUMN NAME       DESCRIPTION
     32  1.1  joerg   1. device         (dev_t)Logical device number from stat(2)
     33  1.1  joerg   2. inode          (ino_t)Inode number from stat(2)
     34  1.1  joerg   3. mtime          Last modification time from stat(2)
     35  1.1  joerg   4. file           Absolute path name (UNIQUE constraint)
     36  1.1  joerg   5. md5_hash       MD5 Hash of the man page (UNIQUE)
     37  1.1  joerg   6. id             A unique integer ID for the page, which
     38  1.1  joerg                     refers to the docid column in mandb (Implicit foreign 
     39  1.1  joerg                     key?) PRIMARY KEY
     40  1.1  joerg   {device, inode} form a UNIQUE index
     41  1.1  joerg 
     42  1.1  joerg (3) mandb_links:
     43  1.1  joerg     This is an index of all the hard/soft links of the man 
     44  1.1  joerg     pages. The list of the linked pages is usually obtained 
     45  1.1  joerg     from the multiple .Nm entries in the page.
     46  1.1  joerg 
     47  1.1  joerg   COLUMN NAME       DESCRIPTION
     48  1.1  joerg   1. link           The name of the hard/soft link (index) 
     49  1.1  joerg   2. target         Name of the target page to which it points  
     50  1.1  joerg   3. section        The section number  
     51  1.1  joerg   4. machine        The machine architecture (if any) for which 
     52  1.1  joerg                     the page is relevant
     53  1.2    wiz   5. md5_hash       MD5 Hash of the target man page.
     54  1.3   leot   6. name_desc      The one line description from the NAME section  
     55