all repos — fluxbox @ e792fff30fabdc070aed577fe9f2bf94f4bc9923

custom fork of the fluxbox windowmanager

Fix menu docs, esp. items allowed in window menu
Glen Whitney gwhitney@post.harvard.edu
commit

e792fff30fabdc070aed577fe9f2bf94f4bc9923

parent

a46e5b83c6e9d0784993550e7bb404cf8250afac

2 files changed, 9 insertions(+), 8 deletions(-)

jump to
M doc/asciidoc/fluxbox-menu.txtdoc/asciidoc/fluxbox-menu.txt

@@ -50,7 +50,7 @@ which appears when you right-click on a window's titlebar or iconbar. This opens

a menu file as defined by *~/.fluxbox/windowmenu*. If this file does not exist, fluxbox will copy in the default from *@pkgdatadir@/windowmenu*. -You do not need to ``reload'' fluxbox after editing the apps file, the changes +You do not need to ``reload'' fluxbox after editing either menu file, the changes should be taken into account the next time you open the menu. ROOT MENU

@@ -188,11 +188,12 @@ as a menu item. See *fluxbox-keys(5)* for more information.

WINDOW MENU ----------- -Like the *ROOT MENU*, this menu file must start with *[begin]* and end with -*[end]*. However, this file consists of only one *[*'tag'*]* per line with no -labels, commands, or icons. +The syntax for the Window Menu is mostly identical to that for the *ROOT MENU*; +it must start with *[begin]* and end with *[end]*, and may have any of the above +tags. However, it may also contain any of the following window-specific *[*'tag'*]*s, +which each must be on a line by itself with no labels, commands, or icons. -The available tags in this menu are: +The additonal available tags in this menu are: *[shade]*;; Provides a menu item to shade or unshade (or, roll-up) the window. This is
M doc/fluxbox-menu.5.indoc/fluxbox-menu.5.in

@@ -53,7 +53,7 @@ Fluxbox installs a default root menu file in \fB@pkgdatadir@/menu\fR\&. You can also use fluxbox \-i to confirm this location\&. Of course this system\-wide menu can be customized for all users at once, but it is also possible to create an individual menu file for each user\&. By convention, users create a menu file in \fB~/\&.fluxbox/menu\fR\&. Once you\(cqve created your own menu file, you\(cqll want to make sure that you properly declare this location in your \(oqinit\(cq file so that fluxbox knows where to look\&. See \fBRESOURCES\fR, below for details\&.

.sp The second type is the \fBWINDOW MENU\fR, which defines the contents of the menu which appears when you right\-click on a window\(cqs titlebar or iconbar\&. This opens a menu file as defined by \fB~/\&.fluxbox/windowmenu\fR\&. If this file does not exist, fluxbox will copy in the default from \fB@pkgdatadir@/windowmenu\fR\&. .sp -You do not need to \(lqreload\(rq fluxbox after editing the apps file, the changes should be taken into account the next time you open the menu\&. +You do not need to \(lqreload\(rq fluxbox after editing either menu file, the changes should be taken into account the next time you open the menu\&. .SH "ROOT MENU" .sp The root menu must begin with a \fB[begin]\fR tag and end with an \fB[end]\fR tag, and every tag must be on its own line\&.

@@ -238,9 +238,9 @@ for more information\&.

.RE .SH "WINDOW MENU" .sp -Like the \fBROOT MENU\fR, this menu file must start with \fB[begin]\fR and end with \fB[end]\fR\&. However, this file consists of only one \fB[\fR\fItag\fR\fB]\fR per line with no labels, commands, or icons\&. +The syntax for the Window Menu is mostly identical to that for the \fBROOT MENU\fR; it must start with \fB[begin]\fR and end with \fB[end]\fR, and may have any of the above tags\&. However, it may also contain any of the following window-specific \fB[\fR\fItag\fR\fB]\fRs, which each must be on a line by itself with no labels, commands, or icons\&. .sp -The available tags in this menu are: +The additional available tags in this menu are: .PP \fB[shade]\fR .RS 4