From 62ff9d7029b0a9393c880d3ebab015dec6b12588 Mon Sep 17 00:00:00 2001 From: Mark Tiefenbruck Date: Wed, 20 Aug 2008 08:10:11 -0700 Subject: fixed some menu documentation --- doc/asciidoc/fluxbox.1 | 22 +++++++++++----------- doc/asciidoc/fluxbox.txt | 19 +++++++++---------- doc/fluxbox.1.in | 22 +++++++++++----------- 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: This 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\. .RE .PP +[config] (label) +.RS 4 +Inserts a fluxbox native submenu item, containing numerous configuration options concerning window placement, focus style, window moving style, etc\. +.RE +.PP [end] .RS 4 This 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 This 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\. .RE .PP -[config] (label) -.RS 4 -Inserts a fluxbox native submenu item, containing numerous configuration options concerning window placement, focus style, window moving style, etc\. -.RE -.PP -[wallpapers] (label) -.RS 4 -This 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\&... -.RE -.PP -[wallpapermenu] (directory) {command} +[wallpapers] (directory) {command} .RS 4 This inserts a menu item to set the wallpaper for each file in the given directory\. The command is optional and defaults to fbsetbg\. .RE @@ -475,6 +470,11 @@ This inserts a menu item to set the wallpaper for each file in the given directo .RS 4 This 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)\. .RE +.PP +[\fIcommand\fR] (label) +.RS 4 +In addition to the commands above, any legal key command may be used as a menu item\. See fluxbox\-keys(5) for more information\. +.RE Any 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\. .sp Here 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: fluxbox to read your menu file. If it cannot find it, the system default menu is used in its place. +[config] (label);; + Inserts a fluxbox native submenu item, containing numerous configuration + options concerning window placement, focus style, window moving style, etc. + [end];; This 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 @@ -464,16 +468,7 @@ The supported tags are: runs the command (which is commonly the name of another window manager). If the command is omitted, fluxbox restarts itself. -[config] (label);; - Inserts a fluxbox native submenu item, containing numerous configuration - options concerning window placement, focus style, window moving style, etc. - -[wallpapers] (label);; - This 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... - -[wallpapermenu] (directory) \{command\};; +[wallpapers] (directory) \{command\};; This inserts a menu item to set the wallpaper for each file in the given directory. The command is optional and defaults to fbsetbg. @@ -483,6 +478,10 @@ The supported tags are: directly (e.g. if you don't have a 3 button mouse, it is rather hard to middle click to show the workspace menu). +['command'] (label);; + In addition to the commands above, any legal key command may be used as a + menu item. See fluxbox-keys(5) for more information. + Any line that starts with a '#' or '!' is considered a comment and ignored by fluxbox. Also, in the label/command/filename fields you can escape any character. 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: This 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\. .RE .PP +[config] (label) +.RS 4 +Inserts a fluxbox native submenu item, containing numerous configuration options concerning window placement, focus style, window moving style, etc\. +.RE +.PP [end] .RS 4 This 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 This 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\. .RE .PP -[config] (label) -.RS 4 -Inserts a fluxbox native submenu item, containing numerous configuration options concerning window placement, focus style, window moving style, etc\. -.RE -.PP -[wallpapers] (label) -.RS 4 -This 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\&... -.RE -.PP -[wallpapermenu] (directory) {command} +[wallpapers] (directory) {command} .RS 4 This inserts a menu item to set the wallpaper for each file in the given directory\. The command is optional and defaults to fbsetbg\. .RE @@ -475,6 +470,11 @@ This inserts a menu item to set the wallpaper for each file in the given directo .RS 4 This 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)\. .RE +.PP +[\fIcommand\fR] (label) +.RS 4 +In addition to the commands above, any legal key command may be used as a menu item\. See fluxbox\-keys(5) for more information\. +.RE Any 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\. .sp Here is an example menu file: -- cgit v0.11.2