aboutsummaryrefslogtreecommitdiff
path: root/doc/fluxbox.1.in
diff options
context:
space:
mode:
authorJim Ramsay <i.am@jimramsay.com>2009-02-10 14:03:01 (GMT)
committerJim Ramsay <i.am@jimramsay.com>2009-05-26 20:14:01 (GMT)
commita69c429e02d11e02d059acc800bd1ceb7e23ce59 (patch)
tree621961b9cd0aa7c0385147390ad173f969ddb1f4 /doc/fluxbox.1.in
parent56e393a71c9b5da57e615af64fd7cd3011da31e7 (diff)
downloadfluxbox-a69c429e02d11e02d059acc800bd1ceb7e23ce59.zip
fluxbox-a69c429e02d11e02d059acc800bd1ceb7e23ce59.tar.bz2
Removed APPLICATIONS section from fluxbox(1)
This is now in its own man page, fluxbox-apps(5).
Diffstat (limited to 'doc/fluxbox.1.in')
-rw-r--r--doc/fluxbox.1.in434
1 files changed, 9 insertions, 425 deletions
diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in
index cb5f215..98dacab 100644
--- a/doc/fluxbox.1.in
+++ b/doc/fluxbox.1.in
@@ -1,12 +1,12 @@
1.\" Title: fluxbox 1.\" Title: fluxbox
2.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] 2.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> 3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 10/18/2008 4.\" Date: 02/10/2009
5.\" Manual: [FIXME: manual] 5.\" Manual: Fluxbox Manual
6.\" Source: [FIXME: source] 6.\" Source: fluxbox.txt 1.1.1
7.\" Language: English 7.\" Language: English
8.\" 8.\"
9.TH "FLUXBOX" "1" "10/18/2008" "[FIXME: source]" "[FIXME: manual]" 9.TH "FLUXBOX" "1" "02/10/2009" "fluxbox\&.txt 1\&.1\&.1" "Fluxbox Manual"
10.\" ----------------------------------------------------------------- 10.\" -----------------------------------------------------------------
11.\" * (re)Define some macros 11.\" * (re)Define some macros
12.\" ----------------------------------------------------------------- 12.\" -----------------------------------------------------------------
@@ -396,7 +396,7 @@ Bottom
396Desktop 396Desktop
397.RE 397.RE
398.sp 398.sp
399Windows on a higher layer will always appear above those on a lower one\&. These layers can be used on application windows, the slit or the toolbar\&. You can assign applications to a certain layer by specifying it in the `apps\' file or through the WindowMenu\&. We discuss the `apps\' file in the APPLICATIONS section\&. We discuss the WindowMenu in the MENUS section\&. We discuss layers in more detail in the LAYERS section\&. 399Windows on a higher layer will always appear above those on a lower one\&. These layers can be used on application windows, the slit or the toolbar\&. You can assign applications to a certain layer by specifying it in the `apps\' file or through the WindowMenu\&. We discuss the `apps\' file in \fBfluxbox\-apps(5)\fR\&. We discuss the WindowMenu in the MENUS section\&. We discuss layers in more detail in the LAYERS section\&.
400.SS "Focus Model" 400.SS "Focus Model"
401.sp 401.sp
402The window that has the focus is the one that receives key and mouse events\&. The focus model is selectable via the Configuration menu located in the root menu\&. We\'ll discuss the different types of focus below in the FOCUS MODEL section\&. 402The window that has the focus is the one that receives key and mouse events\&. The focus model is selectable via the Configuration menu located in the root menu\&. We\'ll discuss the different types of focus below in the FOCUS MODEL section\&.
@@ -828,7 +828,8 @@ Button 3 (Un)Maximize window horizontally\&.
828.IP \(bu 2.3 828.IP \(bu 2.3
829.\} 829.\}
830 830
831\fBRemember\&...\fR: Specify which window settings should be stored in the apps file, covered later on in the APPLICATIONS section\&. 831\fBRemember\&...\fR: Specify which window settings should be stored in the `apps\' file, covered in
832\fBfluxbox\-apps(5)\fR\&.
832.RE 833.RE
833.sp 834.sp
834.RS 4 835.RS 4
@@ -1766,7 +1767,7 @@ session\&.screen0\&.showwindowposition: <boolean>
1766session\&.screen0\&.defaultDeco: <string> 1767session\&.screen0\&.defaultDeco: <string>
1767 This specifies the default window decorations, according to the same 1768 This specifies the default window decorations, according to the same
1768 options available to the `[Deco]\' option in the `apps\' file, described in 1769 options available to the `[Deco]\' option in the `apps\' file, described in
1769 the APPLICATIONS section\&. Default: NORMAL\&. 1770 *fluxbox\-apps(5)*\&. Default: NORMAL\&.
1770 1771
1771session\&.screen0\&.menuDelay: <integer> 1772session\&.screen0\&.menuDelay: <integer>
1772 This sets the delay in milliseconds for submenus to open when you hover 1773 This sets the delay in milliseconds for submenus to open when you hover
@@ -1970,7 +1971,7 @@ There are two ways to assign a window to a different layer\&. When the window is
197012 \- Desktop 197112 \- Desktop
1971.RE 1972.RE
1972.sp 1973.sp
1973The other way to set the layer for a window is through the `apps\' file\&. This method is described in the APPLICATIONS section\&. 1974The other way to set the layer for a window is through the `apps\' file\&. This method is described in \fBfluxbox\-apps(5)\fR\&.
1974.SH "FOCUS MODEL" 1975.SH "FOCUS MODEL"
1975.sp 1976.sp
1976The Focus Model defines how windows gain focus (i\&.e\&. become the active window, which receives keyboard and mouse events)\&. The focus model can be changed in the configuration menu (usually located under \fIfluxbox menu\fR in the Root Menu\&. 1977The Focus Model defines how windows gain focus (i\&.e\&. become the active window, which receives keyboard and mouse events)\&. The focus model can be changed in the configuration menu (usually located under \fIfluxbox menu\fR in the Root Menu\&.
@@ -2109,423 +2110,6 @@ The default installation of fluxbox provides some of these style files\&. See fl
2109.SH "STYLE OVERLAY" 2110.SH "STYLE OVERLAY"
2110.sp 2111.sp
2111In addition to the style file, the overlay file, whose location is specified by session\&.screen0\&.styleOverlay (default: ~/\&.fluxbox/overlay ) can be used to set style resources that override all styles\&. For more information about which parts of fluxbox can be controlled by the overlay file, see fluxstyle(1)\&. 2112In addition to the style file, the overlay file, whose location is specified by session\&.screen0\&.styleOverlay (default: ~/\&.fluxbox/overlay ) can be used to set style resources that override all styles\&. For more information about which parts of fluxbox can be controlled by the overlay file, see fluxstyle(1)\&.
2112.SH "APPLICATIONS"
2113.sp
2114It is possible to force an application to always have the same dimensions, position, and other settings when it is first launched\&. The easiest way to do this is to use the `Remember\&...\' submenu of the window menu, which can usually be opened with a right click on the titlebar\&. More advanced features require manually editing the ~/\&.fluxbox/apps file, where these settings are saved\&.
2115.sp
2116The format of a section in the `apps\' file is:
2117.sp
2118.if n \{\
2119.RS 4
2120.\}
2121.fam C
2122.ps -1
2123.nf
2124.BB lightgray
2125[app] (Property=\'value\') \&.\&.\&. {count \- optional}
2126 [Setting1] {value1}
2127 [Setting2] {value2}
2128 \&.\&.\&.
2129[end]
2130.EB lightgray
2131.fi
2132.fam
2133.ps +1
2134.if n \{\
2135.RE
2136.\}
2137.sp
2138Property can be one of the following tags:
2139.sp
2140o name \- the name of the window (the first field of WM_CLASS) o class \- class of the window (the second field of WM_CLASS) o title \- title of the window (the WM_NAME property) o role \- role of the window (the WM_WINDOW_ROLE property)
2141.sp
2142You can find out the value for these fields for a particular window by running xprop(1)\&. The window title should be used only as a last resort, since it often changes after the window opens\&. Each \fIvalue\fR can be a string or a regular expression\&. All values are case sensitive\&.
2143.sp
2144You can specify multiple properties, which must ALL match for the settings to be applied\&. If a count is supplied in curly brackets at the end of the app line, then the entry will only match at most that many at any time (default is to match all matching windows)\&. Settings associated with an [app] line will not be applied to transient windows\&. [transient] may be used instead to match them\&.
2145.sp
2146.if n \{\
2147.RS 4
2148.\}
2149.fam C
2150.ps -1
2151.nf
2152.BB lightgray
2153# match a standard xterm
2154[app] (name=xterm)
2155# match an xterm started like: xterm \-name myshell
2156[app] (name=myshell)
2157# match the gaim buddy list window
2158[app] (role=buddy_list)
2159# match an rdesktop window to a particular host
2160[app] (title=rdesktop \- hostname\&.*)
2161# match pidgin IRC windows
2162[app] (pidgin) (title=#\&.*)
2163.EB lightgray
2164.fi
2165.fam
2166.ps +1
2167.if n \{\
2168.RE
2169.\}
2170.sp
2171The following are the settings that can be defined in each [app] entry\&. Each name must be enclosed in square brackets, and the value is generally in curly brackets:
2172.sp
2173.RS 4
2174.ie n \{\
2175\h'-04'\(bu\h'+03'\c
2176.\}
2177.el \{\
2178.sp -1
2179.IP \(bu 2.3
2180.\}
2181[Workspace] {0\-N}: Forces the application to open on the workspace specified\&. Workspaces are set by number, beginning with 0\&.
2182.RE
2183.sp
2184.RS 4
2185.ie n \{\
2186\h'-04'\(bu\h'+03'\c
2187.\}
2188.el \{\
2189.sp -1
2190.IP \(bu 2.3
2191.\}
2192[Dimensions] {Width Height}: Open the application with the specified width and height, in pixels\&.
2193.RE
2194.sp
2195.RS 4
2196.ie n \{\
2197\h'-04'\(bu\h'+03'\c
2198.\}
2199.el \{\
2200.sp -1
2201.IP \(bu 2.3
2202.\}
2203[Position] (\fBrefspot\fR) {X Y}: Position the application at a particular spot:
2204.sp
2205.RS 4
2206.ie n \{\
2207\h'-04'\(bu\h'+03'\c
2208.\}
2209.el \{\
2210.sp -1
2211.IP \(bu 2.3
2212.\}
2213TOPLEFT
2214.RE
2215.sp
2216.RS 4
2217.ie n \{\
2218\h'-04'\(bu\h'+03'\c
2219.\}
2220.el \{\
2221.sp -1
2222.IP \(bu 2.3
2223.\}
2224TOP
2225.RE
2226.sp
2227.RS 4
2228.ie n \{\
2229\h'-04'\(bu\h'+03'\c
2230.\}
2231.el \{\
2232.sp -1
2233.IP \(bu 2.3
2234.\}
2235TOPRIGHT
2236.RE
2237.sp
2238.RS 4
2239.ie n \{\
2240\h'-04'\(bu\h'+03'\c
2241.\}
2242.el \{\
2243.sp -1
2244.IP \(bu 2.3
2245.\}
2246LEFT
2247.RE
2248.sp
2249.RS 4
2250.ie n \{\
2251\h'-04'\(bu\h'+03'\c
2252.\}
2253.el \{\
2254.sp -1
2255.IP \(bu 2.3
2256.\}
2257CENTER
2258.RE
2259.sp
2260.RS 4
2261.ie n \{\
2262\h'-04'\(bu\h'+03'\c
2263.\}
2264.el \{\
2265.sp -1
2266.IP \(bu 2.3
2267.\}
2268RIGHT
2269.RE
2270.sp
2271.RS 4
2272.ie n \{\
2273\h'-04'\(bu\h'+03'\c
2274.\}
2275.el \{\
2276.sp -1
2277.IP \(bu 2.3
2278.\}
2279BOTTOMLEFT
2280.RE
2281.sp
2282.RS 4
2283.ie n \{\
2284\h'-04'\(bu\h'+03'\c
2285.\}
2286.el \{\
2287.sp -1
2288.IP \(bu 2.3
2289.\}
2290BOTTOM
2291.RE
2292.sp
2293.RS 4
2294.ie n \{\
2295\h'-04'\(bu\h'+03'\c
2296.\}
2297.el \{\
2298.sp -1
2299.IP \(bu 2.3
2300.\}
2301BOTTOMRIGHT
2302.sp
2303.if n \{\
2304.RS 4
2305.\}
2306.fam C
2307.ps -1
2308.nf
2309.BB lightgray
2310You can optionally specify what X and Y are relative to\&. By default the
2311upper left corner is placed at screen coordinates (X, Y)\&. If you specify a
2312reference point, say LOWERRIGHT, then the lower right corner of the window
2313is positioned (X,Y) pixels from the lower right of the screen\&.
2314.EB lightgray
2315.fi
2316.fam
2317.ps +1
2318.if n \{\
2319.RE
2320.\}
2321.RE
2322.RE
2323.sp
2324.RS 4
2325.ie n \{\
2326\h'-04'\(bu\h'+03'\c
2327.\}
2328.el \{\
2329.sp -1
2330.IP \(bu 2.3
2331.\}
2332Specify the layer to open the window on (by number)\&. Each layer has a number\&. The named ones are: 2\-AboveDock, 4\-Dock, 6\-Top, 8\-Normal, 10\-Bottom, 12\-Desktop\&.
2333.RE
2334.sp
2335.RS 4
2336.ie n \{\
2337\h'-04'\(bu\h'+03'\c
2338.\}
2339.el \{\
2340.sp -1
2341.IP \(bu 2.3
2342.\}
2343[Shaded] {yes|no}: The window is started shaded, or not\&.
2344.RE
2345.sp
2346.RS 4
2347.ie n \{\
2348\h'-04'\(bu\h'+03'\c
2349.\}
2350.el \{\
2351.sp -1
2352.IP \(bu 2.3
2353.\}
2354[Tab] {yes|no}: Whether this window can be tabbed with others\&.
2355.RE
2356.sp
2357.RS 4
2358.ie n \{\
2359\h'-04'\(bu\h'+03'\c
2360.\}
2361.el \{\
2362.sp -1
2363.IP \(bu 2.3
2364.\}
2365[IconHidden] {yes|no}: Hides the app from the icon bar
2366.RE
2367.sp
2368.RS 4
2369.ie n \{\
2370\h'-04'\(bu\h'+03'\c
2371.\}
2372.el \{\
2373.sp -1
2374.IP \(bu 2.3
2375.\}
2376[FocusHidden] {yes|no}: Hides the app from the window cycling list used by Next/PrevWindow key bindings\&.
2377.RE
2378.sp
2379.RS 4
2380.ie n \{\
2381\h'-04'\(bu\h'+03'\c
2382.\}
2383.el \{\
2384.sp -1
2385.IP \(bu 2.3
2386.\}
2387[Hidden] {yes|no}: is both [IconHidden] plus [FocusHidden]
2388.RE
2389.sp
2390.RS 4
2391.ie n \{\
2392\h'-04'\(bu\h'+03'\c
2393.\}
2394.el \{\
2395.sp -1
2396.IP \(bu 2.3
2397.\}
2398[Deco] {NONE|NORMAL|TOOL|TINY|BORDER}: Specify the decoration state\&. There are several predefined dec\- oration sets:
2399.sp
2400.if n \{\
2401.RS 4
2402.\}
2403.fam C
2404.ps -1
2405.nf
2406.BB lightgray
2407o NORMAL \- standard decorations
2408o NONE \- no decorations
2409o BORDER \- like NONE except keep the X window border
2410o TINY \- titlebar with an iconify button
2411o TOOL \- titlebar only
2412.EB lightgray
2413.fi
2414.fam
2415.ps +1
2416.if n \{\
2417.RE
2418.\}
2419.sp
2420.if n \{\
2421.RS 4
2422.\}
2423.fam C
2424.ps -1
2425.nf
2426.BB lightgray
2427A bitmask can also be used for fine\-grained control\&. The bits are (from
2428"1" to 1<<10): titlebar, handle/grips, border, iconify button, maximize
2429button, close button, menu enabled, sticky button, shade button, tabbing
2430enabled, focus enabled\&.
2431.EB lightgray
2432.fi
2433.fam
2434.ps +1
2435.if n \{\
2436.RE
2437.\}
2438.RE
2439.sp
2440.RS 4
2441.ie n \{\
2442\h'-04'\(bu\h'+03'\c
2443.\}
2444.el \{\
2445.sp -1
2446.IP \(bu 2.3
2447.\}
2448[Sticky] {yes|no}: Whether the window is initially stuck or not\&.
2449.RE
2450.sp
2451.RS 4
2452.ie n \{\
2453\h'-04'\(bu\h'+03'\c
2454.\}
2455.el \{\
2456.sp -1
2457.IP \(bu 2.3
2458.\}
2459[Jump] {yes|no}: Jump to workspace\&. This one is only useful if `Workspace\' is set too\&. The workspace is changed to the workspace containing the application being launched\&.
2460.RE
2461.sp
2462.RS 4
2463.ie n \{\
2464\h'-04'\(bu\h'+03'\c
2465.\}
2466.el \{\
2467.sp -1
2468.IP \(bu 2.3
2469.\}
2470[Close] {yes|no}: Save settings on close\&. By default, application settings are not saved when a window is closed\&. Set this option if you want previous settings to be saved when the window is closed\&.
2471.RE
2472.sp
2473.RS 4
2474.ie n \{\
2475\h'-04'\(bu\h'+03'\c
2476.\}
2477.el \{\
2478.sp -1
2479.IP \(bu 2.3
2480.\}
2481[Alpha] {int [int]} Where numbers represent focused and unfocused transparency, respectively\&. One number only will be used for both\&.
2482.RE
2483.sp
2484The apps file also allows you to specify applications that should be started only valid option is (screen=NN), where NN is the screen number on which the command should be run\&.
2485.sp
2486Finally, you can set windows to group together by using the `apps\' file\&. Just place a [group] tag around several [app] tags, with an [end] tag to indicate the end of the group\&. If you place (workspace) after the [group] tag, a new window will only get grouped with other windows on the current workspace\&. You can also specify dimensions, positions, etc\&. for the group as for normal app entries\&. Here is a short example of an `apps\' file:
2487.sp
2488.if n \{\
2489.RS 4
2490.\}
2491.fam C
2492.ps -1
2493.nf
2494.BB lightgray
2495 [startup] {xterm}
2496 # match anything ending with term, up to 2 instances
2497 [app] (name=\&.*[tT]erm) {2}
2498 [Workspace] {1}
2499 [end]
2500 [app] (name=kate)
2501 [Dimensions] {1022 747}
2502 [Position] (WINCENTER) {0 0}
2503 [Close] {yes}
2504 [end]
2505 [app] (name=konqueror)
2506 [Workspace] {1}
2507 [Dimensions] {1006 749}
2508 [Position] {16 0}
2509 [Jump] {yes}
2510 [end]
2511 # start all aterms without decorations
2512 [app] (name=aterm)
2513 [Deco] {NONE}
2514 [end]
2515 # a group with the gimp dock and toolbox
2516 # appears on layer 4 (bottom)
2517 [group]
2518 [app] (name=gimp) (role=gimp\-dock)
2519 [app] (name=gimp) (role=gimp\-toolbox)
2520 [Layer] {4}
2521 [end]
2522.EB lightgray
2523.fi
2524.fam
2525.ps +1
2526.if n \{\
2527.RE
2528.\}
2529.SH "THE SLIT" 2113.SH "THE SLIT"
2530.sp 2114.sp
2531The slit is a special fluxbox window frame that can contain dockable applications, e\&.g\&. \fIbbtools\fR or \fIwmapps\fR\&. 2115The slit is a special fluxbox window frame that can contain dockable applications, e\&.g\&. \fIbbtools\fR or \fIwmapps\fR\&.