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