git.lizzy.rs Git - bspwm.git/blob

212 The initial node is the focused node (or the root if the path starts with \fI/\fR) of the reference desktop (or the selected desktop if the path has a \fIDESKTOP_SEL\fR prefix)\&.

213 .PP

214 1|first

215 .RS 4

216 Jumps to the first child\&.

217 .RE

218 .PP

219 2|second

220 .RS 4

221 Jumps to the second child\&.

222 .RE

223 .PP

224 brother

225 .RS 4

226 Jumps to the brother node\&.

227 .RE

228 .PP

229 parent

230 .RS 4

231 Jumps to the parent node\&.

232 .RE

233 .PP

234 \fIDIR\fR

235 .RS 4

236 Jumps to the node holding the edge in the given direction\&.

237 .RE

238 .RE

239 .sp

240 .it 1 an-trap

241 .nr an-no-space-flag 1

242 .nr an-break-flag 1

243 .br

244 .ps +1

245 \fBModifiers\fR

246 .RS 4

247 .PP

248 [!]focused

249 .RS 4

250 Only consider the focused node\&.

251 .RE

252 .PP

253 [!]active

254 .RS 4

255 Only consider nodes that are the focused node of their desktop\&.

256 .RE

257 .PP

258 [!]automatic

259 .RS 4

260 Only consider nodes in automatic insertion mode\&. See also

261 \fB\-\-presel\-dir\fR

262 under

263 \fBNode\fR

264 in the

265 \fBDOMAINS\fR

266 section below\&.

267 .RE

268 .PP

269 [!]local

270 .RS 4

271 Only consider nodes in the reference desktop\&.

272 .RE

273 .PP

274 [!]leaf

275 .RS 4

276 Only consider leaf nodes\&.

277 .RE

278 .PP

279 [!]window

280 .RS 4

281 Only consider nodes that hold a window\&.

282 .RE

283 .PP

284 [!](tiled|pseudo_tiled|floating|fullscreen)

285 .RS 4

286 Only consider windows in the given state\&.

287 .RE

288 .PP

289 [!]same_class

290 .RS 4

291 Only consider windows that have the same class as the reference window\&.

292 .RE

293 .PP

294 [!]descendant_of

295 .RS 4

296 Only consider nodes that are descendants of the reference node\&.

297 .RE

298 .PP

299 [!]ancestor_of

300 .RS 4

301 Only consider nodes that are ancestors of the reference node\&.

302 .RE

303 .PP

305 .RS 4

306 Only consider windows that have the given flag set\&.

307 .RE

308 .PP

309 [!](below|normal|above)

310 .RS 4

311 Only consider windows in the given layer\&.

312 .RE

313 .PP

314 [!](horizontal|vertical)

315 .RS 4

316 Only consider nodes with the given split type\&.

317 .RE

318 .RE

319 .SS "Desktop"

320 .sp

321 Select a desktop\&.

322 .sp

323 .if n \{\

324 .RS 4

325 .\}

326 .nf

328 [MONITOR_SEL:](focused|^<n>)|

329 <desktop_id>|<desktop_name>)[\&.[!]focused][\&.[!]active]

330 [\&.[!]occupied][\&.[!]urgent][\&.[!]local]

331 [\&.[!]LAYOUT][\&.[!]user_LAYOUT]

332

333 LAYOUT := tiled|monocle

334 .fi

335 .if n \{\

336 .RE

337 .\}

338 .sp

339 .it 1 an-trap

340 .nr an-no-space-flag 1

341 .nr an-break-flag 1

342 .br

343 .ps +1

344 \fBDescriptors\fR

345 .RS 4

346 .PP

347 \fICYCLE_DIR\fR

348 .RS 4

349 Selects the desktop in the given direction relative to the reference desktop\&.

350 .RE

351 .PP

352 any

353 .RS 4

354 Selects the first desktop that matches the given selectors\&.

355 .RE

356 .PP

357 last

358 .RS 4

359 Selects the previously focused desktop relative to the reference desktop\&.

360 .RE

361 .PP

362 newest

363 .RS 4

364 Selects the newest desktop in the history of the focused desktops\&.

365 .RE

366 .PP

367 older

368 .RS 4

369 Selects the desktop older than the reference desktop in the history\&.

370 .RE

371 .PP

372 newer

373 .RS 4

374 Selects the desktop newer than the reference desktop in the history\&.

375 .RE

376 .PP

377 focused

378 .RS 4

379 Selects the currently focused desktop\&.

380 .RE

381 .PP

382 ^<n>

383 .RS 4

384 Selects the nth desktop\&. If

385 \fBMONITOR_SEL\fR

386 is given, selects the nth desktop on the selected monitor\&.

387 .RE

388 .PP

389 <desktop_id>

390 .RS 4

391 Selects the desktop with the given ID\&.

392 .RE

393 .PP

394 <desktop_name>

395 .RS 4

396 Selects the desktop with the given name\&.

397 .RE

398 .RE

399 .sp

400 .it 1 an-trap

401 .nr an-no-space-flag 1

402 .nr an-break-flag 1

403 .br

404 .ps +1

405 \fBModifiers\fR

406 .RS 4

407 .PP

408 [!]focused

409 .RS 4

410 Only consider the focused desktop\&.

411 .RE

412 .PP

413 [!]active

414 .RS 4

415 Only consider desktops that are the focused desktop of their monitor\&.

416 .RE

417 .PP

418 [!]occupied

419 .RS 4

420 Only consider occupied desktops\&.

421 .RE

422 .PP

423 [!]urgent

424 .RS 4

