source: git/doc/dir_structure

spielwiese
Last change on this file was 3259d7, checked in by Michael Orlitzky <michael@…>, 3 years ago
**/*: rename singular.hlp to singular.info. The help file presently named "singular.hlp" is intended to be read with GNU Info, which looks for an extension of ".info" by default. Thus, at the moment, one must run "info singular.hlp" to read the installed file, whereas "info singular" is more natural. This commit replaces "singular.hlp" with "singular.info" throughout the source tree so that the file ultimately has the name that GNU Info or Emacs expect. Closes: https://github.com/Singular/Singular/issues/1107
  • Property mode set to 100644
File size: 2.7 KB
Line 
1Audience and their wishes:
2A) Developer
3A1  - several independent versions of Singular
4A2  - developer version: additional commands, main sources in the current
5    directory or "nearby"
6B) User
7B1   - binaries installable without administrator privileges
8B2   - sources installable without administrator privileges
9C) Administrator
10C1   - installable without conflicts
11C2   - installable for several binary architectures
12C3   - few dependencies
13
14What to install ?
15- sub-projects
16  - have:
17     - libraries
18     - public headers
19     - private headers
20  - can be
21     - also used outside of Singular (factory etc.)
22     - or: relatively useless outside of Singular (liboutput etc.)
23- support files for Singular
24  - gftables
25    (currently: $SINGULARPATH/gftables:%b/LIB/gftables:%b/../LIB/gftables:%b/../../LIB/gftables)
26  - libraries
27    (currently: $SINGULARPATH:%b/LIB:%b/../LIB:%b/../../LIB)
28  - system modules
29    (currently %b)
30  - user modules
31    (currently: $SINGULARPATH:%b/MOD:%b/../MOD:%b/../../MOD)
32  - index file
33    (currently: %b/../doc/singular.idx)
34  - info file
35    (currently: %b/../info/singular.info)
36  - HTML
37    (currently: %b/../html)
38  - examples (planned)
39    (currently: %b/../examples)
40  - emacs
41    (currently: %b/../emacs)
42
43Current layout
44- compile everything inside the current working directory (A1, B2, C1)
45- install into this tree (A2, C1)
46- grammar.cc, scanner.cc etc can be build,
47  but are usually included in the sources (C3: no need for flex/bison)
48- all directories are relative to
49   - the main binary location (A1,B1,C2)
50   - or /usr/local/Singular/bin
51
52 <version>/<arch>     directory for binaries (%b)
53 <version>/<arch>/MOD directory for user modules (%b/MOD)
54 <version>/emacs      directory for emacs scripts
55 <version>/html, <version>/doc, <version>/info, <version>/examples
56                      directories for help stuff
57 <version>/LIB        directory for libraries
58 <version>/LIB/gftables   directory for gftables
59 <Build-dir>/<arch>/include directory for public headers
60 <Build-dir>/<arch>/lib     directory for libraries
61 <Build-dir>/Singular     directory for development version
62                          LIB: <Build-dir>/Singular/LIB
63                          everything else <Build-dir>/emacs,html,info,doc,...
64 for examples: /usr/local/Singular on wawa:
65 ./3-1-0/ix86-Linux/MOD
66 ./3-1-0/ix86-Linux
67 ./3-1-0/x86_64-Linux/MOD
68 ./3-1-0/x86_64-Linux
69 ./3-1-0/emacs
70 ./3-1-0/html
71 ./3-1-0/doc
72 ./3-1-0/examples
73 ./3-1-0/info
74 ./3-1-0/LIB/gftables
75 ./3-1-0/LIB/surfex
76 ./3-1-0/LIB
77 ./3-1-1/ix86-Linux/MOD
78 ./3-1-1/ix86-Linux
79 ./3-1-1/emacs
80 ./3-1-1/html
81 ./3-1-1/doc
82 ./3-1-1/x86_64-Linux/MOD
83 ./3-1-1/x86_64-Linux
84 ./3-1-1/examples
85 ./3-1-1/info
86 ./3-1-1/LIB/gftables
87 ./3-1-1/LIB/surfex
88 ./3-1-1/LIB
89
Note: See TracBrowser for help on using the repository browser.