← Back to branch summary

~ubuntu-branches/debian/sid/menu/sid

« back to all changes in this revision

Viewing changes to doc/update-menus.1

  • Committer: Bazaar Package Importer
  • Author(s): Bill Allombert
  • Date: 2005-05-24 10:34:47 UTC
  • mfrom: (1.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050524103447-9zu50so5d0nte3o9
Tags: 2.1.24
http://bugs.debian.org/306564
http://bugs.debian.org/307450
http://bugs.debian.org/308953
* The "head or tail" release 
* Fix .menus typo in menufile.5. Closes: #306564. Thanks Sean Finney.
* Add Vietnamese menu messages and menu sections translations.
  Thanks Clytie Siddall. Closes: #307450, #308953.
* Update Esperanto menu sections translation. Thanks MJ Ray.
* Add Esperanto menu messages translation. Thanks MJ Ray.
* Unfuzzy Norwegian Bokmål menu messages translation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/update-menus.1
1
1
.\" -*- nroff -*-
2
 
.TH UPDATE-MENUS 1L "Debian Utilities" "DEBIAN"
 
2
.TH UPDATE-MENUS 1 "Debian Utilities" "DEBIAN"
3
3
.SH NAME
4
4
update-menus \- generate Debian menu system
5
5
.SH SYNOPSIS
6
 
.B update-menus [\-v] [\-d] [\-h]
 
6
.B update-menus [\-v] [\-d] [\-h|--help] [--version] [--menufilesdir <dir>] [--menumethod <method>] [--nodefaultdirs] [--stdout]
7
7
.SH DESCRIPTION
8
 
Before the advent of \fIupdate-menus\fP, when the system administrator installed a 
 
8
Before the advent of \fIupdate-menus\fP, when the system administrators installed a 
9
9
package onto a Debian system, they would need to edit various window 
10
10
manager configuration files to make the new program show up on, for example, 
11
11
fvwm's menus. The menus could easily become out of sync with what programs
25
25
.PP
26
26
.I update-menus
27
27
uses the package-supplied menu entry files (in /usr/lib/menu) for
28
 
it's information about the menus (but this can be overruled by the
 
28
its information about the menus (but this can be overruled by the
29
29
system administrator/user, see below). If a menu entry file is executable,
30
30
.I update-menus
31
 
execute the menu entry file, and use it's stdout to generate the menu
 
31
execute the menu entry file, and use its stdout to generate the menu
32
32
database.
33
33
 
34
34
.SH OPTIONS
36
36
Verbose output. Shows all arguments to the /etc/menu-methods programs.
37
37
.IP "-d"
38
38
Debug output. Generates loads of unintelligible output.
39
 
.IP "-h"
 
39
.IP "-h, --help"
40
40
Display usage help and exit.
 
41
.IP "--menufilesdir <dir>" 
 
42
Adds directory <dir> to the list of directory to search for menu files in. 
 
43
.IP "--menumethod <method>" 
 
44
Process only the menu method <method> instead of all the menu methods found.
 
45
.IP "--nodefaultdirs"
 
46
Disables the search of menu entries in system menu directories.
 
47
.IP "--stdout" 
 
48
Output the menu list in a format suitable as input for \fIinstall-menu\fP or a
 
49
menu method file.
 
50
.IP "--version"
 
51
Output version information and exit.
41
52
.SH CONFIGURATION
42
53
There are several ways to tune the operation of update-menus:
43
54
.PP
52
63
.RE     
53
64
.I per window-manager in /etc/menu-methods/$wm
54
65
.RS
55
 
In these configuration files, one can tune generated "system.rc" files for
 
66
In these configuration files, one can tune generated system."$wm"rc files for
56
67
each individual window manager. For example, one can specify that the
57
68
wm should ignore any icons that the packages may supply, or set the
58
69
default wrapper for text-only applications (usually, an xterm is started to
59
70
run a text-only application like vi). Users who want to override the system
60
71
wide defaults put their files in ~/.menu-methods. For more info, see
61
 
/usr/doc/menu/html. 
 
72
/usr/share/doc/menu/html. 
62
73
.RE
63
74
.I globally, in /etc/menu-methods/translate_menus
64
75
.RS
66
77
menu entries and all window managers. You can specify things like:
67
78
`All sections that start with "Apps/Games" should be mapped to "Games"',
68
79
or `menuentryid "gnuplot" should have a title of "GnuTeken" (to
69
 
translate titles into other other languages)'. Look at the default
 
80
translate titles into other languages)'. Look at the default
70
81
/etc/menu-methods/translate_menus for an example. Users who want to
71
82
override the system default translate file, put one in
72
 
~/.menu-methods/translate_menus.
 
83
~/.menu-methods/translate_menus. 
 
84
.BR Note:
 
85
This should not be used for a full translation of the menu. Use po
 
86
files as explained in the source package.
73
87
.RE
74
88
.I error report configuring, in /etc/menu-methods/menu.config
75
89
.RS
76
90
This file contains general information for the overall behaviour of
77
91
update-menus. At the moment you can only configure how verbose the
78
92
output of update-menus is, and where it sends the output. The amount
79
 
of information is specified by `verbosity=VAL'. Use VAL=quite to stop
 
93
of information is specified by `verbosity=VAL'. Use VAL=quiet to stop
80
94
update-menu from reporting anything but the most important errors,
81
95
VAL=normal, VAL=verbose, VAL=debug for progressively more output.
82
96
 
104
118
.RS
105
119
Menu files provided by other Debian packages.
106
120
.RE
107
 
.I /usr/lib/menu/default/*
 
121
.I /usr/share/menu/default/*
108
122
.RS
109
123
Menu files provided by the menu package. (These are for packages that
110
124
don't provide menu entries yet. If you see (or maintain) a package that
111
125
supplies a menu file in /usr/lib/menu/, please email me and I'll remove
112
 
that menu file from /usr/lib/menu/default/).
 
126
that menu file from /usr/share/menu/default/).
113
127
.RE
114
128
.RE
115
129
Menu methods:
120
134
programs, these files are run by
121
135
.I update-menus
122
136
to generate menus for the different programs. Also in this directory
123
 
is the translate file, used for local configuration of the shape of the
 
137
is the translate_menus file, used for local configuration of the shape of the
124
138
menu trees.
125
139
.RE
126
140
.RE
140
154
user. This is usually because the window manager doesn't expect the
141
155
system."$wm"rc files in the directory (usually ~/."$wm", configurable
142
156
in /etc/menu-methods). If you see such a thing, and you find a
143
 
solution, please mail me (joostje@debian.org). It should work OK for
 
157
solution, please mail <menu@packages.debian.org>. It should work OK for
144
158
fvwm and fvwm2: I usually test the package first as an ordinary user.
145
159
.PP
146
160
.SH AUTHOR 
151
165
Tom Lees for a update-menus in pure C (of which I only used one
152
166
function, but that's life).
153
167
.PP
154
 
(Man page by Joey Hess, <joeyh@master.debian.org>)
 
168
Man page by Joey Hess, <joeyh@debian.org>
155
169
.SH "SEE ALSO"
156
170
.BR menufile (5),
157
 
.BR /usr/doc/menu/html
 
171
.BR /usr/share/doc/menu/html