summaryrefslogtreecommitdiff
path: root/docs/usermanual/reference/var_section.xml
blob: 96b746e56c6b6c7f738161945c629aaf415f026d (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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
<?xml version="1.0" encoding="UTF-8"?>
<section id="section_variable" xreflabel="SECTION variable">
  <title>SECTION variable: Package category</title>

  <para>Sections are a means for categorising packages into related groups to
  enable users to find packages easier. The <command>SECTION</command>
  variable is used to declare which section a package belongs to. The most
  common use of the section information is in GUI based package management
  applications.</para>

  <para>The default values for the section variables are:</para>

  <itemizedlist>
    <listitem>
      <para><command>SECTION = "base"</command></para>
    </listitem>

    <listitem>
      <para><command>SECTION_${PN}-doc = "doc"</command></para>
    </listitem>

    <listitem>
      <para><command>SECTION_${PN}-dev = "devel"</command></para>
    </listitem>
  </itemizedlist>

  <para>Note that each package generated by a recipe can have it's own section
  and that by default documentation and development files are seperated out to
  their own sections.</para>

  <para>The table of sections show the current usage of section information.
  This is a recomendation only, althought it is recomended that any additions
  or modifications be discusssed via the open embedded developer mailing list
  first.</para>

  <informaltable>
    <tgroup cols="2">
      <colspec colwidth="1*" />

      <colspec colwidth="3*" />

      <tbody>
        <row>
          <entry>Section</entry>

          <entry>Description</entry>
        </row>

        <row>
          <entry>admin</entry>

          <entry></entry>
        </row>

        <row>
          <entry>base</entry>

          <entry>Base system files. These are applications which are expected
          to be included as part of a base system and include things such as
          init scripts, core utilities, standard system daemons etc.</entry>
        </row>

        <row>
          <entry>base/shell</entry>

          <entry>Shells such as bash, tcsh, ksh etc.</entry>
        </row>

        <row>
          <entry>bootloaders</entry>

          <entry>Bootloaders, which are the applications responsible for
          loading the kernel from the appropriate location (disk, flash,
          network, etc.) and starting it running.</entry>
        </row>

        <row>
          <entry>console</entry>

          <entry>Applications which run on the console. These require no GUI
          related libraries or interfaces to run.</entry>
        </row>

        <row>
          <entry>console/editors</entry>

          <entry></entry>
        </row>

        <row>
          <entry>console/games</entry>

          <entry></entry>
        </row>

        <row>
          <entry>console/multimedia</entry>

          <entry></entry>
        </row>

        <row>
          <entry>console/network</entry>

          <entry></entry>
        </row>

        <row>
          <entry>console/scientific</entry>

          <entry></entry>
        </row>

        <row>
          <entry>console/telephony</entry>

          <entry></entry>
        </row>

        <row>
          <entry>console/tools</entry>

          <entry></entry>
        </row>

        <row>
          <entry>console/utils</entry>

          <entry></entry>
        </row>

        <row>
          <entry>devel</entry>

          <entry>Development related files. These include compilers,
          libraries, headers, debuggers etc.</entry>
        </row>

        <row>
          <entry>devel/libs</entry>

          <entry></entry>
        </row>

        <row>
          <entry>devel/perl</entry>

          <entry></entry>
        </row>

        <row>
          <entry>devel/python</entry>

          <entry></entry>
        </row>

        <row>
          <entry>devel/rexx</entry>

          <entry></entry>
        </row>

        <row>
          <entry>devel/ruby</entry>

          <entry></entry>
        </row>

        <row>
          <entry>devel/scheme</entry>

          <entry></entry>
        </row>

        <row>
          <entry>devel/tcltk</entry>

          <entry></entry>
        </row>

        <row>
          <entry>doc</entry>

          <entry>Documentation, including man pages and sample configuration
          files.</entry>
        </row>

        <row>
          <entry>e/apps</entry>

          <entry></entry>
        </row>

        <row>
          <entry>e/libs</entry>

          <entry></entry>
        </row>

        <row>
          <entry>e/utils</entry>

          <entry></entry>
        </row>

        <row>
          <entry>fonts</entry>

          <entry>Fonts that are not X11 or OPIE specific such as truetype
          fonts.</entry>
        </row>

        <row>
          <entry>games</entry>

          <entry>Games.</entry>
        </row>

        <row>
          <entry>games/arcade</entry>

          <entry></entry>
        </row>

        <row>
          <entry>gpe</entry>

          <entry>GPE GUI enviroment. For the anything that provides or uses
          the GPE UI. Note that development and documentation related files
          should be in the appropriate devel and doc section, not under
          GPE.</entry>
        </row>

        <row>
          <entry>gpe/applications</entry>

          <entry></entry>
        </row>

        <row>
          <entry>gpe/base</entry>

          <entry></entry>
        </row>

        <row>
          <entry>gpe/games</entry>

          <entry></entry>
        </row>

        <row>
          <entry>gpe/libs</entry>

          <entry>GPE runtime libraries. This does not include libraries used
          for development - they should be included in the appropriate devel
          section.</entry>
        </row>

        <row>
          <entry>gpe/multimedia</entry>

          <entry></entry>
        </row>

        <row>
          <entry>inputmethods</entry>

          <entry>inputmethods that are neither libs, nor solely for GPE/Opie or the console</entry>
        </row>

        <row>
          <entry>interpreters</entry>

          <entry></entry>
        </row>

        <row>
          <entry>kde</entry>

          <entry>KDE related applications.</entry>
        </row>

        <row>
          <entry>kde/devel</entry>

          <entry></entry>
        </row>

        <row>
          <entry>kernel</entry>

          <entry>Linux kernels.</entry>
        </row>

        <row>
          <entry>kernel/modules</entry>

          <entry>Linux kernel modules. This include out-of-tree kernel
          modules.</entry>
        </row>

        <row>
          <entry>kernel/userland</entry>

          <entry></entry>
        </row>

        <row>
          <entry>libs</entry>

          <entry>Runtime libraries. This does not include libraries used for
          development - they should be included in the appropriate devel
          section.</entry>
        </row>

        <row>
          <entry>libs/inputmethods</entry>

          <entry></entry>
        </row>

        <row>
          <entry>libs/multimedia</entry>

          <entry></entry>
        </row>

        <row>
          <entry>libs/network</entry>

          <entry></entry>
        </row>

        <row>
          <entry>network</entry>

          <entry></entry>
        </row>

        <row>
          <entry>network/cms</entry>

          <entry></entry>
        </row>

        <row>
          <entry>network/misc</entry>

          <entry></entry>
        </row>

        <row>
          <entry>openmoko</entry>

          <entry>Anything related to openmoko.org</entry>
        </row>

        <row>
          <entry>openmoko/applications</entry>

          <entry></entry>
        </row>

        <row>
          <entry>openmoko/base</entry>

          <entry></entry>
        </row>

        <row>
          <entry>openmoko/examples</entry>

          <entry></entry>
        </row>

        <row>
          <entry>openmoko/libs</entry>

          <entry></entry>
        </row>

        <row>
          <entry>openmoko/pim</entry>

          <entry></entry>
        </row>

        <row>
          <entry>openmoko/tools</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie</entry>

          <entry>OPIE GUI enviroment. For the anything that provides or uses
          the OPIE UI. Note that development and documentation related files
          should be in the appropriate devel and doc section, not under
          OPIE.</entry>
        </row>

        <row>
          <entry>opie/applets</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/applications</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/base</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/codecs</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/datebook</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/decorations</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/fontfactories</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/fonts</entry>

          <entry>OPIE specific fonts. General fonts, such as truetype fonts,
          should be in the fonts section.</entry>
        </row>

        <row>
          <entry>opie/games</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/help</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/inputmethods</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/libs</entry>

          <entry>OPIE runtime libraries. This does not include libraries used
          for development - they should be included in the appropriate devel
          section.</entry>
        </row>

        <row>
          <entry>opie/multimedia</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/network</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/pim</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/security</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/settings</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/shell</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/styles</entry>

          <entry></entry>
        </row>

        <row>
          <entry>opie/today</entry>

          <entry></entry>
        </row>

        <row>
          <entry>utils</entry>

          <entry></entry>
        </row>

        <row>
          <entry>x11</entry>

          <entry>X11 GUI platform. For anything that provides or uses the X11 
          UI and is not GPE. Note that development and documentation related 
          files should be in the appropriate devel and doc section, not under
          X11.</entry>
        </row>

        <row>
          <entry>x11/applications</entry>

          <entry>General applications.</entry>
        </row>

        <row>
          <entry>x11/base</entry>

          <entry>Core X11 applications.</entry>
        </row>

        <row>
          <entry>x11/data</entry>

          <entry></entry>
        </row>

        <row>
          <entry>x11/fonts</entry>

          <entry>X11 specific fonts. General fonts, such as truetype fonts,
          should be in the fonts section.</entry>
        </row>

        <row>
          <entry>x11/games</entry>

          <entry>Games.</entry>
        </row>

        <row>
          <entry>x11/gnome</entry>

          <entry>Core gnome applications.</entry>
        </row>

        <row>
          <entry>x11/gnome/libs</entry>

          <entry>Gnome runtime libraries. This does not include libraries used
          for development - they should be included in the appropriate devel
          section.</entry>
        </row>

        <row>
          <entry>x11/graphics</entry>

          <entry>Applications which manipulate, display, edit, print etc.
          images, photos, diagrams etc.</entry>
        </row>

        <row>
          <entry>x11/libs</entry>

          <entry>X11 runtime libraries. This does not include libraries used
          for development - they should be included in the appropriate devel
          section.</entry>
        </row>

        <row>
          <entry>x11/multimedia</entry>

          <entry>Multimedia applications.</entry>
        </row>

        <row>
          <entry>x11/network</entry>

          <entry></entry>
        </row>

        <row>
          <entry>x11/office</entry>

          <entry>Office and productivity applications.</entry>
        </row>

        <row>
          <entry>x11/scientific</entry>

          <entry>Scientific applications.</entry>
        </row>

        <row>
          <entry>x11/utils</entry>

          <entry></entry>
        </row>

        <row>
          <entry>x11/wm</entry>

          <entry>Window managers.</entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>

  <para>The following tables lists some sections which may be in existing
  recipes. These should not be used in new recipes and should be renamed when
  updated existing recipes that use the specified sections.</para>

  <informaltable>
    <tgroup cols="2">
      <colspec colwidth="1*" />

      <colspec colwidth="3*" />

      <tbody>
        <row>
          <entry>Section</entry>

          <entry>Action</entry>
        </row>

        <row>
          <entry>apps</entry>

          <entry>Replace with appropriate section</entry>
        </row>

        <row>
          <entry>gui</entry>

          <entry>Replace with appropriate section</entry>
        </row>

        <row>
          <entry>media-gfx</entry>

          <entry>Replace with appropriate section</entry>
        </row>

        <row>
          <entry>multimedia</entry>

          <entry>Replace with appropriate section</entry>
        </row>

        <row>
          <entry>net</entry>

          <entry>Replace with network</entry>
        </row>

        <row>
          <entry>unknown</entry>

          <entry>Replace with appropriate section</entry>
        </row>

        <row>
          <entry>x11-misc</entry>

          <entry>Replace with appropriate section</entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>

  <para></para>
</section>