home *** CD-ROM | disk | FTP | other *** search
/ Dream 46 / Amiga_Dream_46.iso / bo / extras / doc / package-developer / tentative-opt-draft < prev    next >
Text File  |  1996-03-06  |  5KB  |  122 lines
  1. Proposed /opt addition to the FSSTND.
  2.  
  3. ------------------------------------------------------------------------
  4.  
  5. /etc/opt -- Machine-specific configuration files for /opt
  6.  
  7. Machine-specific configuration files for add-on application software
  8. packages shall be installed within the directory /etc/opt/<package>,
  9. where <package> is the name of the subtree in /opt where the static
  10. data from that package is stored.  No structure is imposed on the
  11. internal arrangement of /etc/opt/<package>.
  12.  
  13. If a configuration file must reside in a different location in order
  14. for the package or system to function properly, it may be placed in a
  15. location other than /etc/opt/<package>.
  16.  
  17. ------------------------------------------------------------------------
  18.  
  19. /opt -- Add-on application software packages
  20. |
  21. +-bin       Executable files invoked directly by users
  22. +-man       Package manual pages
  23. +-<package> Static package objects
  24.  
  25. /opt is reserved for the installation of add-on application software
  26. packages.
  27.  
  28. A package to be installed in /opt shall install its static files in a
  29. separate /opt/<package> directory tree, where <package> is the name of
  30. the software package.  The possible exceptions are user-executable
  31. files and user-readable manual pages (accessed via `man'), which may
  32. optionally be installed in /opt/bin and /opt/man, respectively.
  33.  
  34. User-executable files that are not installed in the /opt/bin directory
  35. shall be installed in the directory /opt/<package>/bin.
  36.  
  37. User-readable manual pages that are not installed in the /opt/man
  38. directory tree shall be installed in /opt/<package>/man.  /opt/man
  39. shall have the same substructure as /usr/man.  If /opt/<package>/man
  40. is present, the same substructure as /usr/man shall be used.
  41.  
  42. Package files that are variable (change in normal operation) should be
  43. installed in /var/opt.  See the section on /var/opt for more
  44. information.
  45.  
  46. Machine-specific configuration files should be installed in /etc/opt.
  47. See the section on /etc for more information.
  48.  
  49. No other package files should exist outside the /opt, /var/opt, and
  50. /etc/opt hierarchies except for those package files that must reside
  51. in specific locations within the filesystem tree in order to function
  52. properly.  For example, device lock files must be placed in /var/lock
  53. and devices must be located in /dev.
  54.  
  55. ------------------------------------------------------------------------
  56.  
  57. /var/opt -- Variable data for /opt
  58.  
  59. Variable data should be installed in /var/opt/<package>, where
  60. <package> is the name of the subtree in /opt where the static data
  61. from an add-on software package is stored, except where superseded by
  62. another file in /etc.  No structure is imposed on the internal
  63. arrangement of /var/opt/<package>.
  64.  
  65. ------------------------------------------------------------------------
  66.  
  67. * Reference:
  68.  
  69. These extracts are taken from "System V Application Binary Interface"
  70. [ (c) 1990 AT&T ] and is based on System C Interface Definition, Third
  71. Edition.  This books contains the guidelines for System V Release 4.0
  72. and as such are probably "current".
  73.  
  74. Thanks to Stephen Harris <sweh@spuddy.mew.co.uk> for posting the
  75. excerpts.
  76.  
  77. +++++
  78.  
  79. Page 2-16 "File tree for add-on software"
  80.  
  81. /opt, /var/opt and /etc/opt are reserved in the file tree for the installation
  82. of application software packages.  Each add-on software package should adhere
  83. to the following rules:
  84.  
  85.  o Static package objects should be installed in /opt/pkg, where pkg is the
  86.    package abberviation or instance.
  87.  
  88.  o Package objects that change in normal operations (for example, log and
  89.    spool files) should be installed in /var/opt/pkg.
  90.  
  91.  o machine-specific configuration files should be installed in /etc/opt/pkg
  92.  
  93.  o Executables that are directly invoked by users should be installed in
  94.    /opt/pkg/bin
  95.  
  96.  o Only package objects that must reside in specific locations within the
  97.    system file tree in order to function properly (for example, special
  98.    files in /dev) should be installed in those locations.
  99.  
  100. ------
  101.  
  102. Further on page 9-4 of the "System V ABI" we find
  103.  
  104. +++++
  105.  
  106. The /opt subtree
  107.  
  108. The directoy /opt of the / file system is the point of access to the /opt
  109. subtree.  This directory subtree contains files installed by add-on
  110. packages.
  111.  
  112. The following describes the structure of the /opt subtree:
  113.  
  114. /opt          The top directory of the /opt subtree
  115.  
  116. /opt/bin      Executable files provided by application packages and
  117.               invoked directly by users
  118.  
  119. /opt/pkg       Where pkg is the abbreviated name of an add-on software
  120.                package, contains all the static files installed on the
  121.                system as part of that package
  122.