425 Only consider urgent desktops\&.

426 .RE

427 .PP

428 [!]local

429 .RS 4

430 Only consider desktops inside the reference monitor\&.

431 .RE

432 .PP

433 [!](tiled|monocle)

434 .RS 4

435 Only consider desktops with the given layout\&.

436 .RE

437 .PP

438 [!](user_tiled|user_monocle)

439 .RS 4

440 Only consider desktops which have the given layout as userLayout\&.

441 .RE

442 .RE

443 .SS "Monitor"

444 .sp

445 Select a monitor\&.

446 .sp

447 .if n \{\

448 .RS 4

449 .\}

450 .nf

452 focused|pointed|primary|^<n>|

453 <monitor_id>|<monitor_name>)[\&.[!]focused][\&.[!]occupied]

454 .fi

455 .if n \{\

456 .RE

457 .\}

458 .sp

459 .it 1 an-trap

460 .nr an-no-space-flag 1

461 .nr an-break-flag 1

462 .br

463 .ps +1

464 \fBDescriptors\fR

465 .RS 4

466 .PP

467 \fIDIR\fR

468 .RS 4

469 Selects the monitor in the given (spacial) direction relative to the reference monitor\&.

470 .RE

471 .PP

472 \fICYCLE_DIR\fR

473 .RS 4

474 Selects the monitor in the given (cyclic) direction relative to the reference monitor\&.

475 .RE

476 .PP

477 any

478 .RS 4

479 Selects the first monitor that matches the given selectors\&.

480 .RE

481 .PP

482 last

483 .RS 4

484 Selects the previously focused monitor relative to the reference monitor\&.

485 .RE

486 .PP

487 newest

488 .RS 4

489 Selects the newest monitor in the history of the focused monitors\&.

490 .RE

491 .PP

492 older

493 .RS 4

494 Selects the monitor older than the reference monitor in the history\&.

495 .RE

496 .PP

497 newer

498 .RS 4

499 Selects the monitor newer than the reference monitor in the history\&.

500 .RE

501 .PP

502 focused

503 .RS 4

504 Selects the currently focused monitor\&.

505 .RE

506 .PP

507 pointed

508 .RS 4

509 Selects the monitor under the pointer\&.

510 .RE

511 .PP

512 primary

513 .RS 4

514 Selects the primary monitor\&.

515 .RE

516 .PP

517 ^<n>

518 .RS 4

519 Selects the nth monitor\&.

520 .RE

521 .PP

522 <monitor_id>

523 .RS 4

524 Selects the monitor with the given ID\&.

525 .RE

526 .PP

527 <monitor_name>

528 .RS 4

529 Selects the monitor with the given name\&.

530 .RE

531 .RE

532 .sp

533 .it 1 an-trap

534 .nr an-no-space-flag 1

535 .nr an-break-flag 1

536 .br

537 .ps +1

538 \fBModifiers\fR

539 .RS 4

540 .PP

541 [!]focused

542 .RS 4

543 Only consider the focused monitor\&.

544 .RE

545 .PP

546 [!]occupied

547 .RS 4

548 Only consider monitors where the focused desktop is occupied\&.

549 .RE

550 .RE

551 .SH "WINDOW STATES"

552 .PP

553 tiled

554 .RS 4

555 Its size and position are determined by the window tree\&.

556 .RE

557 .PP

558 pseudo_tiled

559 .RS 4

