doc/manual.html (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 |
<!DOCTYPE html> <html> <head> <head> <style type="text/css"> html, body { color: #333; font-family: Helvetica, Arial, sans-serif; font-size: 14px; line-height: 1.6; word-wrap: break-word; max-width: 1000px; margin: 0 auto; } h1, h2, h3, h4, h5, h6 { margin-top: 1em; margin-bottom: 1rem; } h1 { font-size: 1.8rem; font-weight: normal; font-style: normal; border-bottom: 1px solid #eee; } h2 { font-size: 1.5rem; font-weight: normal; font-style: normal; border-bottom: 1px solid #eee; } h3 { font-size: 1.2rem; font-weight: bold; font-style: normal; } h4 { font-size: 1rem; font-weight: bold; font-style: normal; } h5 { font-size: 1rem; font-weight: bold; font-style: italic; } h6 { font-size: 1rem; font-weight: normal; font-style: italic; } code, kbd, pre { font-family: monospace; font-size: 1em; } table { border-spacing: 0; border-collapse: collapse; } td, th { padding: 0; } asdff { box-sizing: border-box; } a { color: #46c; text-decoration: none; } a:hover, a:active { text-decoration: underline; } a:not([href]) { color: inherit; text-decoration: none; } hr { box-sizing: content-box; height: 0; margin: 15px 0; overflow: hidden; background: transparent; border: 0; border-bottom: 1px solid #ddd; } hr::before { display: table; content: ""; } hr::after { display: table; clear: both; content: ""; } p { margin-top: 0; margin-bottom: 0.7em; } blockquote { margin: 0; } code { font-family: "Liberation Mono", monospace; font-size: 1em; } pre { margin-top: 0; margin-bottom: 0; font: 1em "Liberation Mono", monospace; overflow-x: auto; } blockquote { padding: 0 15px; color: #777; border-left: 4px solid #ddd; } blockquote>:first-child { margin-top: 0; } blockquote>:last-child { margin-bottom: 0; } table { display: block; width: 100%; overflow: auto; word-break: normal; } table th { font-weight: bold; } table th, table td { padding: 6px 13px; border: 1px solid #ddd; } table tr { background-color: #fff; border-top: 1px solid #ccc; } table tr:nth-child(2n) { background-color: #f8f8f8; } code { padding: 0.2em; margin: 0; font-size: 0.95em; background-color: #eee; } pre { word-wrap: normal; background-color: #eee; margin: 1em 0; padding: 0.2em; } </style> </head> <body> <h1 id="tint2"><span class="md2man-title">TINT2</span><a name="tint2" href="#tint2" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>tint2 - lightweight panel/taskbar</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>tint2 [-c path_to_config_file]</code></p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>tint2 is a simple panel/taskbar made for modern X window managers. It was specifically made for Openbox but it should also work with other window managers (GNOME, KDE, XFCE etc.).</p><p>Features:</p> <ul> <li>Panel with taskbar, system tray, clock and launcher icons;</li> <li>Easy to customize: color/transparency on fonts, icons, borders and backgrounds;</li> <li>Pager like capability: move tasks between workspaces (virtual desktops), switch between workspaces;</li> <li>Multi-monitor capability: create one panel per monitor, showing only the tasks from the current monitor;</li> <li>Customizable mouse events.</li> </ul> <p>Goals:</p> <ul> <li>Be unintrusive and light (in terms of memory, CPU and aesthetic);</li> <li>Follow the freedesktop.org specifications;</li> <li>Make certain workflows, such as multi-desktop and multi-monitor, easy to use.</li> </ul> <h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-c path_to_config_file</code></dt><dd>Specifies which configuration file to use instead of the default.</dd></dl><h2 id="configuration">CONFIGURATION<a name="configuration" href="#configuration" class="md2man-permalink" title="permalink"></a></h2><h3 id="table-of-contents">Table of contents<a name="table-of-contents" href="#table-of-contents" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p><a href="#introduction">Introduction</a></p></li> <li><p><a href="#backgrounds-and-borders">Backgrounds and borders</a></p></li> <li><p><a href="#panel">Panel</a></p></li> <li><p><a href="#launcher">Launcher</a></p></li> <li><p><a href="#taskbar-pager">Taskbar/Pager</a></p></li> <li><p><a href="#taskbar-buttons">Taskbar buttons</a></p></li> <li><p><a href="#mouse-actions-for-taskbar-buttons">Mouse actions for taskbar buttons</a></p></li> <li><p><a href="#system-tray">System tray</a></p></li> <li><p><a href="#clock">Clock</a></p></li> <li><p><a href="#tooltip">Tooltip</a></p></li> <li><p><a href="#battery">Battery</a></p></li> <li><p><a href="#executor">Executor</a></p></li> <li><p><a href="#example-configuration">Example configuration</a></p></li> </ul> <h3 id="introduction">Introduction<a name="introduction" href="#introduction" class="md2man-permalink" title="permalink"></a></h3><p>These are instructions for configuring tint2 directly by editing its config file. You may also use instead the graphical interface <code>tint2conf</code>.</p><p>The first time you run tint2, it will create the config file in <code>$HOME/.config/tint2/tint2rc</code> (This applies if you have done a clean install. Running tint2 in the source directory without doing 'make install' will not create the config file.)</p><p>You can also specify another file on the command line with the -c option, e.g.: <code>tint2 -c $HOME/tint2.conf</code>. This can be used to run multiple instances of tint2 that use different settings.</p><p>If you change the config file while tint2 is running, the command <code>killall -SIGUSR1 tint2</code> will force tint2 to reload it.</p><p>All the configuration options supported in the config file are listed below. Try to respect as much as possible the order of the options as given below.</p><h3 id="backgrounds-and-borders">Backgrounds and borders<a name="backgrounds-and-borders" href="#backgrounds-and-borders" class="md2man-permalink" title="permalink"></a></h3><p>The tint2 config file starts with the options defining background elements with borders:</p> <ul> <li><p><code>rounded = number_of_pixels</code> : the corner radius</p></li> <li><p><code>border_width = integer</code> : the border width in pixels</p></li> <li><p><code>border_sides = LRTB</code> : the sides to draw the border on (left, right, top, bottom). If not specified, all sides are used. <em>(since 0.12.12)</em></p></li> <li><p><code>background_color = color opacity</code></p> <ul> <li><code>color</code> is specified in hex RGB, e.g. #ff0000 is red</li> <li><code>opacity</code> varies from (0 to 100), where 0 is fully transparent, 100 is fully opaque. Note that for a transparent panel you need to enable a desktop compositor (such as compton or compiz).</li> </ul></li> <li><p><code>border_color = color opacity</code></p> <ul> <li><code>color</code> is specified in hex RGB, e.g. #ff0000 is red</li> <li><code>opacity</code> varies from (0 to 100), where 0 is fully transparent, 100 is fully opaque</li> </ul></li> <li><p><code>background_color_hover = color opacity</code> (default: same as <code>background_color</code>) <em>(since 0.12.3)</em></p> <ul> <li><code>color</code> is specified in hex RGB, e.g. #ff0000 is red</li> <li><code>opacity</code> varies from (0 to 100), where 0 is fully transparent, 100 is fully opaque. Note that for a transparent panel you need to enable a desktop compositor (such as compton or compiz)</li> </ul></li> <li><p><code>border_color_hover = color opacity</code> (default: same as <code>border_color</code>) <em>(since 0.12.3)</em></p> <ul> <li><code>color</code> is specified in hex RGB, e.g. #ff0000 is red</li> <li><code>opacity</code> varies from (0 to 100), where 0 is fully transparent, 100 is fully opaque</li> </ul></li> <li><p><code>background_color_pressed = color opacity</code> (default: same as <code>background_color_hover</code>) <em>(since 0.12.3)</em></p> <ul> <li><code>color</code> is specified in hex RGB, e.g. #ff0000 is red</li> <li><code>opacity</code> varies from (0 to 100), where 0 is fully transparent, 100 is fully opaque. Note that for a transparent panel you need to enable a desktop compositor (such as compton or compiz)</li> </ul></li> <li><p><code>border_color_pressed = color opacity</code> (default: same as <code>border_color_hover</code>) <em>(since 0.12.3)</em></p> <ul> <li><code>color</code> is specified in hex RGB, e.g. #ff0000 is red</li> <li><code>opacity</code> varies from (0 to 100), where 0 is fully transparent, 100 is fully opaque</li> </ul></li> </ul> <p>You can define as many backgrounds as you want. For example, the following config defines two backgrounds:</p><pre class="highlight plaintext"><code>rounded = 1 border_width = 0 background_color = #282828 100 border_color = #000000 0 rounded = 1 border_width = 0 background_color = #f6b655 90 border_color = #cccccc 40 </code></pre> <p>tint2 automatically identifies each background with a number starting from 1 (1, 2, ...). Afterwards, you can apply a background to objects (panel, taskbar, task, clock, systray) using the background id, for example:</p><pre class="highlight plaintext"><code>panel_background_id = 1 taskbar_background_id = 0 task_background_id = 0 task_active_background_id = 2 systray_background_id = 0 clock_background_id = 0 </code></pre> <p>Identifier 0 refers to a special background which is fully transparent, identifier 1 applies the first background defined in the config file etc.</p><h3 id="panel">Panel<a name="panel" href="#panel" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p><code>panel_items = LTSBC</code> defines the items tint2 will show and the order of those items. Each letter refers to an item, defined as:</p> <ul> <li><code>L</code> shows the Launcher</li> <li><code>T</code> shows the Taskbar</li> <li><code>S</code> shows the Systray (also called notification area)</li> <li><code>B</code> shows the Battery status</li> <li><code>C</code> shows the Clock</li> <li><code>F</code> adds an extensible spacer (freespace). Has no effect if <code>T</code> is also present. <em>(since 0.12)</em></li> <li><code>E</code> adds an executor plugin. You can specify more than one. <em>(since 0.12.4)</em></li> </ul> <p>For example, <code>panel_items = STC</code> will show the systray, the taskbar and the clock (from left to right).</p></li> <li><p><code>panel_monitor = monitor (all or 1 or 2 or ...)</code> : Which monitor tint2 draws the panel on</p> <ul> <li>The first monitor is <code>1</code></li> <li>Use <code>panel_monitor = all</code> to get a separate panel per monitor</li> </ul></li> <li><p><code>primary_monitor_first = boolean (0 or 1)</code> : Place the primary monitor before all the other monitors in the list. <em>(since 0.12.4)</em></p></li> </ul> <p><img src="images/panel_padding.jpg" alt=""></p> <ul> <li><p><code>panel_position = vertical_position horizontal_position orientation</code></p> <ul> <li><code>vertical_position</code> is one of: <code>bottom</code>, <code>top</code>, <code>center</code></li> <li><code>horizontal_position</code> is one of: <code>left</code>, <code>right</code>, <code>center</code></li> <li><code>orientation</code> is one of: <code>horizontal</code>, <code>vertical</code></li> </ul></li> <li><p><code>panel_size = width height</code></p> <ul> <li><code>width</code> and <code>height</code> can be specified without units (e.g. <code>123</code>) as pixels, or followed by <code>%</code> as percentages of the monitor size (e.g. <code>50%</code>). Use <code>100%</code> for full monitor width/height. Example:</li> </ul></li> </ul> <pre class="highlight plaintext"><code># The panel's width is 94% the size of the monitor, the height is 30 pixels: panel_size = 94% 30 </code></pre> <ul> <li><code>panel_margin = horizontal_margin vertical_margin</code> : The margins define the distance between the panel and the horizontal/vertical monitor edge. Use <code>0</code> to obtain a panel with the same size as the edge of the monitor (no margin).</li> </ul> <p><img src="images/panel_size_margin.jpg" alt=""></p> <ul> <li><code>panel_padding = horizontal_padding vertical_padding spacing</code> : Please refer to the image below.</li> </ul> <p><img src="images/panel_padding.jpg" alt=""></p> <ul> <li><p><code>font_shadow = boolean (0 or 1)</code></p></li> <li><p><code>panel_background_id = integer</code> : Which background to use for the panel.</p></li> <li><p><code>wm_menu = boolean (0 or 1)</code> : Defines if tint2 forwards unhandled mouse events to your window manager. Useful for window managers such as openbox, which display the start menu if you right click on the desktop.</p></li> <li><p><code>panel_dock = boolean (0 or 1)</code> : Defines if tint2 is placed into the window manager's dock. For the openbox window manager it is advised to also use a modifier for the moveButton option, otherwise the mouse click is not forwarded to tint2 (in ~/.config/openbox/rc.xml).</p></li> <li><p><code>panel_layer = bottom/normal/top</code> : Places tint2 into the bottom/normal/top layer. This is helpful for specifying if the panel can be covered by other windows or not. The default is the bottom layer, but with real transparency normal or top layer may be a nice alternative.</p></li> <li><p><code>strut_policy = follow_size/minimum/none</code> : STRUTs are used by the window manager to decide the size of maximized windows. Note: on multi-monitor (Xinerama) setups, the panel must be placed at the edge (not in the middle) of the virtual screen for this to work correctly.</p> <ul> <li><code>follow_size</code> means that the maximized windows always resize to have a common edge with tint2.</li> <li><code>minimum</code> means that the maximized windows always expand to have a common edge with the hidden panel. This is useful if the <code>autohide</code> option is enabled.</li> <li><code>none</code> means that the maximized windows use the full screen size.</li> </ul></li> <li><p><code>panel_window_name = string</code> : Defines the name of the panel's window. Default: 'tint2'. <em>(since 0.12)</em></p></li> <li><p><code>disable_transparency = boolean (0 or 1)</code> : Whether to disable transparency instead of detecting if it is supported. Useful on broken graphics stacks. <em>(since 0.12)</em></p></li> <li><p><code>mouse_effects = boolean (0 or 1)</code> : Whether to enable mouse hover effects for clickable items. <em>(since 0.12.3)</em></p></li> <li><p><code>mouse_hover_icon_asb = alpha (0 to 100) saturation (-100 to 100) brightness (-100 to 100)</code> : Adjusts the icon color and transparency on mouse hover (works only when mouse_effects = 1).` <em>(since 0.12.3)</em></p></li> <li><p><code>mouse_pressed_icon_asb = alpha (0 to 100) saturation (-100 to 100) brightness (-100 to 100)</code> : Adjusts the icon color and transparency on mouse press (works only when mouse_effects = 1).` <em>(since 0.12.3)</em></p></li> <li><p><code>autohide = boolean (0 or 1)</code> : Whether to enable panel hiding when the mouse cursor exists the panel.</p></li> <li><p><code>autohide_show_timeout = float</code> : Show timeout in seconds after the mouse cursor enters the panel. Use '.' as decimal separator.</p></li> <li><p><code>autohide_hide_timeout = float</code> : Hide timeout in seconds after the mouse cursor exits the panel. Use '.' as decimal separator.</p></li> <li><p><code>autohide_height = integer</code> : panel height (width for vertical panels) in hidden mode.</p></li> </ul> <h3 id="launcher">Launcher<a name="launcher" href="#launcher" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p><code>launcher_item_app = path_to_application</code> : Each <code>launcher_item_app</code> must be a file path to a .desktop file following the freedesktop.org <a href="http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html">specification</a>. The paths may begin with <code>~</code>, which is expanded to the path of the user's home directory. If only a file name is specified, the file is search in the standard application directories (<code>$XDG_DATA_HOME/applications</code>, <code>~/.local/share/applications</code>, <code>$XDG_DATA_DIRS/applications</code>, <code>/usr/local/share/applications</code>, <code>/usr/share/applications</code>, <code>/opt/share/applications</code>).</p></li> <li><p><code>launcher_apps_dir = path_to_directory</code> : Specifies a path to a directory from which the launcher is loading all .desktop files (all subdirectories are explored recursively). Can be used multiple times. The path may begin with <code>~</code>, which is expanded to the path of the user's home directory. <em>(since 0.12)</em></p></li> <li><p><code>launcher_background_id = integer</code> : Defines which background to use.</p></li> <li><p><code>launcher_icon_background_id = integer</code> : Defines which background to use for icons.</p></li> <li><p><code>launcher_padding = horizontal_padding vertical_padding spacing</code></p></li> <li><p><code>launcher_icon_size = integer</code> : The launcher icon size, in pixels.</p></li> <li><p><code>launcher_icon_theme = name_of_theme</code> : (Optional) Uses the specified icon theme to display shortcut icons. Note that tint2 will detect and use the icon theme of your desktop if you have an XSETTINGS manager running (which you probably do), unless <code>launcher_icon_theme_override = 1</code>.</p></li> <li><p><code>launcher_icon_theme_override = boolean (0 or 1)</code> : Whether <code>launcher_icon_theme</code> overrides the value obtained from the XSETTINGS manager. <em>(since 0.12)</em></p></li> <li><p><code>launcher_icon_asb = alpha (0 to 100) saturation (-100 to 100) brightness (-100 to 100)</code> : Adjusts the icon color and transparency.</p></li> <li><p><code>launcher_tooltip = boolean (0 or 1)</code> : Whether to show tooltips for the launcher icons.</p></li> <li><p><code>startup_notifications = boolean (0 or 1)</code> : Whether to show startup notifications when starting applications from the launcher. <em>(since 0.12)</em></p></li> </ul> <h3 id="taskbar-pager">Taskbar / Pager<a name="taskbar-pager" href="#taskbar-pager" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p><code>taskbar_mode = single_desktop/multi_desktop</code></p> <ul> <li><code>single_desktop</code> : Shows a normal taskbar listing the tasks running on the current virtual desktop (also known as 'workspace');</li> <li><code>multi_desktop</code> : Pager like capability. Shows multiple taskbars, one per virtual desktop, with which: <ul> <li>You can drag-and-drop tasks between virtual desktops;</li> <li>You can switch between virtual desktops.</li> </ul></li> </ul></li> <li><p><code>taskbar_distribute_size = boolean (0 or 1)</code> : If enabled, in multi-desktop mode distributes between taskbars the available size proportionally to the number of tasks. Default: disabled. <em>(since 0.12)</em></p></li> <li><p><code>taskbar_padding = horizontal_padding vertical_padding spacing</code></p></li> </ul> <p><img src="images/taskbar_padding.jpg" alt=""></p> <ul> <li><p><code>taskbar_background_id = integer</code> : Which background to use</p></li> <li><p><code>taskbar_active_background_id = integer</code> : Which background to use for the taskbar of the current virtual desktop.</p></li> <li><p><code>taskbar_hide_inactive_tasks = boolean (0 or 1)</code> : If enabled, the taskbar shows only the active task. <em>(since 0.12)</em></p></li> <li><p><code>taskbar_hide_different_monitor = boolean (0 or 1)</code> : If enabled, the taskbar shows only the tasks from the current monitor. Useful when running different tint2 instances on different monitors, each one having its own config. <em>(since 0.12)</em></p></li> <li><p><code>taskbar_always_show_all_desktop_tasks = boolean (0 or 1)</code> : Has effect only if <code>taskbar_mode = multi_desktop</code>. If enabled, tasks that appear on all desktops are shown on all taskbars. Otherwise, they are shown only on the taskbar of the current desktop. <em>(since 0.12.4)</em></p></li> <li><p><code>taskbar_sort_order = none/title/center</code> : Specifies the sort order of the tasks on the taskbar. <em>(since 0.12)</em></p> <ul> <li><code>none</code> : No sorting. New tasks are simply appended at the end of the taskbar when they appear.</li> <li><code>title</code> : Sorts the tasks by title.</li> <li><code>center</code> : Sorts the tasks by their window centers.</li> <li><code>mru</code> : Shows the most recently used tasks first. <em>(since 0.12.4)</em></li> <li><code>lru</code> : Shows the most recently used tasks last. <em>(since 0.12.4)</em></li> </ul></li> <li><p><code>task_align = left/center/right</code> : Specifies the alignment of the tasks on the taskbar. Default: left.</p></li> <li><p><code>taskbar_name = boolean (0 or 1)</code> : Whether to show the virtual desktop name in the taskbar.</p></li> <li><p><code>taskbar_name_padding = padding</code> : Padding for the virtual desktop name.</p></li> <li><p><code>taskbar_name_background_id = integer</code> : Which background to use for the desktop name.</p></li> <li><p><code>taskbar_name_font = [FAMILY-LIST] [STYLE-OPTIONS] [SIZE]</code> : Font configuration for the desktop name.</p></li> <li><p><code>taskbar_name_font_color = color opacity (0 to 100)</code> : Font color for the desktop name.</p></li> <li><p><code>taskbar_name_active_background_id = integer</code> : Which background to use for the name of the current desktop.</p></li> <li><p><code>taskbar_name_active_font_color = color opacity (0 to 100)</code> : Font color for the name of the current desktop.</p></li> </ul> <h1 id="taskbar-buttons">Taskbar buttons<a name="taskbar-buttons" href="#taskbar-buttons" class="md2man-permalink" title="permalink"></a></h1><p>The following options configure the task buttons in the taskbar:</p> <ul> <li><p><code>task_icon = boolean (0 or 1)</code> : Whether to display the task icon.</p></li> <li><p><code>task_text = boolean (0 or 1)</code> : Whether to display the task text.</p></li> <li><p><code>task_centered = boolean (0 or 1)</code> : Whether the task text is centered.</p></li> <li><p><code>task_tooltip = boolean (0 or 1)</code> : Whether to show tooltips for tasks.</p></li> <li><p><code>task_maximum_size = width height</code></p> <ul> <li><code>width</code> is used with horizontal panels to limit the size of the tasks. Use <code>width = 0</code> to get full taskbar width.</li> <li><code>height</code> is used with vertical panels.</li> </ul></li> <li><p><code>task_padding = horizontal_padding vertical_padding spacing</code></p></li> <li><p><code>urgent_nb_of_blink = integer</code> : Number of blinks on 'get attention' events.</p></li> </ul> <p><img src="images/task_padding.jpg" alt=""></p> <ul> <li><p><code>task_font = [FAMILY-LIST] [STYLE-OPTIONS] [SIZE]</code></p></li> <li><p><code>task_font_color = color opacity (0 to 100)</code></p></li> <li><p><code>task_icon_asb = alpha (0 to 100) saturation (-100 to 100) brightness (-100 to 100)</code> : Adjust the task icon's color and transparency.</p></li> <li><p><code>task_background_id = integer</code> : Which background to use for non selected tasks</p></li> </ul> <dl><dt>For the next 3 options STATUS can be <code>active</code> / <code>iconified</code> / <code>urgent</code>:</dt><dd>* <code>task_STATUS_font_color = color opacity (0 to 100)</code></dd></dl> <ul> <li><p><code>task_STATUS_icon_asb = alpha (0 to 100) saturation (-100 to 100) brightness (-100 to 100)</code> : Adjusts the task icon's color and transparency.</p></li> <li><p><code>task_STATUS_background_id = integer</code> : Which background to use for the task.</p></li> </ul> <h3 id="mouse-actions-for-taskbar-buttons">Mouse actions for taskbar buttons<a name="mouse-actions-for-taskbar-buttons" href="#mouse-actions-for-taskbar-buttons" class="md2man-permalink" title="permalink"></a></h3><p>The possible mouse events are: <code>left, middle, right, scroll_up, scroll_down</code>.</p><p>The possible mouse actions are: <code>none, close, toggle, iconify, shade, toggle_iconify, maximize_restore, desktop_left, desktop_right, next_task, prev_task</code>.</p><p>Use <code>mouse_event = action</code> to customize mouse actions. Example: <code> mouse_middle = none mouse_right = close mouse_scroll_up = toggle mouse_scroll_down = iconify </code></p><dl><dt>The action semantics:</dt><dd>* <code>none</code> : If <code>wm_menu = 1</code> is set, the mouse event is forwarded to the window manager. Otherwise it is ignored. * <code>close</code> : close the task * <code>toggle</code> : toggle the task * <code>iconify</code> : iconify (minimize) the task * <code>toggle_iconify</code> : toggle or iconify the task * <code>maximize_restore</code> : maximized or minimized the task * <code>shade</code> : shades (collapses) the task * <code>desktop_left</code> : send the task to the desktop on the left * <code>desktop_right</code> : send the task to the desktop on the right * <code>next_task</code> : send the focus to next task * <code>prev_task</code> : send the focus to previous task</dd></dl><h3 id="system-tray">System Tray<a name="system-tray" href="#system-tray" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p><code>systray_padding = horizontal_padding vertical_padding spacing</code></p></li> <li><p><code>systray_background_id = integer</code> : Which background to use.</p></li> <li><p><code>systray_sort = ascending/descending/left2right/right2left</code> : Specifies the sorting order for the icons in the systray: in ascending/descending alphabetical order of the icon title, or always add icons to the right/left (note that with <code>left2right</code> or <code>right2left</code> the order can be different on panel restart).</p></li> <li><p><code>systray_icon_size = max_icon_size</code> : Set the maximum system tray icon size to <code>number</code>. Set to <code>0</code> for automatic icon sizing.</p></li> <li><p><code>systray_icon_asb = alpha (0 to 100) saturation (-100 to 100) brightness (-100 to 100)</code> : Adjust the systray icons color and transparency.</p></li> <li><p><code>systray_monitor = integer (1, 2, ...)</code> : On which monitor to draw the systray. The first monitor is <code>1</code>. <em>(since 0.12)</em></p></li> </ul> <h3 id="clock">Clock<a name="clock" href="#clock" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p><code>time1_format = %H:%M</code> : The format used by the first line of the clock.</p> <ul> <li><code>time1_format</code>, <code>time2_format</code> and <code>clock_tooltip</code> use the 'strftime' syntax. More info can be found here: <a href="http://www.manpagez.com/man/3/strftime/">http://www.manpagez.com/man/3/strftime/</a></li> <li>To hide the clock, comment <code>time1_format</code> and <code>time2_format</code>.</li> </ul></li> <li><p><code>time1_timezone = :US/Hawaii</code></p> <ul> <li><code>time1_timezone</code>, <code>time2_timezone</code> and <code>clock_tooltip_timezone</code> can be used to specify a timezone. If you do not specify a value the system-wide timezone is used. The timezones can usually be found in <code>/usr/share/zoneinfo</code>. If your timezones are in a different directory, you need to specify the absolute path, e.g. <code>time1_timezone = :/different/zoneinfo/dir/US/Hawaii</code> Always prepend the timezone with a ':'</li> </ul></li> <li><p><code>time1_font = [FAMILY-LIST] [STYLE-OPTIONS] [SIZE]</code></p></li> <li><p><code>time2_format = %A %d %B</code></p></li> <li><p><code>time2_timezone = :Europe/Berlin</code></p></li> <li><p><code>time2_font = [FAMILY-LIST] [STYLE-OPTIONS] [SIZE]</code></p></li> <li><p><code>clock_font_color = color opacity (0 to 100)</code></p></li> <li><p><code>clock_padding = horizontal_padding vertical_padding</code></p></li> <li><p><code>clock_background_id = integer</code> : Which background to use</p></li> <li><p><code>clock_tooltip = %a, %d. %b %Y</code> : Format for the clock's tooltip.</p></li> <li><p><code>clock_tooltip_timezone = :UTC</code></p></li> <li><p><code>clock_lclick_command = text</code> : Command to execute on left click.</p></li> <li><p><code>clock_rclick_command = text</code> : Command to execute on right click.</p></li> <li><p><code>clock_mclick_command = text</code> : Command to execute on middle click. <em>(since 0.12.1)</em></p></li> <li><p><code>clock_uwheel_command = text</code> : Command to execute on wheel scroll up. <em>(since 0.12.1)</em></p></li> <li><p><code>clock_dwheel_command = text</code> : Command to execute on wheel scroll down. <em>(since 0.12.1)</em></p></li> </ul> <h3 id="tooltip">Tooltip<a name="tooltip" href="#tooltip" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p><code>tooltip_padding = horizontal_padding vertical_padding</code></p></li> <li><p><code>tooltip_show_timeout = float</code> : Delay to show the tooltip in seconds. Use <code>.</code> as decimal separator.</p></li> <li><p><code>tooltip_hide_timeout = float</code> : Delay to hide the tooltip in seconds. Use <code>.</code> as decimal separator.</p></li> <li><p><code>tooltip_background_id = integer</code> : Which background to use for tooltips. Note that with fake transparency the alpha channel and corner radius options are not respected.</p></li> <li><p><code>tooltip_font_color = color opacity (0 to 100)</code></p></li> <li><p><code>tooltip_font = [FAMILY-LIST] [STYLE-OPTIONS] [SIZE]</code></p></li> </ul> <h3 id="battery">Battery<a name="battery" href="#battery" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p><code>battery_hide = never/integer (0 to 100)</code> : At what battery percentage the battery item is hidden.</p></li> <li><p><code>battery_low_status = integer</code>: At what battery percentage the low command is executed.</p></li> <li><p><code>battery_low_cmd = notify-send "battery low"</code> : Command to execute when the battery is low.</p></li> <li><p><code>bat1_font = [FAMILY-LIST] [STYLE-OPTIONS] [SIZE]</code></p></li> <li><p><code>bat2_font = [FAMILY-LIST] [STYLE-OPTIONS] [SIZE]</code></p></li> <li><p><code>battery_font_color = color opacity (0 to 100)</code></p></li> <li><p><code>battery_padding = horizontal_padding vertical_padding</code></p></li> <li><p><code>battery_background_id = integer</code> : Which background to use for the battery.</p></li> <li><p><code>battery_tooltip_enabled = boolean (0 or 1)</code> : Enable/disable battery tooltips. <em>(since 0.12.3)</em></p></li> <li><p><code>battery_lclick_command = text</code> : Command to execute on left click. <em>(since 0.12.1)</em></p></li> <li><p><code>battery_rclick_command = text</code> : Command to execute on right click. <em>(since 0.12.1)</em></p></li> <li><p><code>battery_mclick_command = text</code> : Command to execute on middle click. <em>(since 0.12.1)</em></p></li> <li><p><code>battery_uwheel_command = text</code> : Command to execute on wheel scroll up. <em>(since 0.12.1)</em></p></li> <li><p><code>battery_dwheel_command = text</code> : Command to execute on wheel scroll down. <em>(since 0.12.1)</em></p></li> <li><p><code>ac_connected_cmd = text</code> : Command to execute when the power adapter is plugged in. <em>(since 0.12.3)</em></p></li> <li><p><code>ac_disconnected_cmd = text</code> : Command to execute when the power adapter is unplugged. <em>(since 0.12.3)</em></p></li> </ul> <h3 id="executor">Executor<a name="executor" href="#executor" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p><code>execp = new</code> : Begins the configuration of a new executor plugin. Multiple such plugins are supported; just use multiple <code>E</code>s in <code>panel_items</code>. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_command = text</code> : Command to execute. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_interval = integer</code> : The command is executed again after <code>execp_interval</code> seconds from the moment it exits. If zero, the command is executed only once. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_continuous = integer</code> : If non-zero, the last <code>execp_continuous</code> lines from the output of the command are displayed, every <code>execp_continuous</code> lines; this is useful for showing the output of commands that run indefinitely, such as <code>ping 127.0.0.1</code>. If zero, the output of the command is displayed after it finishes executing. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_has_icon = boolean (0 or 1)</code> : If <code>execp_has_icon = 1</code>, the first line printed by the command is interpreted as a path to an image file. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_cache_icon = boolean (0 or 1)</code> : If <code>execp_cache_icon = 0</code>, the image is reloaded each time the command is executed (useful if the image file is changed on disk by the program executed by <code>execp_command</code>). <em>(since 0.12.4)</em></p></li> <li><p><code>execp_icon_w = integer</code> : You can use <code>execp_icon_w</code> and <code>execp_icon_h</code> to resize the image. If one of them is zero/missing, the image is rescaled proportionally. If both of them are zero/missing, the image is not rescaled. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_icon_h = integer</code> : See <code>execp_icon_w</code>. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_tooltip = text</code> : The tooltip. Leave it empty to not display a tooltip. Not specifying this option leads to showing an automatically generated tooltip with information about when the command was last executed. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_font = [FAMILY-LIST] [STYLE-OPTIONS] [SIZE]</code> : The font used to draw the text. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_font_color = color opacity</code> : The font color. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_markup = boolean (0 or 1)</code> : If non-zero, the output of the command is treated as Pango markup, which allows rich text formatting. The format is <a href="https://developer.gnome.org/pygtk/stable/pango-markup-language.html">documented here</a>. Note that using this with commands that print data downloaded from the Internet is a possible security risk. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_background_id = integer</code> : Which background to use. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_centered = boolean (0 or 1)</code> : Whether to center the text. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_padding = horizontal_padding vertical_padding spacing_between_icon_and_text</code> <em>(since 0.12.4)</em></p></li> <li><p><code>execp_lclick_command = text</code> : Command to execute on left click. If not defined, <code>execp_command</code> is executed immediately, unless it is currently running. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_mclick_command = text</code> : Command to execute on right click. If not defined, <code>execp_command</code> is executed immediately, unless it is currently running. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_rclick_command = text</code> : Command to execute on middle click. If not defined, <code>execp_command</code> is executed immediately, unless it is currently running. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_uwheel_command = text</code> : Command to execute on wheel scroll up. If not defined, <code>execp_command</code> is executed immediately, unless it is currently running. <em>(since 0.12.4)</em></p></li> <li><p><code>execp_dwheel_command = text</code> : Command to execute on wheel scroll down. If not defined, <code>execp_command</code> is executed immediately, unless it is currently running. <em>(since 0.12.4)</em></p></li> </ul> <h4 id="executor-samples">Executor samples<a name="executor-samples" href="#executor-samples" class="md2man-permalink" title="permalink"></a></h4><h5 id="print-the-hostname">Print the hostname<a name="print-the-hostname" href="#print-the-hostname" class="md2man-permalink" title="permalink"></a></h5><pre class="highlight plaintext"><code>execp = new execp_command = hostname execp_interval = 0 </code></pre> <h5 id="print-disk-usage-for-the-root-partition-every-10-seconds">Print disk usage for the root partition every 10 seconds<a name="print-disk-usage-for-the-root-partition-every-10-seconds" href="#print-disk-usage-for-the-root-partition-every-10-seconds" class="md2man-permalink" title="permalink"></a></h5><pre class="highlight plaintext"><code>execp = new execp_command = df -h | awk '/\/$/ { print $6 ": " $2 " " $5}' execp_interval = 10 </code></pre> <h5 id="button-with-icon-and-rich-text-executes-command-when-clicked">Button with icon and rich text, executes command when clicked<a name="button-with-icon-and-rich-text-executes-command-when-clicked" href="#button-with-icon-and-rich-text-executes-command-when-clicked" class="md2man-permalink" title="permalink"></a></h5><pre class="highlight plaintext"><code>execp = new execp_command = echo /usr/share/icons/elementary-xfce/emblems/24/emblem-colors-blue.png; echo '<span foreground="#7f7">Click</span> <span foreground="#77f">me</span> <span foreground="#f77">pls</span>' execp_has_icon = 1 execp_interval = 0 execp_centered = 1 execp_font = sans 9 execp_markup = 1 execp_font_color = #aaffaa 100 execp_padding = 2 0 execp_tooltip = I will tell you a secret... execp_lclick_command = zenity --info "--text=$(uname -sr)" execp_background_id = 2 </code></pre> <h5 id="desktop-pager-with-text">Desktop pager with text<a name="desktop-pager-with-text" href="#desktop-pager-with-text" class="md2man-permalink" title="permalink"></a></h5><pre class="highlight plaintext"><code>execp = new execp_command = xprop -root -spy | awk '/^_NET_CURRENT_DESKTOP/ { print "Workspace " ($3 + 1) ; fflush(); }' execp_interval = 1 execp_continuous = 1 </code></pre> <h5 id="desktop-pager-with-icon">Desktop pager with icon<a name="desktop-pager-with-icon" href="#desktop-pager-with-icon" class="md2man-permalink" title="permalink"></a></h5><pre class="highlight plaintext"><code>execp_command = xprop -root -spy | awk -v home="$HOME" '/^_NET_CURRENT_DESKTOP/ { print home "/.config/myPager/" ($3 + 1) ".png\n" ; fflush(); }' execp_interval = 1 execp_has_icon = 1 execp_cache_icon = 1 execp_continuous = 2 </code></pre> <h5 id="round-trip-time-to-the-gateway-refreshed-every-second">Round-trip time to the gateway, refreshed every second<a name="round-trip-time-to-the-gateway-refreshed-every-second" href="#round-trip-time-to-the-gateway-refreshed-every-second" class="md2man-permalink" title="permalink"></a></h5><pre class="highlight plaintext"><code>execp = new execp_command = ping -i 1 -W 1 -O -D -n $(ip route | grep default | grep via | grep -o '[0-9]*\.[0-9]*\.[0-9]*\.[0-9]*') | awk '/no/ { print "<span foreground=\"#faa\">timeout</span>"; fflush(); }; /time=/ { gsub(/time=/, "", $8); printf "<span foreground=\"#7af\">%3.0f %s</span>\n", $8, $9; fflush(); } ' execp_continuous = 1 execp_interval = 1 execp_markup = 1 </code></pre> <h5 id="memory-usage">Memory usage<a name="memory-usage" href="#memory-usage" class="md2man-permalink" title="permalink"></a></h5><pre class="highlight plaintext"><code>execp = new execp_command = free -s 2 | awk '/^-/ { printf "Mem: '$(free -h | awk '/^Mem:/ { print $2 }')' %.0f%\n", 100*$3/($3+$4); fflush(stdout) }' execp_interval = 1 execp_continuous = 1 </code></pre> <h5 id="network-load">Network load<a name="network-load" href="#network-load" class="md2man-permalink" title="permalink"></a></h5><pre class="highlight plaintext"><code># Note the use of "stdbuf -oL" to force the program to flush the output line by line. execp = new execp_command = stdbuf -oL bwm-ng -o csv -t 1000 | awk -F ';' '/total/ { printf "Net: %.0f Mb/s\n", ($5*8/1.0e6) }; fflush(stdout)' execp_continuous = 1 execp_interval = 1 </code></pre> <h3 id="example-configuration">Example configuration<a name="example-configuration" href="#example-configuration" class="md2man-permalink" title="permalink"></a></h3><pre class="highlight plaintext"><code>#--------------------------------------------- ## TINT2 CONFIG FILE #--------------------------------------------- #--------------------------------------------- ## BACKGROUND AND BORDER #--------------------------------------------- rounded = 7 border_width = 2 background_color = #000000 60 border_color = #ffffff 18 rounded = 5 border_width = 0 background_color = #ffffff 40 border_color = #ffffff 50 rounded = 5 border_width = 0 background_color = #ffffff 18 border_color = #ffffff 70 #--------------------------------------------- ## PANEL #--------------------------------------------- panel_monitor = all panel_position = bottom center panel_size = 94% 30 panel_margin = 0 0 panel_padding = 7 0 font_shadow = 0 panel_background_id = 1 wm_menu = 0 panel_dock = 0 panel_layer = bottom #--------------------------------------------- ## TASKBAR #--------------------------------------------- #taskbar_mode = multi_desktop taskbar_mode = single_desktop taskbar_padding = 2 3 2 taskbar_background_id = 0 #taskbar_active_background_id = 0 #--------------------------------------------- ## TASKS #--------------------------------------------- task_icon = 1 task_text = 1 task_maximum_size = 140 35 task_centered = 1 task_padding = 6 3 task_font = sans 7 task_font_color = #ffffff 70 task_background_id = 3 task_icon_asb = 100 0 0 ## replace STATUS by 'urgent', 'active' or 'iconfied' #task_STATUS_background_id = 2 #task_STATUS_font_color = #ffffff 85 #task_STATUS_icon_asb = 100 0 0 ## example: task_active_background_id = 2 task_active_font_color = #ffffff 85 task_active_icon_asb = 100 0 0 urgent_nb_of_blink = 8 #--------------------------------------------- ## SYSTRAYBAR #--------------------------------------------- systray = 1 systray_padding = 0 4 5 systray_background_id = 0 systray_sort = left2right systray_icon_size = 0 systray_icon_asb = 100 0 0 #--------------------------------------------- ## CLOCK #--------------------------------------------- time1_format = %H:%M time1_font = sans 8 time2_format = %A %d %B time2_font = sans 6 clock_font_color = #ffffff 76 clock_padding = 1 0 clock_background_id = 0 #clock_lclick_command = xclock clock_rclick_command = orage #clock_tooltip = %A %d %B #time1_timezone = :US/Hawaii #time2_timezone = :Europe/Berlin #clock_tooltip_timezone = :/usr/share/zoneinfo/Europe/Paris #--------------------------------------------- ## BATTERY #--------------------------------------------- battery = 0 battery_hide = 98 battery_low_status = 10 battery_low_cmd = notify-send "battery low" bat1_font = sans 8 bat2_font = sans 6 battery_font_color = #ffffff 76 battery_padding = 1 0 battery_background_id = 0 #--------------------------------------------- ## TOOLTIP #--------------------------------------------- tooltip = 0 tooltip_padding = 2 2 tooltip_show_timeout = 0.7 tooltip_hide_timeout = 0.3 tooltip_background_id = 1 tooltip_font_color = #OOOOOO 80 tooltip_font = sans 10 #--------------------------------------------- ## MOUSE ACTION ON TASK #--------------------------------------------- mouse_middle = none mouse_right = close mouse_scroll_up = toggle mouse_scroll_down = iconify #--------------------------------------------- ## AUTOHIDE OPTIONS #--------------------------------------------- autohide = 0 autohide_show_timeout = 0.3 autohide_hide_timeout = 2 autohide_height = 4 strut_policy = minimum </code></pre> <h2 id="author">AUTHOR<a name="author" href="#author" class="md2man-permalink" title="permalink"></a></h2><p>tint2 was written by Thierry Lorthiois <a href="mailto:lorthiois@bbsoft.fr">lorthiois@bbsoft.fr</a>. It is based on ttm, originally written by Pål Staurland <a href="mailto:staura@gmail.com">staura@gmail.com</a>.</p><p>This manual page was originally written by Daniel Moerner <a href="mailto:dmoerner@gmail.com">dmoerner@gmail.com</a>, for the Debian project (but may be used by others). It was adopted from the tint2 docs.</p><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p>The main website <a href="https://gitlab.com/o9000/tint2">https://gitlab.com/o9000/tint2</a> and the wiki page at <a href="https://gitlab.com/o9000/tint2/wikis/home">https://gitlab.com/o9000/tint2/wikis/home</a>.</p> </body> </html> |