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