1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
.\" -*- nroff -*-
.TH MENUFILE 5L "File Formats" "DEBIAN"
.SH NAME
menufile \- entry in the Debian menu system
.SH SYNOPSIS
.B ~/.menu/*
.PP
.B /etc/menu/*
.PP
.B /usr/lib/menu/*
.PP
.B /usr/lib/menu/default/*
.SH DESCRIPTION
Menu files add entries to the Debian menu system. The system administrator can place
menu files in /etc/menu/ to override menu files that packages add to
/usr/lib/menu/ . The user can place menu files in ~/.menu/ to override all
other menu files.
.PP
This man page may be out of date in some
places. Look at /usr/doc/menu/html for more up-to-date info.
.PP
The menu files are usually named after the Debian package that
contains the programs listed in them. In it, you can list several
"menuentries", that specify a specific item in the menu
"menu entries", that specify a specific item in the menu
structure. Each menu entry specifies what package it depends on, if
that package is not installed, the menu entry will be ignored by
.BR update-menus(1) .
(In a menu entry you can specify pseudo-packages that start
with "local", update-menus will always use those menu entries).
If you wish to remove an item from the menu entirely, make an empty menu
file with the same name as the file you want to override.
.SH Examples
Dosemu could install the following menu file as /usr/lib/menu/dosemu:
.PP
?package(dosemu):needs=text section=Apps/Emulators title="Dosemu" command=dosemu
?package(dosemu):needs=x11 section=Apps/Emulators title="Dosemu" command=xdos
.PP
The system administrator wants to override this file to change how dosemu is run, so
/etc/menu/dosemu is created:
.PP
?package(dosemu):needs=text section=Apps/Emulators title="Dosemu" command="dosemu -A"
?package(dosemu):needs=x11 section=Apps/Emulators title="Dosemu" command="xdos -A"
.PP
A user does not want Dosemu to appear on his menus at all, so he creates
an empty file named ~/.menu/dosemu .
.SH FORMAT
A menu file consists of 0 or more lines of the following format:
.RS
.PP
\fB?package(package-name):var1=value var2=varlue2 \fR ...
.TP
needs=
What type of display will the program run on? This variable must be
defined, and should be one of the
following:
.RS
.TP
needs=text
any text display
.TP
needs=x11
X11 displays
.TP
needs=vc
At the Linux console (i.e.: svgalib programs)
.TP
needs=wm
A window manager.
.TP
needs=fvwmmodule
A fvwm version 1.x compatible module.
.TP
needs=fvwm2module
A fvwm version 2.x compatible module.
.RE
.TP
section
The section in which the menu entry should appear. See \fBMENU LAYOUT\fP for
preferred section names.
.RS
.RE
.TP
icon
An icon for this menu entry. If no icon is available, just don't
define this. (icon="none" is also possible, preferably just leave it out)
.TP
title
The title of the program that will appear on the menus. Keep it short.
If two menu entries share the same title and section, the one that
bests fits the available display will be used. So in the example above
with two menu entries that both have the menu id "title", if X is
available, the x11 one will be used, otherwise the text one will be used.
Must be defined.
.TP
command
The command to be executed when this menu entry is selected.
.RE
.SH "MENU LAYOUT"
This is the preferred layout of the menus. Currently it is a suggestion
only. Use `/' to separate sub-menu names, for example, "Apps/Editors" or
"Games/Arcade".
.PP
\fIApps\fP -- all normal apps
\fIEditors\fP -- editors
\fIEmulators\fP -- Dosemu, ...
\fIGraphics\fP -- xpaint, xfig, xtiff,
\fIMath\fP -- Math apps: gnuplot, octave, oleo,..
\fINet\fP -- mail, news, web, irc, etc
\fIProgramming\fP -- debuggers, etc
\fIShells\fP -- Different shells, like bash, zsh, ...
\fISound\fP --
\fISystem\fP -- system administration and monitoring
\fITools\fP -- other tools: xclock, xmag, xman,
\fIViewers\fP -- Picture viewers, gs, ...
\fIGames\fP -- games and recreations
\fIAdventure\fP -- walk around virtual space, zork, MOO's, etc
\fIArcade\fP -- (any game where reflexes count)
\fIBoard\fP -- Like: Gnuchess, pente, gnugo
\fICard\fP -- solitaire, etc
\fIPuzzles\fP -- Stuff from xpuzzles, ...
\fISports\fP -- Games derived from "real world" sports
\fITetris-like\fP -- games involving falling blocks
\fIToys\fP -- (oneko, xeyes, etc.)
\fIScreen\fP --
\fILock\fP -- xlock, etc.
\fIScreen-saver\fP --
\fIRoot-window\fP -- things that fill the root window
\fIWindow-managers\fP -- (change between fvwm, afterstep, etc)
\fIModules\fP -- fvwm modules, etc.
\fIXShells\fP -- shells (like xterm, rxvt, ...)
.SH NOTES
If you want to specify an icon or hotkey for a sub-menu (for example,
the Editors sub-menu), just use the same syntax but leave the command
empty:
?package(mypackage):needs=X11 section=Apps icon=icon.xpm hotkey=E title="Editors"
.PP
Whenever any menu files are changed, you must run
.BR update-menus (1)
.SH FILES
(Earlier listed files override later files with the same names.)
.PP
.I ~/.menus/*
.RS
Menu files added by the user.
.RE
.I /etc/menu/*
.RS
Menu files added by the system administrator.
.RE
.I /usr/lib/menu/*
.RS
Menu files provided by other Debian packages.
.RE
.I /usr/lib/menu/default/*
.RS
Menu files provided by the menu package.
.RE
.SH AUTHOR
Joost Witteveen <joostje@debian.org>, based on work by
Lars Wirzenius <liw@iki.fi>
.PP
(Man page by Joey Hess, <joeyh@master.debian.org>)
.SH "SEE ALSO"
.BR update-menus (1),
.BR /usr/doc/menu/html/index.html
|
