Penguin
Recent Changes
Annotated edit history of menufile(5) version 4, including all changes. View license author blame.
Rev Author # Line
1 perry 1 MENUFILE
2 !!!MENUFILE
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 Examples
7 FORMAT
8 MENU LAYOUT
9 NOTES
10 FILES
11 AUTHOR
12 SEE ALSO
13 ----
14 !!NAME
15
16
17 menufile - entry in the Debian menu system
18 !!SYNOPSIS
19
20
21 __~/.menu/*__
22
23
24 __/etc/menu/*__
25
26
27 __/usr/lib/menu/*__
28
29
30 __/usr/lib/menu/default/*__
31 !!DESCRIPTION
32
33
34 Menu files add entries to the Debian menu system. The system
35 administrator can place menu files in /etc/menu/ to override
36 menu files that packages add to /usr/lib/menu/ . The user
37 can place menu files in ~/.menu/ to override all other menu
38 files.
39
40
41 This man page may be out of date in some places. Look at
42 /usr/doc/menu/html for more up-to-date info.
43
44
45 The menu files are usually named after the Debian package
46 that contains the programs listed in them. In it, you can
47 list several
48 update-menus(1)__. (In a menu entry you can specify
49 pseudo-packages that start with
50 __
51 !!Examples
52
53
54 Dosemu could install the following menu file as
55 /usr/lib/menu/dosemu:
56
57
58 ?package(dosemu):needs=text section=Apps/Emulators
59 title=
60
61
62 The system administrator wants to override this file to
63 change how dosemu is run, so /etc/menu/dosemu is
64 created:
65
66
67 ?package(dosemu):needs=text section=Apps/Emulators
68 title=
69
70
71 A user does not want Dosemu to appear on his menus at all,
72 so he creates an empty file named ~/.menu/dosemu
73 .
74 !!FORMAT
75
76
77 A menu file consists of 0 or more lines of the following
78 format:
79
80
81 __?package(package-name):var1=value var2=varlue2__
82 ...
83
84
85 needs=
86
87
88 What type of display will the program run on? This variable
89 must be defined, and should be one of the
90 following:
91
92
93 needs=text
94
95
96 any text display
97
98
99 needs=x11
100
101
102 X11 displays
103
104
105 needs=vc
106
107
108 At the Linux console (i.e.: svgalib programs)
109
110
111 needs=wm
112
113
114 A window manager.
115
116
117 needs=fvwmmodule
118
119
120 A fvwm version 1.x compatible module.
121
122
123 needs=fvwm2module
124
125
126 A fvwm version 2.x compatible module.
127
128
129 section
130
131
132 The section in which the menu entry should appear. See
133 __MENU LAYOUT__ for preferred section names.
134
135
136 icon
137
138
139 An icon for this menu entry. If no icon is available, just
140 don't define this. (icon=
141
142
143 title
144
145
146 The title of the program that will appear on the menus. Keep
147 it short. If two menu entries share the same title and
148 section, the one that bests fits the available display will
149 be used. So in the example above with two menu entries that
150 both have the menu id
151
152
153 command
154
155
156 The command to be executed when this menu entry is
157 selected.
158 !!MENU LAYOUT
159
160
161 This is the preferred layout of the menus. Currently it is a
162 suggestion only. Use `/' to separate sub-menu names, for
163 example,
164
165
166 ''Apps'' -- all normal apps ''Editors'' -- editors
167 ''Emulators'' -- Dosemu, ... ''Graphics'' -- xpaint,
168 xfig, xtiff, ''Math'' -- Math apps: gnuplot, octave,
169 oleo,.. ''Net'' -- mail, news, web, irc, etc
170 ''Programming'' -- debuggers, etc ''Shells'' --
171 Different shells, like bash, zsh, ... ''Sound'' --
172 ''System'' -- system administration and monitoring
173 ''Tools'' -- other tools: xclock, xmag, xman,
174 ''Viewers'' -- Picture viewers, gs, ... ''Games'' --
175 games and recreations ''Adventure'' -- walk around
176 virtual space, zork, MOO's, etc ''Arcade'' -- (any game
177 where reflexes count) ''Board'' -- Like: Gnuchess, pente,
178 gnugo ''Card'' -- solitaire, etc ''Puzzles'' -- Stuff
179 from xpuzzles, ... ''Sports'' -- Games derived from
180 ''Tetris-like'' -- games
181 involving falling blocks ''Toys'' -- (oneko, xeyes, etc.)
182 ''Screen'' -- ''Lock'' -- xlock, etc.
183 ''Screen-saver'' -- ''Root-window'' -- things that
184 fill the root window ''Window-managers'' -- (change
185 between fvwm, afterstep, etc) ''Modules'' -- fvwm
186 modules, etc. ''XShells'' -- shells (like xterm, rxvt,
187 ...)
188 !!NOTES
189
190
191 If you want to specify an icon or hotkey for a sub-menu (for
192 example, the Editors sub-menu), just use the same syntax but
193 leave the command empty:
194
195
196 ?package(mypackage):needs=X11 section=Apps icon=icon.xpm
197 hotkey=E title=
198
199
200 Whenever any menu files are changed, you must run
4 perry 201 update-menus(1)
1 perry 202 !!FILES
203
204
205 (Earlier listed files override later files with the same
206 names.)
207
208
209 ''~/.menus/*''
210
211
212 Menu files added by the user.
213
214
215 ''/etc/menu/*''
216
217
218 Menu files added by the system administrator.
219
220
221 ''/usr/lib/menu/*''
222
223
224 Menu files provided by other Debian packages.
225
226
227 ''/usr/lib/menu/default/*''
228
229
230 Menu files provided by the menu package.
231 !!AUTHOR
232
233
234 Joost Witteveen
235
236
237 (Man page by Joey Hess,
238 !!SEE ALSO
239
240
4 perry 241 update-menus(1),
1 perry 242 __/usr/doc/menu/html/index.html__
243 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.