doc/fluxbox-keys.5.in (raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 |
'\" t .\" Title: fluxbox-keys .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> .\" Date: 02/27/2011 .\" Manual: Fluxbox Manual .\" Source: fluxbox-keys.txt .\" Language: English .\" .TH "FLUXBOX\-KEYS" "5" "02/27/2011" "fluxbox\-keys\&.txt" "Fluxbox Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" fluxbox-keys \- keyboard shortcuts configuration for fluxbox(1) .SH "SYNOPSIS" .sp ~/\&.fluxbox/keys .SH "SYNTAX" .sp Variable parameters are shown in emphasis: \fIargument\fR .sp Optional parameters are shown in square brackets: [\fIargument\fR] .sp All other characters shown are required verbatim\&. Whitespace is required where shown, but it is fine to add more whitespace\&. .SH "DESCRIPTION" .sp The keys file defines the keyboard shortcuts for \fIfluxbox(1)\fR\&. .sp You can customize fluxbox\(cqs key handling through the ~/\&.fluxbox/keys file\&. The file consists of lines of the basic format: .sp \fB[\fR\fB\fImodifiers\fR\fR\fB] \fR\fB\fIkey\fR\fR\fB :\*(Aqcommand\*(Aq [\fR\fB\fIarguments\fR\fR\fB \fR\fB\fI\&...\fR\fR\fB]\fR .sp The space between the \fIkey\fR and the \fB:\fR before the \fIcommand\fR is mandatory\&. .sp All modifiers and commands are case\-insensitive\&. Some command arguments (especially those that will be passed to the shell) are case\-sensitive\&. Some key names are case\-sensitive\&. .sp Lines beginning with a \fI#\fR or \fI!\fR are considered comments and are unread by fluxbox\&. .sp You will need to \(lqreload\(rq fluxbox after editing the keys file so it picks up your change\&. .SH "MODIFIERS" .sp You can get a list of possible modifiers by calling \(oqxmodmap \-pm\(cq\&. This also shows you to which keys the modifiers are mapped, but the following modifiers are most commonly used: .sp \fBShift Control Mod1 Mod4\fR .sp where \fBMod1\fR is the Alt key on the PC keyboard and \fBMod4\fR is usually a key branded with a familiar company logo\&. .PP There are also some special modifiers that refer to mouse button events .RS 4 .PP \fBOnDesktop\fR .RS 4 The mouse cursor is over the desktop (root window), and not any window\&. .RE .PP \fBOnToolbar\fR .RS 4 The mouse cursor is over the toolbar (which is normally at the bottom of the screen)\&. .RE .PP \fBOnWindow\fR .RS 4 The mouse cursor is over a window\&. .RE .PP \fBOnTitlebar\fR .RS 4 The mouse cursor is over a window\(cqs titlebar\&. .RE .PP \fBDouble\fR .RS 4 Limits this action to double\-clicks only\&. .RE .RE .SS "Combining Modifiers" .sp To combine two or more modifiers, just list them (space\-delimited) in any order\&. .SH "KEYS" .sp You may specify a key by its key name (for example, \fBa\fR or \fBspace\fR) or by its numeric keycode (for example, \fB38\fR or \fB0xf3\fR)\&. .sp If you don\(cqt know the name of a key, you can run \fBxev(1)\fR in a terminal, push the key, and see the name in the output\&. If you have some "special" keys that do not produce a key name in the output of \fBxev(1)\fR, you can just use the keycode (NOT the keysym!) in your keys file\&. .sp Commands can also be bound to mouse events (\fIN\fR denotes the number of the button, eg\&. \fI1\fR is the primary button, \fI4\fR/\fI5\fR are the wheel buttons): .PP \fBMouseN\fR .RS 4 The mouse button \fIN\fR is pressed down and held\&. .RE .PP \fBClickN\fR .RS 4 The mouse button \fIN\fR is clicked (pressed and released with no movement in between) .RE .PP \fBMoveN\fR .RS 4 The mouse button \fIN\fR is currently held, the binded action is triggered as often as the mouse moves\&. .RE .sp There are some special "keys" that let you bind events to non\-keyboard events: .PP \fBChangeWorkspace\fR .RS 4 Fires when the workspace changes\&. This can be used to change backgrounds or do anything else you like when you switch to a new workspace\&. See the \fBEXAMPLES\fR below for one idea\&. .RE .if n \{\ .sp .\} .RS 4 .it 1 an-trap .nr an-no-space-flag 1 .nr an-break-flag 1 .br .ps +1 \fBWarning\fR .ps -1 .br .sp Use caution with this event! For example, do NOT bind this to any action that changes your current workspace\&. If you break your fluxbox with this feature, you get to keep the pieces\&. .sp .5v .RE .SH "CHAINING" .sp Key bindings can be chained in a fashion similar to Emacs key bindings using the syntax: .sp \fImodifiers\-1\fR \fIkey\-1\fR \fImodifiers\-2\fR \fIkey\-2\fR :\*(Aqcommand\*(Aq [\fIarguments \&...\fR]* .sp To abort a chained command part\-way through typing it, press the <ESC> key\&. .PP \fBTo Bind CTRL+C CTRL+X (Which means, press CTRL+C then CTRL+X) to quit fluxbox\fR. .sp .if n \{\ .RS 4 .\} .nf Control c Control x :Quit .fi .if n \{\ .RE .\} .sp .SH "KEYMODES" .sp A specific set of key mappings can be activated and de\-activated on\-the\-fly using what are called keymodes\&. The syntax to define a mapping in a keymode is: .sp \fB\fIkeymode\fR\fR\fB: \fR\fB\fImodifiers\fR\fR\fB \fR\fB\fIkey\fR\fR\fB :\*(Aqcommand\*(Aq [\fR\fB\fIarguments\fR\fR\fB \fR\fB\fI\&...\fR\fR\fB]\fR .sp Where \fIkeymode\fR is any alpha\-numeric string name\&. .sp When this keymode is activated (see the \fBKeyMode\fR command below), all bindings prefaced by that keymode name become active (and all other keybindings will be deactivated) until the keymode changes again\&. .SH "COMMANDS" .PP Some commands have multiple names which are shown below as .RS 4 CMD1 | CMD2 .RE .PP Related commands have been grouped below as .RS 4 CMD1 / CMD2 .RE .PP The commands are broken up into sections as follows .RS 4 .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Mouse Commands .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Window Commands .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Workspace Commands .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Menu Commands .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Window Manager Commands .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Special Commands .RE .RE .SS "Mouse Commands" .sp These commands may only be bound to mouse buttons (plus modifiers), not keystrokes\&. In all cases, the action finishes when the mouse button is released\&. .PP \fBStartMoving\fR .RS 4 Start dragging to move the window\&. .RE .PP \fBStartResizing\fR [\fIcorner\fR] .RS 4 Start dragging to resize the window as if you had grabbed the window at the specified \fIcorner\fR\&. .PP By default \fIcorner\fR is \fBBottomRight\fR, but may be overridden with one of: .RS 4 \fBNearestCorner NearestEdge Center TopLeft Top TopRight Left Right BottomLeft Bottom BottomRight\fR .RE .RE .PP \fBStartTabbing\fR .RS 4 Start dragging to add this window to another\(cqs tabgroup\&. .RE .PP \fBActivateTab\fR .RS 4 Activates the tab underneath the mouse\&. .RE .SS "Window Commands" .sp These commands ordinarily affect only the currently focused window\&. The \fBOnWindow\fR modifier and \fBForEach\fR command may affect the window that is used\&. .PP \fBMinimize\fR | \fBMinimizeWindow\fR | \fBIconify\fR .RS 4 Minimize the current window, equivalent to the window button\&. .RE .PP \fBMaximize\fR | \fBMaximizeWindow\fR .RS 4 Maximize the current window, equivalent to the window button\&. .RE .PP \fBMaximizeHorizontal\fR / \fBMaximizeVertical\fR .RS 4 Maximize the current window in one direction only, leaving the other dimension unchanged\&. \fBFullscreen\fR Resize the window\(cqs content to fit the whole screen, without any window decoration\&. .RE .PP \fBRaise\fR / \fBLower\fR .RS 4 Reorder this window to the top or bottom of the window stack, within its current layer\&. See \fIfluxbox(1)\fR for a discussion of layers\&. .RE .PP \fBRaiseLayer\fR / \fBLowerLayer\fR [\fIoffset\fR] .RS 4 Raise the window up to the layer above, or lower it to the layer below\&. See \fIfluxbox(1)\fR for a discussion of layers\&. .RE .PP \fBSetLayer\fR \fIlayer\fR .RS 4 Move the window to the specified layer\&. \fIlayer\fR should be one of \fBAboveDock\fR, \fBDock\fR, \fBTop\fR, \fBNormal\fR, \fBBottom\fR, \fBDesktop\fR\&. See \fIfluxbox(1)\fR for a discussion of layers\&. .RE .PP \fBClose\fR .RS 4 Close the current window, equivalent to the window button\&. .RE .PP \fBKill\fR | \fBKillWindow\fR .RS 4 Close a window that\(cqs not responding to \fBClose\fR, like using \fBxkill(1)\fR\&. .RE .PP \fBShade\fR | \fBShadeWindow\fR .RS 4 Toggle the \fBshaded\fR state of the current window, equivalent to the window button\&. A \fBshaded\fR window appears as only the title bar\&. .RE .PP \fBShadeOn\fR / \fBShadeOff\fR .RS 4 Set the \fBshaded\fR state of the window to On / Off\&. .RE .PP \fBStick\fR | \fBStickWindow\fR .RS 4 Toggle the \fBsticky\fR state of the current window, equivalent to the window button\&. A \fBsticky\fR window is visible on all workspaces\&. .RE .PP \fBSetDecor\fR \fIdecor\fR .RS 4 Sets which window decorations will be shown\&. \fIdecor\fR has the same format as the \(oq[Deco]\(cq parameter in the apps file\&. See \(oqman fluxbox\(cq section APPLICATIONS for more info\&. .RE .PP \fBToggleDecor\fR .RS 4 Toggles the presence of the window decorations (title bar, window buttons, and resize bar)\&. .RE .PP \fBNextTab\fR / \fBPrevTab\fR .RS 4 Cycle to the next / previous tab in the current tab group\&. .RE .PP \fBTab\fR \fInumber\fR .RS 4 Cycle to the given tab in the current tab group, where \fB1\fR is the first tab\&. A negative \fInumber\fR counts from the end of the tab group (\fB\-1\fR is the last tab, \fB\-2\fR is the next\-to\-last, etc\&.)\&. .RE .PP \fBMoveTabRight\fR / \fBMoveTabLeft\fR .RS 4 Reorder the tabs in the current tab group, swapping the current tab with the one to the right / left\&. .RE .PP \fBDetachClient\fR .RS 4 Remove the current tab from the tab group, placing it in its own window\&. .RE .PP \fBResizeTo\fR \fIwidth\fR \fIheight\fR .RS 4 Resizes the window to the given width and height\&. .RE .PP \fBResize\fR \fIdelta\-width\fR \fIdelta\-height\fR .RS 4 Resizes the window relative to the current width and height\&. .RE .PP \fBResizeHorizontal\fR \fIdelta\-width\fR / \fBResizeVertical\fR \fIdelta\-height\fR .RS 4 Resizes the window in one dimension only .RE .PP \fBMoveTo\fR \fIx\fR \fIy\fR [\fIanchor\fR] .RS 4 Moves the window to the given coordinates, given in pixels\&. .sp If either \fIx\fR or \fIy\fR is set to \fB\e\fR*, that coordinate will be ignored, and the movement will only take place in one dimension\&. .PP The default \fIanchor\fR is the upper left corner, but this may be overridden with one of: .RS 4 \fBTopLeft Left BottomLeft Top Center Bottom TopRight Right BottomRight\fR .RE .RE .PP \fBMove\fR \fIdelta\-x\fR \fIdelta\-y\fR .RS 4 Moves the window relative to its current position\&. Positive numbers refer to right and down, and negative to left and up, respectively\&. .RE .PP \fBMoveRight\fR \fId\fR / \fBMoveLeft\fR \fId\fR / \fBMoveUp\fR \fId\fR / \fBMoveDown\fR \fId\fR .RS 4 Moves the window relative to its current position by the number of pixels specified in \fId\fR\&. If the number is negative, it moves in the opposite direction\&. .RE .PP \fBTakeToWorkspace\fR \fIworkspace\fR / \fBSendToWorkspace\fR \fIworkspace\fR .RS 4 Sends you along with the current window to the selected workspace\&. SendToWorkspace just sends the window\&. The first workspace is number \fB1\fR, not 0\&. .RE .PP \fBTakeToNextWorkspace\fR [\fIoffset\fR] / \fBTakeToPrevWorkspace\fR [\fIoffset\fR] .RS 4 Sends you along with the current window to the next or previous workspace\&. If you set \fIoffset\fR to a value greater than the default of \fB1\fR, it will move you that number of workspaces ahead or behind\&. If you go beyond the end of the currently defined workspaces, it will wrap around to the other end automatically\&. .RE .PP \fBSendToNextWorkspace\fR [\fIoffset\fR] / \fBSendToPrevWorkspace\fR [\fIoffset\fR] .RS 4 Identical to the "TakeTo\&..." commands, but again this sends only the window, and does not move you away from your current workspace\&. .RE .PP \fBSetAlpha\fR [\fIalpha\fR [\fIunfocused\-alpha\fR]] .RS 4 Sets the alpha value of a window\&. .sp Putting a \fB+\fR or \fB\-\fR in front of the value adds or subtracts from the current value\&. A plain integer sets the value explicitly\&. .PP no arguments .RS 4 Resets both focused and unfocused settings to default opacity\&. .RE .PP one argument .RS 4 Changes both focused and unfocused alpha settings\&. .RE .PP two arguments .RS 4 First value becomes the focused alpha, second becomes the unfocused alpha value\&. .RE .RE .PP \fBSetHead\fR \fInumber\fR .RS 4 Moves the window to the given display head\&. Only available when fluxbox has been compiled with Xinerama support\&. .RE .PP \fBSendToNextHead\fR [\fIoffset\fR] / \fBSendToPrevHead\fR [\fIoffset\fR] .RS 4 Sends the current window to the next/previous display head\&. If you specify an \fIoffset\fR greater than \fB1\fR, it will move the window that many heads\&. If this takes the window beyond the total number of heads, it will wrap around to the beginning\&. .RE .PP \fBSetXProp\fR \fIPROP=value\fR .RS 4 Sets the xproperty \fIPROP\fR of the current window to \fIvalue\fR\&. Delete the content of \fIPROP\fR by using \fIPROP=\fR\&. .RE .SS "Workspace Commands" .sp These commands affect the entire workspace (or "desktop" as it is sometimes called)\&. .PP \fBAddWorkspace\fR / \fBRemoveLastWorkspace\fR .RS 4 Adds or removes a workspace from the end of the list of workspaces\&. .RE .PP \fBNextWorkspace\fR [\fIn\fR] / \fBPrevWorkspace\fR [\fIn\fR] / \fBRightWorkspace\fR [\fIn\fR] / \fBLeftWorkspace\fR [\fIn\fR] .RS 4 Switch to the Next / Previous workspace\&. All versions accept an offset value \fIn\fR, which defaults to \fB1\fR and refers to the number of workspaces to move at one time\&. {Next,Prev}Workspace wrap around when going past the last workspace, whereas {Right,Left}Workspace do not\&. .RE .PP \fBWorkspace\fR \fInumber\fR .RS 4 Jumps to the given workspace \fInumber\fR\&. The first workspace is \fB1\fR\&. .RE .PP \fBNextWindow\fR [{\fIoptions\fR}] [\fIpattern\fR] / \fBPrevWindow\fR [{\fIoptions\fR}] [\fIpattern\fR] .RS 4 Focuses the next / previous window in the focus list\&. .PP \fIoptions\fR is one or more of the following, space delimited: .RS 4 .PP \fBstatic\fR .RS 4 Instead of moving in order of most\-recent focus, move in order of when the window was opened (or, the order shown in the iconbar)\&. .RE .PP \fBgroups\fR .RS 4 Only include the current tab in windows with multiple tabs\&. .RE .sp If \fIpattern\fR arguments are supplied, only windows that match all the patterns are considered \- all others are skipped\&. See the section \fBCLIENT PATTERNS\fR below for more information\&. .sp This pair of commands has a special side\-effect when the keybinding used has a modifier \- It will temporarily raise the cycled window to the front so you can see it, but if you continue holding down the modifier and press the key again (For example, keep holding "Alt" while you tap the "Tab" key a few times), fluxbox will lower the window again when you move on to the next one\&. This allows you to preview the windows in order, but does not change the order in doing so\&. .RE .RE .PP \fBNextGroup\fR [{\fIoptions\fR}] [\fIpattern\fR] / \fBPrevGroup\fR [{\fIoptions\fR}] [\fIpattern\fR] .RS 4 Equivalent to NextWindow / PrevWindow above, but with the \fBgroups\fR option forced on\&. .RE .PP \fBGotoWindow\fR \fInumber\fR [{\fIoptions\fR}] [\fIpattern\fR] .RS 4 Focuses and activates the window at position \fInumber\fR in the focus list\&. The \fIoptions\fR and \fIpattern\fR arguments have the same meaning as \fBNextWindow\fR above\&. .RE .PP \fBActivate\fR [\fIpattern\fR] | \fBFocus\fR [\fIpattern\fR] .RS 4 With \fIpattern\fR, this is an alias for \fBGoToWindow\fR 1 \fIpattern\fR\&. Without, this behaves like a window command, so that OnWindow events can change the focused window\&. .RE .PP \fBAttach\fR \fIpattern\fR .RS 4 Combines all windows that match the \fIpattern\fR into a single tab group\&. See \fBCLIENT PATTERNS\fR for more about the \fIpattern\fR arguments\&. .RE .PP \fBFocusLeft\fR / \fBFocusRight\fR / \fBFocusUp\fR / \fBFocusDown\fR .RS 4 Focus to the next window which is located in the direction specified\&. .RE .PP \fBArrangeWindows\fR \fIpattern\fR / \fBArrangeWindowsVertical\fR \fIpattern\fR / \fBArrangeWindowsHorizontal\fR \fIpattern\fR .RS 4 Tries to arrange all windows on the current workspace so that they overlap the least amount possible\&. \fBArrangeWindowsVertical\fR prefers vertical splits (windows side by side), whereas \fBArrangeWindowsHorizontal\fR prefers horizontal splits (windows on top of eachother)\&. See \fBCLIENT PATTERNS\fR for more about the \fIpattern\fR arguments\&. .RE .PP \fBShowDesktop\fR .RS 4 Minimizes all windows on the current workspace\&. If they are already all minimized, then it restores them\&. .RE .PP \fBDeiconify\fR \fImode\fR \fIdestination\fR .RS 4 Deiconifies windows (or, restores from a minimized state)\&. .PP Where \fImode\fR may be one of: .RS 4 .PP \fBAll\fR .RS 4 All icons across all workspaces\&. .RE .PP \fBAllWorkspace\fR .RS 4 All icons on the current workspace\&. .RE .PP \fBLast\fR .RS 4 The last icon across all workspaces\&. .RE .PP \fBLastWorkspace\fR (default) .RS 4 The last icon on the current workspace\&. .RE .RE .PP And \fIdestination\fR may be one of: .RS 4 .PP \fBCurrent\fR (default) .RS 4 Deiconify to the current workspace\&. .RE .PP \fBOriginQuiet\fR .RS 4 Deiconify to the window\(cqs original workspace, but does so in the background, without moving you there\&. .RE .RE .RE .PP \fBSetWorkspaceName\fR \fIname\fR / \fBSetWorkspaceNameDialog\fR .RS 4 Sets the name of the current workspace\&. .RE .PP \fBCloseAllWindows\fR .RS 4 Closes all windows on all desktops\&. .RE .SS "Menu Commands" .sp These commands open or close fluxbox popup menus\&. For more information on what these menus contain or how to configure them, see \fIfluxbox(1)\fR\&. .PP \fBRootMenu\fR .RS 4 Opens the root menu\&. See \fBROOT MENU\fR in \fBfluxbox\-menu(5)\fR for details\&. .RE .PP \fBWorkspaceMenu\fR .RS 4 Opens a menu showing all workspaces and windows\&. See \fBWorkspace Menu\fR in \fBfluxbox(1)\fR for details\&. .RE .PP \fBWindowMenu\fR .RS 4 Opens a menu containing actions for the current window\&. See \fBWINDOW MENU\fR in \fBfluxbox\-menu(5)\fR for details\&. .PP \fBClientMenu\fR [\fIpattern\fR] .RS 4 Opens a menu that contains all windows\&. If you specify a \fIpattern\fR, only matching windows will be in the menu\&. Selecting a window will jump to that workspace and raise the window\&. See \fBCLIENT PATTERNS\fR below for more details on the \fIpattern\fR argument\&. .RE .PP \fBCustomMenu\fR \fIpath\fR .RS 4 Opens a custom menu file\&. This \fIpath\fR must be a valid menu file in the same format as detailed by the \fBROOT MENU\fR section of \fBfluxbox\-menu(5)\fR\&. .RE .PP \fBHideMenus\fR .RS 4 Hide all fluxbox popup menus\&. .RE .RE .SS "Window Manager Commands" .sp These commands affect the Window Manager, or more than one window\&. .PP \fBRestart\fR [\fIpath\fR] .RS 4 Restarts fluxbox\&. This does not close any running applications\&. If the optional \fIpath\fR is a path to an executable window manager, that manager is started in place of fluxbox\&. .RE .PP \fBQuit\fR | \fBExit\fR .RS 4 Exits fluxbox\&. This will normally cause X to stop as well and terminate all existing applications, returning you to the login manager or console\&. .RE .PP \fBReconfig\fR | \fBReconfigure\fR .RS 4 Reloads all fluxbox configuration files including the keys file, apps file, and init file, if they have changed\&. .RE .PP \fBSetStyle\fR \fIpath\fR .RS 4 Sets the current style to that given in \fIpath\fR, which must be the full path to a fluxbox style\&. .RE .PP \fBReloadStyle\fR .RS 4 Reloads only the current style\&. Useful after editing a style which is currently in use\&. .RE .PP \fBExecCommand\fR \fIargs \&...\fR | \fBExec\fR \fIargs \&...\fR | \fBExecute\fR \fIargs \&...\fR .RS 4 Probably the most\-used binding of all\&. Passes all the arguments to your \fB$SHELL\fR (or /bin/sh if $SHELL is not set)\&. You can use this to launch applications, run shell scripts, etc\&. Since all arguments are passed verbatim to the shell, you can use environment variables, pipes, or anything else the shell can do\&. Note that processes only see environment variables that were set before fluxbox started (such as in \fB~/\&.fluxbox/startup\fR), or any that are set via the \fBExport\fR or \fBSetEnv\fR commands, below\&. See \fBfluxbox(1)\fR for more details on the \fBENVIRONMENT\fR and \fB\e~/\&.fluxbox/startup\fR file\&. .RE .PP \fBCommandDialog\fR .RS 4 Pops up a dialog box that lets you type in any of these commands manually\&. .RE .PP \fBSetEnv\fR \fIname\fR \fIvalue\fR | \fBExport\fR \fIname\fR=\fIvalue\fR .RS 4 Sets an environment variable in Fluxbox\&. It will be passed to any applications spawned by any future ExecCommand commands\&. .RE .PP \fBSetResourceValue\fR \fIresourcename\fR \fIresourcevalue\fR | \fBSetResourceValueDialog\fR .RS 4 Sets a fluxbox resource value, which are normally stored in the init file\&. See \fIfluxbox(1)\fR for more details on available resources and allowed values\&. .RE .SS "Special Commands" .sp These commands have special meanings or behaviors\&. .PP \fBMacroCmd\fR {\fIcommand1\fR} {\fIcommand2\fR} {\fIcommand3\fR} \fI\&...\fR .RS 4 Allows you to execute more than one command with one keybinding\&. The commands will be executed in series\&. The \fB{\fR \fB}\fR brackets are literally required, as in the following example: .sp .if n \{\ .RS 4 .\} .nf MacroCmd {MoveTo 0 0} {ResizeTo 1280 800} .fi .if n \{\ .RE .\} .RE .PP \fBDelay\fR {\fIcommand\fR} [\fImicroseconds\fR] .RS 4 Delays running \fIcommand\fR for the given amount of time\&. If the same key binding is activated again, the timer will be restarted\&. .RE .PP \fBToggleCmd\fR {\fIcommand1\fR} {\fIcommand2\fR} \fI\&...\fR .RS 4 Alternates between the commands\&. On the first press of the bound key, runs \fIcommand1\fR\&. On the next press, runs \fIcommand2\fR\&. .RE .PP \fBBindKey\fR \fIkeybinding\fR .RS 4 Adds the given \fIkeybinding\fR (which must be a valid key binding as defined in the DESCRIPTION section above) to your keys file\&. .RE .PP \fBKeyMode\fR \fIkeymode\fR [\fIreturn\-keybinding\fR] .RS 4 Activates the named \fIkeymode\fR (or, all key binding lines prefaced with the same \fIkeymode\fR:) and deactivates all others until the \fIreturn\-keybinding\fR (by default \fBEscape\fR) is pressed\&. The default keymode is named \fIdefault\fR\&. .RE .PP \fBForEach\fR {\fIcommand\fR} [{\fIcondition\fR}] | \fBMap\fR {\fIcommand\fR} [{\fIcondition\fR}] .RS 4 Runs the given \fIcommand\fR (normally one from the \fBWindow Commands\fR section above) on each window\&. If you specify a \fIcondition\fR (See \fBConditions\fR, below) the action will be limited to matching windows\&. .RE .PP \fBIf\fR {\fIcondition\fR} {\fIthen\-command\fR} [{\fIelse\-command\fR}] | \fBCond\fR {\fIcondition\fR} {\fIthen\-command\fR} [{\fIelse\-command\fR}] .RS 4 If the \fIcondition\fR command returns \fBtrue\fR, then run the \fIthen\-command\fR, otherwise run the optional \fIelse\-command\fR\&. See \fBConditions\fR below for more information on the \fIcondition\fR argument\&. .RE .SS "Conditions" .sp These special commands are used to match windows conditionally\&. They are commonly used by the \fBIf\fR and \fBForEach\fR command\&. .PP \fBMatches\fR \fIpattern\fR .RS 4 Returns \fBtrue\fR if the current window matches the given \fIpattern\fR\&. See \fBCLIENT PATTERNS\fR below for details on the \fIpattern\fR syntax\&. .sp If your key binding uses the \fBOnWindow\fR modifier, it matches against the window you clicked, not the currently focused window\&. .sp To check other windows besides the currently focused one, see the \fBEvery\fR and \fBSome\fR conditions below\&. .RE .PP \fBSome\fR \fIcondition\fR .RS 4 Retuns \fBtrue\fR if any window on any workspace (not just the currently focused one) matches the \fIcondition\fR\&. .RE .PP \fBEvery\fR \fIcondition\fR .RS 4 Retuns \fBtrue\fR if every window on every workspace (not just the current one) matches the \fIcondition\fR\&. .RE .PP \fBNot\fR \fIcondition\fR .RS 4 Returns \fBtrue\fR if \fIcondition\fR returns \fBfalse\fR, and vice\-versa\&. .RE .PP \fBAnd\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...] .RS 4 Returns \fBtrue\fR if and only if all given conditions return \fBtrue\fR\&. .RE .PP \fBOr\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...] .RS 4 Returns \fBtrue\fR if any of the listed conditions return \fBtrue\fR\&. .RE .PP \fBXor\fR {\fIcondition1\fR} {\fIcondition2\fR} [{\fIcondition3\fR} \&...] .RS 4 Returns the boolean \fBxor\fR of the truth values for all conditions listed\&. .RE .SH "CLIENT PATTERNS" .sp Many of the more advanced commands take a \fIpattern\fR argument, which allows you to direct the action at a specific window or set of windows which match the properties specified in the \fIpattern\fR\&. .PP A \fIpattern\fR looks like this .RS 4 \fB(\fR[\fIpropertyname\fR[!]=]\fIregexp\fR\fB)\fR \&... .RE .sp Match definitions are enclosed in parentheses \fB(\fR\&...\fB)\fR, and if no \fIpropertyname\fR is given then \fBName\fR is assumed\&. The \fIregexp\fR can contain any regular expression, or the special value \fB[current]\fR, which matches the corresponding value of the currently focused window\&. See \fIregex(7)\fR for more information on acceptable regular expressions\&. .sp \fIpropertyname\fR is not case sensitive, whereas the \fIregexp\fR is\&. .sp If you specify multiple \fB(\fR\fB\fIpattern\fR\fR) arguments, this implies an AND condition \- All specified patterns must match\&. .sp You can use \fB=\fR to test for equality or \fB!=\fR to test for inequality\&. .PP The following values are accepted for \fIpropertyname\fR .RS 4 .PP \fBName\fR .RS 4 A string, corresponding to the CLASSNAME property (The first field of WM_CLASS from the output of the \fBxprop(1)\fR utility)\&. .RE .PP \fBClass\fR .RS 4 A string, corresponding to the CLASSCLASS property (The second field of WM_CLASS from the output of the \fBxprop(1)\fR utility)\&. .RE .PP \fBTitle\fR .RS 4 A string, corresponding to the window title (WM_NAME from \fBxprop(1)\fR)\&. .RE .PP \fBRole\fR .RS 4 A string, corresponding to the ROLE property (WM_WINDOW_ROLE from \fBxprop(1)\fR)\&. .RE .PP \fBTransient\fR .RS 4 Either \fByes\fR or \fBno\fR, depending on whether the window is transient (typically, a popup dialog) or not\&. .RE .PP \fBMaximized\fR .RS 4 Either \fByes\fR or \fBno\fR, depending on whether the window is maximized or not\&. .RE .PP \fBMinimized\fR .RS 4 Either \fByes\fR or \fBno\fR, depending on whether the window is minimized (iconified) or not\&. .RE .PP \fBShaded\fR .RS 4 Either \fByes\fR or \fBno\fR, depending on whether the window is shaded or not\&. .RE .PP \fBStuck\fR .RS 4 Either \fByes\fR or \fBno\fR, depending on whether the window is sticky (on all workspaces) or not\&. .RE .PP \fBFocusHidden\fR .RS 4 Either \fByes\fR or \fBno\fR, depending on whether the window has asked to be left off the focus list (or, the alt\-tab list), or not\&. .RE .PP \fBIconHidden\fR .RS 4 Either \fByes\fR or \fBno\fR, depending on whether the window has asked to be left off the icon list (or, the taskbar), or not\&. .RE .PP \fBUrgent\fR .RS 4 Either \fByes\fR or \fBno\fR, depending on whether the window has the urgent hint set\&. .RE .PP \fBWorkspace\fR .RS 4 A number corresponding to the workspace number to which the window is attached\&. The first workspace here is \fB0\fR\&. You may also use \fB[current]\fR to match the currently visible workspace\&. .RE .PP \fBWorkspaceName\fR .RS 4 A string corresponding to the name of the workspace to which the window is attached\&. .RE .PP \fBHead\fR .RS 4 The number of the display head to which the window is attached\&. You may match this against the special value \fB[mouse]\fR which refers to the head where the mouse pointer currently resides\&. .RE .PP \fBLayer\fR .RS 4 The string name of the window\(cqs layer, which is one of \fBAboveDock\fR, \fBDock\fR, \fBTop\fR, \fBNormal\fR, \fBBottom\fR, \fBDesktop\fR .RE .PP \fBScreen\fR .RS 4 The number of the currently used \fIscreen\fR\&. If the setup of the running xserver involves independent screens (\fInot Xinerama\fR), the $DISPLAY environment contains something like \fI:0\&.1\fR or \fI:1\&.0\fR\&. The part after the dot (\fI\&.\fR) is the number of the screen\&. .RE .PP \fB@XPROP\fR .RS 4 A string, corresponding to any xproperty (Use either the \fBxprop(1)\fR utility or the \fISetXProp\fR command to set a xproperty to a window) .RE .RE .PP \fBMatches any windows with the CLASSNAME of "xterm"\fR. .sp .if n \{\ .RS 4 .\} .nf (xterm) .fi .if n \{\ .RE .\} .PP \fBMatches any windows with the same CLASSNAME as the currently focused window\fR. .sp .if n \{\ .RS 4 .\} .nf (Name=[current]) .fi .if n \{\ .RE .\} .PP \fBMatches any windows on the same head as the mouse but on a different layer than the currently focused window\fR. .sp .if n \{\ .RS 4 .\} .nf (Head=[mouse]) (Layer!=[current]) .fi .if n \{\ .RE .\} .PP \fBMatches any windows having a xproperty named FOO with "bar" in it\fR. .sp .if n \{\ .RS 4 .\} .nf (@FOO=\&.*bar\&.*) .fi .if n \{\ .RE .\} .sp .SH "FILES" .PP \fB~/\&.fluxbox/keys\fR .RS 4 This is the default location for the keybinding definitions\&. .RE .PP \fB/usr/X11R6/include/X11/keysymdef\&.h\fR .RS 4 X key names are in this file\&. .RE .PP \fB/usr/X11R6/lib/X11/XKeysymDB\fR .RS 4 X key names are also in this file\&. .RE .SH "RESOURCES" .PP \fBsession\&.keyFile:\fR \fIlocation\fR .RS 4 This may be set to override the location of the keybinding definitions\&. .RE .SH "ENVIRONMENT" .sp Remember that \fBExecCommand\fR command can take advantage of other environment variables if they are set before fluxbox is started, or via the \fBExport\fR or \fBSetEnv\fR commands\&. For example, if \fB$TERM\fR is set, it could be use like this: .sp .if n \{\ .RS 4 .\} .nf Mod1 x :ExecCommand $TERM .fi .if n \{\ .RE .\} .sp For more information about environment variables, see your shell\(cqs manual\&. .SH "EXAMPLES" .sp Here are some interesting and/or useful examples you can do with your keys file\&. .sp .if n \{\ .RS 4 .\} .nf # Mod4+drag moves a window OnWindow Mod4 Mouse1 :StartMoving # If any xterm windows are open, cycle through them\&. If none are open, open # one: Mod4 t :If {Some Matches (xterm)} {NextWindow (xterm)} {Exec xterm} # Set a different wallpaper on every workspace: ChangeWorkspace :Exec fbsetbg ~/\&.fluxbox/bg$(xprop \-root _NET_CURRENT_DESKTOP | awk \*(Aq{print $3}\*(Aq)\&.png # Focusses the next window with it\*(Aqs xproperty \*(AqPROP\*(Aq set to \*(Aqfoo\*(Aq Mod4 p Mod4 Tab :NextWindow (@PROP=foo) .fi .if n \{\ .RE .\} .SH "AUTHORS" .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Jim Ramsay <i\&.am at jimramsay com> (>fluxbox\-1\&.0\&.0) .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Curt Micol <asenchi at asenchi com> (>fluxbox\-0\&.9\&.11) .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Tobias Klausmann <klausman at users sourceforge net> (\(lafluxbox\-0\&.9\&.11) .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Grubert <grubert at users sourceforge net> (fluxbox) .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Matthew Hawkins <matt at mh dropbear id au> (blackbox) .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Wilbert Berendsen <wbsoft at xs4all nl> (blackbox) .RE .SH "SEE ALSO" .sp fluxbox(1) xprop(1) xev(1) xkill(1) regex(7) |