This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update to perl.pod suggested
[perl5.git] / hints / README.hints
1 These files are used by Configure to set things which Configure either
2 can't or doesn't guess properly.  Most of these hint files have been
3 tested with at least some version of perl5, but some are still left
4 over from perl4.  I would appreciate hearing about any problems
5 or suggested changes.
6
7 Hint file naming convention:   Each hint file name should have only
8 one '.'.  (This is for portability to non-unix filesystems.)  Names
9 should also fit in <= 14 characters, for portability to older SVR3
10 systems.  File names are of the form $osname_$osvers.sh, with all '.'
11 changed to '_', and all characters such as '/' that don't belong in
12 Unix filenames omitted.
13
14 For example, consider SunOS 4.1.3.  Configure determines $osname=sunos
15 (all names are converted to lower case) and $osvers=4.1.3.  Configure
16 will search for an appropriate hint file in the following order:
17
18         sunos_4_1_3.sh
19         sunos_4_1.sh
20         sunos_4.sh
21         sunos.sh
22
23 If you need to create a hint file, please try to use as general a name
24 as possible and include minor version differences inside case or test
25 statements.  Be sure also to include a default choice.  (See
26 aix.sh for one example.) That way, if you write a hint file for
27 foonix 3.2, it might still work without any changes when foonix 3.3 is
28 released.
29
30 Please also comment carefully on why the different hints are needed.
31 That way, a future version of Configure may be able to automatically
32 detect what is needed.  A glossary of config.sh variables is in the
33 file Porting/Glossary.
34
35 Have the appropriate amount of fun :-)
36
37     Andy Dougherty              doughera@lafcol.lafayette.edu
38     Dept. of Physics
39     Lafayette College, Easton PA 18042