summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMark Tiefenbruck <mark@fluxbox.org>2008-08-20 15:10:11 (GMT)
committerMark Tiefenbruck <mark@fluxbox.org>2008-08-20 15:10:11 (GMT)
commit62ff9d7029b0a9393c880d3ebab015dec6b12588 (patch)
treec031adadb0006511068621164f4469876af7d6ad /doc
parent4bf00f68573f3ad172b879e78ad441e74a916e66 (diff)
downloadfluxbox_lack-62ff9d7029b0a9393c880d3ebab015dec6b12588.zip
fluxbox_lack-62ff9d7029b0a9393c880d3ebab015dec6b12588.tar.bz2
fixed some menu documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/asciidoc/fluxbox.122
-rw-r--r--doc/asciidoc/fluxbox.txt19
-rw-r--r--doc/fluxbox.1.in22
3 files changed, 31 insertions, 32 deletions
diff --git a/doc/asciidoc/fluxbox.1 b/doc/asciidoc/fluxbox.1
index 0272673..1a07ee4 100644
--- a/doc/asciidoc/fluxbox.1
+++ b/doc/asciidoc/fluxbox.1
@@ -393,6 +393,11 @@ The supported tags are:
393This tells fluxbox to start parsing the menu file\. This tag is required for fluxbox to read your menu file\. If it cannot find it, the system default menu is used in its place\. 393This tells fluxbox to start parsing the menu file\. This tag is required for fluxbox to read your menu file\. If it cannot find it, the system default menu is used in its place\.
394.RE 394.RE
395.PP 395.PP
396[config] (label)
397.RS 4
398Inserts a fluxbox native submenu item, containing numerous configuration options concerning window placement, focus style, window moving style, etc\.
399.RE
400.PP
396[end] 401[end]
397.RS 4 402.RS 4
398This tells fluxbox that it is at the end of a menu\. This can either be a submenu or the main root menu\. There must be at least one of these tags in your menu to correspond to the required [begin] tag\. 403This tells fluxbox that it is at the end of a menu\. This can either be a submenu or the main root menu\. There must be at least one of these tags in your menu to correspond to the required [begin] tag\.
@@ -456,17 +461,7 @@ When selected this item re\-reads the current style and menu files and applies a
456This tells fluxbox to restart\. If command is supplied, it shuts down and runs the command (which is commonly the name of another window manager)\. If the command is omitted, fluxbox restarts itself\. 461This tells fluxbox to restart\. If command is supplied, it shuts down and runs the command (which is commonly the name of another window manager)\. If the command is omitted, fluxbox restarts itself\.
457.RE 462.RE
458.PP 463.PP
459[config] (label) 464[wallpapers] (directory) {command}
460.RS 4
461Inserts a fluxbox native submenu item, containing numerous configuration options concerning window placement, focus style, window moving style, etc\.
462.RE
463.PP
464[wallpapers] (label)
465.RS 4
466This allows you to list your backgrounds\. This tag is built in to use fbsetbg(1) and allows you to simply click on an image to set your wallpaper\. See? fluxbox makes it easy\&...
467.RE
468.PP
469[wallpapermenu] (directory) {command}
470.RS 4 465.RS 4
471This inserts a menu item to set the wallpaper for each file in the given directory\. The command is optional and defaults to fbsetbg\. 466This inserts a menu item to set the wallpaper for each file in the given directory\. The command is optional and defaults to fbsetbg\.
472.RE 467.RE
@@ -475,6 +470,11 @@ This inserts a menu item to set the wallpaper for each file in the given directo
475.RS 4 470.RS 4
476This tells fluxbox to insert a link to the workspaces menu directly into your menu\. This is handy for those users who can\'t access the workspace menu directly (e\.g\. if you don\'t have a 3 button mouse, it is rather hard to middle click to show the workspace menu)\. 471This tells fluxbox to insert a link to the workspaces menu directly into your menu\. This is handy for those users who can\'t access the workspace menu directly (e\.g\. if you don\'t have a 3 button mouse, it is rather hard to middle click to show the workspace menu)\.
477.RE 472.RE
473.PP
474[\fIcommand\fR] (label)
475.RS 4
476In addition to the commands above, any legal key command may be used as a menu item\. See fluxbox\-keys(5) for more information\.
477.RE
478Any line that starts with a \fI#\fR or \fI!\fR is considered a comment and ignored by fluxbox\. Also, in the label/command/filename fields you can escape any character\. Using \fI\e\e\fR inserts a literal back\-slash into the label/command/filename field\. 478Any line that starts with a \fI#\fR or \fI!\fR is considered a comment and ignored by fluxbox\. Also, in the label/command/filename fields you can escape any character\. Using \fI\e\e\fR inserts a literal back\-slash into the label/command/filename field\.
479.sp 479.sp
480Here is an example menu file: 480Here is an example menu file:
diff --git a/doc/asciidoc/fluxbox.txt b/doc/asciidoc/fluxbox.txt
index 7ca1456..479a6ee 100644
--- a/doc/asciidoc/fluxbox.txt
+++ b/doc/asciidoc/fluxbox.txt
@@ -396,6 +396,10 @@ The supported tags are:
396 fluxbox to read your menu file. If it cannot find it, the system default 396 fluxbox to read your menu file. If it cannot find it, the system default
397 menu is used in its place. 397 menu is used in its place.
398 398
399[config] (label);;
400 Inserts a fluxbox native submenu item, containing numerous configuration
401 options concerning window placement, focus style, window moving style, etc.
402
399[end];; 403[end];;
400 This tells fluxbox that it is at the end of a menu. This can either be a 404 This tells fluxbox that it is at the end of a menu. This can either be a
401 submenu or the main root menu. There must be at least one of these tags in 405 submenu or the main root menu. There must be at least one of these tags in
@@ -464,16 +468,7 @@ The supported tags are:
464 runs the command (which is commonly the name of another window manager). If 468 runs the command (which is commonly the name of another window manager). If
465 the command is omitted, fluxbox restarts itself. 469 the command is omitted, fluxbox restarts itself.
466 470
467[config] (label);; 471[wallpapers] (directory) \{command\};;
468 Inserts a fluxbox native submenu item, containing numerous configuration
469 options concerning window placement, focus style, window moving style, etc.
470
471[wallpapers] (label);;
472 This allows you to list your backgrounds. This tag is built in to use
473 fbsetbg(1) and allows you to simply click on an image to set your wallpaper.
474 See? fluxbox makes it easy...
475
476[wallpapermenu] (directory) \{command\};;
477 This inserts a menu item to set the wallpaper for each file in the given 472 This inserts a menu item to set the wallpaper for each file in the given
478 directory. The command is optional and defaults to fbsetbg. 473 directory. The command is optional and defaults to fbsetbg.
479 474
@@ -483,6 +478,10 @@ The supported tags are:
483 directly (e.g. if you don't have a 3 button mouse, it is rather hard to 478 directly (e.g. if you don't have a 3 button mouse, it is rather hard to
484 middle click to show the workspace menu). 479 middle click to show the workspace menu).
485 480
481['command'] (label);;
482 In addition to the commands above, any legal key command may be used as a
483 menu item. See fluxbox-keys(5) for more information.
484
486Any line that starts with a '#' or '!' is considered a comment and ignored by 485Any line that starts with a '#' or '!' is considered a comment and ignored by
487fluxbox. Also, in the label/command/filename fields you can escape any 486fluxbox. Also, in the label/command/filename fields you can escape any
488character. Using '\\' inserts a literal back-slash into the 487character. Using '\\' inserts a literal back-slash into the
diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in
index 0272673..1a07ee4 100644
--- a/doc/fluxbox.1.in
+++ b/doc/fluxbox.1.in
@@ -393,6 +393,11 @@ The supported tags are:
393This tells fluxbox to start parsing the menu file\. This tag is required for fluxbox to read your menu file\. If it cannot find it, the system default menu is used in its place\. 393This tells fluxbox to start parsing the menu file\. This tag is required for fluxbox to read your menu file\. If it cannot find it, the system default menu is used in its place\.
394.RE 394.RE
395.PP 395.PP
396[config] (label)
397.RS 4
398Inserts a fluxbox native submenu item, containing numerous configuration options concerning window placement, focus style, window moving style, etc\.
399.RE
400.PP
396[end] 401[end]
397.RS 4 402.RS 4
398This tells fluxbox that it is at the end of a menu\. This can either be a submenu or the main root menu\. There must be at least one of these tags in your menu to correspond to the required [begin] tag\. 403This tells fluxbox that it is at the end of a menu\. This can either be a submenu or the main root menu\. There must be at least one of these tags in your menu to correspond to the required [begin] tag\.
@@ -456,17 +461,7 @@ When selected this item re\-reads the current style and menu files and applies a
456This tells fluxbox to restart\. If command is supplied, it shuts down and runs the command (which is commonly the name of another window manager)\. If the command is omitted, fluxbox restarts itself\. 461This tells fluxbox to restart\. If command is supplied, it shuts down and runs the command (which is commonly the name of another window manager)\. If the command is omitted, fluxbox restarts itself\.
457.RE 462.RE
458.PP 463.PP
459[config] (label) 464[wallpapers] (directory) {command}
460.RS 4
461Inserts a fluxbox native submenu item, containing numerous configuration options concerning window placement, focus style, window moving style, etc\.
462.RE
463.PP
464[wallpapers] (label)
465.RS 4
466This allows you to list your backgrounds\. This tag is built in to use fbsetbg(1) and allows you to simply click on an image to set your wallpaper\. See? fluxbox makes it easy\&...
467.RE
468.PP
469[wallpapermenu] (directory) {command}
470.RS 4 465.RS 4
471This inserts a menu item to set the wallpaper for each file in the given directory\. The command is optional and defaults to fbsetbg\. 466This inserts a menu item to set the wallpaper for each file in the given directory\. The command is optional and defaults to fbsetbg\.
472.RE 467.RE
@@ -475,6 +470,11 @@ This inserts a menu item to set the wallpaper for each file in the given directo
475.RS 4 470.RS 4
476This tells fluxbox to insert a link to the workspaces menu directly into your menu\. This is handy for those users who can\'t access the workspace menu directly (e\.g\. if you don\'t have a 3 button mouse, it is rather hard to middle click to show the workspace menu)\. 471This tells fluxbox to insert a link to the workspaces menu directly into your menu\. This is handy for those users who can\'t access the workspace menu directly (e\.g\. if you don\'t have a 3 button mouse, it is rather hard to middle click to show the workspace menu)\.
477.RE 472.RE
473.PP
474[\fIcommand\fR] (label)
475.RS 4
476In addition to the commands above, any legal key command may be used as a menu item\. See fluxbox\-keys(5) for more information\.
477.RE
478Any line that starts with a \fI#\fR or \fI!\fR is considered a comment and ignored by fluxbox\. Also, in the label/command/filename fields you can escape any character\. Using \fI\e\e\fR inserts a literal back\-slash into the label/command/filename field\. 478Any line that starts with a \fI#\fR or \fI!\fR is considered a comment and ignored by fluxbox\. Also, in the label/command/filename fields you can escape any character\. Using \fI\e\e\fR inserts a literal back\-slash into the label/command/filename field\.
479.sp 479.sp
480Here is an example menu file: 480Here is an example menu file: