summaryrefslogtreecommitdiff
path: root/Master/tlpkg/TeXLive/TLConfig.pm
blob: d7c6039c8c3aedd65a0f10c56c5438570fc15e66 (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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
# $Id$
# TeXLive::TLConfig.pm - module exporting configuration stuff
# Copyright 2007, 2008, 2009 Norbert Preining
# This file is licensed under the GNU General Public License version 2
# or any later version.

package TeXLive::TLConfig;

BEGIN {
  use Exporter ();
  use vars qw( @ISA @EXPORT_OK @EXPORT );
  @ISA = qw(Exporter);
  @EXPORT_OK = qw(
    $ReleaseYear
    @MetaCategories
    @NormalCategories
    @Categories
    $MetaCategoriesRegexp
    $CategoriesRegexp
    $DefaultCategory
    $DefaultContainerExtension
    $InfraLocation
    $DatabaseName
    $BlockSize
    $Archive
    $TeXLiveServerURL
    $TeXLiveServerPath
    $TeXLiveURL
    $WinSpecialUpdatePackagesRegexp
    @CriticalPackagesList
    @AllowedConfigOptions
    $WindowsMainMenuName
    $RelocPrefix
    $RelocTree
    %TLPDBSettingType
    %TLPDBSettingDesc
    %TLPDBOptionType
    %TLPDBOptionDesc
    %TLPDBOptionTlmgrName
  );
  @EXPORT = @EXPORT_OK;
}

# the year of our release, will be used in the location of the
# network packges, and in menu names, and probably many other places
$ReleaseYear = 2009;

# Meta Categories do not ship files, but call only for other packages
our @MetaCategories = qw/Collection Scheme/;
our $MetaCategoriesRegexp = '(Collection|Scheme)';
#
# Normal Categories contain actial files and do not depend on other things.
our @NormalCategories = qw/Package TLCore ConTeXt/;
#
# list of all Categories
our @Categories = (@MetaCategories, @NormalCategories);

# repeat, as a regexp.
our $CategoriesRegexp = '(Collection|Scheme|Package|TLCore|ConTeXt)';

our $DefaultCategory = "Package";

# location of various infra files (texlive.tlpdb, .tlpobj etc)
# relative to a root (e.g., the Master/, or the installation path)
our $InfraLocation = "tlpkg";
our $DatabaseName = "texlive.tlpdb";

our $BlockSize = 4096;

# the way we package things on the web
our $DefaultContainerExtension = "tar.xz";

our $Archive = "archive";
our $TeXLiveServerURL = "http://mirror.ctan.org";
# from 2009 on we try to put them all into tlnet directly without any
# release year since we hope that we can switch over to 2010 on the fly
# our $TeXLiveServerPath = "systems/texlive/tlnet/$ReleaseYear";
our $TeXLiveServerPath = "systems/texlive/tlnet";
our $TeXLiveURL = "$TeXLiveServerURL/$TeXLiveServerPath";
our $RelocTree = "texmf-dist";
our $RelocPrefix = "RELOC";

our $WinSpecialUpdatePackagesRegexp = 
  '^(texlive\.infra|tlperl\.win32$)';



our @CriticalPackagesList = qw/texlive.infra/;
push(@CriticalPackagesList, "tlperl.win32") if ($^O=~/^MSWin(32|64)$/i);
  

our @AllowedConfigOptions = qw/
  available_architectures
  opt_create_symlinks
  opt_create_formats
  opt_paper
  opt_sys_bin
  opt_sys_info
  opt_sys_man
  opt_install_docfiles
  opt_install_srcfiles
  platform
  location
  backupdir
  autobackup
  /;

#
# definition of the option strings and their value types 
# possible types are:
# - u: url
# - b: boolean, saved as 0/1
# - p: path (local path)
# - n: naturnal number
#      it allows n:[a]..[b]
#         if a is empty start at -infty
#         if b is empty end at +infty
#      so "n:.." is equivalent to "n"

# WARNING: keep these in sync!
#
our %TLPDBOptionTlmgrName = (
  "location"            => "location",
  "create_formats"      => "formats",
  "desktop_integration" => "deskint",
  "file_assocs"         => "fileassocs",
  "post_code"           => "postcode",
  "sys_bin"             => "sys_bin",
  "sys_info"            => "sys_info",
  "sys_man"             => "sys_man",
  "install_docfiles"    => "docfiles",
  "install_srcfiles"    => "srcfiles",
  "w32_multi_user"      => "multiuser",
  "autobackup"          => "autobackup",
  "backupdir"           => "backupdir");
our %TLPDBOptionType = (
  "location"            => "u",
  "create_formats"      => "b",
  "desktop_integration" => "b",
  "file_assocs"         => "n:0..2",
  "post_code"           => "b",
  "sys_bin"             => "p",
  "sys_info"            => "p",
  "sys_man"             => "p",
  "install_docfiles"    => "b",
  "install_srcfiles"    => "b",
  "w32_multi_user"      => "b",
  "autobackup"          => "n:-1..",
  "backupdir"           => "p");
our %TLPDBOptionDesc = (
  "location"            => "Default installation location",
  "create_formats"      => "Create formats on installation",
  "desktop_integration" => "Create shortcuts (menu and desktop) in postinst",
  "file_assocs"         => "Change file associations in postinst",
  "post_code"           => "Run postinst code blobs",
  "sys_bin"             => "Destination for symlinks for binaries",
  "sys_info"            => "Destination for symlinks for info docs",
  "sys_man"             => "Destination for symlinks for man pages",
  "install_docfiles"    => "Install documentation files",
  "install_srcfiles"    => "Install source files",
  "w32_multi_user"      => "Install for shortcuts/menu items for all users (w32)",
  "autobackup"          => "Number of backups to keep",
  "backupdir"           => "Directory for backups");

our %TLPDBSettingType = (
  "platform"                => "s",
  "available_architectures" => "l"
);
our %TLPDBSettingDesc = (
  "platform"                => "Main platform for this computer",
  "available_architectures" => "All available/installed architectures"
);


our $WindowsMainMenuName = "TeX Live $ReleaseYear";


1;


=head1 NAME

C<TeXLive::TLConfig> -- TeX Live Configurations

=head1 SYNOPSIS

  use TeXLive::TLConfig;

=head1 DESCRIPTION

The L<TeXLive::TLConfig> module contains definitions of variables 
configuring all of TeX Live.

=over 4

=head1 EXPORTED VARIABLES

All of the following variables are pulled into the callers namespace,
i.e., are declared with C<EXPORT> (and C<EXPORT_OK>).

=item C<@TeXLive::TLConfig::MetaCategories>

The list of meta categories, i.e., those categories whose packages only
depend on other packages, but don't ship any files. Currently 
C<Collection> and <Scheme>.

=item C<@TeXLive::TLConfig::NormalCategories>

The list of normal categories, i.e., those categories whose packages do
ship files. Currently C<TLCore>, C<Package>, C<ConTeXt>.

=item C<@TeXLive::TLConfig::Categories>

The list of all categories, i.e., the union of the above.

=item C<$TeXLive::TLConfig::CategoriesRegexp>

A regexp matching any category.

=item C<$TeXLive::TLConfig::DefaultCategory>

The default category used when creating new packages.

=item C<$TeXLive::TLConfig::InfraLocation>

The subdirectory with various infrastructure files (C<texlive.tlpdb>,
tlpobj files, ...) relative to the root of the installation; currently
C<tlpkg>.

=item C<$TeXLive::TLConfig::BlockSize>

The assumed block size, currently 4k.

=item C<$TeXLive::TLConfig::Archive>
=item C<$TeXLive::TLConfig::TeXLiveURL>

These values specify where to find packages.

=item C<$TeXLive::TLConfig::TeXLiveServerURL>
=item C<$TeXLive::TLConfig::TeXLiveServerPath>

C<TeXLiveURL> is concatencated from these values, with a string between.
The defaults are respectively, C<http://mirror.ctan.org> and
C<systems/texlive/tlnet/>I<rel>, where I<rel> specifies the TeX Live
release version, such as C<tldev> or C<2008>.

=item C<$TeXLive::TLConfig::WinSpecialUpdatePackagesRegexp>

A regexp matching all those packages which cannot be normally updated 
because they contain files which are open during the update process.

=item C<@TeXLive::TLConfig::CriticalPackagesList>

A list of all those packages which we do not update regularly
since they are too central, currently only texlive.infra.

=item C<@TeXLive::TLConfig::AllowedConfigOptions>

A list of a config options that can be set in 00texlive.installation.

=item C<$TeXLive::TLConfig::RelocTree>

the texmf-tree name that can be relocated, defaults to "texmf-dist"

=item C<$TeXLive::TLConfig::RelocPrefix>

The string that replaces the RelocTree in the tlpdb if a package is
reloaced, defaults to "RELOC".

=back

=head1 SEE ALSO

The modules L<TeXLive::TLUtils>, L<TeXLive::TLPSRC>,
L<TeXLive::TLPDB>, L<TeXLive::TLTREE>, L<TeXLive::TeXCatalogue>.

=head1 AUTHORS AND COPYRIGHT

This script and its documentation were written for the TeX Live
distribution (L<http://tug.org/texlive>) and both are licensed under the
GNU General Public License Version 2 or later.

=cut

### Local Variables:
### perl-indent-level: 2
### tab-width: 2
### indent-tabs-mode: nil
### End:
# vim:set tabstop=2 expandtab: #