home *** CD-ROM | disk | FTP | other *** search
/ PC Plus SuperCD (UK) 1999 September / pcp155a.iso / linux / siag / source / FILES < prev    next >
Encoding:
Text File  |  1999-01-24  |  4.1 KB  |  143 lines
  1.  
  2. By default, files are installed into this structure. It matches the
  3. World According to Stallman, aka the GNU filesystem standard.
  4.  
  5. A "feature" of this standard is to scatter files around the file system
  6. depending on their purpose. This map is my attempt to document where
  7. everything ends up and why.
  8.  
  9. The exact locations depend on arguments given to configure when compiling.
  10. Type './configure --help' for a summary of available options. See also
  11. comments after the map.
  12.  
  13. Some of the directories in this tree are empty. They are included here
  14. because they are defined in the GNU FSS.
  15.  
  16. /usr
  17. |-/include
  18. `-/local [1][2]
  19.   |-/bin [3]        siag, pw, egon executables
  20.   |-/sbin
  21.   |-/libexec [4]
  22.   | `-/siag
  23.   |   `-/plugins    plugins (all of them)
  24.   |-/share [5]
  25.   | |-/siag
  26.   | | |-/siod        SIOD runtime library
  27.   | | |-/common        Dictionaries, common Scheme libraries
  28.   | | |-/xcommon    Scheme libraries for X support
  29.   | | |-/plugins    Scheme libraries for plugins
  30.   | | |-/siag        Scheme for all versions of Siag
  31.   | | |-/xsiag        Scheme for Xt version of Siag
  32.   | | |-/pw        you get the picture...
  33.   | | |-/xpw
  34.   | | |-/egon
  35.   | | `-/xegon
  36.   | `-/emacs
  37.   |   `-/site-lisp
  38.   |-/etc
  39.   |-/com
  40.   |-/var
  41.   |-/lib        nothing
  42.   |-/info
  43.   |-/include
  44.   |-/man [6]
  45.   | `/man1        siag.1, pw.1, egon.1, image_plugin.1
  46.   `-/doc
  47.     `-/siag
  48.       |-/siod        SIOD docs
  49.       |-/common        Common docs
  50.       |-/xcommon    Common X docs
  51.       |-/siag        Siag docs
  52.       | `-/examples    Siag examples
  53.       |-/xsiag        Xt Siag docs
  54.       |-/pw        PW docs
  55.       | `-/examples    PW examples
  56.       |-/xpw        Xt PW docs
  57.       |-/egon        Egon docs
  58.       | `-/examples    Egon examples
  59.       `-/xegon        Xt Egon docs
  60.  
  61. [1] prefix, default /usr/local
  62. [2] exec-prefix, default ${prefix}
  63. [3] bindir, default ${exec-prefix}/bin
  64. [4] libexecdir, default ${exec-prefix}/libexec
  65. [5] datadir, default ${prefix}/share
  66. [6] mandir, default ${prefix}/man
  67.  
  68. The following C preprocessor symbols are defined, along with their
  69. default values:
  70.  
  71. LIBEXECDIR="/usr/local/libexec/siag"
  72. DATADIR="/usr/local/share/siag"
  73. DOCDIR="/usr/local/doc/siag"
  74.  
  75. The following C and SIOD string variables are set, along with their
  76. default values:
  77.  
  78. libexecdir=LIBEXECDIR
  79. datadir=DATADIR
  80. docdir=DOCDIR
  81.  
  82. The libexecdir variable is used to find plugins. The datadir is used to
  83. find Scheme libraries. The docdir is used to find online documentation.
  84. The docdir is a de facto standard extension to the GNU standard.
  85.  
  86. Important change: nothing is installed into the /usr/local/lib
  87. directory. Previous versions installed plugins and Scheme files there.
  88.  
  89. As usual, things are meant to be installed by typing "make install" and
  90. not moved around manually afterwards. Putting files where Siag can't find
  91. them will inevitably lead to loss of functionality and possibly loss of
  92. data. However, it is possible to move the files if the environment
  93. variables SIAGHOME and SIAGDOCS are used to tell Siag their new
  94. whereabouts. If the variables are set, the following changes are
  95. made to the directory structure:
  96.  
  97. $SIAGHOME
  98.  |-/siod        SIOD runtime library
  99.  |-/common        Dictionaries, common Scheme libraries
  100.  |-/xcommon        Scheme libraries for X support
  101.  |-/plugins        Plugins, scheme libraries for plugins
  102.  |-/siag        Scheme for all versions of Siag
  103.  |-/xsiag        Scheme for Xt version of Siag
  104.  |-/pw            you get the picture...
  105.  |-/xpw
  106.  |-/egon
  107.  `-/xegon
  108.  
  109. $SIAGDOCS
  110.  |-/siod        SIOD docs
  111.  |-/common        Common docs
  112.  |-/xcommon        Common X docs
  113.  |-/siag        Siag docs
  114.  | `-/examples        Siag examples
  115.  |-/xsiag        Xt Siag docs
  116.  |-/pw            PW docs
  117.  | `-/examples        PW examples
  118.  |-/xpw            Xt PW docs
  119.  |-/egon        Egon docs
  120.  | `-/examples        Egon examples
  121.  `-/xegon        Xt Egon docs
  122.  
  123. Setting the variables changes these C and SIOD variables in the
  124. following way:
  125.  
  126. libexecdir=$SIAGHOME
  127. datadir=$SIAGHOME
  128. docdir=$SIAGDOCS
  129.  
  130. Simply put: $SIAGHOME contains the merged contents of
  131. /usr/local/libexec/siag and /usr/local/share/siag.
  132. $SIAGDOCS contains the contents of /usr/local/docs/siag.
  133.  
  134. This exercise is not recommended. It is only meant for installing
  135. pre-compiled binaries on systems where you are not root and recompiling
  136. is not an option. Better solutions include:
  137.  
  138.  - become root
  139.  - get a compiler
  140.  - get a new system
  141.  - grow tomatoes
  142.  
  143.