diff options
-rw-r--r-- | doc/fluxbox.1.in | 127 |
1 files changed, 116 insertions, 11 deletions
diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in index 63b4155..74f2ef6 100644 --- a/doc/fluxbox.1.in +++ b/doc/fluxbox.1.in | |||
@@ -18,7 +18,9 @@ | |||
18 | .\" | 18 | .\" |
19 | .\" Changed to fluxbox by Henrik Kinnunen (fluxgen@linuxmail.org) | 19 | .\" Changed to fluxbox by Henrik Kinnunen (fluxgen@linuxmail.org) |
20 | .\" | 20 | .\" |
21 | .\" Updated for fluxbox 0.5.1 by Matthew Hawkins <matt@mh.dropbear.id.au> | 21 | .\" Updated for fluxbox 0.1.5 by Matthew Hawkins <matt@mh.dropbear.id.au> |
22 | .\" | ||
23 | .\" Updated for version 0.1.6 by Rando Christensen <eyez@babblica.net> | ||
22 | .\" | 24 | .\" |
23 | .\" ..define sort of <blockquote><pre> macro | 25 | .\" ..define sort of <blockquote><pre> macro |
24 | .de EX | 26 | .de EX |
@@ -80,7 +82,7 @@ Display version info and exit. | |||
80 | .TP | 82 | .TP |
81 | .BI \-rc \ rcfile | 83 | .BI \-rc \ rcfile |
82 | Use another rcfile than the default | 84 | Use another rcfile than the default |
83 | .IR "~/.fluxboxrc" . | 85 | .IR "~/.fluxbox/init" . |
84 | .TP | 86 | .TP |
85 | .BI \-display \ display | 87 | .BI \-display \ display |
86 | Start Fluxbox on the specified display. | 88 | Start Fluxbox on the specified display. |
@@ -102,14 +104,15 @@ When started, Fluxbox will try to find a default menufile in | |||
102 | You can provide a system-wide menu for your users here. | 104 | You can provide a system-wide menu for your users here. |
103 | .PP | 105 | .PP |
104 | On exit or restart, Fluxbox will save user defaults in the file | 106 | On exit or restart, Fluxbox will save user defaults in the file |
105 | .I ~/.fluxboxrc | 107 | .I ~/.fluxbox/init |
106 | in the user's home directory. | 108 | in the user's home directory. |
107 | Some resources in this file can be edited by hand. | 109 | Some resources in this file can be edited by hand. |
108 | .SH USING FLUXBOX | 110 | .SH USING FLUXBOX |
109 | Fluxbox includes keyboard handling. 0.1.4 integrated | 111 | Fluxbox includes keyboard handling. 0.1.4 integrated |
110 | .IR bbkeys (1) | 112 | .IR bbkeys (1) |
111 | however from version 0.1.5 the whole keyboard handling code was rewritten | 113 | however from version 0.1.5 the whole keyboard handling code was rewritten |
112 | from scratch. | 114 | from scratch. You can get a script to convert your bbkeys file into fluxbox |
115 | format at the fluxbox webpage, http://fluxbox.sourceforge.net/. | ||
113 | .SS Root window (background): | 116 | .SS Root window (background): |
114 | Right click (button 3) will pop up the root menu. | 117 | Right click (button 3) will pop up the root menu. |
115 | With this you can launch your applications. | 118 | With this you can launch your applications. |
@@ -148,6 +151,10 @@ Send window to another workspace. | |||
148 | When you select the workspace with the middle button, Fluxbox will | 151 | When you select the workspace with the middle button, Fluxbox will |
149 | send you along with the application to the selected workspace | 152 | send you along with the application to the selected workspace |
150 | .TP | 153 | .TP |
154 | .B Send Group To... | ||
155 | Sends a window, along with all windows currently grouped with it, to | ||
156 | another workspace. Follows the same rules as Send To... | ||
157 | .TP | ||
151 | .B Shade | 158 | .B Shade |
152 | Shade the window (display titlebar only) | 159 | Shade the window (display titlebar only) |
153 | .TP | 160 | .TP |
@@ -181,12 +188,22 @@ When you doubleclick on the titlebar of a window, it will `shade', so | |||
181 | that only the titlebar stays visible. | 188 | that only the titlebar stays visible. |
182 | Another double click will redisplay the window contents. | 189 | Another double click will redisplay the window contents. |
183 | .SS Window Buttons: | 190 | .SS Window Buttons: |
184 | The button at the left upper corner of a window is the Minimize button. | 191 | In fluxbox, the window button's configuration is controlled by your |
185 | Clicking with any button causes the window to be iconified. | 192 | .I ~/.fluxbox/titlebar |
186 | The rightmost button (with the X) closes the application. | 193 | file, which specifies which buttons to put on the right of left side of |
187 | The other button on the right (if present) maximizes the window in three ways: | 194 | the title bar. The default is: |
195 | .EX 0 | ||
196 | Right: minimize maximize close | ||
197 | Left: sticky | ||
198 | .EE | ||
199 | Clicking the minimize button with any button causes the window to be iconified. | ||
200 | Clicking the close button with any button closes the application. | ||
201 | The maximize button (if present) maximizes the window in three ways: | ||
188 | Button 1 causes full screen maximization, button 2 maximizes the window only | 202 | Button 1 causes full screen maximization, button 2 maximizes the window only |
189 | vertically, and button 3 only horizontally. | 203 | vertically, and button 3 only horizontally. |
204 | The Sticky button sets has the same meaning as the | ||
205 | .I (Un)Stick window | ||
206 | menu option. | ||
190 | .SS Any menu: | 207 | .SS Any menu: |
191 | Clicking button 3 in a menu will popdown the menu. | 208 | Clicking button 3 in a menu will popdown the menu. |
192 | Clicking button 1 on the titlebar of any (sub)menu and then dragging it somewhere | 209 | Clicking button 1 on the titlebar of any (sub)menu and then dragging it somewhere |
@@ -210,7 +227,7 @@ in your home directory, and to create a menu file, e.g. | |||
210 | in this directory, or copy the system-wide menu file to this location. | 227 | in this directory, or copy the system-wide menu file to this location. |
211 | Next, we have to tell Fluxbox to load our menu file instead of the default. | 228 | Next, we have to tell Fluxbox to load our menu file instead of the default. |
212 | This is accomplished by adding (or changing) a resource value in the | 229 | This is accomplished by adding (or changing) a resource value in the |
213 | .I ~/.fluxboxrc | 230 | .I ~/.fluxbox/init |
214 | file e.g.: | 231 | file e.g.: |
215 | .EX | 232 | .EX |
216 | session.menuFile: ~/.fluxbox/menu | 233 | session.menuFile: ~/.fluxbox/menu |
@@ -624,6 +641,19 @@ window.button.pressed.colorTo: Color | |||
624 | window.frame.focusColor: Color | 641 | window.frame.focusColor: Color |
625 | window.frame.unfocusColor: Color | 642 | window.frame.unfocusColor: Color |
626 | 643 | ||
644 | ! Tab settings | ||
645 | ! if these are unset, some reasonable defaults will be picked. | ||
646 | window.tab.justify: Right | ||
647 | window.tab.label.unfocus: Texture | ||
648 | window.tab.label.unfocus.color: Color | ||
649 | window.tab.label.unfocus.textColor: Color | ||
650 | window.tab.label.focus: Texture | ||
651 | window.tab.label.focus.color: Color | ||
652 | window.tab.label.focus.textColor: Color | ||
653 | window.tab.borderWidth: 1 | ||
654 | window.tab.borderColor: Color | ||
655 | window.tab.font: fixed | ||
656 | |||
627 | ! Font and justification for window labels | 657 | ! Font and justification for window labels |
628 | window.font: Font | 658 | window.font: Font |
629 | window.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR | 659 | window.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR |
@@ -674,6 +704,8 @@ file. The file takes the format of : | |||
674 | In the example below, Mod1 is the 'Alt' key on the PC keyboard and Mod4 is | 704 | In the example below, Mod1 is the 'Alt' key on the PC keyboard and Mod4 is |
675 | one of the three extra keys on a pc104 branded with a sickening corporate logo. | 705 | one of the three extra keys on a pc104 branded with a sickening corporate logo. |
676 | .EX | 706 | .EX |
707 | # Fluxbox keys file. | ||
708 | # Any line starting with a # is a comment. | ||
677 | Mod1 Tab :NextWindow | 709 | Mod1 Tab :NextWindow |
678 | Mod1 F1 :Workspace1 | 710 | Mod1 F1 :Workspace1 |
679 | Mod1 F2 :Workspace2 | 711 | Mod1 F2 :Workspace2 |
@@ -696,6 +728,53 @@ Control n Mod1 n :NextTab | |||
696 | .EE | 728 | .EE |
697 | As you can see from the last line, keybinds can be chained in a fashion similar | 729 | As you can see from the last line, keybinds can be chained in a fashion similar |
698 | to emacs keybindings. | 730 | to emacs keybindings. |
731 | Here is a list of possible Operations: | ||
732 | .EX | ||
733 | Minimize | ||
734 | Raise | ||
735 | Lower | ||
736 | Close | ||
737 | Workspace1 | ||
738 | Workspace2 | ||
739 | Workspace3 | ||
740 | Workspace4 | ||
741 | Workspace5 | ||
742 | Workspace6 | ||
743 | Workspace7 | ||
744 | Workspace8 | ||
745 | Workspace9 | ||
746 | Workspace10 | ||
747 | Workspace11 | ||
748 | Workspace12 | ||
749 | NextWorkspace | ||
750 | PrevWorkspace | ||
751 | LeftWorkspace | ||
752 | RightWorkspace | ||
753 | KillWindow | ||
754 | NextWindow | ||
755 | PrevWindow | ||
756 | NextTab | ||
757 | PrevTab | ||
758 | ShadeWindow | ||
759 | MaximizeWindow | ||
760 | StickWindow | ||
761 | ExecCommand | ||
762 | MaximizeVertical | ||
763 | MaximizeHorizontal | ||
764 | NudgeRight | ||
765 | NudgeLeft | ||
766 | NudgeUp | ||
767 | NudgeDown | ||
768 | BigNudgeRight | ||
769 | BigNudgeLeft | ||
770 | BigNudgeUp | ||
771 | BigNudgeDown | ||
772 | HorizontalIncrement | ||
773 | VerticalIncrement | ||
774 | HorizontalDecrement | ||
775 | VerticalDecrement | ||
776 | ToggleDecor | ||
777 | .EE | ||
699 | .SH TITLEBAR FILE | 778 | .SH TITLEBAR FILE |
700 | Fluxbox lets you customise the button layout on the window titlebar. This is | 779 | Fluxbox lets you customise the button layout on the window titlebar. This is |
701 | done by modifying the | 780 | done by modifying the |
@@ -727,9 +806,30 @@ bbpager -w & | |||
727 | exec fluxbox | 806 | exec fluxbox |
728 | .EE | 807 | .EE |
729 | Of course to use the slit you must have slit support compiled in. | 808 | Of course to use the slit you must have slit support compiled in. |
809 | .SH CONFIGURATION MENU | ||
810 | Fluxbox has a few options that are configured by a configure menu. | ||
811 | Most are self-explanatory, but here are a few notes: | ||
812 | .TP | ||
813 | .B Tab Placement | ||
814 | The Tabs can be placed almost anywhere on a window. Again, these are | ||
815 | mostly self-explanatory. however, using the | ||
816 | .I Relative | ||
817 | options will make the total width of all tabs be equal to the total width | ||
818 | of the window. The | ||
819 | .I Rotate Vertical Tabs | ||
820 | option makes tabs that are placed on the Right or left side of the window | ||
821 | be turned on their sides. | ||
822 | .TP | ||
823 | .B Sloppy Window Grouping | ||
824 | This option allows you to drop a tab anywhere on the target window to group it, | ||
825 | instead of only on the target window's tab. | ||
826 | .TP | ||
827 | .B Maximize Slit Stop | ||
828 | This option makes maximizing windows stop at the slit border, so that your | ||
829 | slit stays visible at all times. | ||
730 | .SH RESOURCE FILE | 830 | .SH RESOURCE FILE |
731 | Usually the | 831 | Usually the |
732 | .I ~/.fluxboxrc | 832 | .I ~/.fluxbox/init |
733 | resource file is created and maintained by Fluxbox itself. | 833 | resource file is created and maintained by Fluxbox itself. |
734 | All options from the | 834 | All options from the |
735 | .B [config] | 835 | .B [config] |
@@ -775,6 +875,11 @@ format is used. | |||
775 | The default value is: | 875 | The default value is: |
776 | .IR "%I:%M %p" . | 876 | .IR "%I:%M %p" . |
777 | .TP | 877 | .TP |
878 | .B session.screen0.rootCommand: | ||
879 | This overrides the style's rootCommand. When this value is set, it will keep | ||
880 | your background the same, regardless of what any style would like your | ||
881 | background to be. | ||
882 | .TP | ||
778 | .B session.autoRaiseDelay: | 883 | .B session.autoRaiseDelay: |
779 | Adjusts the delay (in ms) before focused windows will raise when using the | 884 | Adjusts the delay (in ms) before focused windows will raise when using the |
780 | Autoraise option. | 885 | Autoraise option. |
@@ -913,7 +1018,7 @@ gkrellm in the slit, always visible yet out of the way of real work. | |||
913 | Fluxbox uses | 1018 | Fluxbox uses |
914 | .RB $ HOME | 1019 | .RB $ HOME |
915 | to find its | 1020 | to find its |
916 | .I .fluxboxrc | 1021 | .I .fluxbox/init |
917 | file, and to resolve stylefile and \-directory names. | 1022 | file, and to resolve stylefile and \-directory names. |
918 | .TP | 1023 | .TP |
919 | .B DISPLAY | 1024 | .B DISPLAY |