nilix/fluxbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix menu docs, esp. items allowed in window menu

Browse source
This commit is contained in:
Glen Whitney 2019-04-22 10:53:04 -07:00
parent a46e5b83c6
commit e792fff30f
2 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/asciidoc/fluxbox-menu.txt
View file

@ -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, a menu file as defined by *~/.fluxbox/windowmenu*. If this file does not exist,
fluxbox will copy in the default from *@pkgdatadir@/windowmenu*. 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. should be taken into account the next time you open the menu.
ROOT MENU ROOT MENU
@ -188,11 +188,12 @@ Fluxbox Functions
WINDOW MENU WINDOW MENU
----------- -----------
Like the *ROOT MENU*, this menu file must start with *[begin]* and end with The syntax for the Window Menu is mostly identical to that for the *ROOT MENU*;
*[end]*. However, this file consists of only one *[*'tag'*]* per line with no it must start with *[begin]* and end with *[end]*, and may have any of the above
labels, commands, or icons. 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]*;; *[shade]*;;
Provides a menu item to shade or unshade (or, roll-up) the window. This is Provides a menu item to shade or unshade (or, roll-up) the window. This is

6
doc/fluxbox-menu.5.in
View file

@ -53,7 +53,7 @@ Fluxbox installs a default root menu file in \fB@pkgdatadir@/menu\fR\&. You can
.sp .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\&. 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 .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" .SH "ROOT MENU"
.sp .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\&. 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 .RE
.SH "WINDOW MENU" .SH "WINDOW MENU"
.sp .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 .sp
The available tags in this menu are: The additional available tags in this menu are:
.PP .PP
\fB[shade]\fR \fB[shade]\fR
.RS 4 .RS 4