docs/usermanual/reference/var_section.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <section id="section_variable" xreflabel="SECTION variable">
   3   <title>SECTION variable: Package category</title>
   4
   5   <para>Sections are a means for categorising packages into related groups to
   6   enable users to find packages easier. The <command>SECTION</command>
   7   variable is used to declare which section a package belongs to. The most
   8   common use of the section information is in GUI based package management
   9   applications.</para>
  10
  11   <para>The default values for the section variables are:</para>
  12
  13   <itemizedlist>
  14     <listitem>
  15       <para><command>SECTION = "base"</command></para>
  16     </listitem>
  17
  18     <listitem>
  19       <para><command>SECTION_${PN}-doc = "doc"</command></para>
  20     </listitem>
  21
  22     <listitem>
  23       <para><command>SECTION_${PN}-dev = "devel"</command></para>
  24     </listitem>
  25   </itemizedlist>
  26
  27   <para>Note that each package generated by a recipe can have it's own section
  28   and that by default documentation and development files are seperated out to
  29   their own sections.</para>
  30
  31   <para>The table of sections show the current usage of section information.
  32   This is a recomendation only, althought it is recomended that any additions
  33   or modifications be discusssed via the open embedded developer mailing list
  34   first.</para>
  35
  36   <informaltable>
  37     <tgroup cols="2">
  38       <colspec colwidth="1*" />
  39
  40       <colspec colwidth="3*" />
  41
  42       <tbody>
  43         <row>
  44           <entry>Section</entry>
  45
  46           <entry>Description</entry>
  47         </row>
  48
  49         <row>
  50           <entry>admin</entry>
  51
  52           <entry></entry>
  53         </row>
  54
  55         <row>
  56           <entry>base</entry>
  57
  58           <entry>Base system files. These are applications which are expected
  59           to be included as part of a base system and include things such as
  60           init scripts, core utilities, standard system daemons etc.</entry>
  61         </row>
  62
  63         <row>
  64           <entry>base/shell</entry>
  65
  66           <entry>Shells such as bash, tcsh, ksh etc.</entry>
  67         </row>
  68
  69         <row>
  70           <entry>bootloaders</entry>
  71
  72           <entry>Bootloaders, which are the applications responsible for
  73           loading the kernel from the appropriate location (disk, flash,
  74           network, etc.) and starting it running.</entry>
  75         </row>
  76
  77         <row>
  78           <entry>console</entry>
  79
  80           <entry>Applications which run on the console. These require no GUI
  81           related libraries or interfaces to run.</entry>
  82         </row>
  83
  84         <row>
  85           <entry>console/editors</entry>
  86
  87           <entry></entry>
  88         </row>
  89
  90         <row>
  91           <entry>console/games</entry>
  92
  93           <entry></entry>
  94         </row>
  95
  96         <row>
  97           <entry>console/multimedia</entry>
  98
  99           <entry></entry>
 100         </row>
 101
 102         <row>
 103           <entry>console/network</entry>
 104
 105           <entry></entry>
 106         </row>
 107
 108         <row>
 109           <entry>console/scientific</entry>
 110
 111           <entry></entry>
 112         </row>
 113
 114         <row>
 115           <entry>console/telephony</entry>
 116
 117           <entry></entry>
 118         </row>
 119
 120         <row>
 121           <entry>console/tools</entry>
 122
 123           <entry></entry>
 124         </row>
 125
 126         <row>
 127           <entry>console/utils</entry>
 128
 129           <entry></entry>
 130         </row>
 131
 132         <row>
 133           <entry>devel</entry>
 134
 135           <entry>Development related files. These include compilers,
 136           libraries, headers, debuggers etc.</entry>
 137         </row>
 138
 139         <row>
 140           <entry>devel/libs</entry>
 141
 142           <entry></entry>
 143         </row>
 144
 145         <row>
 146           <entry>devel/perl</entry>
 147
 148           <entry></entry>
 149         </row>
 150
 151         <row>
 152           <entry>devel/python</entry>
 153
 154           <entry></entry>
 155         </row>
 156
 157         <row>
 158           <entry>devel/rexx</entry>
 159
 160           <entry></entry>
 161         </row>
 162
 163         <row>
 164           <entry>devel/ruby</entry>
 165
 166           <entry></entry>
 167         </row>
 168
 169         <row>
 170           <entry>devel/scheme</entry>
 171
 172           <entry></entry>
 173         </row>
 174
 175         <row>
 176           <entry>devel/tcltk</entry>
 177
 178           <entry></entry>
 179         </row>
 180
 181         <row>
 182           <entry>doc</entry>
 183
 184           <entry>Documentation, including man pages and sample configuration
 185           files.</entry>
 186         </row>
 187
 188         <row>
 189           <entry>e/apps</entry>
 190
 191           <entry></entry>
 192         </row>
 193
 194         <row>
 195           <entry>e/libs</entry>
 196
 197           <entry></entry>
 198         </row>
 199
 200         <row>
 201           <entry>e/utils</entry>
 202
 203           <entry></entry>
 204         </row>
 205
 206         <row>
 207           <entry>fonts</entry>
 208
 209           <entry>Fonts that are not X11 or OPIE specific such as truetype
 210           fonts.</entry>
 211         </row>
 212
 213         <row>
 214           <entry>games</entry>
 215
 216           <entry>Games.</entry>
 217         </row>
 218
 219         <row>
 220           <entry>games/arcade</entry>
 221
 222           <entry></entry>
 223         </row>
 224
 225         <row>
 226           <entry>gpe</entry>
 227
 228           <entry>GPE GUI enviroment. For the anything that provides or uses
 229           the GPE UI. Note that development and documentation related files
 230           should be in the appropriate devel and doc section, not under
 231           GPE.</entry>
 232         </row>
 233
 234         <row>
 235           <entry>gpe/applications</entry>
 236
 237           <entry></entry>
 238         </row>
 239
 240         <row>
 241           <entry>gpe/base</entry>
 242
 243           <entry></entry>
 244         </row>
 245
 246         <row>
 247           <entry>gpe/games</entry>
 248
 249           <entry></entry>
 250         </row>
 251
 252         <row>
 253           <entry>gpe/libs</entry>
 254
 255           <entry>GPE runtime libraries. This does not include libraries used
 256           for development - they should be included in the appropriate devel
 257           section.</entry>
 258         </row>
 259
 260         <row>
 261           <entry>gpe/multimedia</entry>
 262
 263           <entry></entry>
 264         </row>
 265
 266         <row>
 267           <entry>inputmethods</entry>
 268
 269           <entry>inputmethods that are neither libs, nor solely for GPE/Opie or the console</entry>
 270         </row>
 271
 272         <row>
 273           <entry>interpreters</entry>
 274
 275           <entry></entry>
 276         </row>
 277
 278         <row>
 279           <entry>kde</entry>
 280
 281           <entry>KDE related applications.</entry>
 282         </row>
 283
 284         <row>
 285           <entry>kde/devel</entry>
 286
 287           <entry></entry>
 288         </row>
 289
 290         <row>
 291           <entry>kernel</entry>
 292
 293           <entry>Linux kernels.</entry>
 294         </row>
 295
 296         <row>
 297           <entry>kernel/modules</entry>
 298
 299           <entry>Linux kernel modules. This include out-of-tree kernel
 300           modules.</entry>
 301         </row>
 302
 303         <row>
 304           <entry>kernel/userland</entry>
 305
 306           <entry></entry>
 307         </row>
 308
 309         <row>
 310           <entry>libs</entry>
 311
 312           <entry>Runtime libraries. This does not include libraries used for
 313           development - they should be included in the appropriate devel
 314           section.</entry>
 315         </row>
 316
 317         <row>
 318           <entry>libs/inputmethods</entry>
 319
 320           <entry></entry>
 321         </row>
 322
 323         <row>
 324           <entry>libs/multimedia</entry>
 325
 326           <entry></entry>
 327         </row>
 328
 329         <row>
 330           <entry>libs/network</entry>
 331
 332           <entry></entry>
 333         </row>
 334
 335         <row>
 336           <entry>network</entry>
 337
 338           <entry></entry>
 339         </row>
 340
 341         <row>
 342           <entry>network/cms</entry>
 343
 344           <entry></entry>
 345         </row>
 346
 347         <row>
 348           <entry>network/misc</entry>
 349
 350           <entry></entry>
 351         </row>
 352
 353         <row>
 354           <entry>openmoko</entry>
 355
 356           <entry>Anything related to openmoko.org</entry>
 357         </row>
 358
 359         <row>
 360           <entry>openmoko/applications</entry>
 361
 362           <entry></entry>
 363         </row>
 364
 365         <row>
 366           <entry>openmoko/base</entry>
 367
 368           <entry></entry>
 369         </row>
 370
 371         <row>
 372           <entry>openmoko/examples</entry>
 373
 374           <entry></entry>
 375         </row>
 376
 377         <row>
 378           <entry>openmoko/libs</entry>
 379
 380           <entry></entry>
 381         </row>
 382
 383         <row>
 384           <entry>openmoko/pim</entry>
 385
 386           <entry></entry>
 387         </row>
 388
 389         <row>
 390           <entry>openmoko/tools</entry>
 391
 392           <entry></entry>
 393         </row>
 394
 395         <row>
 396           <entry>opie</entry>
 397
 398           <entry>OPIE GUI enviroment. For the anything that provides or uses
 399           the OPIE UI. Note that development and documentation related files
 400           should be in the appropriate devel and doc section, not under
 401           OPIE.</entry>
 402         </row>
 403
 404         <row>
 405           <entry>opie/applets</entry>
 406
 407           <entry></entry>
 408         </row>
 409
 410         <row>
 411           <entry>opie/applications</entry>
 412
 413           <entry></entry>
 414         </row>
 415
 416         <row>
 417           <entry>opie/base</entry>
 418
 419           <entry></entry>
 420         </row>
 421
 422         <row>
 423           <entry>opie/codecs</entry>
 424
 425           <entry></entry>
 426         </row>
 427
 428         <row>
 429           <entry>opie/datebook</entry>
 430
 431           <entry></entry>
 432         </row>
 433
 434         <row>
 435           <entry>opie/decorations</entry>
 436
 437           <entry></entry>
 438         </row>
 439
 440         <row>
 441           <entry>opie/fontfactories</entry>
 442
 443           <entry></entry>
 444         </row>
 445
 446         <row>
 447           <entry>opie/fonts</entry>
 448
 449           <entry>OPIE specific fonts. General fonts, such as truetype fonts,
 450           should be in the fonts section.</entry>
 451         </row>
 452
 453         <row>
 454           <entry>opie/games</entry>
 455
 456           <entry></entry>
 457         </row>
 458
 459         <row>
 460           <entry>opie/help</entry>
 461
 462           <entry></entry>
 463         </row>
 464
 465         <row>
 466           <entry>opie/inputmethods</entry>
 467
 468           <entry></entry>
 469         </row>
 470
 471         <row>
 472           <entry>opie/libs</entry>
 473
 474           <entry>OPIE runtime libraries. This does not include libraries used
 475           for development - they should be included in the appropriate devel
 476           section.</entry>
 477         </row>
 478
 479         <row>
 480           <entry>opie/multimedia</entry>
 481
 482           <entry></entry>
 483         </row>
 484
 485         <row>
 486           <entry>opie/network</entry>
 487
 488           <entry></entry>
 489         </row>
 490
 491         <row>
 492           <entry>opie/pim</entry>
 493
 494           <entry></entry>
 495         </row>
 496
 497         <row>
 498           <entry>opie/security</entry>
 499
 500           <entry></entry>
 501         </row>
 502
 503         <row>
 504           <entry>opie/settings</entry>
 505
 506           <entry></entry>
 507         </row>
 508
 509         <row>
 510           <entry>opie/shell</entry>
 511
 512           <entry></entry>
 513         </row>
 514
 515         <row>
 516           <entry>opie/styles</entry>
 517
 518           <entry></entry>
 519         </row>
 520
 521         <row>
 522           <entry>opie/today</entry>
 523
 524           <entry></entry>
 525         </row>
 526
 527         <row>
 528           <entry>utils</entry>
 529
 530           <entry></entry>
 531         </row>
 532
 533         <row>
 534           <entry>x11</entry>
 535
 536           <entry>X11 GUI platform. For anything that provides or uses the X11
 537           UI and is not GPE. Note that development and documentation related
 538           files should be in the appropriate devel and doc section, not under
 539           X11.</entry>
 540         </row>
 541
 542         <row>
 543           <entry>x11/applications</entry>
 544
 545           <entry>General applications.</entry>
 546         </row>
 547
 548         <row>
 549           <entry>x11/base</entry>
 550
 551           <entry>Core X11 applications.</entry>
 552         </row>
 553
 554         <row>
 555           <entry>x11/data</entry>
 556
 557           <entry></entry>
 558         </row>
 559
 560         <row>
 561           <entry>x11/fonts</entry>
 562
 563           <entry>X11 specific fonts. General fonts, such as truetype fonts,
 564           should be in the fonts section.</entry>
 565         </row>
 566
 567         <row>
 568           <entry>x11/games</entry>
 569
 570           <entry>Games.</entry>
 571         </row>
 572
 573         <row>
 574           <entry>x11/gnome</entry>
 575
 576           <entry>Core gnome applications.</entry>
 577         </row>
 578
 579         <row>
 580           <entry>x11/gnome/libs</entry>
 581
 582           <entry>Gnome runtime libraries. This does not include libraries used
 583           for development - they should be included in the appropriate devel
 584           section.</entry>
 585         </row>
 586
 587         <row>
 588           <entry>x11/graphics</entry>
 589
 590           <entry>Applications which manipulate, display, edit, print etc.
 591           images, photos, diagrams etc.</entry>
 592         </row>
 593
 594         <row>
 595           <entry>x11/libs</entry>
 596
 597           <entry>X11 runtime libraries. This does not include libraries used
 598           for development - they should be included in the appropriate devel
 599           section.</entry>
 600         </row>
 601
 602         <row>
 603           <entry>x11/multimedia</entry>
 604
 605           <entry>Multimedia applications.</entry>
 606         </row>
 607
 608         <row>
 609           <entry>x11/network</entry>
 610
 611           <entry></entry>
 612         </row>
 613
 614         <row>
 615           <entry>x11/office</entry>
 616
 617           <entry>Office and productivity applications.</entry>
 618         </row>
 619
 620         <row>
 621           <entry>x11/scientific</entry>
 622
 623           <entry>Scientific applications.</entry>
 624         </row>
 625
 626         <row>
 627           <entry>x11/utils</entry>
 628
 629           <entry></entry>
 630         </row>
 631
 632         <row>
 633           <entry>x11/wm</entry>
 634
 635           <entry>Window managers.</entry>
 636         </row>
 637       </tbody>
 638     </tgroup>
 639   </informaltable>
 640
 641   <para>The following tables lists some sections which may be in existing
 642   recipes. These should not be used in new recipes and should be renamed when
 643   updated existing recipes that use the specified sections.</para>
 644
 645   <informaltable>
 646     <tgroup cols="2">
 647       <colspec colwidth="1*" />
 648
 649       <colspec colwidth="3*" />
 650
 651       <tbody>
 652         <row>
 653           <entry>Section</entry>
 654
 655           <entry>Action</entry>
 656         </row>
 657
 658         <row>
 659           <entry>apps</entry>
 660
 661           <entry>Replace with appropriate section</entry>
 662         </row>
 663
 664         <row>
 665           <entry>gui</entry>
 666
 667           <entry>Replace with appropriate section</entry>
 668         </row>
 669
 670         <row>
 671           <entry>media-gfx</entry>
 672
 673           <entry>Replace with appropriate section</entry>
 674         </row>
 675
 676         <row>
 677           <entry>multimedia</entry>
 678
 679           <entry>Replace with appropriate section</entry>
 680         </row>
 681
 682         <row>
 683           <entry>net</entry>
 684
 685           <entry>Replace with network</entry>
 686         </row>
 687
 688         <row>
 689           <entry>unknown</entry>
 690
 691           <entry>Replace with appropriate section</entry>
 692         </row>
 693
 694         <row>
 695           <entry>x11-misc</entry>
 696
 697           <entry>Replace with appropriate section</entry>
 698         </row>
 699       </tbody>
 700     </tgroup>
 701   </informaltable>
 702
 703   <para></para>
 704 </section>