home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / unix / volume24 / mkid2 / part01 / README < prev    next >
Text File  |  1991-10-09  |  2KB  |  43 lines
  1. Here is the overview section of the id.texinfo document:
  2.  
  3. Overview
  4. ********
  5.  
  6.    An ID database is simply a file containing a list of file names, a
  7. list of identifiers, and a binary relation (stored as a bit matrix)
  8. indicating which of the identifiers appear in each file.  With this
  9. database and some tools to manipulate the data, a host of tasks
  10. become simpler and faster. You can `grep' through hundreds of files
  11. for a name, skipping the files that don't contain the name.  You can
  12. search for all the memos containing references to a project.  You can
  13. edit every file that calls some function, adding a new required
  14. argument. Anyone with a large software project to maintain, or a
  15. large set of text files to organize can benefit from the ID database
  16. and the tools that manipulate it.
  17.  
  18.    There are several programs in the ID family.  The `mkid' program
  19. scans the files, finds the identifiers and builds the ID database. 
  20. The `lid' and `aid' tools are used to generate lists of file names
  21. containing an identifier (perhaps to recompile every file that
  22. references a macro which just changed). The `eid' program will invoke
  23. an editor on each of the files containing an identifier and the `gid'
  24. program will `grep' for an identifier in the subset of files known to
  25. contain it.  The `pid' tool is used to query the path names of the
  26. files in the database (rather than the contents).  Finally, the `iid'
  27. tool is an interactive program supporting complex queries to
  28. intersect and join sets of file names.
  29.  
  30. That ends the overview.
  31.  
  32.  
  33. To build and install mkid, look through the Makefile - all the various
  34. configuration options are (more or less :-) documented there. Change them
  35. around to work for your system, and type "make" to build the programs.
  36.  
  37. To make the texinfo online documentation type "make id-info".
  38.  
  39. To make the printed manual construct the .dvi file with "make id.dvi".  You
  40. will have to figure out how printing .dvi files works on your system (talk
  41. to a local TeX guru -- if you don't have TeX, you won't be able to print the
  42. manual, sorry).
  43.