Merge branch 'master' into bug23712-rra
[debian-policy.git] / menu-policy.sgml
blobc91974064bae9c61f96b28d2201220066f296a5d
1 <!doctype debiandoc system [
2 <!-- include version information so we don't have to hard code it
3 within the document -->
4 <!entity % versiondata SYSTEM "version.ent"> %versiondata;
5 ]>
6 <debiandoc>
8 <!--
9 The debian-policy mailing list has taken responsibility for the
10 contents of this document, with the package maintainers responsible
11 for packaging administrivia only.
12 -->
14 <book>
15 <titlepag>
16 <title>The Debian Menu sub-policy</title>
17 <author>
18 <name>Chris Waters</name>
19 </author>
20 <author>
21 <name>Joey Hess</name>
22 </author>
23 <author>
24 <name>Joost Witteveen</name>
25 </author>
26 <author>
27 <name>The Debian Policy mailing List</name>
28 <email>debian-policy@lists.debian.org</email>
29 </author>
30 <version>version &version;, &date;</version>
32 <abstract>
33 This manual describes the policy requirements for the Menu
34 system used in the Debian distribution. This
35 document is part of the policy package for Debian.
36 </abstract>
38 <copyright>
39 <copyrightsummary>
40 Copyright &copy; 1999 Software in the Public Interest, Inc.
41 </copyrightsummary>
42 <p>
43 This manual is free software; you may redistribute it and/or
44 modify it under the terms of the GNU General Public License
45 as published by the Free Software Foundation; either version
46 2, or (at your option) any later version.
47 </p>
48 <p>
49 This is distributed in the hope that it will be useful, but
50 <em>without any warranty</em>; without even the implied
51 warranty of merchantability or fitness for a particular
52 purpose. See the GNU General Public License for more
53 details.
54 </p>
55 <p>
56 A copy of the GNU General Public License is available as
57 <tt>/usr/doc/copyright/GPL</tt> in the Debian
58 distribution or on the World Wide Web at
59 <url id="http://www.gnu.org/copyleft/gpl.html"
60 name="The GNU General Public Licence">. You can also obtain it by writing to the
61 Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
62 Boston, MA 02110-1301, USA.
63 </p>
64 </copyright>
65 </titlepag>
67 <toc detail="sect">
68 <chapt>
69 <heading>About this document</heading>
71 <p>
72 This document is distributed as the <tt>menu-policy</tt> files
73 in the Debian package
74 <package><url name="debian-policy" id="http://packages.debian.org/debian-policy"></package>.
75 It is also available from the Debian web mirrors at
76 <tt><url name="/doc/packaging-manuals/menu-policy/"
77 id="http://www.debian.org/doc/packaging-manuals/menu-policy/"></tt>.
78 </p>
80 <p>
81 This document has been extracted and separated from the
82 <em>Menu</em> package to:<enumlist>
83 <item>
84 <p>Increase the visibility of the Menu sub policy</p>
85 </item>
86 <item>
87 <p>
88 Reduce the coupling between policy and
89 implementation. If this separation is not made, every
90 time we want to change menu policy, we have to arrange
91 to get the maintainer to release a new version of the
92 package, even if the package has not otherwise
93 changed. It also involves yet another layer, making the
94 policy changes that much harder to implement.</p>
95 </item>
96 </enumlist>
97 </p>
98 </chapt>
100 <chapt>
101 <heading>Menu Structure</heading>
103 If you have a package which doesn't fit within the existing
104 menu hierarchy, please bring it up on the debian-devel mailing
105 list. If you have other proposals for changing the menu
106 hierarchy, or making other changes to menu policy, please
107 bring it up on debian-policy.
108 </p>
109 <sect>
110 <heading>Preferred menu structure</heading>
112 Here is the authoritative list of Debian's menu
113 structure. Packages must be placed in leaf sections.
114 </p>
115 <p><taglist>
116 <tag>Applications</tag>
117 <item>
118 <p>Normal applications</p>
119 <p><taglist>
120 <tag>Applications/Accessibility</tag>
121 <item>
122 <p>Tools to aid people with disabilities or for machines
123 lacking usual input devices.</p>
124 <p>Examples: gok, yasr, dasher.</p>
125 </item>
126 <tag>Applications/Amateur Radio</tag>
127 <item>
128 <p>Anything relating to HAM radio.</p>
129 <p>Examples: baken, hamsoft, twlog</p>
130 </item>
131 <tag>Applications/Data Management</tag>
132 <item>
133 <p>Interactive database programs, collection managers,
134 address books, bibliography tools, etc.</p>
135 <p>gaby, alexandria, mdbtools</p>
136 </item>
137 <tag>Applications/Editors</tag>
138 <item>
139 <p>Editors, other than office word processors, for
140 text-based information.</p>
141 <p>Examples: ksubtile, nano, hexedit</p>
142 </item>
143 <tag>Applications/Education</tag>
144 <item>
145 <p>Educational and training softwares.</p>
146 <p>Examples: gtypist, gcompris, quiz</p>
147 </item>
148 <tag>Applications/Emulators</tag>
149 <item>
150 <p>Software that allows you to run non-native
151 software or more than one OS at a time.</p>
152 <p>Examples: wine, dosemu, qemu</p>
153 </item>
154 <tag>Applications/File Management</tag>
155 <item>
156 <p>Tools for file management, archiving,
157 searching, CD/DVD burning, backup, etc.</p>
158 <p>Examples: file-roller, mc, baobab</p>
159 </item>
160 <tag>Applications/Graphics</tag>
161 <item>
162 <p>2D and 3D graphics manipulation software.</p>
163 <p>Examples: gimp, inkscape, imagemagick</p>
164 </item>
165 <tag>Applications/Mobile Devices</tag>
166 <item>
167 <p>Software that allows you to interface with mobile
168 devices (phones, PDAs, etc.).</p>
169 <p>Examples: kandy, gnokii, gnome-pilot</p>
170 </item>
171 <tag>Applications/Network</tag>
172 <item>
173 Network related software. This is a three-level
174 section, do not put entries directly here.
175 <taglist>
176 <tag>Applications/Network/Communication</tag>
177 <item>
178 <p>Mail, USENET news, chat, instant messaging,
179 IP telephony, video conferencing software, etc.</p>
180 <p>Examples: xchat, gaim, mutt</p>
181 </item>
182 <tag>Applications/Network/File Transfer</tag>
183 <item>
184 <p>File transfer software such as download
185 managers, FTP clients, P2P clients, etc.</p>
186 <p>Examples: amule, gftp, d4x</p>
187 </item>
188 <tag>Applications/Network/Monitoring</tag>
189 <item>
190 <p>Network monitoring software</p>
191 <p>Examples: gip, ettercap, iptstate</p>
192 </item>
193 <tag>Applications/Network/Web Browsing</tag>
194 <item>
195 <p>Web browsers, tools for offline browsing, etc.</p>
196 <p>Examples: elinks, epiphany-browser, webhttrack</p>
197 </item>
198 <tag>Applications/Network/Web News</tag>
199 <item>
200 <p>Web feed (RSS, Atom, etc.) and podcast aggregators.
201 </p>
202 <p>Examples: akregator, kitty, liferea</p>
203 </item>
204 </taglist>
205 </item>
206 <tag>Applications/Office</tag>
207 <item>
208 <p>Office suites, word processors, spreadsheets,
209 CRM, ERP, financial sofware, etc.</p>
210 <p>Examples: openoffice.org, tinyerp-client, gnucash</p>
211 </item>
212 <tag>Applications/Programming</tag>
213 <item>
214 <p>IDEs, debuggers, etc.</p>
215 <p>Examples: anjuta, gdb, eclipse</p>
216 </item>
217 <tag>Applications/Project Management</tag>
218 <item>
219 <p>Timetable managers, group task trackers,
220 bug tracking software, etc.</p>
221 <p>Examples: planner, bugzilla, gnotime</p>
222 </item>
223 <tag>Applications/Science</tag>
224 <item>
225 Scientific and engineering-related software.
226 <taglist>
227 <tag>Applications/Science/Astronomy</tag>
228 <item>
229 <p>Astronomy-related software.</p>
230 <p>Examples: celestia, spacechart, stellarium</p>
231 </item>
232 <tag>Applications/Science/Biology</tag>
233 <item>
234 <p>Biology-related software.</p>
235 <p>Examples: arb, ncbi-tools-x11, seaview</p>
236 </item>
237 <tag>Applications/Science/Chemistry</tag>
238 <item>
239 <p>Chemistry-related software.</p>
240 <p>Examples: chemtool, kalzium, xdrawchem</p>
241 </item>
242 <tag>Applications/Science/Data Analysis</tag>
243 <item>
244 <p>Software designed for processing, extracting,
245 and presenting generic scientific data.</p>
246 <p>Examples: fityk, ygraph, mn-fit</p>
247 </item>
248 <tag>Applications/Science/Electronics</tag>
249 <item>
250 <p>Circuit design tools, simulators and
251 assemblers for microprocessors, etc</p>
252 <p>Examples: geda, gnucap, tkgate</p>
253 </item>
254 <tag>Applications/Science/Engineering</tag>
255 <item>
256 <p>CAD, UML tools, diagram-drawing and
257 other engineering-related software.</p>
258 <p>Examples: tcm, dia, qcad</p>
259 </item>
260 <tag>Applications/Science/Geoscience</tag>
261 <item>
262 <p>Geoscience-related software.</p>
263 <p>Examples: earth3d, qgis, therion</p>
264 </item>
265 <tag>Applications/Science/Mathematics</tag>
266 <item>
267 <p>Mathematics-related software.</p>
268 <p>Examples: gcalctool, snappea, xeukleides</p>
269 </item>
270 <tag>Applications/Science/Medicine</tag>
271 <item>
272 <p>Medicine-related software.</p>
273 <p>Examples: mssstest, gnumed-client, xmedcon</p>
274 </item>
275 <tag>Applications/Science/Physics</tag>
276 <item>
277 <p>Physics-related software.</p>
278 <p>Examples: kxterm, ifrit, paw</p>
279 </item>
280 <tag>Applications/Science/Social</tag>
281 <item>
282 <p>Social sciences-related software.</p>
283 <p>Examples: gnomesword, hanzim, bibletime</p>
284 </item>
285 </taglist>
286 </item>
287 <tag>Applications/Shells</tag>
288 <item>
289 <p>Various shells to be used inside a terminal emulator.</p>
290 <p>Examples: bash, ksh, zsh</p>
291 </item>
292 <tag>Applications/Sound</tag>
293 <item>
294 <p>Sound players, editors, and rippers/recorders.</p>
295 <p>Examples: beep-media-player, grip, audacity</p>
296 </item>
297 <tag>Applications/System</tag>
298 <item>
299 System related software.
300 <taglist>
301 <tag>Applications/System/Administration</tag>
302 <item>
303 <p>Administrative and system configuration utilities,
304 also tools for personal user settings.</p>
305 <p>Examples: gnome-control-center, configure-debian, gksu</p>
306 </item>
307 <tag>Applications/System/Hardware</tag>
308 <item>
309 <p>Tools for manipulating specific hardware,
310 especially non-standard laptop hardware.</p>
311 <p>Examples: toshutils, nvclock-gtk, nvtv</p>
312 </item>
313 <tag>Applications/System/Language Environment</tag>
314 <item>
315 <p>This section is reserved for language-env as a
316 special case.</p>
317 </item>
318 <tag>Applications/System/Monitoring</tag>
319 <item>
320 <p>System information and monitoring tools, log viewers,
321 etc.</p>
322 <p>Examples: top, hal-device-manager, gtkdiskfree</p>
323 </item>
324 <tag>Applications/System/Package Management</tag>
325 <item>
326 <p>Package managers and related tools.</p>
327 <p>Examples: aptitude, deborphan, smartpm</p>
328 </item>
329 <tag>Applications/System/Security</tag>
330 <item>
331 <p>Security, cryptography and privacy related software,
332 antiviruses, tools to track and report bugs, etc.</p>
333 <p>Examples: gpgkeys, bastille, avscan</p>
334 </item>
335 </taglist>
336 </item>
337 <tag>Applications/Terminal Emulators</tag>
338 <item>
339 <p>Graphical terminal emulators.</p>
340 <p>Examples: xterm, gnome-terminal, rxvt</p>
341 </item>
342 <tag>Applications/Text</tag>
343 <item>
344 <p>Text oriented tools like dictionaries, OCR,
345 translation, text analysis software, etc.</p>
346 <p>Examples: kdrill, stardict, turkey</p>
347 </item>
348 <tag>Applications/TV and Radio</tag>
349 <item>
350 <p>TV-in, TV-out, FM radio, teletext browsers, etc.</p>
351 <p>Examples: gradio, gatos, alevt</p>
352 </item>
353 <tag>Applications/Viewers</tag>
354 <item>
355 <p>Software for viewing images, documents
356 and other (non-video) media.</p>
357 <p>Examples: gqview, evince, gthumb</p>
358 </item>
359 <tag>Applications/Video</tag>
360 <item>
361 <p>Video players, editors, and rippers/recorders.</p>
362 <p>Examples: istanbul, totem, kino</p>
363 </item>
364 <tag>Applications/Web Development</tag>
365 <item>
366 <p>Software for web site editing, web
367 programming, and site administration.</p>
368 <p>Examples: bluefish, screem, gphpedit</p>
369 </item>
370 </taglist>
371 </p>
372 </item>
373 <tag>Games</tag>
374 <item>
375 Games and recreations
376 <taglist>
377 <tag>Games/Action</tag>
378 <item>
379 <p>Games that involve a lot of action
380 and require fast reflexes.</p>
381 <p>Examples: xsoldier, supertux, xmoto</p>
382 </item>
383 <tag>Games/Adventure</tag>
384 <item>
385 <p>Role playing and adventure games,
386 interactive movies and stories, etc.</p>
387 <p>Examples: beneath-a-steel-sky, egoboo, kq</p>
388 </item>
389 <tag>Games/Blocks</tag>
390 <item>
391 <p>Tetris-like games involving falling blocks.</p>
392 <p>Examples: crack-attack, frozen-bubble, netris</p>
393 </item>
394 <tag>Games/Board</tag>
395 <item>
396 <p>Games played on a board.</p>
397 <p>Examples: phalanx, xshogi, xboard</p>
398 </item>
399 <tag>Games/Card</tag>
400 <item>
401 <p>Games involving a deck of cards.</p>
402 <p>Examples: pysol, ace-of-penguins, xpat2</p>
403 </item>
404 <tag>Games/Puzzles</tag>
405 <item>
406 <p>Tests of ingenuity and logic.</p>
407 <p>Examples: xmpuzzles, sgt-puzzles, enigma</p>
408 </item>
409 <tag>Games/Simulation</tag>
410 <item>
411 <p>Simulations of the real world
412 in all detail and complexity.</p>
413 <p>Examples: flightgear, torcs</p>
414 </item>
415 <tag>Games/Strategy</tag>
416 <item>
417 <p>Games involving long-term strategic thinking.</p>
418 <p>Examples: wesnoth, widelands, netpanzer</p>
419 </item>
420 <tag>Games/Tools</tag>
421 <item>
422 <p>Server browsers, configurators, editors, and other
423 game-related tools that are not games themselves.</p>
424 <p>Examples: xqf, crystalspace</p>
425 </item>
426 <tag>Games/Toys</tag>
427 <item>
428 <p>Amusements, eye-candy, entertaining
429 demos, screen hacks (screensavers), etc.</p>
430 <p>Examples: xdesktopwaves, xphoon, xpenguins</p>
431 </item>
432 </taglist>
433 </item>
434 <tag>Help</tag>
435 <item>
436 <p>programs that provide user documentation</p>
437 <p>Examples: debian-reference, apt-howto, dhelp</p>
438 </item>
439 <tag>Screen</tag>
440 <item>
441 Programs that affect the whole screen.
442 <taglist>
443 <tag>Screen/Saving</tag>
444 <item>
445 <p>Tools for blanking the screen. Entries of screen hacks and
446 configuration GUIs should go to other appropriate sections.
447 </p>
448 <p>Examples: xscreensaver, xlockmore</p>
449 </item>
450 <tag>Screen/Locking</tag>
451 <item>
452 <p>Tools for locking the screen.</p>
453 <p>Examples: xscreensaver, xlockmore</p>
454 </item>
455 </taglist>
456 </item>
457 <tag>Window Managers</tag>
458 <item>
459 <p>X window managers.</p>
460 <p>Examples: fluxbox, metacity, waimea</p>
461 </item>
462 <tag>FVWM Modules</tag>
463 <item>
464 <p>FVWM-based window manager modules. As only modules related to
465 the running window-manager are displayed, do not create
466 subsections for specific window-managers.</p>
467 <p>Examples: fvwm, fvwm-gnome, fvwm95</p>
468 </item>
469 <tag>Window Maker</tag>
470 <item>
471 <p>This section is reserved for wmaker as a special case.</p>
472 <p>All wmaker specific entries must go here.</p>
473 </item>
474 </taglist>
475 </p>
476 </sect>
477 </chapt>
478 </book>
479 </debiandoc>
480 <!-- Local variables: -->
481 <!-- indent-tabs-mode: t -->
482 <!-- End: -->