Some build fixes for the upgrading checklist
[debian-policy.git] / menu-policy.xml
blobede5c9adf3590f989e43f658676d4e2ca723face
1 <?xml version='1.0' encoding='utf-8'?>
2 <!-- -*- DocBook -*- -->
3 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
4     "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
5 <!ENTITY % versiondata SYSTEM "version.xml"> %versiondata;
6 ]>
8 <book lang="en">
9   <title>The Debian Menu sub-policy</title>
11   <bookinfo>
12     <authorgroup>
13       <author>
14         <personname>
15           <firstname>Chris</firstname><surname>Waters</surname>
16         </personname>
17       </author>
18       <author>
19         <personname>
20           <firstname>Joey</firstname><surname>Hess</surname>
21         </personname>
22       </author>
23       <author>
24         <personname>
25           <firstname>Joost</firstname><surname>Witteveen</surname>
26         </personname>
27       </author>
28       <author>
29         <othername>The Debian Policy mailing List</othername>
30         <email>debian-policy@lists.debian.org</email>
31       </author>
32     </authorgroup>
34     <releaseinfo>version &version;</releaseinfo>
35     <pubdate>&date;</pubdate>
37     <abstract>
38       <para>
39         This manual describes the policy requirements for the Menu system
40         used in the Debian distribution.  This document is part of the
41         policy package for Debian.
42       </para>
43     </abstract>
45     <copyright>
46       <year>1999</year>
47       <holder>Software in the Public Interest, Inc.</holder>
48     </copyright>
50     <legalnotice>
51       <para>
52         This manual is free software; you may redistribute it and/or modify
53         it under the terms of the GNU General Public License as published by
54         the Free Software Foundation; either version 2, or (at your option)
55         any later version.
56       </para>
57       <para>
58         This is distributed in the hope that it will be useful, but
59         <emphasis>without any warranty</emphasis>; without even the implied
60         warranty of merchantability or fitness for a particular purpose.
61         See the GNU General Public License for more details.
62       </para>
63       <para>
64         A copy of the GNU General Public License is available as
65         <literal>/usr/doc/copyright/GPL</literal> in the Debian distribution
66         or on the World Wide Web at <ulink
67         url="http://www.gnu.org/copyleft/gpl.html">The GNU General Public
68         Licence</ulink>.  You can also obtain it by writing to the Free
69         Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
70         02110-1301, USA.
71       </para>
72     </legalnotice>
73   </bookinfo>
75   <chapter id="ch1">
76     <title>About this document</title>
77     <para>
78       This document is distributed as the <literal>menu-policy</literal>
79       files in the Debian package <systemitem role="package"><ulink
80       url="http://packages.debian.org/debian-policy">debian-policy</ulink></systemitem>.
81       It is also available from the Debian web mirrors at <literal><ulink
82       url="http://www.debian.org/doc/packaging-manuals/menu-policy/">/doc/packaging-manuals/menu-policy/</ulink></literal>.
83     </para>
84     <para>
85       This document has been extracted and separated from the
86       <emphasis>Menu</emphasis> package to:
87     </para>
88     <orderedlist numeration="arabic">
89       <listitem>
90         <para>
91           Increase the visibility of the Menu sub policy
92         </para>
93       </listitem>
94       <listitem>
95         <para>
96           Reduce the coupling between policy and implementation.  If this
97           separation is not made, every time we want to change menu
98           policy, we have to arrange to get the maintainer to release a
99           new version of the package, even if the package has not
100           otherwise changed.  It also involves yet another layer, making
101           the policy changes that much harder to implement.
102         </para>
103       </listitem>
104     </orderedlist>
105     <para>
106       The <ulink url="mailto:debian-policy@lists.debian.org">debian-policy
107       mailing list</ulink> has taken responsibility for the contents of
108       this document, with the <emphasis>Menu</emphasis> package
109       maintainer's responsible for packaging administrivia only.
110     </para>
111   </chapter>
113   <chapter id="ch2">
114     <title>Menu Structure</title>
116     <para>
117       If you have a package which doesn't fit within the existing menu
118       hierarchy, please bring it up on the debian-devel mailing list.  If
119       you have other proposals for changing the menu hierarchy, or making
120       other changes to menu policy, please bring it up on debian-policy.
121     </para>
123     <section id="s2.1">
124       <title>Preferred menu structure</title>
126       <para>
127         Here is the authoritative list of Debian's menu structure.
128         Packages must be placed in leaf sections.
129       </para>
131       <variablelist>
132         <varlistentry>
133           <term>Applications</term>
134           <listitem>
135             <para>
136               Normal applications
137             </para>
138             <variablelist>
139               <varlistentry>
140                 <term>Applications/Accessibility</term>
141                 <listitem>
142                   <para>
143                     Tools to aid people with disabilities or for machines
144                     lacking usual input devices.
145                   </para>
146                   <para>
147                     Examples: gok, yasr, dasher.
148                   </para>
149                 </listitem>
150               </varlistentry>
151               <varlistentry>
152                 <term>Applications/Amateur Radio</term>
153                 <listitem>
154                   <para>
155                     Anything relating to HAM radio.
156                   </para>
157                   <para>
158                     Examples: baken, hamsoft, twlog
159                   </para>
160                 </listitem>
161               </varlistentry>
162               <varlistentry>
163                 <term>Applications/Data Management</term>
164                 <listitem>
165                   <para>
166                     Interactive database programs, collection managers,
167                     address books, bibliography tools, etc.
168                   </para>
169                   <para>
170                     gaby, alexandria, mdbtools
171                   </para>
172                 </listitem>
173               </varlistentry>
174               <varlistentry>
175                 <term>Applications/Editors</term>
176                 <listitem>
177                   <para>
178                     Editors, other than office word processors, for
179                     text-based information.
180                   </para>
181                   <para>
182                     Examples: ksubtile, nano, hexedit
183                   </para>
184                 </listitem>
185               </varlistentry>
186               <varlistentry>
187                 <term>Applications/Education</term>
188                 <listitem>
189                   <para>
190                     Educational and training softwares.
191                   </para>
192                   <para>
193                     Examples: gtypist, gcompris, quiz
194                   </para>
195                 </listitem>
196               </varlistentry>
197               <varlistentry>
198                 <term>Applications/Emulators</term>
199                 <listitem>
200                   <para>
201                     Software that allows you to run non-native software or
202                     more than one OS at a time.
203                   </para>
204                   <para>
205                     Examples: wine, dosemu, qemu
206                   </para>
207                 </listitem>
208               </varlistentry>
209               <varlistentry>
210                 <term>Applications/File Management</term>
211                 <listitem>
212                   <para>
213                     Tools for file management, archiving, searching,
214                     CD/DVD burning, backup, etc.
215                   </para>
216                   <para>
217                     Examples: file-roller, mc, baobab
218                   </para>
219                 </listitem>
220               </varlistentry>
221               <varlistentry>
222                 <term>Applications/Graphics</term>
223                 <listitem>
224                   <para>
225                     2D and 3D graphics manipulation software.
226                   </para>
227                   <para>
228                     Examples: gimp, inkscape, imagemagick
229                   </para>
230                 </listitem>
231               </varlistentry>
232               <varlistentry>
233                 <term>Applications/Mobile Devices</term>
234                 <listitem>
235                   <para>
236                     Software that allows you to interface with mobile
237                     devices (phones, PDAs, etc.).
238                   </para>
239                   <para>
240                     Examples: kandy, gnokii, gnome-pilot
241                   </para>
242                 </listitem>
243               </varlistentry>
244               <varlistentry>
245                 <term>Applications/Network</term>
246                 <listitem>
247                   <para>
248                     Network related software.  This is a three-level
249                     section, do not put entries directly here.
250                   </para>
251                   <variablelist>
252                     <varlistentry>
253                       <term>Applications/Network/Communication</term>
254                       <listitem>
255                         <para>
256                           Mail, USENET news, chat, instant messaging, IP
257                           telephony, video conferencing software, etc.
258                         </para>
259                         <para>
260                           Examples: xchat, gaim, mutt
261                         </para>
262                       </listitem>
263                     </varlistentry>
264                     <varlistentry>
265                       <term>Applications/Network/File Transfer</term>
266                       <listitem>
267                         <para>
268                           File transfer software such as download
269                           managers, FTP clients, P2P clients, etc.
270                         </para>
271                         <para>
272                           Examples: amule, gftp, d4x
273                         </para>
274                       </listitem>
275                     </varlistentry>
276                     <varlistentry>
277                       <term>Applications/Network/Monitoring</term>
278                       <listitem>
279                         <para>
280                           Network monitoring software
281                         </para>
282                         <para>
283                           Examples: gip, ettercap, iptstate
284                         </para>
285                       </listitem>
286                     </varlistentry>
287                     <varlistentry>
288                       <term>Applications/Network/Web Browsing</term>
289                       <listitem>
290                         <para>
291                           Web browsers, tools for offline browsing, etc.
292                         </para>
293                         <para>
294                           Examples: elinks, epiphany-browser, webhttrack
295                         </para>
296                       </listitem>
297                     </varlistentry>
298                     <varlistentry>
299                       <term>Applications/Network/Web News</term>
300                       <listitem>
301                         <para>
302                           Web feed (RSS, Atom, etc.) and podcast aggregators.
303                         </para>
304                         <para>
305                           Examples: akregator, kitty, liferea
306                         </para>
307                       </listitem>
308                     </varlistentry>
309                   </variablelist>
310                 </listitem>
311               </varlistentry>
312               <varlistentry>
313                 <term>Applications/Office</term>
314                 <listitem>
315                   <para>
316                     Office suites, word processors, spreadsheets, CRM,
317                     ERP, financial sofware, etc.
318                   </para>
319                   <para>
320                     Examples: openoffice.org, tinyerp-client, gnucash
321                   </para>
322                 </listitem>
323               </varlistentry>
324               <varlistentry>
325                 <term>Applications/Programming</term>
326                 <listitem>
327                   <para>
328                     IDEs, debuggers, etc.
329                   </para>
330                   <para>
331                     Examples: anjuta, gdb, eclipse
332                   </para>
333                 </listitem>
334               </varlistentry>
335               <varlistentry>
336                 <term>Applications/Project Management</term>
337                 <listitem>
338                   <para>
339                     Timetable managers, group task trackers, bug tracking
340                     software, etc.
341                   </para>
342                   <para>
343                     Examples: planner, bugzilla, gnotime
344                   </para>
345                 </listitem>
346               </varlistentry>
347               <varlistentry>
348                 <term>Applications/Science</term>
349                 <listitem>
350                   <para>
351                     Scientific and engineering-related software.
352                   </para>
353                   <variablelist>
354                     <varlistentry>
355                       <term>Applications/Science/Astronomy</term>
356                       <listitem>
357                         <para>
358                           Astronomy-related software.
359                         </para>
360                         <para>
361                           Examples: celestia, spacechart, stellarium
362                         </para>
363                       </listitem>
364                     </varlistentry>
365                     <varlistentry>
366                       <term>Applications/Science/Biology</term>
367                       <listitem>
368                         <para>
369                           Biology-related software.
370                         </para>
371                         <para>
372                           Examples: arb, ncbi-tools-x11, seaview
373                         </para>
374                       </listitem>
375                     </varlistentry>
376                     <varlistentry>
377                       <term>Applications/Science/Chemistry</term>
378                       <listitem>
379                         <para>
380                           Chemistry-related software.
381                         </para>
382                         <para>
383                           Examples: chemtool, kalzium, xdrawchem
384                         </para>
385                       </listitem>
386                     </varlistentry>
387                     <varlistentry>
388                       <term>Applications/Science/Data Analysis</term>
389                       <listitem>
390                         <para>
391                           Software designed for processing, extracting,
392                           and presenting generic scientific data.
393                         </para>
394                         <para>
395                           Examples: fityk, ygraph, mn-fit
396                         </para>
397                       </listitem>
398                     </varlistentry>
399                     <varlistentry>
400                       <term>Applications/Science/Electronics</term>
401                       <listitem>
402                         <para>
403                           Circuit design tools, simulators and assemblers
404                           for microprocessors, etc
405                         </para>
406                         <para>
407                           Examples: geda, gnucap, tkgate
408                         </para>
409                       </listitem>
410                     </varlistentry>
411                     <varlistentry>
412                       <term>Applications/Science/Engineering</term>
413                       <listitem>
414                         <para>
415                           CAD, UML tools, diagram-drawing and other
416                           engineering-related software.
417                         </para>
418                         <para>
419                           Examples: tcm, dia, qcad
420                         </para>
421                       </listitem>
422                     </varlistentry>
423                     <varlistentry>
424                       <term>Applications/Science/Geoscience</term>
425                       <listitem>
426                         <para>
427                           Geoscience-related software.
428                         </para>
429                         <para>
430                           Examples: earth3d, qgis, therion
431                         </para>
432                       </listitem>
433                     </varlistentry>
434                     <varlistentry>
435                       <term>Applications/Science/Mathematics</term>
436                       <listitem>
437                         <para>
438                           Mathematics-related software.
439                         </para>
440                         <para>
441                           Examples: gcalctool, snappea, xeukleides
442                         </para>
443                       </listitem>
444                     </varlistentry>
445                     <varlistentry>
446                       <term>Applications/Science/Medicine</term>
447                       <listitem>
448                         <para>
449                           Medicine-related software.
450                         </para>
451                         <para>
452                           Examples: mssstest, gnumed-client, xmedcon
453                         </para>
454                       </listitem>
455                     </varlistentry>
456                     <varlistentry>
457                       <term>Applications/Science/Physics</term>
458                       <listitem>
459                         <para>
460                           Physics-related software.
461                         </para>
462                         <para>
463                           Examples: kxterm, ifrit, paw
464                         </para>
465                       </listitem>
466                     </varlistentry>
467                     <varlistentry>
468                       <term>Applications/Science/Social</term>
469                       <listitem>
470                         <para>
471                           Social sciences-related software.
472                         </para>
473                         <para>
474                           Examples: gnomesword, hanzim, bibletime
475                         </para>
476                       </listitem>
477                     </varlistentry>
478                   </variablelist>
479                 </listitem>
480               </varlistentry>
481               <varlistentry>
482                 <term>Applications/Shells</term>
483                 <listitem>
484                   <para>
485                     Various shells to be used inside a terminal emulator.
486                   </para>
487                   <para>
488                     Examples: bash, ksh, zsh
489                   </para>
490                 </listitem>
491               </varlistentry>
492               <varlistentry>
493                 <term>Applications/Sound</term>
494                 <listitem>
495                   <para>
496                     Sound players, editors, and rippers/recorders.
497                   </para>
498                   <para>
499                     Examples: beep-media-player, grip, audacity
500                   </para>
501                 </listitem>
502               </varlistentry>
503               <varlistentry>
504                 <term>Applications/System</term>
505                 <listitem>
506                   <para>
507                     System related software.
508                   </para>
509                   <variablelist>
510                     <varlistentry>
511                       <term>Applications/System/Administration</term>
512                       <listitem>
513                         <para>
514                           Administrative and system configuration
515                           utilities, also tools for personal user
516                           settings.
517                         </para>
518                         <para>
519                           Examples: gnome-control-center,
520                           configure-debian, gksu
521                         </para>
522                       </listitem>
523                     </varlistentry>
524                     <varlistentry>
525                       <term>Applications/System/Hardware</term>
526                       <listitem>
527                         <para>
528                           Tools for manipulating specific hardware,
529                           especially non-standard laptop hardware.
530                         </para>
531                         <para>
532                           Examples: toshutils, nvclock-gtk, nvtv
533                         </para>
534                       </listitem>
535                     </varlistentry>
536                     <varlistentry>
537                       <term>Applications/System/Language Environment</term>
538                       <listitem>
539                         <para>
540                           This section is reserved for language-env as a
541                           special case.
542                         </para>
543                       </listitem>
544                     </varlistentry>
545                     <varlistentry>
546                       <term>Applications/System/Monitoring</term>
547                       <listitem>
548                         <para>
549                           System information and monitoring tools, log
550                           viewers, etc.
551                         </para>
552                         <para>
553                           Examples: top, hal-device-manager, gtkdiskfree
554                         </para>
555                       </listitem>
556                     </varlistentry>
557                     <varlistentry>
558                       <term>Applications/System/Package Management</term>
559                       <listitem>
560                         <para>
561                           Package managers and related tools.
562                         </para>
563                         <para>
564                           Examples: aptitude, deborphan, smartpm
565                         </para>
566                       </listitem>
567                     </varlistentry>
568                     <varlistentry>
569                       <term>Applications/System/Security</term>
570                       <listitem>
571                         <para>
572                           Security, cryptography and privacy related
573                           software, antiviruses, tools to track and report
574                           bugs, etc.
575                         </para>
576                         <para>
577                           Examples: gpgkeys, bastille, avscan
578                         </para>
579                       </listitem>
580                     </varlistentry>
581                   </variablelist>
582                 </listitem>
583               </varlistentry>
584               <varlistentry>
585                 <term>Applications/Terminal Emulators</term>
586                 <listitem>
587                   <para>
588                     Graphical terminal emulators.
589                   </para>
590                   <para>
591                     Examples: xterm, gnome-terminal, rxvt
592                   </para>
593                 </listitem>
594               </varlistentry>
595               <varlistentry>
596                 <term>Applications/Text</term>
597                 <listitem>
598                   <para>
599                     Text oriented tools like dictionaries, OCR,
600                     translation, text analysis software, etc.
601                   </para>
602                   <para>
603                     Examples: kdrill, stardict, turkey
604                   </para>
605                 </listitem>
606               </varlistentry>
607               <varlistentry>
608                 <term>Applications/TV and Radio</term>
609                 <listitem>
610                   <para>
611                     TV-in, TV-out, FM radio, teletext browsers, etc.
612                   </para>
613                   <para>
614                     Examples: gradio, gatos, alevt
615                   </para>
616                 </listitem>
617               </varlistentry>
618               <varlistentry>
619                 <term>Applications/Viewers</term>
620                 <listitem>
621                   <para>
622                     Software for viewing images, documents and other
623                     (non-video) media.
624                   </para>
625                   <para>
626                     Examples: gqview, evince, gthumb
627                   </para>
628                 </listitem>
629               </varlistentry>
630               <varlistentry>
631                 <term>Applications/Video</term>
632                 <listitem>
633                   <para>
634                     Video players, editors, and rippers/recorders.
635                   </para>
636                   <para>
637                     Examples: istanbul, totem, kino
638                   </para>
639                 </listitem>
640               </varlistentry>
641               <varlistentry>
642                 <term>Applications/Web Development</term>
643                 <listitem>
644                   <para>
645                     Software for web site editing, web programming, and
646                     site administration.
647                   </para>
648                   <para>
649                     Examples: bluefish, screem, gphpedit
650                   </para>
651                 </listitem>
652               </varlistentry>
653             </variablelist>
654           </listitem>
655         </varlistentry>
657         <varlistentry>
658           <term>Games</term>
659           <listitem>
660             <para>
661               Games and recreations
662             </para>
663             <variablelist>
664               <varlistentry>
665                 <term>Games/Action</term>
666                 <listitem>
667                   <para>
668                     Games that involve a lot of action and require fast
669                     reflexes.
670                   </para>
671                   <para>
672                     Examples: xsoldier, supertux, xmoto
673                   </para>
674                 </listitem>
675               </varlistentry>
676               <varlistentry>
677                 <term>Games/Adventure</term>
678                 <listitem>
679                   <para>
680                     Role playing and adventure games, interactive movies
681                     and stories, etc.
682                   </para>
683                   <para>
684                     Examples: beneath-a-steel-sky, egoboo, kq
685                   </para>
686                 </listitem>
687               </varlistentry>
688               <varlistentry>
689                 <term>Games/Blocks</term>
690                 <listitem>
691                   <para>
692                     Tetris-like games involving falling blocks.
693                   </para>
694                   <para>
695                     Examples: crack-attack, frozen-bubble, netris
696                   </para>
697                 </listitem>
698               </varlistentry>
699               <varlistentry>
700                 <term>Games/Board</term>
701                 <listitem>
702                   <para>
703                     Games played on a board.
704                   </para>
705                   <para>
706                     Examples: phalanx, xshogi, xboard
707                   </para>
708                 </listitem>
709               </varlistentry>
710               <varlistentry>
711                 <term>Games/Card</term>
712                 <listitem>
713                   <para>
714                     Games involving a deck of cards.
715                   </para>
716                   <para>
717                     Examples: pysol, ace-of-penguins, xpat2
718                   </para>
719                 </listitem>
720               </varlistentry>
721               <varlistentry>
722                 <term>Games/Puzzles</term>
723                 <listitem>
724                   <para>
725                     Tests of ingenuity and logic.
726                   </para>
727                   <para>
728                     Examples: xmpuzzles, sgt-puzzles, enigma
729                   </para>
730                 </listitem>
731               </varlistentry>
732               <varlistentry>
733                 <term>Games/Simulation</term>
734                 <listitem>
735                   <para>
736                     Simulations of the real world in all detail and
737                     complexity.
738                   </para>
739                   <para>
740                     Examples: flightgear, torcs
741                   </para>
742                 </listitem>
743               </varlistentry>
744               <varlistentry>
745                 <term>Games/Strategy</term>
746                 <listitem>
747                   <para>
748                     Games involving long-term strategic thinking.
749                   </para>
750                   <para>
751                     Examples: wesnoth, widelands, netpanzer
752                   </para>
753                 </listitem>
754               </varlistentry>
755               <varlistentry>
756                 <term>Games/Tools</term>
757                 <listitem>
758                   <para>
759                     Server browsers, configurators, editors, and other
760                     game-related tools that are not games themselves.
761                   </para>
762                   <para>
763                     Examples: xqf, crystalspace
764                   </para>
765                 </listitem>
766               </varlistentry>
767               <varlistentry>
768                 <term>Games/Toys</term>
769                 <listitem>
770                   <para>
771                     Amusements, eye-candy, entertaining demos, screen
772                     hacks (screensavers), etc.
773                   </para>
774                   <para>
775                     Examples: xdesktopwaves, xphoon, xpenguins
776                   </para>
777                 </listitem>
778               </varlistentry>
779             </variablelist>
780           </listitem>
781         </varlistentry>
783         <varlistentry>
784           <term>Help</term>
785           <listitem>
786             <para>
787               programs that provide user documentation
788             </para>
789             <para>
790               Examples: debian-reference, apt-howto, dhelp
791             </para>
792           </listitem>
793         </varlistentry>
795         <varlistentry>
796           <term>Screen</term>
797           <listitem>
798             <para>
799               Programs that affect the whole screen.
800             </para>
801             <variablelist>
802               <varlistentry>
803                 <term>Screen/Saving</term>
804                 <listitem>
805                   <para>
806                     Tools for blanking the screen.  Entries of screen
807                     hacks and configuration GUIs should go to other
808                     appropriate sections.
809                   </para>
810                   <para>
811                     Examples: xscreensaver, xlockmore
812                   </para>
813                 </listitem>
814               </varlistentry>
815               <varlistentry>
816                 <term>Screen/Locking</term>
817                 <listitem>
818                   <para>
819                     Tools for locking the screen.
820                   </para>
821                   <para>
822                     Examples: xscreensaver, xlockmore
823                   </para>
824                 </listitem>
825               </varlistentry>
826             </variablelist>
827           </listitem>
828         </varlistentry>
830         <varlistentry>
831           <term>Window Managers</term>
832           <listitem>
833             <para>
834               X window managers.
835             </para>
836             <para>
837               Examples: fluxbox, metacity, waimea
838             </para>
839           </listitem>
840         </varlistentry>
842         <varlistentry>
843           <term>FVWM Modules</term>
844           <listitem>
845             <para>
846               FVWM-based window manager modules.  As only modules related
847               to the running window-manager are displayed, do not create
848               subsections for specific window-managers.
849             </para>
850             <para>
851               Examples: fvwm, fvwm-gnome, fvwm95
852             </para>
853           </listitem>
854         </varlistentry>
856         <varlistentry>
857           <term>Window Maker</term>
858           <listitem>
859             <para>
860               This section is reserved for wmaker as a special case.
861             </para>
862             <para>
863               All wmaker specific entries must go here.
864             </para>
865           </listitem>
866         </varlistentry>
867       </variablelist>
868     </section>
869   </chapter>
870 </book>