doc/readme.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4 <head>
   5 <style type="text/css">
   6 html,
   7 body {
   8   color: #333;
   9   font-family: Helvetica, Arial, sans-serif;
  10   font-size: 14px;
  11   line-height: 1.6;
  12   word-wrap: break-word;
  13   max-width: 1000px;
  14   margin: 0 auto;
  15 }
  16
  17 h1,
  18 h2,
  19 h3,
  20 h4,
  21 h5,
  22 h6 {
  23   margin-top: 1em;
  24   margin-bottom: 1rem;
  25 }
  26
  27 h1 {
  28   font-size: 1.8rem;
  29   font-weight: normal;
  30   font-style: normal;
  31   border-bottom: 1px solid #eee;
  32 }
  33
  34 h2 {
  35   font-size: 1.5rem;
  36   font-weight: normal;
  37   font-style: normal;
  38   border-bottom: 1px solid #eee;
  39 }
  40
  41 h3 {
  42   font-size: 1.2rem;
  43   font-weight: bold;
  44   font-style: normal;
  45 }
  46
  47 h4 {
  48   font-size: 1rem;
  49   font-weight: bold;
  50   font-style: normal;
  51 }
  52
  53 h5 {
  54   font-size: 1rem;
  55   font-weight: bold;
  56   font-style: italic;
  57 }
  58
  59 h6 {
  60   font-size: 1rem;
  61   font-weight: normal;
  62   font-style: italic;
  63 }
  64
  65
  66 code,
  67 kbd,
  68 pre {
  69   font-family: monospace;
  70   font-size: 1em;
  71 }
  72
  73 table {
  74   border-spacing: 0;
  75   border-collapse: collapse;
  76 }
  77
  78 td,
  79 th {
  80   padding: 0;
  81 }
  82
  83 asdff {
  84   box-sizing: border-box;
  85 }
  86
  87 a {
  88   color: #46c;
  89   text-decoration: none;
  90 }
  91
  92 a:hover,
  93 a:active {
  94   text-decoration: underline;
  95 }
  96
  97 a:not([href]) {
  98   color: inherit;
  99   text-decoration: none;
 100 }
 101
 102 hr {
 103   box-sizing: content-box;
 104   height: 0;
 105   margin: 15px 0;
 106   overflow: hidden;
 107   background: transparent;
 108   border: 0;
 109   border-bottom: 1px solid #ddd;
 110 }
 111
 112 hr::before {
 113   display: table;
 114   content: "";
 115 }
 116
 117 hr::after {
 118   display: table;
 119   clear: both;
 120   content: "";
 121 }
 122
 123 p {
 124   margin-top: 0;
 125   margin-bottom: 0.7em;
 126 }
 127
 128 blockquote {
 129   margin: 0;
 130 }
 131
 132 code {
 133   font-family: "Liberation Mono", monospace;
 134   font-size: 1em;
 135 }
 136
 137 pre {
 138   margin-top: 0;
 139   margin-bottom: 0;
 140   font: 1em "Liberation Mono", monospace;
 141   overflow-x: auto;
 142 }
 143
 144 blockquote {
 145   padding: 0 15px;
 146   color: #777;
 147   border-left: 4px solid #ddd;
 148 }
 149
 150 blockquote>:first-child {
 151   margin-top: 0;
 152 }
 153
 154 blockquote>:last-child {
 155   margin-bottom: 0;
 156 }
 157
 158 table {
 159   display: block;
 160   width: 100%;
 161   overflow: auto;
 162   word-break: normal;
 163 }
 164
 165 table th {
 166   font-weight: bold;
 167 }
 168
 169 table th,
 170 table td {
 171   padding: 6px 13px;
 172   border: 1px solid #ddd;
 173 }
 174
 175 table tr {
 176   background-color: #fff;
 177   border-top: 1px solid #ccc;
 178 }
 179
 180 table tr:nth-child(2n) {
 181   background-color: #f8f8f8;
 182 }
 183
 184 code {
 185   padding: 0.2em;
 186   margin: 0;
 187   font-size: 0.95em;
 188   background-color: #eee;
 189 }
 190
 191 pre {
 192   word-wrap: normal;
 193   background-color: #eee;
 194   margin: 1em 0;
 195   padding: 0.2em;
 196 }
 197
 198
 199 </style>
 200 </head>
 201 <body>
 202 <h2>TINT2 needs help</h2>
 203
 204 <p>I had to adopt tint2 from <a href="https://gitlab.com/o9000/tint2">o9000</a> account rather automatically after it was suddenly sentenced to end-of-life by previous maintainer without warning. My free time is too limited, so I may not be able to keep pace with all bugs and feature requests, some of whom need to be recovered yet (Chris Lee disabled sections for MR and issues).</p>
 205
 206 <p>There already was number of fixes, optimizations and just enhancements since 2021, just now I just merging whatever I already have. There are still few more ideas to implement, until I can consider tint2&rsquo;s development is exhausted without breaking some of its own core rules, starting with lightweightness and versatility.</p>
 207
 208 <p>Testing for BSD specifically will not be possible as I don&rsquo;t use it anywhere, so at most I&rsquo;m able to check POSIX compatibility.</p>
 209
 210 <p>So, for short - any help is welcome, not a problem if someone maintains own fork for a while when I&rsquo;m unable to respond about own fork.</p>
 211
 212 <p>Code does not die. Not as long as there&rsquo;s compiler, able to build it, and system, able to run it, in the world. Moreover while it&rsquo;s FLOSS project.</p>
 213
 214 <h1>Latest stable release: 17.1</h1>
 215
 216 <p>Changes: https://gitlab.com/nick87720z/tint2/blob/17.1/ChangeLog</p>
 217
 218 <p>Documentation: <a href="manual.html">manual.html</a></p>
 219
 220 <p>Compile it with (after you install the <a href="https://gitlab.com/o9000/tint2/wikis/Install#dependencies">dependencies</a>):</p>
 221
 222 <p><code>
 223 git clone https://gitlab.com/nick87720z/tint2.git
 224 cd tint2
 225 git checkout 17.1
 226 mkdir build
 227 cd build
 228 cmake ..
 229 make -j4
 230 </code></p>
 231
 232 <p>To install, run (as root):</p>
 233
 234 <p><code>
 235 make install
 236 update-icon-caches /usr/local/share/icons/hicolor
 237 update-mime-database /usr/local/share/mime
 238 </code></p>
 239
 240 <p>And then you can run the panel <code>tint2</code> and the configuration program <code>tint2conf</code>.</p>
 241
 242 <p>Please report any problems to https://gitlab.com/nick87720z/tint2/issues. Your feedback is much appreciated.</p>
 243
 244 <p>P.S. GitLab is now the official location of the tint2 project, migrated from Google Code, which is shutting down. In case you are wondering why not GitHub, BitBucket etc., we chose GitLab because it is open source, it is mature and works well, looks cool and has a very nice team.</p>
 245
 246 <h1>What is tint2?</h1>
 247
 248 <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.). It is based on ttm https://code.google.com/p/ttm/.</p>
 249
 250 <h1>Features</h1>
 251
 252 <ul>
 253 <li>Panel with configurable set of applets:
 254
 255 <ul>
 256 <li>taskbar, system tray, clock, launcher</li>
 257 <li>arbitrary buttons with configurable commands per each mouse button (including scroll buttons)</li>
 258 <li>executors - like buttons, but using configurable command to set appearance (see manual)</li>
 259 </ul>
 260 </li>
 261 <li>Easy to customize:
 262
 263 <ul>
 264 <li>Color/transparency on fonts, icons, borders and backgrounds;<br/>
 265 <strong>Note:</strong> Full transparency requires a compositor such as Compton (if not provided already by the window manager, as in Compiz/Unity, KDE or XFCE);</li>
 266 <li>Customizable mouse events;</li>
 267 <li>Customizable interpreters for action commands;</li>
 268 </ul>
 269 </li>
 270 <li>Pager like capability: move tasks between workspaces (virtual desktops), switch between workspaces;</li>
 271 <li>Multi-monitor capability: create a panel for each monitor, showing only the tasks from that monitor;</li>
 272 </ul>
 273
 274
 275 <h1>Goals</h1>
 276
 277 <ul>
 278 <li>Be unintrusive and light (in terms of memory, CPU and aesthetic);</li>
 279 <li>Follow the freedesktop.org specifications;</li>
 280 <li>Make certain workflows, such as multi-desktop and multi-monitor, easy to use.</li>
 281 </ul>
 282
 283
 284 <h1>I want it!</h1>
 285
 286 <ul>
 287 <li><a href="https://gitlab.com/o9000/tint2/wikis/Install">Install tint2</a></li>
 288 </ul>
 289
 290
 291 <h1>How do I &hellip;</h1>
 292
 293 <ul>
 294 <li><a href="https://gitlab.com/o9000/tint2/wikis/Install">Install</a></li>
 295 <li><a href="https://gitlab.com/nick87720z/tint2/blob/master/manual.html">Configure</a></li>
 296 <li><a href="https://gitlab.com/o9000/tint2/wikis/ThirdPartyApplets">Add applet not supported by tint2</a></li>
 297 <li><a href="https://gitlab.com/o9000/tint2/wikis/FAQ">Other frequently asked questions</a></li>
 298 <li><a href="https://gitlab.com/o9000/tint2/wikis/Debug">Obtain a stack trace when tint2 crashes</a></li>
 299 </ul>
 300
 301
 302 <h1>Known issues</h1>
 303
 304 <ul>
 305 <li>Graphical glitches on Intel graphics cards can be avoided by changing the acceleration method to UXA (<a href="https://gitlab.com/o9000/tint2/issues/595">issue 595</a>)</li>
 306 <li>Window managers that do not follow exactly the EWMH specification might not interact well with tint2 (<a href="https://gitlab.com/o9000/tint2/issues/627">issue 627</a>).</li>
 307 </ul>
 308
 309
 310 <h1>How can I help out?</h1>
 311
 312 <ul>
 313 <li>Report bugs and ask questions on the <a href="https://gitlab.com/nick87720z/tint2/issues">issue tracker</a>;</li>
 314 <li>Contribute to the development by helping us fix bugs and suggesting new features. Please read the contribution guide: <a href="CONTRIBUTING.md">CONTRIBUTING.md</a></li>
 315 </ul>
 316
 317
 318 <h1>Links</h1>
 319
 320 <ul>
 321 <li>Home page: https://gitlab.com/nick87720z/tint2</li>
 322 <li>Download latest release: https://gitlab.com/nick87720z/tint2/-/archive/17.1/tint2-17.1.tar.bz2</li>
 323 <li>Git repository: https://gitlab.com/nick87720z/tint2.git</li>
 324 <li>Documentation: https://gitlab.com/o9000/tint2/wikis/home</li>
 325 <li>Downloads: https://gitlab.com/o9000/tint2-archive/tree/master or https://code.google.com/p/tint2/downloads/list</li>
 326 <li>Old project locations (inactive): https://gitlab.com/o9000/tint2 https://code.google.com/p/tint2</li>
 327 </ul>
 328
 329
 330 <h1>Screenshots</h1>
 331
 332 <h2>Default config:</h2>
 333
 334 <p><img src="https://gitlab.com/nick87720z/tint2/uploads/948fa74eca60864352a033580350b4c3/Screenshot_2016-01-23_14-42-57.png" alt="Screenshot_2016-01-23_14-42-57" /></p>
 335
 336 <h2>Various configs:</h2>
 337
 338 <ul>
 339 <li><a href="https://gitlab.com/o9000/tint2/wikis/screenshots">Screenshots</a></li>
 340 </ul>
 341
 342
 343 <h2>Demos</h2>
 344
 345 <ul>
 346 <li><a href="https://gitlab.com/o9000/tint2/wikis/whats-new-0.13.0.gif">Compact panel, separator, color gradients</a></li>
 347 <li><a href="https://gitlab.com/o9000/tint2/wikis/whats-new-0.12.4.gif">Executor</a></li>
 348 <li><a href="https://gitlab.com/o9000/tint2/wikis/whats-new-0.12.3.gif">Mouse over effects</a></li>
 349 <li><a href="https://gitlab.com/o9000/tint2/wikis/whats-new-0.12.gif">Distribute size between taskbars, freespace</a></li>
 350 </ul>
 351
 352
 353 <h2>More</h2>
 354
 355 <ul>
 356 <li><a href="https://gitlab.com/o9000/tint2/wikis/Home">Tint2 wiki</a></li>
 357 </ul>
 358
 359 </body>
 360 </html>