diff options
Diffstat (limited to 'doc/asciidoc/fluxbox-menu.txt')
-rw-r--r-- | doc/asciidoc/fluxbox-menu.txt | 206 |
1 files changed, 103 insertions, 103 deletions
diff --git a/doc/asciidoc/fluxbox-menu.txt b/doc/asciidoc/fluxbox-menu.txt index eecdf98..925b80e 100644 --- a/doc/asciidoc/fluxbox-menu.txt +++ b/doc/asciidoc/fluxbox-menu.txt | |||
@@ -77,114 +77,114 @@ detailed below. | |||
77 | Structural Tags | 77 | Structural Tags |
78 | ~~~~~~~~~~~~~~~ | 78 | ~~~~~~~~~~~~~~~ |
79 | *[begin]* ('title');; | 79 | *[begin]* ('title');; |
80 | This tells fluxbox to start parsing the menu file. This tag is required for | 80 | This tells fluxbox to start parsing the menu file. This tag is required for |
81 | fluxbox to read your menu file. If it cannot find it, the system default menu | 81 | fluxbox to read your menu file. If it cannot find it, the system default menu |
82 | is used in its place. The 'title' appears at the top of the menu. And *[end]* | 82 | is used in its place. The 'title' appears at the top of the menu. And *[end]* |
83 | tag is required to end the menu. | 83 | tag is required to end the menu. |
84 | 84 | ||
85 | *[submenu]* ('label') {'title'} <'icon'>;; | 85 | *[submenu]* ('label') {'title'} <'icon'>;; |
86 | This tells fluxbox to create and parse a new menu, which is inserted as a | 86 | This tells fluxbox to create and parse a new menu, which is inserted as a |
87 | submenu into the parent menu. These menus are parsed recursively, so there is | 87 | submenu into the parent menu. These menus are parsed recursively, so there is |
88 | no limit to the number of levels or nested submenus you can have. The 'label' | 88 | no limit to the number of levels or nested submenus you can have. The 'label' |
89 | is the text that will appear in the parent menu, and the 'title' is shown at | 89 | is the text that will appear in the parent menu, and the 'title' is shown at |
90 | the top of the submenu. If omitted, the 'title' will be the same as the | 90 | the top of the submenu. If omitted, the 'title' will be the same as the |
91 | 'label'. An *[end]* tag is required to end the submenu. | 91 | 'label'. An *[end]* tag is required to end the submenu. |
92 | 92 | ||
93 | *[end]*;; | 93 | *[end]*;; |
94 | This tells fluxbox that it is at the end of a menu. This can either be a | 94 | This tells fluxbox that it is at the end of a menu. This can either be a |
95 | *[submenu]* or the *[begin]* tag of the main root menu. There must be at | 95 | *[submenu]* or the *[begin]* tag of the main root menu. There must be at |
96 | least one of these tags in your menu to correspond to the required *[begin]* | 96 | least one of these tags in your menu to correspond to the required *[begin]* |
97 | tag, and one for each *[submenu]*. | 97 | tag, and one for each *[submenu]*. |
98 | 98 | ||
99 | *[encoding]* {'encoding'};; | 99 | *[encoding]* {'encoding'};; |
100 | This begins an *[encoding]* section and specifies the string encoding of | 100 | This begins an *[encoding]* section and specifies the string encoding of |
101 | all strings until the matching *[endencoding]* tag. For a list of available | 101 | all strings until the matching *[endencoding]* tag. For a list of available |
102 | encodings on your system, run *iconv -l*. | 102 | encodings on your system, run *iconv -l*. |
103 | 103 | ||
104 | *[endencoding]*;; | 104 | *[endencoding]*;; |
105 | This ends an *[encoding]* section. | 105 | This ends an *[encoding]* section. |
106 | 106 | ||
107 | *[include]* ('path');; | 107 | *[include]* ('path');; |
108 | Parses the file specified by filename inline with the current menu. The | 108 | Parses the file specified by filename inline with the current menu. The |
109 | 'path' can be the full path to a file or it can begin with *~/*, which will | 109 | 'path' can be the full path to a file or it can begin with *~/*, which will |
110 | be expanded into your home directory. If 'path' is a directory, then all | 110 | be expanded into your home directory. If 'path' is a directory, then all |
111 | files in that directory are included. | 111 | files in that directory are included. |
112 | 112 | ||
113 | *[separator]*;; | 113 | *[separator]*;; |
114 | This will create a nice separation line. Useful for splitting up sections in | 114 | This will create a nice separation line. Useful for splitting up sections in |
115 | a ``pretty'' way. The optional 'comment' is not displayed, but can be useful | 115 | a ``pretty'' way. The optional 'comment' is not displayed, but can be useful |
116 | for internal documentation or script parsing of menu files. | 116 | for internal documentation or script parsing of menu files. |
117 | 117 | ||
118 | *[nop]* ('label') <'icon'>;; | 118 | *[nop]* ('label') <'icon'>;; |
119 | Insert a non-operational item into the current menu. This is much like | 119 | Insert a non-operational item into the current menu. This is much like |
120 | *[separator]*, but instead of a line, it inserts a 'label'. This can be used | 120 | *[separator]*, but instead of a line, it inserts a 'label'. This can be used |
121 | to help format the menu into blocks or sections if so desired. The 'label' is | 121 | to help format the menu into blocks or sections if so desired. The 'label' is |
122 | optional, and if omitted a blank item will be inserted. | 122 | optional, and if omitted a blank item will be inserted. |
123 | 123 | ||
124 | Applications | 124 | Applications |
125 | ~~~~~~~~~~~~ | 125 | ~~~~~~~~~~~~ |
126 | *[exec]* ('label') {'command...'} <'icon'>;; | 126 | *[exec]* ('label') {'command...'} <'icon'>;; |
127 | Inserts a command item into the menu. When you select the menu item from the | 127 | Inserts a command item into the menu. When you select the menu item from the |
128 | menu, fluxbox runs 'command...' in your *$SHELL* (or /bin/sh if $SHELL is not | 128 | menu, fluxbox runs 'command...' in your *$SHELL* (or /bin/sh if $SHELL is not |
129 | set). You can use this to launch applications, run shell scripts, etc. Since | 129 | set). You can use this to launch applications, run shell scripts, etc. Since |
130 | all arguments are passed verbatim to the shell, you can use environment | 130 | all arguments are passed verbatim to the shell, you can use environment |
131 | variables, pipes, or anything else the shell can do. Note that processes only | 131 | variables, pipes, or anything else the shell can do. Note that processes only |
132 | see environment variables that were set before fluxbox started (such as in | 132 | see environment variables that were set before fluxbox started (such as in |
133 | ~/.fluxbox/startup). | 133 | ~/.fluxbox/startup). |
134 | 134 | ||
135 | Fluxbox Functions | 135 | Fluxbox Functions |
136 | ~~~~~~~~~~~~~~~~~ | 136 | ~~~~~~~~~~~~~~~~~ |
137 | *[config]* ('label') <'icon'>;; | 137 | *[config]* ('label') <'icon'>;; |
138 | Inserts a fluxbox native submenu item, containing numerous configuration | 138 | Inserts a fluxbox native submenu item, containing numerous configuration |
139 | options concerning window placement, focus style, window moving style, etc. | 139 | options concerning window placement, focus style, window moving style, etc. |
140 | See *Configuration Menu* in *fluxbox(1)* for details. | 140 | See *Configuration Menu* in *fluxbox(1)* for details. |
141 | 141 | ||
142 | *[reconfig]* ('label') <'icon'>;; | 142 | *[reconfig]* ('label') <'icon'>;; |
143 | When selected this item re-reads the current style and menu files and applies | 143 | When selected this item re-reads the current style and menu files and applies |
144 | any changes. This is useful for creating a new style or theme, as you don't | 144 | any changes. This is useful for creating a new style or theme, as you don't |
145 | have to constantly restart fluxbox every time you save your style. However, | 145 | have to constantly restart fluxbox every time you save your style. However, |
146 | fluxbox automatically rereads the menu whenever it changes. | 146 | fluxbox automatically rereads the menu whenever it changes. |
147 | 147 | ||
148 | *[restart]* ('label') {'command'} <'icon'>;; | 148 | *[restart]* ('label') {'command'} <'icon'>;; |
149 | This tells fluxbox to restart. If 'command' is supplied, it shuts down and | 149 | This tells fluxbox to restart. If 'command' is supplied, it shuts down and |
150 | runs the command (which is commonly the name of another window manager). If | 150 | runs the command (which is commonly the name of another window manager). If |
151 | 'command' is omitted, fluxbox restarts itself. | 151 | 'command' is omitted, fluxbox restarts itself. |
152 | 152 | ||
153 | *[exit]* ('label') <'icon'>;; | 153 | *[exit]* ('label') <'icon'>;; |
154 | Inserts an item that shuts down and exits fluxbox. Any open windows are | 154 | Inserts an item that shuts down and exits fluxbox. Any open windows are |
155 | reparented to the root window before fluxbox exits. | 155 | reparented to the root window before fluxbox exits. |
156 | 156 | ||
157 | *[style]* ('label') {'filename'} <'icon'>;; | 157 | *[style]* ('label') {'filename'} <'icon'>;; |
158 | This tells fluxbox to insert an item that, when selected, reads style file | 158 | This tells fluxbox to insert an item that, when selected, reads style file |
159 | named filename and apply the new textures, colors and fonts to the current | 159 | named filename and apply the new textures, colors and fonts to the current |
160 | running session. | 160 | running session. |
161 | 161 | ||
162 | *[stylesmenu]* ('directory') <'icon'>;; | 162 | *[stylesmenu]* ('directory') <'icon'>;; |
163 | Reads all filenames from the specified directory, assuming that they are all | 163 | Reads all filenames from the specified directory, assuming that they are all |
164 | valid style files, and creates inline menu items in the current menu for | 164 | valid style files, and creates inline menu items in the current menu for |
165 | every filename, that, when selected by the user will apply the selected style | 165 | every filename, that, when selected by the user will apply the selected style |
166 | file to the current session. The labels that are created in the menu are the | 166 | file to the current session. The labels that are created in the menu are the |
167 | filenames of the style files. | 167 | filenames of the style files. |
168 | 168 | ||
169 | *[stylesdir]* ('label') {'directory'} <'icon'>;; | 169 | *[stylesdir]* ('label') {'directory'} <'icon'>;; |
170 | Creates a submenu entry with 'label' (that is also the title of the new | 170 | Creates a submenu entry with 'label' (that is also the title of the new |
171 | submenu), and inserts in that submenu all filenames in the specified | 171 | submenu), and inserts in that submenu all filenames in the specified |
172 | 'directory', assuming that they are all valid style files (directories are | 172 | 'directory', assuming that they are all valid style files (directories are |
173 | ignored) in the same way as the *[stylesdir]* command does. Both | 173 | ignored) in the same way as the *[stylesdir]* command does. Both |
174 | *[stylesdir]* and *[stylesmenu]* commands make it possible to install style | 174 | *[stylesdir]* and *[stylesmenu]* commands make it possible to install style |
175 | files without editing your init file. | 175 | files without editing your init file. |
176 | 176 | ||
177 | *[wallpapers]* ('directory') {'command'} <'icon'>;; | 177 | *[wallpapers]* ('directory') {'command'} <'icon'>;; |
178 | This inserts a menu item to set the wallpaper for each file in the given | 178 | This inserts a menu item to set the wallpaper for each file in the given |
179 | directory. The 'command' is optional, and defaults to *fbsetbg*. | 179 | directory. The 'command' is optional, and defaults to *fbsetbg*. |
180 | 180 | ||
181 | *[workspaces]* ('label') <'icon'>;; | 181 | *[workspaces]* ('label') <'icon'>;; |
182 | This tells fluxbox to insert a link to the workspaces menu directly into your | 182 | This tells fluxbox to insert a link to the workspaces menu directly into your |
183 | menu. See *Workspace Menu* in *fluxbox(1)* for details. | 183 | menu. See *Workspace Menu* in *fluxbox(1)* for details. |
184 | 184 | ||
185 | *[*'command'*]* ('label') <'icon'>;; | 185 | *[*'command'*]* ('label') <'icon'>;; |
186 | In addition to the commands above, any legal keys file 'command' may be used | 186 | In addition to the commands above, any legal keys file 'command' may be used |
187 | as a menu item. See *fluxbox-keys(5)* for more information. | 187 | as a menu item. See *fluxbox-keys(5)* for more information. |
188 | 188 | ||
189 | WINDOW MENU | 189 | WINDOW MENU |
190 | ----------- | 190 | ----------- |
@@ -195,79 +195,79 @@ labels, commands, or icons. | |||
195 | The available tags in this menu are: | 195 | The available tags in this menu are: |
196 | 196 | ||
197 | *[shade]*;; | 197 | *[shade]*;; |
198 | Provides a menu item to shade or unshade (or, roll-up) the window. This is | 198 | Provides a menu item to shade or unshade (or, roll-up) the window. This is |
199 | equivalent to the shade titlebar button. | 199 | equivalent to the shade titlebar button. |
200 | 200 | ||
201 | *[stick]*;; | 201 | *[stick]*;; |
202 | Provides a menu item to stick or unstick the window. Stuck windows are | 202 | Provides a menu item to stick or unstick the window. Stuck windows are |
203 | displayed on all workspaces. This is equivalent to the stick titlebar button. | 203 | displayed on all workspaces. This is equivalent to the stick titlebar button. |
204 | 204 | ||
205 | *[maximize]*;; | 205 | *[maximize]*;; |
206 | Provides a menu item to maximize or unmaximize the window, equivalent to the | 206 | Provides a menu item to maximize or unmaximize the window, equivalent to the |
207 | maximize titlebar button. The button with which you click alters the | 207 | maximize titlebar button. The button with which you click alters the |
208 | behaviour of this item as follows: | 208 | behaviour of this item as follows: |
209 | 209 | ||
210 | * Button 1 (Un)Maximize as normal. | 210 | * Button 1 (Un)Maximize as normal. |
211 | * Button 2 (Un)Maximize window vertically. | 211 | * Button 2 (Un)Maximize window vertically. |
212 | * Button 3 (Un)Maximize window horizontally. | 212 | * Button 3 (Un)Maximize window horizontally. |
213 | 213 | ||
214 | *[iconify]*;; | 214 | *[iconify]*;; |
215 | Provides a menu item to iconify (or, minimize) the window, equivalent to the | 215 | Provides a menu item to iconify (or, minimize) the window, equivalent to the |
216 | iconify titlebar button. | 216 | iconify titlebar button. |
217 | 217 | ||
218 | *[close]*;; | 218 | *[close]*;; |
219 | Closes the window gracefully, equivalent to the titlebar button. | 219 | Closes the window gracefully, equivalent to the titlebar button. |
220 | 220 | ||
221 | *[kill]*;; | 221 | *[kill]*;; |
222 | Kills the window's process, like *xkill(1)*. | 222 | Kills the window's process, like *xkill(1)*. |
223 | 223 | ||
224 | *[raise]*;; | 224 | *[raise]*;; |
225 | Raise the window to the top of the stack within its layer. | 225 | Raise the window to the top of the stack within its layer. |
226 | 226 | ||
227 | *[lower]*;; | 227 | *[lower]*;; |
228 | Lower the window to the bottom of the stack within its layer. | 228 | Lower the window to the bottom of the stack within its layer. |
229 | 229 | ||
230 | *[settitledialog]*;; | 230 | *[settitledialog]*;; |
231 | Opens a dialog which can be used to set the window's title. Some applications | 231 | Opens a dialog which can be used to set the window's title. Some applications |
232 | may re-set their own title from time-to-time, wiping out your setting. | 232 | may re-set their own title from time-to-time, wiping out your setting. |
233 | 233 | ||
234 | *[sendto]*;; | 234 | *[sendto]*;; |
235 | Sends the window to a different workspace. When you select the workspace with | 235 | Sends the window to a different workspace. When you select the workspace with |
236 | a middle-click, fluxbox will also change to the new workspace. A regular | 236 | a middle-click, fluxbox will also change to the new workspace. A regular |
237 | click only sends the window. | 237 | click only sends the window. |
238 | 238 | ||
239 | *[layer]*;; | 239 | *[layer]*;; |
240 | Adds a ``Layer...'' submenu which lets you change the layer of this window. | 240 | Adds a ``Layer...'' submenu which lets you change the layer of this window. |
241 | 241 | ||
242 | *[alpha]*;; | 242 | *[alpha]*;; |
243 | Adds a ``Transparency...'' submenu which lets you change the focused and | 243 | Adds a ``Transparency...'' submenu which lets you change the focused and |
244 | unfocused transparency of this window. | 244 | unfocused transparency of this window. |
245 | 245 | ||
246 | *[extramenus]*;; | 246 | *[extramenus]*;; |
247 | Adds the ``Remember...'' menu item, which allows you to specify which | 247 | Adds the ``Remember...'' menu item, which allows you to specify which |
248 | settings should be stored in the `apps' file (See *fluxbox-apps(5)* for more | 248 | settings should be stored in the `apps' file (See *fluxbox-apps(5)* for more |
249 | details). | 249 | details). |
250 | 250 | ||
251 | *[separator]*;; | 251 | *[separator]*;; |
252 | Adds a horizontal line to the menu | 252 | Adds a horizontal line to the menu |
253 | 253 | ||
254 | FILES | 254 | FILES |
255 | ----- | 255 | ----- |
256 | *~/.fluxbox/menu*:: | 256 | *~/.fluxbox/menu*:: |
257 | This is the default location for the user's root menu. | 257 | This is the default location for the user's root menu. |
258 | *@pkgdatadir@/menu*:: | 258 | *@pkgdatadir@/menu*:: |
259 | This is the system-wide root menu file. It will be used if the user's root | 259 | This is the system-wide root menu file. It will be used if the user's root |
260 | menu is missing or unparseable. | 260 | menu is missing or unparseable. |
261 | *~/.fluxbox/windowmenu*:: | 261 | *~/.fluxbox/windowmenu*:: |
262 | This is the user's window menu definition file | 262 | This is the user's window menu definition file |
263 | *@pkgdatadir@/menu*:: | 263 | *@pkgdatadir@/menu*:: |
264 | This is the default window menu. If the user does not have this file, it will | 264 | This is the default window menu. If the user does not have this file, it will |
265 | be copied to *~/.fluxbox/windowmenu* on fluxbox startup. | 265 | be copied to *~/.fluxbox/windowmenu* on fluxbox startup. |
266 | 266 | ||
267 | RESOURCES | 267 | RESOURCES |
268 | --------- | 268 | --------- |
269 | *session.menuFile:* 'location':: | 269 | *session.menuFile:* 'location':: |
270 | This may be set to override the location of the user's root menu. | 270 | This may be set to override the location of the user's root menu. |
271 | 271 | ||
272 | ENVIRONMENT | 272 | ENVIRONMENT |
273 | ----------- | 273 | ----------- |