summaryrefslogtreecommitdiff
path: root/Master/tlpkg/doc/vars-docu.txt
blob: 3b869c4e1fc2ab36bd47d3e60349fdf42330915f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Documentation of the content of the %vars hash which is the only way to 
transport ship information between various installer menus and the main
program.

1) collections and schemes
--------------------------
selected collections/schemes
	collection-<collection> 0|1		OUT
	scheme-<scheme> 0|1			OUT
total number of collections
	n_collections_available 84		IN
and the number of collections selected:
	n_collections_selected 1		OUT
the selected scheme
	selected_scheme scheme-<scheme>		OUT


2) platforms
------------
location of the arch
	diskbin_<arch-os> 0|1			IN/OUT
	netbin_<arch-os> 0|1			IN/OUT
the current one
	inst_platform <arch-os>			IN
the current platform ???
	this_platform <arch-os>			IN
number of systems available in total
	n_systems_available 15			IN
number of systems selected
	n_systems_selected 3			OUT


3) options
----------
build all formats
	option_fmt 0|1				OUT
letter instead of A4
	option_letter 0|1			OUT
install symlinks (on unix)
	option_symlinks 0|1			OUT
and the respective destinations for the symlinks
	sys_info <path/to/info/dir>		OUT
	sys_bin /usr/local/bin			OUT
	sys_man /usr/local/man			OUT
do install the doc files
	option_doc 0|1				OUT
do install the src files
	option_src 0|1				OUT
destination paths
	TEXMFSYSVAR /home/norbert/tltest/2008/texmf-var		OUT
	TEXDIR /home/norbert/tltest/2008			OUT
	TEXMFLOCAL /home/norbert/tltest/texmf-local		OUT
	TEXMFHOME ~/texmf					OUT

4) other stuff ???
------------------
total size to be used
	total_size 54		DEDUCED
no idea ????
	page 0


NEW LAYOUT
==========

%MediaData = (
	media => CD|DVD|NET
	location => /path/to/master | base-url
	release => NNNN
	tlpdb => the respective tlpdb
	all_collections => [ ... ]
	std_collections => [ ... ]
	lang_collections => [ ... ]
	lang_doc_collections => [ ... ]
	schemes => [ ... ]
	n_collections => NN
	n_schemes => NN
	diskbins => [ ... ]
	netbins => [ ... ]
	n_systems_available => NN   (== #(#diskbins u #netbins))
	this_platform => <arch-os>
)

%vars = (
	systems => [ ... ] 	  # those selected for installation
	collections => [ ... ]	  # those selected for installation
	selected_scheme => scheme-<scheme>
	option_fmt => 0|1
	option_letter 0|1			OUT
	option_symlinks 0|1			OUT
	sys_info <path/to/info/dir>		OUT
	sys_bin /usr/local/bin			OUT
	sys_man /usr/local/man			OUT
	option_doc 0|1				OUT
	option_src 0|1				OUT
	TEXMFSYSVAR /home/norbert/tltest/2008/texmf-var		OUT
	TEXDIR /home/norbert/tltest/2008			OUT
	TEXMFLOCAL /home/norbert/tltest/texmf-local		OUT
	TEXMFHOME ~/texmf					OUT
)