diff options
Diffstat (limited to 'doc/fluxbox.1.in')
-rw-r--r-- | doc/fluxbox.1.in | 54 |
1 files changed, 30 insertions, 24 deletions
diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in index 9ce4f3c..79d57c1 100644 --- a/doc/fluxbox.1.in +++ b/doc/fluxbox.1.in | |||
@@ -1,13 +1,13 @@ | |||
1 | '\" t | 1 | '\" t |
2 | .\" Title: fluxbox | 2 | .\" Title: fluxbox |
3 | .\" Author: [see the "AUTHORS" section] | 3 | .\" Author: Henrik Kinnunen <fluxgen@fluxbox.org> |
4 | .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> | 4 | .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> |
5 | .\" Date: 02/19/2011 | 5 | .\" Date: 27 February 2011 |
6 | .\" Manual: Fluxbox Manual | 6 | .\" Manual: Fluxbox Manual |
7 | .\" Source: fluxbox.txt | 7 | .\" Source: fluxbox.txt |
8 | .\" Language: English | 8 | .\" Language: English |
9 | .\" | 9 | .\" |
10 | .TH "FLUXBOX" "1" "02/19/2011" "fluxbox\&.txt" "Fluxbox Manual" | 10 | .TH "FLUXBOX" "1" "27 February 2011" "fluxbox\&.txt" "Fluxbox Manual" |
11 | .\" ----------------------------------------------------------------- | 11 | .\" ----------------------------------------------------------------- |
12 | .\" * Define some portability stuff | 12 | .\" * Define some portability stuff |
13 | .\" ----------------------------------------------------------------- | 13 | .\" ----------------------------------------------------------------- |
@@ -74,7 +74,7 @@ Starting fluxbox with this option will designate a file in which you want to log | |||
74 | \fB\-rc\fR \fIrcfile\fR | 74 | \fB\-rc\fR \fIrcfile\fR |
75 | .RS 4 | 75 | .RS 4 |
76 | Use a different config file other than the default | 76 | Use a different config file other than the default |
77 | \fB\e~/\&.fluxbox/init\fR\&. | 77 | \fB~/\&.fluxbox/init\fR\&. |
78 | .RE | 78 | .RE |
79 | .PP | 79 | .PP |
80 | \fB\-v\fR, \fB\-version\fR | 80 | \fB\-v\fR, \fB\-version\fR |
@@ -103,11 +103,11 @@ Lists all available internal commands\&. | |||
103 | .RE | 103 | .RE |
104 | .SH "STARTING FLUXBOX" | 104 | .SH "STARTING FLUXBOX" |
105 | .sp | 105 | .sp |
106 | \fBfluxbox(1)\fR comes with a program called \fBstartfluxbox(1)\fR usually located wherever you installed fluxbox\&. This script provides you with many options and variables that can be set when starting fluxbox\&. To actually call fluxbox and begin using it, you should place \(lqexec startfluxbox\(rq in your \fB~/\&.xinitrc\fR as the last executed command\&. This is assuming that the location of \fBfluxbox(1)\fR and \fBstartfluxbox(1)\fR are in your shell\(cqs $PATH\&. Also note that you may need to create the \fB~/\&.xinitrc\fR file or your setup may use \fB\e~/\&.xsession\fR instead, depending on your X setup\&. Some X login managers like \fBgdm(1)\fR or \fBkdm(1)\fR may simply provide a \(lqFluxbox\(rq session for you without having to alter any settings\&. | 106 | \fBfluxbox(1)\fR comes with a program called \fBstartfluxbox(1)\fR usually located wherever you installed fluxbox\&. This script provides you with many options and variables that can be set when starting fluxbox\&. To actually call fluxbox and begin using it, you should place \(lqexec startfluxbox\(rq in your \fB~/\&.xinitrc\fR as the last executed command\&. This is assuming that the location of \fBfluxbox(1)\fR and \fBstartfluxbox(1)\fR are in your shell\(cqs $PATH\&. Also note that you may need to create the \fB~/\&.xinitrc\fR file or your setup may use \fB~/\&.xsession\fR instead, depending on your X setup\&. Some X login managers like \fBgdm(1)\fR or \fBkdm(1)\fR may simply provide a \(lqFluxbox\(rq session for you without having to alter any settings\&. |
107 | .sp | 107 | .sp |
108 | By using fluxbox \-i you\(cqll see the defaults used by \fBfluxbox(1)\fR\&. These are what fluxbox looks for upon startup\&. In the list of \(lqDefaults:\(rq you\(cqll see a menu file location, this is where you can provide a system\-wide menu file for your users\&. | 108 | By using fluxbox \-i you\(cqll see the defaults used by \fBfluxbox(1)\fR\&. These are what fluxbox looks for upon startup\&. In the list of \(lqDefaults:\(rq you\(cqll see a menu file location, this is where you can provide a system\-wide menu file for your users\&. |
109 | .sp | 109 | .sp |
110 | On exit or restart, fluxbox will save user defaults in the file \fB\e~/\&.fluxbox/init\fR\&. Resources in this file can also be edited by hand, see the \fBRESOURCES\fR section for more details\&. \fBfluxbox(1)\fR also has many tools to edit these; look through the main menu once fluxbox has started to find different ways of managing your session\&. | 110 | On exit or restart, fluxbox will save user defaults in the file \fB~/\&.fluxbox/init\fR\&. Resources in this file can also be edited by hand, see the \fBRESOURCES\fR section for more details\&. \fBfluxbox(1)\fR also has many tools to edit these; look through the main menu once fluxbox has started to find different ways of managing your session\&. |
111 | .SH "USING FLUXBOX" | 111 | .SH "USING FLUXBOX" |
112 | .sp | 112 | .sp |
113 | When using fluxbox for the first time, users who are more accustomed to full desktop environments such as KDE or Gnome may be a little surprised by the minimal screen content\&. fluxbox is designed to be fast and powerful, so it may take a bit of getting used to \(em however, the rewards are worthwhile\&. | 113 | When using fluxbox for the first time, users who are more accustomed to full desktop environments such as KDE or Gnome may be a little surprised by the minimal screen content\&. fluxbox is designed to be fast and powerful, so it may take a bit of getting used to \(em however, the rewards are worthwhile\&. |
@@ -491,9 +491,9 @@ Keyboard bindings: | |||
491 | .IP \(bu 2.3 | 491 | .IP \(bu 2.3 |
492 | .\} | 492 | .\} |
493 | 493 | ||
494 | \fBWin+1\fR | 494 | \fBWIN+1\fR |
495 | \(-> | 495 | \- |
496 | \fBWin+9\fR: Select the 1st \(-> 9th tab in the current window | 496 | \fBWIN+9\fR: Select the 1st \(-> 9th tab in the current window |
497 | .RE | 497 | .RE |
498 | .sp | 498 | .sp |
499 | .RS 4 | 499 | .RS 4 |
@@ -662,7 +662,7 @@ for a small \(lqrun program\(rq dialog | |||
662 | .\} | 662 | .\} |
663 | 663 | ||
664 | \fBCTRL+F1\fR | 664 | \fBCTRL+F1\fR |
665 | \(-> | 665 | \- |
666 | \fBCTRL+F12\fR: Switch to the 1st \(-> 12th workspace | 666 | \fBCTRL+F12\fR: Switch to the 1st \(-> 12th workspace |
667 | .RE | 667 | .RE |
668 | .sp | 668 | .sp |
@@ -676,7 +676,7 @@ for a small \(lqrun program\(rq dialog | |||
676 | .\} | 676 | .\} |
677 | 677 | ||
678 | \fBWIN+F1\fR | 678 | \fBWIN+F1\fR |
679 | \(-> | 679 | \- |
680 | \fBWIN+F12\fR: Send the current window to a specific workspace | 680 | \fBWIN+F12\fR: Send the current window to a specific workspace |
681 | .RE | 681 | .RE |
682 | .sp | 682 | .sp |
@@ -690,7 +690,7 @@ for a small \(lqrun program\(rq dialog | |||
690 | .\} | 690 | .\} |
691 | 691 | ||
692 | \fBCTRL+WIN+F1\fR | 692 | \fBCTRL+WIN+F1\fR |
693 | \(-> | 693 | \- |
694 | \fBCTRL+WIN+F12\fR: Take the current window to a specific workspace | 694 | \fBCTRL+WIN+F12\fR: Take the current window to a specific workspace |
695 | .RE | 695 | .RE |
696 | .SH "MENUS" | 696 | .SH "MENUS" |
@@ -726,7 +726,7 @@ upon a default install\&. Remember that you can confirm this with fluxbox \-i\&. | |||
726 | \fBUser Styles\fR | 726 | \fBUser Styles\fR |
727 | .RS 4 | 727 | .RS 4 |
728 | This is where your custom styles are listed\&. It will list any styles from | 728 | This is where your custom styles are listed\&. It will list any styles from |
729 | \fB\e~/\&.fluxbox/styles/\fR, which may be styles you grab from the Internet, or your own custom styles, provided you follow the standards described in | 729 | \fB~/\&.fluxbox/styles/\fR, which may be styles you grab from the Internet, or your own custom styles, provided you follow the standards described in |
730 | \fBfluxbox\-style(5)\fR\&. | 730 | \fBfluxbox\-style(5)\fR\&. |
731 | .RE | 731 | .RE |
732 | .PP | 732 | .PP |
@@ -1054,7 +1054,7 @@ Pops up a dialog to enter a new name for the current workspace\&. | |||
1054 | .PP | 1054 | .PP |
1055 | \fBRemove Last\fR | 1055 | \fBRemove Last\fR |
1056 | .RS 4 | 1056 | .RS 4 |
1057 | Remove the last workspace in the list\&. Any windows curretly open there will be sent to the next\-to\-last workspace\&. | 1057 | Remove the last workspace in the list\&. Any windows currently open there will be sent to the next\-to\-last workspace\&. |
1058 | .RE | 1058 | .RE |
1059 | .SH "TOOLBAR" | 1059 | .SH "TOOLBAR" |
1060 | .sp | 1060 | .sp |
@@ -1086,12 +1086,12 @@ This displays the name of the current workspace\&. | |||
1086 | .PP | 1086 | .PP |
1087 | \fBPrevWorkspace\fR | 1087 | \fBPrevWorkspace\fR |
1088 | .RS 4 | 1088 | .RS 4 |
1089 | This displays an arrow that allows to switch to the workspace left of the current one\&. | 1089 | This displays an arrow that allows one to switch to the workspace left of the current one\&. |
1090 | .RE | 1090 | .RE |
1091 | .PP | 1091 | .PP |
1092 | \fBNextWorkspace\fR | 1092 | \fBNextWorkspace\fR |
1093 | .RS 4 | 1093 | .RS 4 |
1094 | This displays an arrow that allows to switch to the workspace right of the current one\&. | 1094 | This displays an arrow that allows one to switch to the workspace right of the current one\&. |
1095 | .RE | 1095 | .RE |
1096 | .PP | 1096 | .PP |
1097 | \fBPrevWindow\fR | 1097 | \fBPrevWindow\fR |
@@ -1306,14 +1306,14 @@ fluxbox enables you to use specialized files that contain \fBX(1)\fR resources t | |||
1306 | The default installation of fluxbox provides some of these style files\&. See \fBfluxbox\-style(5)\fR to accommodate the growing number of style components\&. | 1306 | The default installation of fluxbox provides some of these style files\&. See \fBfluxbox\-style(5)\fR to accommodate the growing number of style components\&. |
1307 | .SS "Style Overlay" | 1307 | .SS "Style Overlay" |
1308 | .sp | 1308 | .sp |
1309 | In addition to the style file, the overlay file, whose location is specified by \fBsession\&.screen0\&.styleOverlay\fR (default: \fB\e~/\&.fluxbox/overlay\fR) 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 \fBfluxbox\-style(5)\fR\&. | 1309 | In addition to the style file, the overlay file, whose location is specified by \fBsession\&.screen0\&.styleOverlay\fR (default: \fB~/\&.fluxbox/overlay\fR) 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 \fBfluxbox\-style(5)\fR\&. |
1310 | .SH "THE SLIT" | 1310 | .SH "THE SLIT" |
1311 | .sp | 1311 | .sp |
1312 | The slit is a special fluxbox window frame that can contain dockable applications, such as \(lqbbtools\(rq or \(lqwindow maker dockapps\(rq\&. | 1312 | The slit is a special fluxbox window frame that can contain dockable applications, such as \(lqbbtools\(rq or \(lqwindow maker dockapps\(rq\&. |
1313 | .sp | 1313 | .sp |
1314 | When applications are run in the slit they have no window borders of their own; instead they are framed in the slit, and they are always visible in the current workspace\&. | 1314 | When applications are run in the slit they have no window borders of their own; instead they are framed in the slit, and they are always visible in the current workspace\&. |
1315 | .sp | 1315 | .sp |
1316 | Most dockable applications use the \-w option to run in the slit\&. For example, you could put in your \fB\e~/\&.fluxbox/startup\fR: | 1316 | Most dockable applications use the \-w option to run in the slit\&. For example, you could put in your \fB~/\&.fluxbox/startup\fR: |
1317 | .sp | 1317 | .sp |
1318 | .if n \{\ | 1318 | .if n \{\ |
1319 | .RS 4 | 1319 | .RS 4 |
@@ -1368,15 +1368,15 @@ This sets the alpha value for the slit\&. Use the left mouse button to decrease | |||
1368 | \fBClients\fR | 1368 | \fBClients\fR |
1369 | .RS 4 | 1369 | .RS 4 |
1370 | This submenu lets you reorder the the applications running in the slit\&. You are able to hide apps from the slit by unselecting them in the list showing\&. This will not kill the app\&. You can make them re\-appear by selecting them in the list\&. The "Save SlitList" option saves the new order to you slitlist located in | 1370 | This submenu lets you reorder the the applications running in the slit\&. You are able to hide apps from the slit by unselecting them in the list showing\&. This will not kill the app\&. You can make them re\-appear by selecting them in the list\&. The "Save SlitList" option saves the new order to you slitlist located in |
1371 | \fB\e~/\&.fluxbox/slitlist\fR\&. See the next section for details\&. | 1371 | \fB~/\&.fluxbox/slitlist\fR\&. See the next section for details\&. |
1372 | .RE | 1372 | .RE |
1373 | .SS "Slitlist File" | 1373 | .SS "Slitlist File" |
1374 | .sp | 1374 | .sp |
1375 | fluxbox\(cqs slitlist file is available for those that use dockapps in the slit\&. This file helps fluxbox keep track of the \fBorder\fR of the dockapps when in the slit\&. The file is generally located at \fB\e~/\&.fluxbox/slitlist\fR\&. | 1375 | fluxbox\(cqs slitlist file is available for those that use dockapps in the slit\&. This file helps fluxbox keep track of the \fBorder\fR of the dockapps when in the slit\&. The file is generally located at \fB~/\&.fluxbox/slitlist\fR\&. |
1376 | .sp | 1376 | .sp |
1377 | A simple procedure for getting the slit sequences the way you like it is: 1\&. Run fluxbox with no pre\-loaded dockapps 2\&. Run dockapps individually in the order you want them 3\&. Add dockapps to your \fBstartfluxbox(1)\fR script | 1377 | A simple procedure for getting the slit sequences the way you like it is: 1\&. Run fluxbox with no pre\-loaded dockapps 2\&. Run dockapps individually in the order you want them 3\&. Add dockapps to your \fBstartfluxbox(1)\fR script |
1378 | .sp | 1378 | .sp |
1379 | This sequence will be saved by default to \fB\e~/\&.fluxbox/slitlist\fR and will be remembered for future instances of fluxbox\&. | 1379 | This sequence will be saved by default to \fB~/\&.fluxbox/slitlist\fR and will be remembered for future instances of fluxbox\&. |
1380 | .sp | 1380 | .sp |
1381 | Users are free to manually edit the slitlist file\&. It is a simple list of window names, as given by \fBxprop(1)\fR, one per dockapp\&. Similar to the init file it should not be edited while fluxbox is running\&. Otherwise changes may get overwritten\&. | 1381 | Users are free to manually edit the slitlist file\&. It is a simple list of window names, as given by \fBxprop(1)\fR, one per dockapp\&. Similar to the init file it should not be edited while fluxbox is running\&. Otherwise changes may get overwritten\&. |
1382 | .sp | 1382 | .sp |
@@ -1456,7 +1456,7 @@ There are two ways to assign a window to a different layer\&. When the window is | |||
1456 | The other way to set the layer for a window is through the \(oqapps\(cq file\&. This method is described in \fBfluxbox\-apps(5)\fR\&. | 1456 | The other way to set the layer for a window is through the \(oqapps\(cq file\&. This method is described in \fBfluxbox\-apps(5)\fR\&. |
1457 | .SH "RESOURCES" | 1457 | .SH "RESOURCES" |
1458 | .sp | 1458 | .sp |
1459 | Usually the \fB\e~/\&.fluxbox/init\fR resource file is created and maintained by fluxbox itself\&. You can use the \fBConfigure Menu\fR, mentioned above, to set most of these options\&. However, we\(cqll cover all of the resource options that are available to the user\&. If you edit this file while fluxbox is running, you must \(lqreconfigure\(rq to reload the resource options\&. | 1459 | Usually the \fB~/\&.fluxbox/init\fR resource file is created and maintained by fluxbox itself\&. You can use the \fBConfigure Menu\fR, mentioned above, to set most of these options\&. However, we\(cqll cover all of the resource options that are available to the user\&. If you edit this file while fluxbox is running, you must \(lqreconfigure\(rq to reload the resource options\&. |
1460 | .sp | 1460 | .sp |
1461 | When running fluxbox in a multiple\-screen environment the screen0 key can also be screen1, screen2, to customize the behavior of fluxbox on each desktop accordingly\&. Here are the resources that are currently available: | 1461 | When running fluxbox in a multiple\-screen environment the screen0 key can also be screen1, screen2, to customize the behavior of fluxbox on each desktop accordingly\&. Here are the resources that are currently available: |
1462 | .PP | 1462 | .PP |
@@ -1975,7 +1975,7 @@ Default right: | |||
1975 | \fBShade Minimize Maximize Close\fR | 1975 | \fBShade Minimize Maximize Close\fR |
1976 | .RE | 1976 | .RE |
1977 | .sp | 1977 | .sp |
1978 | All of the \fIlocation\fR resources following require a pathname to their specific files\&. This is where you can specify different files\&. Most of the defaults will be located in the user\(cqs \fB\e~/\&.fluxbox\fR directory\&. | 1978 | All of the \fIlocation\fR resources following require a pathname to their specific files\&. This is where you can specify different files\&. Most of the defaults will be located in the user\(cqs \fB~/\&.fluxbox\fR directory\&. |
1979 | .PP | 1979 | .PP |
1980 | \fBsession\&.appsFile\fR: \fIlocation\fR | 1980 | \fBsession\&.appsFile\fR: \fIlocation\fR |
1981 | .RS 4 | 1981 | .RS 4 |
@@ -2032,7 +2032,7 @@ for details\&. | |||
2032 | \fBsession\&.screen0\&.windowMenu\fR: \fIlocation\fR | 2032 | \fBsession\&.screen0\&.windowMenu\fR: \fIlocation\fR |
2033 | .RS 4 | 2033 | .RS 4 |
2034 | This optionally specifies the location of a user\-defined window menu\&. If left blank, it will use | 2034 | This optionally specifies the location of a user\-defined window menu\&. If left blank, it will use |
2035 | \fB\e~/\&.fluxbox/windowmenu\fR\&. | 2035 | \fB~/\&.fluxbox/windowmenu\fR\&. |
2036 | .sp | 2036 | .sp |
2037 | Default: | 2037 | Default: |
2038 | \fBblank\fR | 2038 | \fBblank\fR |
@@ -2190,3 +2190,9 @@ If you find any bugs, please visit the #fluxbox irc channel on irc\&.freenode\&. | |||
2190 | .SH "SEE ALSO" | 2190 | .SH "SEE ALSO" |
2191 | .sp | 2191 | .sp |
2192 | fluxbox\-apps(5) fluxbox\-keys(5) fluxbox\-style(5) fluxbox\-menu(5) fluxbox\-remote(1) fbsetroot(1) fbsetbg(1) fbrun(1) startfluxbox(1) | 2192 | fluxbox\-apps(5) fluxbox\-keys(5) fluxbox\-style(5) fluxbox\-menu(5) fluxbox\-remote(1) fbsetroot(1) fbsetbg(1) fbrun(1) startfluxbox(1) |
2193 | .SH "AUTHOR" | ||
2194 | .PP | ||
2195 | \fBHenrik Kinnunen\fR <\&fluxgen@fluxbox\&.org\&> | ||
2196 | .RS 4 | ||
2197 | Author. | ||
2198 | .RE | ||