diff options
-rw-r--r-- | doc/fluxbox.1.in | 144 |
1 files changed, 142 insertions, 2 deletions
diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in index 1d91017..60cc00c 100644 --- a/doc/fluxbox.1.in +++ b/doc/fluxbox.1.in | |||
@@ -87,7 +87,7 @@ Start Fluxbox on the specified display. | |||
87 | Programs started by Fluxbox will have the | 87 | Programs started by Fluxbox will have the |
88 | .B DISPLAY | 88 | .B DISPLAY |
89 | environment variable set to this value, too. | 89 | environment variable set to this value, too. |
90 | .SH RUNNING BLACKBOX | 90 | .SH RUNNING FLUXBOX |
91 | This program is usually started by the user's startup script, most times called | 91 | This program is usually started by the user's startup script, most times called |
92 | .IR ~/.xinitrc . | 92 | .IR ~/.xinitrc . |
93 | To run fluxbox, modify the script by adding | 93 | To run fluxbox, modify the script by adding |
@@ -664,6 +664,44 @@ can easily set lots of keys with a single command, e.g. | |||
664 | *font: lucidasans-10 | 664 | *font: lucidasans-10 |
665 | .EE | 665 | .EE |
666 | This sets already nice defaults for many components. | 666 | This sets already nice defaults for many components. |
667 | .SH KEYS FILE | ||
668 | Fluxbox 0.1.5 has new keybinding code, and you can customise it through the | ||
669 | .IR ~/.fluxbox/keys | ||
670 | file. The file takes the format of : | ||
671 | .EX | ||
672 | <modifier> <key> :<operation> | ||
673 | .EE | ||
674 | 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. | ||
676 | .EX | ||
677 | Mod1 Tab :NextWindow | ||
678 | Mod1 F1 :Workspace1 | ||
679 | Mod1 F2 :Workspace2 | ||
680 | Mod1 F3 :Workspace3 | ||
681 | Mod1 F4 :Workspace4 | ||
682 | Mod1 F5 :Workspace5 | ||
683 | Mod1 F6 :Workspace6 | ||
684 | Mod1 F7 :Workspace7 | ||
685 | Mod1 F8 :Workspace8 | ||
686 | Mod1 F9 :Workspace9 | ||
687 | Mod1 F10 :Workspace10 | ||
688 | Mod1 F11 :Workspace11 | ||
689 | Mod1 F12 :Workspace12 | ||
690 | Mod4 b :PrevWorkspace | ||
691 | Mod4 c :Minimize | ||
692 | Mod4 r :ExecCommand rxvt | ||
693 | Mod4 v :NextWorkspace | ||
694 | Mod4 x :Close | ||
695 | .EE | ||
696 | .SH TITLEBAR FILE | ||
697 | Fluxbox lets you customise the button layout on the window titlebar. This is | ||
698 | done by modifying the | ||
699 | .IR ~/.fluxbox/titlebar | ||
700 | file. | ||
701 | .EX | ||
702 | Right: minimize maximize close | ||
703 | Left: sticky | ||
704 | .EE | ||
667 | .SH THE SLIT | 705 | .SH THE SLIT |
668 | The slit is a special Fluxbox window frame that can contain dockable | 706 | The slit is a special Fluxbox window frame that can contain dockable |
669 | applications, e.g. the `bbtools.' | 707 | applications, e.g. the `bbtools.' |
@@ -698,6 +736,28 @@ However, there are some resources in it you might want to edit yourself: | |||
698 | .TP | 736 | .TP |
699 | .B session.menuFile: | 737 | .B session.menuFile: |
700 | This tells Fluxbox where to look for its menu file. | 738 | This tells Fluxbox where to look for its menu file. |
739 | .EX | ||
740 | session.menuFile: /home/myself/.fluxbox/menu | ||
741 | .EE | ||
742 | .TP | ||
743 | .B session.titlebarFile: | ||
744 | This tells Fluxbox where to find the file describing the layout of buttons | ||
745 | on each windows' titlebar. | ||
746 | .EX | ||
747 | session.titlebarFile: /home/myself/.fluxbox/titlebar | ||
748 | .EE | ||
749 | .TP | ||
750 | .B session.keyFile: | ||
751 | This tells Fluxbox where to find the file describing the keybindings. | ||
752 | .EX | ||
753 | session.keyFile: /home/myself/.fluxbox/keys | ||
754 | .EE | ||
755 | .TP | ||
756 | .B session.styleFile: | ||
757 | This tells Fluxbox where to find the style (theme) file for this session. | ||
758 | .EX | ||
759 | session.styleFile: @pkgdatadir@/styles/Flux | ||
760 | .EE | ||
701 | .TP | 761 | .TP |
702 | .B session.screen0.toolbar.widthPercent: | 762 | .B session.screen0.toolbar.widthPercent: |
703 | This determines the amount (in %) of space the toolbar will take. | 763 | This determines the amount (in %) of space the toolbar will take. |
@@ -744,6 +804,20 @@ server's memory. | |||
744 | Default value is | 804 | Default value is |
745 | .IR 5 . | 805 | .IR 5 . |
746 | .TP | 806 | .TP |
807 | .B session.opaqueMove: | ||
808 | When moving a window, setting this to | ||
809 | .IR True | ||
810 | will draw the window contents as it moves (nasty on slow systems), if | ||
811 | .IR False | ||
812 | it will only draw an outline of the window border. | ||
813 | .TP | ||
814 | .B session.imageDither: | ||
815 | .IR True | ||
816 | or | ||
817 | .IR False | ||
818 | to, respectively, enable or disable dithering of images. Only necessary | ||
819 | on systems with small colour depths (8bpp or less) | ||
820 | .TP | ||
747 | .B session.colorsPerChannel: | 821 | .B session.colorsPerChannel: |
748 | This tells Fluxbox how many colors to take from the X server on pseudocolor | 822 | This tells Fluxbox how many colors to take from the X server on pseudocolor |
749 | displays. A channel would be red, green, or blue. | 823 | displays. A channel would be red, green, or blue. |
@@ -752,12 +826,78 @@ Value must be between 2 and 6. | |||
752 | When you run Fluxbox on an 8-bit display, you must set this resource to 4. | 826 | When you run Fluxbox on an 8-bit display, you must set this resource to 4. |
753 | Default value is | 827 | Default value is |
754 | .IR 4. | 828 | .IR 4. |
829 | .TP | ||
830 | .B session.iconbar: | ||
831 | .IR True | ||
832 | or | ||
833 | .IR False | ||
834 | to enable or disable Fluxbox using the toolbar to display iconified windows. | ||
835 | .TP | ||
836 | .B session.tabs: | ||
837 | .IR True | ||
838 | or | ||
839 | .IR False | ||
840 | to enable/disable Fluxbox's PWM-like window tabs. Tabs let you group windows | ||
841 | together, they will take up identical desktop space (windows smaller or larger | ||
842 | than the existing group size get resized automatically) and can be moved as a | ||
843 | group around the desktop or to a different workspace. | ||
844 | Default value is | ||
845 | .IR True . | ||
846 | .TP | ||
847 | .B session.screen0.tab.placement: | ||
848 | Tells Fluxbox where to put the tab on the window. This can be customised | ||
849 | through Fluxbox's Configuration/Tab Placement menu. Values are | ||
850 | .IR Top | ||
851 | .IR Bottom | ||
852 | .IR Left | ||
853 | .IR Right | ||
854 | .TP | ||
855 | .B session.screen0.tab.alignment: | ||
856 | Tells Fluxbox how to align tabs to the window. Values are | ||
857 | .IR Top | ||
858 | .IR Bottom | ||
859 | .IR Left | ||
860 | .IR Right | ||
861 | .IR Center | ||
862 | .IR Relative | ||
863 | This should also be done via the Configuration/Tab Placement menu. | ||
864 | .TP | ||
865 | .B session.screen0.tab.rotatevertical: | ||
866 | If True, will rotate text on the tab so it is readable on vertically- | ||
867 | placed tabs. Once again, use the Configuration/Tab Placement menu. | ||
755 | .PP | 868 | .PP |
756 | When running Fluxbox in a multiple desktop environment the | 869 | When running Fluxbox in a multiple desktop environment the |
757 | .B screen0 | 870 | .B screen0 |
758 | key can also be | 871 | key can also be |
759 | .B screen1, 2 | 872 | .B screen1, 2 |
760 | etc. for any appropriate desktop. | 873 | etc. for any appropriate desktop, and you can customise the behaviour of |
874 | Fluxbox on each desktop accordingly. A favourite of the man page author | ||
875 | with a dual-head Matrox G450 was to autohide the slit and toolbar on | ||
876 | screen0 and set it alwaysontop and not autohidden on screen1, with a | ||
877 | larger date format on screen1 | ||
878 | .EX | ||
879 | session.screen0.toolbar.onTop: False | ||
880 | session.screen0.toolbar.autoHide: True | ||
881 | session.screen0.toolbar.placement: BottomCenter | ||
882 | session.screen0.toolbar.widthPercent: 42 | ||
883 | session.screen0.slit.onTop: False | ||
884 | session.screen0.slit.autoHide: True | ||
885 | session.screen0.slit.placement: TopLeft | ||
886 | session.screen0.slit.direction: Vertical | ||
887 | session.screen0.strftimeFormat: %I:%M %p | ||
888 | session.screen1.toolbar.onTop: True | ||
889 | session.screen1.toolbar.autoHide: False | ||
890 | session.screen1.toolbar.placement: BottomCenter | ||
891 | session.screen1.toolbar.widthPercent: 69 | ||
892 | session.screen1.slit.onTop: True | ||
893 | session.screen1.slit.autoHide: False | ||
894 | session.screen1.slit.placement: CenterRight | ||
895 | session.screen1.slit.direction: Vertical | ||
896 | session.screen1.strftimeFormat: %a %d %R [%s] | ||
897 | .EE | ||
898 | This way the main workspace (screen0) has the maximum amount of space available | ||
899 | and the secondary workspace could show the time and run some withrawn apps like | ||
900 | gkrellm in the slit, always visible yet out of the way of real work. | ||
761 | .SH ENVIRONMENT | 901 | .SH ENVIRONMENT |
762 | .TP | 902 | .TP |
763 | .B HOME | 903 | .B HOME |