doc/implementation/dir_vars.txt

   1 This document describes the various directories and environment
   2 variables relating to directories used by Maxima.
   3
   4 As of version 5.9.1, Maxima supports two different installed
   5 directory layouts:
   6           1) "source"
   7           2) "autotools"
   8
   9 The "source" layout is that of the Maxima tarball (and cvs module.)
  10 The "autotools" layout is the layout of the files installed by the
  11 GNU Autotools.
  12
  13 Maxima needs to know the following locations:
  14
  15        1) The parent directory for Maxima compiled images/executables:
  16           maxima-imagesdir
  17
  18        2) The parent directory for Maxima share files:
  19           maxima-sharedir
  20
  21        3) The parent directory for the sym package:
  22           maxima-symdir
  23
  24        4) The parent directory for Maxima source files:
  25           maxima-srcdir
  26
  27        5) The parent directory for Maxima demo files:
  28           maxima-demodir
  29
  30        6) The parent directory for Maxima test files:
  31           maxima-testsdir
  32
  33        7) The parent directory for general documentation
  34           maxima-docdir
  35
  36        8) The parent directory for Maxima info documentation:
  37           maxima-infodir
  38
  39        9) The parent directory for Maxima html documentation:
  40           maxima-htmldir
  41
  42       10) The parent directory for the Maxima plotting tcl scripts:
  43           maxima-plotdir
  44
  45 In order to determine the layout for the locations, it needs to know
  46 which installed directory layout is being used:
  47
  48       11) Whether maxima should use the "autotools" layout:
  49           maxima-layout-autotools
  50
  51 Maxima also will read user files from a directory in the user's
  52 area. This directory is independent of the installed layout:
  53
  54       12) The parent directory for user's files:
  55           maxima-userdir
  56
  57       13) The parent directory for temporary files:
  58           maxima-tempdir
  59
  60 Maxima needs to know location of locale specific data
  61 (translated documentation, localized messages etc):
  62
  63       14) The sub-directory for locale specific data:
  64           maxima-lang-subdir
  65           Usually value of this variable is automatically derived
  66           from current user's locale.
  67