Debian Codegraph @

README

raw
1 The interface uses debconf for consistency with the rest of the Debian
2 installer.
3
4 On startup, the tasksel program will read all *.desc files in
5 /usr/share/tasksel/ for information about what tasks are available. The
6 tasks will be presented in a simple list selection screen with their short
7 descriptions.
8
9 On exit, tasksel executes the appropriate command to install the selected
10 packages. If the -t option is given, then tasksel prints out the command
11 line to use to stdout instead. All other messages are printed to stderr.
12
13 To get a new task added to Debian, please file a bug report on tasksel.
14 Or, create a task package yourself, and then file a bug report on tasksel
15 for it to be added to tasksel's UI.
16
17 Debian derived distributions can add a new .desc file to
18 /usr/share/tasksel/ to add additional tasks, or modify/divert
19 debian-tasks.desc to remove tasks.
20
21 The file format is a rfc-822 style stanza, with fields named Task, Section
22 Description (which should include an extended description), Key, Packages,
23 Enhances, Test-, Relevance, and Parent fields. Here is an example:
24
25 Task: graphical-games
26 Relevance: 9
27 Parent: games
28 Section: user
29 Description: Graphical games
30 This task provides a variety of graphical games. Old-school unix games are
31 not included.
32 Key:
33 x-window-system-core
34 Packages: list
35 quake
36 myst
37 monkey-island
38
39 The Key field lists packages that are essential to the task. If those
40 packages are not available, then the task will not be available either. It
41 need not list all the packages in the task, if some only serve to make it
42 better when they are available.
43
44 The Packages field tells how to get a complete list of packages that are in
45 the task. In the example above, it uses the "list" method, which is defined
46 in /usr/lib/tasksel/packages/list. This simple method just lets you list
47 the packages you want to include in the task in the following lines.
48 All Key packages will be also be selected for installation when a task is
49 installed.
50
51 In Debian, we have switched to using task packages, so the task files just
52 list the task packages as Key, and don't list other packages in the task
53 (instead they are Depends and Recommends of the task package). Another
54 available method is "standard", which just installs all standard priority
55 packages, and another is "manual", which, as a special case, runs aptitude
56 interactively to select what to install.
57
58 It's also possible to define other methods, by adding programs to
59 /usr/lib/tasksel/packages/. Then list the name of the program as the first
60 word of the task field, and it will be run and passed the name of the task as
61 its first parameter and any further lines of the task field as its other
62 parameters, and should output a list of packages in that task. The "list"
63 method described above is a simple example of such a program.
64
65 There is support for automatically installing tasks based on test programs.
66 If a task has a Test-* field, then a program in /usr/lib/tasksel/tests/
67 will be run. For example Test-lang fields cause /usr/lib/tasksel/tests/lang
68 to be run. The test is passed first the name of the task, and then the
69 contents of the field as parameters. The exit code of the test controls
70 what to do with the task:
71
72 0 - do not display, but do install task
73 1 - do not display task
74 2 - display task, marked for installation
75 3 - display task, not marked for installation
76
77 One use of these tests is in automatically selecting a language task
78 appropriate for the user's locale, and hiding the rest. The lang test
79 handles this by comparing the value of the Test-lang field of a task with
80 the locale setting. Tests could also be used for things like automatically
81 installing hardware support tasks on systems with the right hardware.
82
83 There is support for tasks that enhance other tasks. If a task has a
84 Enhances field, then it should only be installed if all the tasks
85 listed as in that field are installed. For example, a french-desktop task
86 enchances a system that has both the french and desktop tasks, and will be
87 automatically installed on such a system but not others. Such tasks are
88 hidden from the menu.
89
90 If two tasks both enhance the same task, but only one should be selected,
91 this can be accomplished by adding Test-* fields.
92
93 Tasks can be children of a parent task, indicated by using the Parent
94 field. For example, the desktop task is the parent of gnome-desktop,
95 kde-desktop, etc. This only controls the display; child tasks are displayed
96 nested underneath the parent. Only 1 level of nesting is currently
97 supported. Selecting the parent task does not select any or all of
98 the child tasks, nor does selecting a child task ensure that the parent
99 task is installed. Instead, use dependencies between the task packages to
100 express any such relationships.
101
102 If a task is important enough that it should go near the top,
103 give it a relevance of 1. If a task is not likely to be
104 used, give it a relevance of 9. Default is 5. Relevance can go from
105 1 to 99.
106
107 The Section field is not used by tasksel, but debian-cd currently uses it
108 to determine if a task is a localization task, or a desktop task, or a
109 server task.
110
111 tasksel also supports preinst, postinst, prerm, and postrm scripts for
112 tasks. These are run before a task is installed, and after it is removed as
113 with the dpkg scripts. These scripts sould be installed in
114 /usr/lib/tasksel/info/, for example, /usr/lib/tasksel/info/desktop.preinst.
115 Currently they are passed no parameters, but this might change later. These
116 scripts should take care not to output anything to stdout. You are not
117 encouraged to use these scripts to install any packages, as in some
118 situations apt can hang prompting for a CD switch if run from one of these
119 scripts.