560 A tiled window that automatically shrinks but doesn\(cqt stretch beyond its floating size\&.

561 .RE

562 .PP

563 floating

564 .RS 4

565 Can be moved/resized freely\&. Although it doesn\(cqt use any tiling space, it is still part of the window tree\&.

566 .RE

567 .PP

568 fullscreen

569 .RS 4

570 Fills its monitor rectangle and has no borders\&.

571 .RE

572 .SH "NODE FLAGS"

573 .PP

574 hidden

575 .RS 4

576 Is hidden and doesn\(cqt occupy any tiling space\&.

577 .RE

578 .PP

579 sticky

580 .RS 4

581 Stays in the focused desktop of its monitor\&.

582 .RE

583 .PP

584 private

585 .RS 4

586 Tries to keep the same tiling position/size\&.

587 .RE

588 .PP

589 locked

590 .RS 4

591 Ignores the

592 \fBnode \-\-close\fR

593 message\&.

594 .RE

595 .PP

596 marked

597 .RS 4

598 Is marked (useful for deferred actions)\&. A marked node becomes unmarked after being sent on a preselected node\&.

599 .RE

600 .PP

601 urgent

602 .RS 4

603 Has its urgency hint set\&. This flag is set externally\&.

604 .RE

605 .SH "STACKING LAYERS"

606 .sp

607 There\(cqs three stacking layers: BELOW, NORMAL and ABOVE\&.

608 .sp

609 In each layer, the window are orderered as follow: tiled & pseudo\-tiled < floating < fullscreen\&.

610 .SH "RECEPTACLES"

611 .sp

612 A leaf node that doesn\(cqt hold any window is called a receptacle\&. When a node is inserted on a receptacle in automatic mode, it will replace the receptacle\&. A receptacle can be inserted on a node, preselected and killed\&. Receptacles can therefore be used to build a tree whose leaves are receptacles\&. Using the appropriate rules, one can then send windows on the leaves of this tree\&. This feature is used in \fIexamples/receptacles\fR to store and recreate layouts\&.

613 .SH "DOMAINS"

614 .SS "Node"

615 .sp

616 .it 1 an-trap

617 .nr an-no-space-flag 1

618 .nr an-break-flag 1

619 .br

620 .ps +1

621 \fBGeneral Syntax\fR

622 .RS 4

623 .sp

624 node [\fINODE_SEL\fR] \fICOMMANDS\fR

625 .sp

626 If \fINODE_SEL\fR is omitted, \fBfocused\fR is assumed\&.

627 .RE

628 .sp

629 .it 1 an-trap

630 .nr an-no-space-flag 1

631 .nr an-break-flag 1

632 .br

633 .ps +1

634 \fBCommands\fR

635 .RS 4

636 .PP

637 \fB\-f\fR, \fB\-\-focus\fR [\fINODE_SEL\fR]

638 .RS 4

639 Focus the selected or given node\&.

640 .RE

641 .PP

642 \fB\-a\fR, \fB\-\-activate\fR [\fINODE_SEL\fR]

643 .RS 4

644 Activate the selected or given node\&.

645 .RE

646 .PP

647 \fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR]

648 .RS 4

649 Send the selected node to the given desktop\&. If

650 \fB\-\-follow\fR

651 is passed, the focused node will stay focused\&.

652 .RE

653 .PP

654 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR]

655 .RS 4

656 Send the selected node to the given monitor\&. If

657 \fB\-\-follow\fR

658 is passed, the focused node will stay focused\&.

659 .RE

660 .PP

661 \fB\-n\fR, \fB\-\-to\-node\fR \fINODE_SEL\fR [\fB\-\-follow\fR]

662 .RS 4

663 Send the selected node on the given node\&. If

664 \fB\-\-follow\fR

665 is passed, the focused node will stay focused\&.

666 .RE

667 .PP

668 \fB\-s\fR, \fB\-\-swap\fR \fINODE_SEL\fR [\fB\-\-follow\fR]

669 .RS 4

670 Swap the selected node with the given node\&. If

671 \fB\-\-follow\fR

672 is passed, the focused node will stay focused\&.

673 .RE

674 .PP

675 \fB\-p\fR, \fB\-\-presel\-dir\fR [~]\fIDIR\fR|cancel

676 .RS 4

677 Preselect the splitting area of the selected node (or cancel the preselection)\&. If

678 \fB~\fR

679 is prepended to

680 \fIDIR\fR

681 and the current preselection direction matches

682 \fIDIR\fR, then the argument is interpreted as

683 \fBcancel\fR\&. A node with a preselected area is said to be in "manual insertion mode"\&.

684 .RE

685 .PP

686 \fB\-o\fR, \fB\-\-presel\-ratio\fR \fIRATIO\fR

687 .RS 4

688 Set the splitting ratio of the preselection area\&.

689 .RE

690 .PP

691 \fB\-v\fR, \fB\-\-move\fR \fIdx\fR \fIdy\fR

692 .RS 4

693 Move the selected window by

694 \fIdx\fR

695 pixels horizontally and

696 \fIdy\fR

697 pixels vertically\&.

698 .RE

699 .PP

701 .RS 4

702 Resize the selected window by moving the given handle by

703 \fIdx\fR

704 pixels horizontally and

705 \fIdy\fR

706 pixels vertically\&.

707 .RE

708 .PP

709 \fB\-r\fR, \fB\-\-ratio\fR \fIRATIO\fR|(+|\-)(\fIPIXELS\fR|\fIFRACTION\fR)

710 .RS 4

711 Set the splitting ratio of the selected node (0 <

712 \fIRATIO\fR

713 < 1)\&.

714 .RE

715 .PP

716 \fB\-R\fR, \fB\-\-rotate\fR \fI90|270|180\fR

717 .RS 4

718 Rotate the tree rooted at the selected node\&.

719 .RE

720 .PP

721 \fB\-F\fR, \fB\-\-flip\fR \fIhorizontal|vertical\fR

722 .RS 4

723 Flip the the tree rooted at selected node\&.

724 .RE

725 .PP

726 \fB\-E\fR, \fB\-\-equalize\fR

727 .RS 4

728 Reset the split ratios of the tree rooted at the selected node to their default value\&.

729 .RE

730 .PP

731 \fB\-B\fR, \fB\-\-balance\fR

732 .RS 4

733 Adjust the split ratios of the tree rooted at the selected node so that all windows occupy the same area\&.

734 .RE

735 .PP

736 \fB\-C\fR, \fB\-\-circulate\fR forward|backward

737 .RS 4

738 Circulate the windows of the tree rooted at the selected node\&.

739 .RE

740 .PP

741 \fB\-t\fR, \fB\-\-state\fR [~](tiled|pseudo_tiled|floating|fullscreen)

742 .RS 4

743 Set the state of the selected window\&. If

744 \fB~\fR

745 is present and the current state matches the given state, then the argument is interpreted as the last state\&.

746 .RE

747 .PP

749 .RS 4

750 Set or toggle the given flag for the selected node\&.

751 .RE

752 .PP

753 \fB\-l\fR, \fB\-\-layer\fR below|normal|above

754 .RS 4

755 Set the stacking layer of the selected window\&.

756 .RE

757 .PP

758 \fB\-i\fR, \fB\-\-insert\-receptacle\fR

759 .RS 4

760 Insert a receptacle node at the selected node\&.

761 .RE

762 .PP

763 \fB\-c\fR, \fB\-\-close\fR

764 .RS 4

765 Close the windows rooted at the selected node\&.

766 .RE

767 .PP

768 \fB\-k\fR, \fB\-\-kill\fR

769 .RS 4

770 Kill the windows rooted at the selected node\&.

771 .RE

772 .RE

773 .SS "Desktop"

774 .sp

775 .it 1 an-trap

776 .nr an-no-space-flag 1

777 .nr an-break-flag 1

778 .br

779 .ps +1

780 \fBGeneral Syntax\fR

781 .RS 4

782 .sp

783 desktop [\fIDESKTOP_SEL\fR] \fICOMMANDS\fR

784 .sp

785 If \fIDESKTOP_SEL\fR is omitted, \fBfocused\fR is assumed\&.

786 .RE

787 .sp

788 .it 1 an-trap

789 .nr an-no-space-flag 1

790 .nr an-break-flag 1

791 .br

792 .ps +1

793 \fBCOMMANDS\fR

794 .RS 4

795 .PP

796 \fB\-f\fR, \fB\-\-focus\fR [\fIDESKTOP_SEL\fR]

797 .RS 4

798 Focus the selected or given desktop\&.

799 .RE

800 .PP

801 \fB\-a\fR, \fB\-\-activate\fR [\fIDESKTOP_SEL\fR]

802 .RS 4

803 Activate the selected or given desktop\&.

804 .RE

805 .PP

806 \fB\-m\fR, \fB\-\-to\-monitor\fR \fIMONITOR_SEL\fR [\fB\-\-follow\fR]

807 .RS 4

808 Send the selected desktop to the given monitor\&. If

809 \fB\-\-follow\fR

810 is passed, the focused desktop will stay focused\&.

811 .RE

812 .PP

813 \fB\-s\fR, \fB\-\-swap\fR \fIDESKTOP_SEL\fR [\fB\-\-follow\fR]

814 .RS 4

815 Swap the selected desktop with the given desktop\&. If

816 \fB\-\-follow\fR

817 is passed, the focused desktop will stay focused\&.

818 .RE

819 .PP

820 \fB\-l\fR, \fB\-\-layout\fR \fICYCLE_DIR\fR|monocle|tiled

821 .RS 4

822 Set or cycle the layout of the selected desktop\&.

823 .RE

824 .PP

825 \fB\-n\fR, \fB\-\-rename\fR <new_name>

826 .RS 4

827 Rename the selected desktop\&.

828 .RE

829 .PP

830 \fB\-b\fR, \fB\-\-bubble\fR \fICYCLE_DIR\fR

831 .RS 4

832 Bubble the selected desktop in the given direction\&.

833 .RE

834 .PP

835 \fB\-r\fR, \fB\-\-remove\fR

836 .RS 4

837 Remove the selected desktop\&.

838 .RE

839 .RE

840 .SS "Monitor"

841 .sp

842 .it 1 an-trap

843 .nr an-no-space-flag 1

844 .nr an-break-flag 1

845 .br

846 .ps +1

847 \fBGeneral Syntax\fR

848 .RS 4

849 .sp

850 monitor [\fIMONITOR_SEL\fR] \fICOMMANDS\fR

851 .sp

852 If \fIMONITOR_SEL\fR is omitted, \fBfocused\fR is assumed\&.

853 .RE

854 .sp

855 .it 1 an-trap

856 .nr an-no-space-flag 1

857 .nr an-break-flag 1

858 .br

859 .ps +1

860 \fBCommands\fR

861 .RS 4

862 .PP

863 \fB\-f\fR, \fB\-\-focus\fR [\fIMONITOR_SEL\fR]

864 .RS 4

865 Focus the selected or given monitor\&.

866 .RE

867 .PP

868 \fB\-s\fR, \fB\-\-swap\fR \fIMONITOR_SEL\fR

869 .RS 4

870 Swap the selected monitor with the given monitor\&.

871 .RE

872 .PP

873 \fB\-a\fR, \fB\-\-add\-desktops\fR <name>\&...

874 .RS 4

875 Create desktops with the given names in the selected monitor\&.

876 .RE

877 .PP

878 \fB\-o\fR, \fB\-\-reorder\-desktops\fR <name>\&...

879 .RS 4

880 Reorder the desktops of the selected monitor to match the given order\&.

881 .RE

882 .PP

883 \fB\-d\fR, \fB\-\-reset\-desktops\fR <name>\&...

884 .RS 4

885 Rename, add or remove desktops depending on whether the number of given names is equal, superior or inferior to the number of existing desktops\&.

886 .RE

887 .PP

888 \fB\-g\fR, \fB\-\-rectangle\fR WxH+X+Y

889 .RS 4

890 Set the rectangle of the selected monitor\&.

891 .RE

892 .PP

893 \fB\-n\fR, \fB\-\-rename\fR <new_name>

894 .RS 4

895 Rename the selected monitor\&.

896 .RE

897 .PP

898 \fB\-r\fR, \fB\-\-remove\fR

899 .RS 4

900 Remove the selected monitor\&.

901 .RE

902 .RE

903 .SS "Query"

904 .sp

905 .it 1 an-trap

906 .nr an-no-space-flag 1

907 .nr an-break-flag 1

908 .br

909 .ps +1

910 \fBGeneral Syntax\fR

911 .RS 4

912 .sp

913 query \fICOMMANDS\fR [\fIOPTIONS\fR]

914 .RE

915 .sp

916 .it 1 an-trap

917 .nr an-no-space-flag 1

918 .nr an-break-flag 1

919 .br

920 .ps +1

921 \fBCommands\fR

922 .RS 4

923 .sp

924 The optional selectors are references\&.

925 .PP

926 \fB\-N\fR, \fB\-\-nodes\fR [\fINODE_SEL\fR]

927 .RS 4

928 List the IDs of the matching nodes\&.

929 .RE

930 .PP

931 \fB\-D\fR, \fB\-\-desktops\fR [\fIDESKTOP_SEL\fR]

932 .RS 4

933 List the IDs (or names) of the matching desktops\&.

934 .RE

935 .PP

936 \fB\-M\fR, \fB\-\-monitors\fR [\fIMONITOR_SEL\fR]

937 .RS 4

938 List the IDs (or names) of the matching monitors\&.

939 .RE

940 .PP

941 \fB\-T\fR, \fB\-\-tree\fR

942 .RS 4

943 Print a JSON representation of the matching item\&.

944 .RE

945 .RE

946 .sp

947 .it 1 an-trap

948 .nr an-no-space-flag 1

949 .nr an-break-flag 1

950 .br

951 .ps +1

952 \fBOptions\fR

953 .RS 4

954 .PP

955 \fB\-m\fR,\fB\-\-monitor\fR [\fIMONITOR_SEL\fR], \fB\-d\fR,\fB\-\-desktop\fR [\fIDESKTOP_SEL\fR], \fB\-n\fR, \fB\-\-node\fR [\fINODE_SEL\fR]

956 .RS 4

957 Constrain matches to the selected monitor, desktop or node\&. The descriptor can be omitted for

958 \fI\-M\fR,

959 \fI\-D\fR

960 and

961 \fI\-N\fR\&.

962 .RE

963 .PP

964 \fB\-\-names\fR

965 .RS 4

966 Print names instead of IDs\&. Can only be used with

967 \fI\-M\fR

968 and

969 \fI\-D\fR\&.

970 .RE

971 .RE

972 .SS "Wm"

973 .sp

974 .it 1 an-trap

975 .nr an-no-space-flag 1

976 .nr an-break-flag 1

977 .br

978 .ps +1

979 \fBGeneral Syntax\fR

980 .RS 4

981 .sp

982 wm \fICOMMANDS\fR

983 .RE

984 .sp

985 .it 1 an-trap

986 .nr an-no-space-flag 1

987 .nr an-break-flag 1

988 .br

989 .ps +1

990 \fBCommands\fR

991 .RS 4

992 .PP

993 \fB\-d\fR, \fB\-\-dump\-state\fR

994 .RS 4

995 Dump the current world state on standard output\&.

996 .RE

997 .PP

998 \fB\-l\fR, \fB\-\-load\-state\fR <file_path>

999 .RS 4

1000 Load a world state from the given file\&. The path must be absolute\&.

1001 .RE

1002 .PP

1003 \fB\-a\fR, \fB\-\-add\-monitor\fR <name> WxH+X+Y

1004 .RS 4

1005 Add a monitor for the given name and rectangle\&.

1006 .RE

1007 .PP

1008 \fB\-O\fR, \fB\-\-reorder\-monitors\fR <name>\&...

1009 .RS 4

1010 Reorder the list of monitors to match the given order\&.

1011 .RE

1012 .PP

1013 \fB\-o\fR, \fB\-\-adopt\-orphans\fR

1014 .RS 4

1015 Manage all the unmanaged windows remaining from a previous session\&.

1016 .RE

1017 .PP

1018 \fB\-h\fR, \fB\-\-record\-history\fR on|off

1019 .RS 4

1020 Enable or disable the recording of node focus history\&.

1021 .RE

1022 .PP

1023 \fB\-g\fR, \fB\-\-get\-status\fR

1024 .RS 4

1025 Print the current status information\&.

1026 .RE

1027 .PP

1028 \fB\-r\fR, \fB\-\-restart\fR

1029 .RS 4

1030 Restart the window manager

1031 .RE

1032 .RE

1033 .SS "Rule"

1034 .sp

1035 .it 1 an-trap

1036 .nr an-no-space-flag 1

1037 .nr an-break-flag 1

1038 .br

1039 .ps +1

1040 \fBGeneral Syntax\fR

1041 .RS 4

1042 .sp

1043 rule \fICOMMANDS\fR

1044 .RE

1045 .sp

1046 .it 1 an-trap

1047 .nr an-no-space-flag 1

1048 .nr an-break-flag 1

1049 .br

1050 .ps +1

1051 \fBCommands\fR

1052 .RS 4

1053 .PP

1055 .RS 4

1056 Create a new rule\&.

1057 .RE

1058 .PP

1060 .RS 4

1061 Remove the given rules\&.

1062 .RE

1063 .PP

1064 \fB\-l\fR, \fB\-\-list\fR

1065 .RS 4

1066 List the rules\&.

1067 .RE

1068 .RE

1069 .SS "Config"

1070 .sp

1071 .it 1 an-trap

1072 .nr an-no-space-flag 1

1073 .nr an-break-flag 1

1074 .br

1075 .ps +1

1076 \fBGeneral Syntax\fR

1077 .RS 4

1078 .PP

1079 config [\-m \fIMONITOR_SEL\fR|\-d \fIDESKTOP_SEL\fR|\-n \fINODE_SEL\fR] <setting> [<value>]

1080 .RS 4

1081 Get or set the value of <setting>\&.

1082 .RE

1083 .RE

1084 .SS "Subscribe"

1085 .sp

1086 .it 1 an-trap

1087 .nr an-no-space-flag 1

1088 .nr an-break-flag 1

1089 .br

1090 .ps +1

1091 \fBGeneral Syntax\fR

1092 .RS 4

1093 .PP

1095 .RS 4

1096 Continuously print events\&. See the

1097 \fBEVENTS\fR

1098 section for the description of each event\&.

1099 .RE

1100 .RE

1101 .sp

1102 .it 1 an-trap

1103 .nr an-no-space-flag 1

1104 .nr an-break-flag 1

1105 .br

1106 .ps +1

1107 \fBOptions\fR

1108 .RS 4

1109 .PP

1110 \fB\-f\fR, \fB\-\-fifo\fR

1111 .RS 4

1112 Print a path to a FIFO from which events can be read and return\&.

1113 .RE

1114 .PP

1115 \fB\-c\fR, \fB\-\-count\fR \fICOUNT\fR

1116 .RS 4

1117 Stop the corresponding

1118 \fBbspc\fR

1119 process after having received

1120 \fICOUNT\fR

1121 events\&.

1122 .RE

1123 .RE

1124 .SS "Quit"

1125 .sp

1126 .it 1 an-trap

1127 .nr an-no-space-flag 1

1128 .nr an-break-flag 1

1129 .br

1130 .ps +1

1131 \fBGeneral Syntax\fR

1132 .RS 4

1133 .PP

1134 quit [<status>]

1135 .RS 4

1136 Quit with an optional exit status\&.

1137 .RE

1138 .RE

1139 .SH "EXIT CODES"

1140 .sp

1141 If the server can\(cqt handle a message, \fBbspc\fR will return with a non\-zero exit code\&.

1142 .SH "SETTINGS"

1143 .sp

1144 Colors are in the form \fI#RRGGBB\fR, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&.

1145 .sp

1146 All the boolean settings are \fIfalse\fR by default unless stated otherwise\&.

1147 .SS "Global Settings"

1148 .PP

1149 \fInormal_border_color\fR

1150 .RS 4

1151 Color of the border of an unfocused window\&.

1152 .RE

1153 .PP

1154 \fIactive_border_color\fR

1155 .RS 4

1156 Color of the border of a focused window of an unfocused monitor\&.

1157 .RE

1158 .PP

1159 \fIfocused_border_color\fR

1160 .RS 4

1161 Color of the border of a focused window of a focused monitor\&.

1162 .RE

1163 .PP

1164 \fIpresel_feedback_color\fR

1165 .RS 4

1166 Color of the

1167 \fBnode \-\-presel\-{dir,ratio}\fR

1168 message feedback area\&.

1169 .RE

1170 .PP

1171 \fIsplit_ratio\fR

1172 .RS 4

1173 Default split ratio\&.

1174 .RE

1175 .PP

1176 \fIstatus_prefix\fR

1177 .RS 4

1178 Prefix prepended to each of the status lines\&.

1179 .RE

1180 .PP

1181 \fIexternal_rules_command\fR

1182 .RS 4

1183 Absolute path to the command used to retrieve rule consequences\&. The command will receive the following arguments: window ID, class name, instance name, and intermediate consequences\&. The output of that command must have the following format:

1184 \fBkey1=value1 key2=value2 \&...\fR

1185 (the valid key/value pairs are given in the description of the

1186 \fIrule\fR

1187 command)\&.

1188 .RE

1189 .PP

1190 \fIautomatic_scheme\fR

1191 .RS 4

1192 The insertion scheme used when the insertion point is in automatic mode\&. Accept the following values:

1193 \fBlongest_side\fR,

1194 \fBalternate\fR,

1195 \fBspiral\fR\&.

1196 .RE

1197 .PP

1198 \fIinitial_polarity\fR

1199 .RS 4

1200 On which child should a new window be attached when adding a window on a single window tree in automatic mode\&. Accept the following values:

1201 \fBfirst_child\fR,

1202 \fBsecond_child\fR\&.

1203 .RE

1204 .PP

1205 \fIdirectional_focus_tightness\fR

1206 .RS 4

1207 The tightness of the algorithm used to decide whether a window is on the

1208 \fIDIR\fR

1209 side of another window\&. Accept the following values:

1210 \fBhigh\fR,

1211 \fBlow\fR\&.

1212 .RE

1213 .PP

1214 \fIremoval_adjustment\fR

1215 .RS 4

1216 Adjust the brother when unlinking a node from the tree in accordance with the automatic insertion scheme\&.

1217 .RE

1218 .PP

1219 \fIpresel_feedback\fR

1220 .RS 4

1221 Draw the preselection feedback area\&. Defaults to

1222 \fItrue\fR\&.

1223 .RE

1224 .PP

1225 \fIborderless_monocle\fR

1226 .RS 4

1227 Remove borders of tiled windows for the

1228 \fBmonocle\fR

1229 desktop layout\&.

1230 .RE

1231 .PP

1232 \fIgapless_monocle\fR

1233 .RS 4

1234 Remove gaps of tiled windows for the

1235 \fBmonocle\fR

1236 desktop layout\&.

1237 .RE

1238 .PP

1239 \fItop_monocle_padding\fR, \fIright_monocle_padding\fR, \fIbottom_monocle_padding\fR, \fIleft_monocle_padding\fR

1240 .RS 4

1241 Padding space added at the sides of the screen for the

1242 \fBmonocle\fR

1243 desktop layout\&.

1244 .RE

1245 .PP

1246 \fIsingle_monocle\fR

1247 .RS 4

1248 Set the desktop layout to

1249 \fBmonocle\fR

1250 if there\(cqs only one tiled window in the tree\&.

1251 .RE

1252 .PP

1253 \fIpointer_motion_interval\fR

1254 .RS 4

1255 The minimum interval, in milliseconds, between two motion notify events\&.

1256 .RE

1257 .PP

1258 \fIpointer_modifier\fR

1259 .RS 4

1260 Keyboard modifier used for moving or resizing windows\&. Accept the following values:

1261 \fBshift\fR,

1262 \fBcontrol\fR,

1263 \fBlock\fR,

1264 \fBmod1\fR,

1265 \fBmod2\fR,

1266 \fBmod3\fR,

1267 \fBmod4\fR,

1268 \fBmod5\fR\&.

1269 .RE

1270 .PP

1271 \fIpointer_action1\fR, \fIpointer_action2\fR, \fIpointer_action3\fR

1272 .RS 4

1273 Action performed when pressing

1274 \fIpointer_modifier\fR

1275 +

1276 \fIbutton<n>\fR\&. Accept the following values:

1277 \fBmove\fR,

1278 \fBresize_side\fR,

1279 \fBresize_corner\fR,

1280 \fBfocus\fR,

1281 \fBnone\fR\&.

1282 .RE

1283 .PP

1284 \fIclick_to_focus\fR

1285 .RS 4

1286 Button used for focusing a window (or a monitor)\&. The possible values are:

1287 \fBbutton1\fR,

1288 \fBbutton2\fR,

1289 \fBbutton3\fR,

1290 \fBany\fR,

1291 \fBnone\fR\&. Defaults to

1292 \fBbutton1\fR\&.

1293 .RE

1294 .PP

1295 \fIswallow_first_click\fR

1296 .RS 4

1297 Don\(cqt replay the click that makes a window focused if

1298 \fIclick_to_focus\fR

1299 isn\(cqt

1300 \fBnone\fR\&.

1301 .RE

1302 .PP

1303 \fIfocus_follows_pointer\fR

1304 .RS 4

1305 Focus the window under the pointer\&.

1306 .RE

1307 .PP

1308 \fIpointer_follows_focus\fR

1309 .RS 4

1310 When focusing a window, put the pointer at its center\&.

1311 .RE

1312 .PP

1313 \fIpointer_follows_monitor\fR

1314 .RS 4

1315 When focusing a monitor, put the pointer at its center\&.

1316 .RE

1317 .PP

1318 \fImapping_events_count\fR

1319 .RS 4

1320 Handle the next

1321 \fBmapping_events_count\fR

1322 mapping notify events\&. A negative value implies that every event needs to be handled\&.

1323 .RE

1324 .PP

1325 \fIignore_ewmh_focus\fR

1326 .RS 4

1327 Ignore EWMH focus requests coming from applications\&.

1328 .RE

1329 .PP

1330 \fIignore_ewmh_fullscreen\fR

1331 .RS 4

1332 Block the fullscreen state transitions that originate from an EWMH request\&. The possible values are:

1333 \fBnone\fR,

1334 \fBall\fR, or a comma separated list of the following values:

1335 \fBenter\fR,

1336 \fBexit\fR\&.

1337 .RE

1338 .PP

1339 \fIignore_ewmh_struts\fR

1340 .RS 4

1341 Ignore strut hinting from clients requesting to reserve space (i\&.e\&. task bars)\&.

1342 .RE

1343 .PP

1344 \fIcenter_pseudo_tiled\fR

1345 .RS 4

1346 Center pseudo tiled windows into their tiling rectangles\&. Defaults to

1347 \fItrue\fR\&.

1348 .RE

1349 .PP

1350 \fIhonor_size_hints\fR

1351 .RS 4

1352 Apply ICCCM window size hints\&.

1353 .RE

1354 .PP

1355 \fIremove_disabled_monitors\fR

1356 .RS 4

1357 Consider disabled monitors as disconnected\&.

1358 .RE

1359 .PP

1360 \fIremove_unplugged_monitors\fR

1361 .RS 4

1362 Remove unplugged monitors\&.

1363 .RE

1364 .PP

1365 \fImerge_overlapping_monitors\fR

1366 .RS 4

1367 Merge overlapping monitors (the bigger remains)\&.

1368 .RE

1369 .SS "Monitor and Desktop Settings"

1370 .PP

1371 \fItop_padding\fR, \fIright_padding\fR, \fIbottom_padding\fR, \fIleft_padding\fR

1372 .RS 4

1373 Padding space added at the sides of the monitor or desktop\&.

1374 .RE

1375 .SS "Desktop Settings"

1376 .PP

1377 \fIwindow_gap\fR

1378 .RS 4

1379 Size of the gap that separates windows\&.

1380 .RE

1381 .SS "Node Settings"

1382 .PP

1383 \fIborder_width\fR

1384 .RS 4

1385 Window border width\&.

1386 .RE

1387 .SH "POINTER BINDINGS"

1388 .PP

1389 \fIclick_to_focus\fR

1390 .RS 4

1391 Focus the window (or the monitor) under the pointer if the value isn\(cqt

1392 \fBnone\fR\&.

1393 .RE

1394 .PP

1395 \fIpointer_modifier\fR + \fIbutton1\fR

1396 .RS 4

1397 Move the window under the pointer\&.

1398 .RE

1399 .PP

1400 \fIpointer_modifier\fR + \fIbutton2\fR

1401 .RS 4

1402 Resize the window under the pointer by dragging the nearest side\&.

1403 .RE

1404 .PP

1405 \fIpointer_modifier\fR + \fIbutton3\fR

1406 .RS 4

1407 Resize the window under the pointer by dragging the nearest corner\&.

1408 .RE

1409 .sp

1410 The behavior of \fIpointer_modifier\fR + \fIbutton<n>\fR can be modified through the \fIpointer_action<n>\fR setting\&.

1411 .SH "EVENTS"

1412 .PP

1413 \fIreport\fR

1414 .RS 4

1415 See the next section for the description of the format\&.

1416 .RE

1417 .PP

1418 \fImonitor_add <monitor_id> <monitor_name> <monitor_geometry>\fR

1419 .RS 4

1420 A monitor is added\&.

1421 .RE

1422 .PP

1423 \fImonitor_rename <monitor_id> <old_name> <new_name>\fR

1424 .RS 4

1425 A monitor is renamed\&.

1426 .RE

1427 .PP

1428 \fImonitor_remove <monitor_id>\fR

1429 .RS 4

1430 A monitor is removed\&.

1431 .RE

1432 .PP

1433 \fImonitor_swap <src_monitor_id> <dst_monitor_id>\fR

1434 .RS 4

1435 A monitor is swapped\&.

1436 .RE

1437 .PP

1438 \fImonitor_focus <monitor_id>\fR

1439 .RS 4

1440 A monitor is focused\&.

1441 .RE

1442 .PP

1443 \fImonitor_geometry <monitor_id> <monitor_geometry>\fR

1444 .RS 4

1445 The geometry of a monitor changed\&.

1446 .RE

1447 .PP

1448 \fIdesktop_add <monitor_id> <desktop_id> <desktop_name>\fR

1449 .RS 4

1450 A desktop is added\&.

1451 .RE

1452 .PP

1453 \fIdesktop_rename <monitor_id> <desktop_id> <old_name> <new_name>\fR

1454 .RS 4

1455 A desktop is renamed\&.

1456 .RE

1457 .PP

1458 \fIdesktop_remove <monitor_id> <desktop_id>\fR

1459 .RS 4

1460 A desktop is removed\&.

1461 .RE

1462 .PP

1463 \fIdesktop_swap <src_monitor_id> <src_desktop_id> <dst_monitor_id> <dst_desktop_id>\fR

1464 .RS 4

1465 A desktop is swapped\&.

1466 .RE

1467 .PP

1468 \fIdesktop_transfer <src_monitor_id> <src_desktop_id> <dst_monitor_id>\fR

1469 .RS 4

1470 A desktop is transferred\&.

1471 .RE

1472 .PP

1473 \fIdesktop_focus <monitor_id> <desktop_id>\fR

1474 .RS 4

1475 A desktop is focused\&.

1476 .RE

1477 .PP

1478 \fIdesktop_activate <monitor_id> <desktop_id>\fR

1479 .RS 4

1480 A desktop is activated\&.

1481 .RE

1482 .PP

1483 \fIdesktop_layout <monitor_id> <desktop_id> tiled|monocle\fR

1484 .RS 4

1485 The layout of a desktop changed\&.

1486 .RE

1487 .PP

1488 \fInode_add <monitor_id> <desktop_id> <ip_id> <node_id>\fR

1489 .RS 4

1490 A node is added\&.

1491 .RE

1492 .PP

1493 \fInode_remove <monitor_id> <desktop_id> <node_id>\fR

1494 .RS 4

1495 A node is removed\&.

1496 .RE

1497 .PP

1498 \fInode_swap <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR

1499 .RS 4

1500 A node is swapped\&.

1501 .RE

1502 .PP

1503 \fInode_transfer <src_monitor_id> <src_desktop_id> <src_node_id> <dst_monitor_id> <dst_desktop_id> <dst_node_id>\fR

1504 .RS 4

1505 A node is transferred\&.

1506 .RE

1507 .PP

1508 \fInode_focus <monitor_id> <desktop_id> <node_id>\fR

1509 .RS 4

1510 A node is focused\&.

1511 .RE

1512 .PP

1513 \fInode_activate <monitor_id> <desktop_id> <node_id>\fR

1514 .RS 4

1515 A node is activated\&.

1516 .RE

1517 .PP

1518 \fInode_presel <monitor_id> <desktop_id> <node_id> (dir DIR|ratio RATIO|cancel)\fR

1519 .RS 4

1520 A node is preselected\&.

1521 .RE

1522 .PP

1523 \fInode_stack <node_id_1> below|above <node_id_2>\fR

1524 .RS 4

1525 A node is stacked below or above another node\&.

1526 .RE

1527 .PP

1528 \fInode_geometry <monitor_id> <desktop_id> <node_id> <node_geometry>\fR

1529 .RS 4

1530 The geometry of a window changed\&.

1531 .RE

1532 .PP

1533 \fInode_state <monitor_id> <desktop_id> <node_id> tiled|pseudo_tiled|floating|fullscreen on|off\fR

1534 .RS 4

1535 The state of a window changed\&.

1536 .RE

1537 .PP

1539 .RS 4

1540 One of the flags of a node changed\&.

1541 .RE

1542 .PP

1543 \fInode_layer <monitor_id> <desktop_id> <node_id> below|normal|above\fR

1544 .RS 4

1545 The layer of a window changed\&.

1546 .RE

1547 .PP

1548 \fIpointer_action <monitor_id> <desktop_id> <node_id> move|resize_corner|resize_side begin|end\fR

1549 .RS 4

1550 A pointer action occurred\&.

1551 .RE

1552 .sp

1553 Please note that \fBbspwm\fR initializes monitors before it reads messages on its socket, therefore the initial monitor events can\(cqt be received\&.

1554 .SH "REPORT FORMAT"

1555 .sp

1556 Each report event message is composed of items separated by colons\&.

1557 .sp

1558 Each item has the form \fI<type><value>\fR where \fI<type>\fR is the first character of the item\&.

1559 .PP

1560 \fIM<monitor_name>\fR

1561 .RS 4

1562 Focused monitor\&.

1563 .RE

1564 .PP

1565 \fIm<monitor_name>\fR