Debian Codegraph @

doc/herbstluftwm-tutorial.html

raw
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>herbstluftwm-tutorial(7)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
15 }
16
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
25 }
26
27 body {
28 margin: 1em 5% 1em 5%;
29 }
30
31 a {
32 color: blue;
33 text-decoration: underline;
34 }
35 a:visited {
36 color: fuchsia;
37 }
38
39 em {
40 font-style: italic;
41 color: navy;
42 }
43
44 strong {
45 font-weight: bold;
46 color: #083194;
47 }
48
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54 }
55
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
58 }
59 h2 {
60 padding-top: 0.5em;
61 }
62 h3 {
63 float: left;
64 }
65 h3 + * {
66 clear: left;
67 }
68 h5 {
69 font-size: 1.0em;
70 }
71
72 div.sectionbody {
73 margin-left: 0;
74 }
75
76 hr {
77 border: 1px solid silver;
78 }
79
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83 }
84
85 ul, ol, li > p {
86 margin-top: 0;
87 }
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
90
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
97 }
98 pre {
99 white-space: pre-wrap;
100 }
101
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
106 }
107 #email {
108 }
109 #revnumber, #revdate, #revremark {
110 }
111
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117 }
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
121 }
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
125 }
126
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130 }
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
136 }
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
142 }
143
144 div.content { /* Block element content. */
145 padding: 0;
146 }
147
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155 }
156 div.title + * {
157 margin-top: 0;
158 }
159
160 td div.title:first-child {
161 margin-top: 0.0em;
162 }
163 div.content div.title:first-child {
164 margin-top: 0.0em;
165 }
166 div.content + div.title {
167 margin-top: 0.0em;
168 }
169
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
175 }
176
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
182 }
183
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
190 }
191
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
195 }
196
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
200 }
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204 }
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
208 }
209
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
217 }
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
221 }
222
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
226 }
227
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
231
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235 }
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
241 }
242 dd > *:first-child {
243 margin-top: 0.1em;
244 }
245
246 ul, ol {
247 list-style-position: outside;
248 }
249 ol.arabic {
250 list-style-type: decimal;
251 }
252 ol.loweralpha {
253 list-style-type: lower-alpha;
254 }
255 ol.upperalpha {
256 list-style-type: upper-alpha;
257 }
258 ol.lowerroman {
259 list-style-type: lower-roman;
260 }
261 ol.upperroman {
262 list-style-type: upper-roman;
263 }
264
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270 }
271
272 tfoot {
273 font-weight: bold;
274 }
275 td > div.verse {
276 white-space: pre;
277 }
278
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282 }
283 div.hdlist tr {
284 padding-bottom: 15px;
285 }
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288 }
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
294 }
295 td.hdlist2 {
296 vertical-align: top;
297 }
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301 }
302
303 .comment {
304 background: yellow;
305 }
306
307 .footnote, .footnoteref {
308 font-size: 0.8em;
309 }
310
311 span.footnote, span.footnoteref {
312 vertical-align: super;
313 }
314
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318 }
319
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
322 }
323
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
332 }
333
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338 }
339 div.colist td img {
340 margin-top: 0.3em;
341 }
342
343 @media print {
344 #footer-badges { display: none; }
345 }
346
347 #toc {
348 margin-bottom: 2.5em;
349 }
350
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357 }
358
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
362 }
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366 }
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370 }
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374 }
375
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
392
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
409
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
412
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
416
417 div.unbreakable { page-break-inside: avoid; }
418
419
420 /*
421 * xhtml11 specific
422 *
423 * */
424
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428 }
429 div.tableblock > table {
430 border: 3px solid #527bbd;
431 }
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435 }
436 p.table {
437 margin-top: 0;
438 }
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
442 }
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446 }
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450 }
451
452
453 /*
454 * html5 specific
455 *
456 * */
457
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461 }
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465 }
466 p.tableblock {
467 margin-top: 0;
468 }
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475 }
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481 }
482
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486 }
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490 }
491 table.tableblock.frame-none {
492 border-style: hidden;
493 }
494
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497 }
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500 }
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503 }
504
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507 }
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510 }
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513 }
514
515
516 /*
517 * manpage specific
518 *
519 * */
520
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526 }
527 body.manpage h2 {
528 border-style: none;
529 }
530 body.manpage div.sectionbody {
531 margin-left: 3em;
532 }
533
534 @media print {
535 body.manpage div#toc { display: none; }
536 }
537
538
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
543
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
547
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561 // toclevels = 1..4.
562 toc: function (toclevels) {
563
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
605 }
606
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637 },
638
639
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
643
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
654 }
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
682 }
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
689 }
690 }
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
703 }
704 }
705 }
706 },
707
708 install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
728 }
729
730 }
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 herbstluftwm-tutorial(7) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>herbstluftwm-tutorial -
743 A tutorial introduction to herbstluftwm
744 </p>
745 </div>
746 </div>
747 <div id="content">
748 <div class="sect1">
749 <h2 id="_description">Description</h2>
750 <div class="sectionbody">
751 <div class="paragraph"><p>This tutorial explains how to create a basic herbstluftwm setup and introduces
752 the major herbstluftwm features. This tutorial neither covers all features nor
753 specifies the mentioned features entirely; see
754 <a href="herbstluftwm.html"><strong>herbstluftwm</strong>(1)</a> for a compact and more complete
755 description.</p></div>
756 <div class="paragraph"><p>This tutorial covers these topics:</p></div>
757 <div class="ulist"><ul>
758 <li>
759 <p>
760 <a href="#installation">Basic installation</a>
761 </p>
762 </li>
763 <li>
764 <p>
765 <a href="#client">Usage of the client</a>
766 </p>
767 </li>
768 <li>
769 <p>
770 <a href="#tiling">The tiling method</a>
771 </p>
772 </li>
773 <li>
774 <p>
775 <a href="#tags">Tags (or workspaces&#8230;)</a>
776 </p>
777 </li>
778 <li>
779 <p>
780 <a href="#monitors">Multi-Monitor handling</a>
781 </p>
782 </li>
783 </ul></div>
784 </div>
785 </div>
786 <div class="sect1">
787 <h2 id="installation">Basic installation</h2>
788 <div class="sectionbody">
789 <div class="paragraph"><p>This describes two alternate installation methods. In any case, you also have to
790 install the dependencies. Beside the standard libraries (XLib) which are
791 found on nearly any system, you should install dzen2 (as current as possible)
792 which is needed by the default <code>panel.sh</code>.</p></div>
793 <div class="sect2">
794 <h3 id="_via_the_package_manager">Via the package manager</h3>
795 <div class="paragraph"><p>You always should prefer installing herbstluftwm via your package manager on your
796 system. It should be called <code>herbstluftwm</code>.</p></div>
797 <div class="paragraph"><p>After installing it, the default configuration file has to be copied to your
798 home directory:</p></div>
799 <div class="listingblock">
800 <div class="content">
801 <pre><code>mkdir -p ~/.config/herbstluftwm
802 cp /etc/xdg/herbstluftwm/autostart ~/.config/herbstluftwm/</code></pre>
803 </div></div>
804 <div class="paragraph"><p>You also should activate the tab completion for <code>herbstclient</code>. In case of
805 bash, you can either activate the tab completion in general or source the
806 herbstclient-completion from the bash_completion.d directory in your bashrc. In
807 case of zsh the tab-completion normally is activated already (if not, consider
808 activating it).</p></div>
809 </div>
810 <div class="sect2">
811 <h3 id="_directly_from_git">Directly from git</h3>
812 <div class="paragraph"><p>If there is no package for your platform or if you want to use the current git
813 version, then you can pull directly from the main repository:</p></div>
814 <div class="listingblock">
815 <div class="content">
816 <pre><code>git clone https://github.com/herbstluftwm/herbstluftwm
817 cd herbstluftwm
818 make # build the binaries
819
820 # install files
821 mkdir -p ~/bin
822 # you also have to put $HOME/bin to your path, e.g. by:
823 echo 'export PATH=$PATH:$HOME/bin' &gt;&gt; ~/.bashrc # or to your zshrc, etc...
824 ln -s `pwd`/herbstluftwm ~/bin/
825 ln -s `pwd`/herbstclient ~/bin/
826
827 # copy the configuration
828 mkdir -p ~/.config/herbstluftwm/
829 cp share/autostart ~/.config/herbstluftwm/
830 cp share/panel.sh ~/.config/herbstluftwm/</code></pre>
831 </div></div>
832 <div class="ulist"><ul>
833 <li>
834 <p>
835 If you are using bash, then source the bash completion file in your <code>~/.bashrc</code>
836 </p>
837 <div class="listingblock">
838 <div class="content">
839 <pre><code>source path-to/herbstluftwm/share/herbstclient-completion</code></pre>
840 </div></div>
841 </li>
842 <li>
843 <p>
844 If you are using zsh, then copy the <code>share/_herbstclient</code> file to the
845 appropriate zsh-completion directory.
846 </p>
847 </li>
848 </ul></div>
849 <div class="paragraph"><p>Each time there is an update, you have to do the following steps in your
850 herbstluftwm directory:</p></div>
851 <div class="listingblock">
852 <div class="content">
853 <pre><code>git pull
854 make</code></pre>
855 </div></div>
856 </div>
857 </div>
858 </div>
859 <div class="sect1">
860 <h2 id="_configure_herbstluftwm_as_your_window_manager">Configure herbstluftwm as your window manager</h2>
861 <div class="sectionbody">
862 <div class="paragraph"><p>As usual you can define herbstluftwm as your window manager by either selecting
863 herbstluftwm in your login manager or by starting it in your <code>~/.xinitrc</code>,
864 mostly by writing to your xinitrc (or <code>.xsession</code> on some systems):</p></div>
865 <div class="listingblock">
866 <div class="content">
867 <pre><code># start herbstluftwm in locked mode (it will be unlocked at the end of your
868 # autostart)
869 exec herbstluftwm --locked</code></pre>
870 </div></div>
871 <div class="paragraph"><p>After logging in the next time, you will get a default herbstluftwm session.</p></div>
872 </div>
873 </div>
874 <div class="sect1">
875 <h2 id="_first_start">First start</h2>
876 <div class="sectionbody">
877 <div class="paragraph"><p>After starting herbstluftwm, the screen is surrounded by a green frame initially,
878 which indicates that there is only one large frame. A frame is a container
879 where actual windows can be placed or which can be split into two
880 frames.</p></div>
881 <div class="paragraph"><p>Start an <code>xterm</code> by pressing Alt-Return, which will fill your entire screen.</p></div>
882 </div>
883 </div>
884 <div class="sect1">
885 <h2 id="client">Using the client</h2>
886 <div class="sectionbody">
887 <div class="paragraph"><p>The only way to communicate to herbstluftwm is by using the client application
888 called <a href="herbstclient.html"><code>herbstclient</code></a>. Its usual syntax is:
889 <code>herbstclient COMMAND [ARGUMENTS]</code>. This calls a certain <code>COMMAND</code> within your
890 running herbstluftwm instance. This causes some effect (which depends on the
891 given <code>COMMAND</code> and <code>ARGUMENTS</code>), produces some output which is printed by
892 <code>herbstclient</code> and lets <code>herbstclient</code> exit with a exit-code (e.g. 0 for
893 success) like many other UNIX tools:</p></div>
894 <div class="listingblock">
895 <div class="content">
896 <pre><code> shell COMMANDS,
897 ╲ COMMAND, ARGUMENTS
898 ╲ ARGUMENTS ╭────────────╮
899 ╲ │ │
900 V │ V
901 herbstclient herbstluftwm
902 ╱ ^ │
903 ╱ output, │ │
904 ╱ exit-code ╰────────────╯
905 V output,
906 shell/terminal exit-code</code></pre>
907 </div></div>
908 <div class="paragraph"><p>The most simple command only prints the herbstluftwm version:</p></div>
909 <div class="listingblock">
910 <div class="content">
911 <pre><code>$ # lines prefixed with $ describes what to type, other lines describe the
912 $ # typical output
913 $ # Type: her&lt;tab&gt;c&lt;tab&gt; ve&lt;tab&gt;
914 $ herbstclient version
915 herbstluftwm 0.4.1 (built on Aug 30 2012)
916 $ herbstclient set window_border_active_color red
917 $ # now the window border turned red</code></pre>
918 </div></div>
919 <div class="paragraph"><p>The configuration of herbstluftwm only is done by calling commands via
920 herbstclient. So the only configuration file is the <code>autostart</code> which is placed
921 at <code>~/.config/herbstluftwm/</code> and which is a sequence of those herbstclient
922 calls.</p></div>
923 <div class="paragraph"><p>Open it in your favourite text editor and replace the Mod-line by this to use
924 the Super-key (or also called Windows-key) as the main modifier:</p></div>
925 <div class="listingblock">
926 <div class="content">
927 <pre><code># Mod=Mod1 # use alt as the main modifier
928 Mod=Mod4 # use Super as the main modifier</code></pre>
929 </div></div>
930 <div class="paragraph"><p>After saving the autostart file, you have to reload the configuration:</p></div>
931 <div class="listingblock">
932 <div class="content">
933 <pre><code># the following line is identical to directly calling:
934 # ~/.config/herbstluftwm/autostart
935 herbstclient reload</code></pre>
936 </div></div>
937 <div class="paragraph"><p>Now you may notice that the red border color of your terminal turned green
938 again, because the color is set in the default autostart. That&#8217;s the typical
939 configuration workflow:</p></div>
940 <div class="olist arabic"><ol class="arabic">
941 <li>
942 <p>
943 Try some new settings in the command line
944 </p>
945 </li>
946 <li>
947 <p>
948 Add them to the autostart file
949 </p>
950 </li>
951 <li>
952 <p>
953 Press Mod-Shift-r which calls the <code>reload</code> command or directly execute the
954 autostart file from your shell to get the error messages if something went
955 wrong.
956 </p>
957 </li>
958 </ol></div>
959 <div class="paragraph"><p>To learn more about herbstluftwm, just go through the man page line by
960 line and check using the <a href="herbstluftwm.html">herbstluftwm(1) man page</a> what
961 it does. For a quick introduction to the central paradigms, continue reading
962 this.</p></div>
963 </div>
964 </div>
965 <div class="sect1">
966 <h2 id="tiling">Tiling</h2>
967 <div class="sectionbody">
968 <div class="paragraph"><p>Initially there is one frame. Each frame has one of the two following possible
969 types:</p></div>
970 <div class="olist arabic"><ol class="arabic">
971 <li>
972 <p>
973 It serves as a container for windows, i.e. it can hold zero up to
974 arbitrarily many windows. Launch several more terminals to see what happens:
975 If there are multiple windows in one frame, they are aligned below each other.
976 To change this layout algorithm, press Mod-space to cycle all the available
977 layouting algorithms for the focused frame.
978 </p>
979 </li>
980 <li>
981 <p>
982 A frame also can be split into two subframes, which can be aligned next to
983 or below each other. Press Mod-o to split to an horizontal alignment. To
984 navigate to the fresh frame right of the old one press Mod-l. Press Mod-u to
985 split vertically. The intuitive navigation is:<br />
986 </p>
987 <div class="listingblock">
988 <div class="content">
989 <pre><code> ⎧ h (or ←) ⎫ ⎧ left
990 ⎪ j (or ↓) ⎪ means ⎪ down
991 Mod + ⎨ k (or ↑) ⎬ ═══════&gt; focus ⎨ up
992 ⎩ l (or →) ⎭ ⎩ right</code></pre>
993 </div></div>
994 <div class="paragraph"><p>To undo splitting, you can remove a frame via Mod-r. To shift some window from
995 one frame to one of its neighbours, use the same keyboard shortcut while holding
996 the Shift key pressed. It is not possible to resize single windows, only to
997 resize frames. The according keyboard shortcut is the same while holding Control
998 pressed. All in all it is:</p></div>
999 <div class="listingblock">
1000 <div class="content">
1001 <pre><code> ⎧ h (or ←) ⎫ ⎧ left
1002 ⎧ ⎫ ⎪ j (or ↓) ⎪ means ⎧ focus frame ⎫ ⎪ down
1003 Mod + ⎨ Shift ⎬ + ⎨ k (or ↑) ⎬ ═════&gt; ⎨ move window ⎬ ⎨ up
1004 ⎩ Control ⎭ ⎩ l (or →) ⎭ ⎩ resize frame ⎭ ⎩ right</code></pre>
1005 </div></div>
1006 </li>
1007 </ol></div>
1008 <div class="paragraph"><p>With this, you can define a custom layout. It can be printed via the <code>layout</code>
1009 command:</p></div>
1010 <div class="listingblock">
1011 <div class="content">
1012 <pre><code>$ herbstclient layout
1013 ╾─┐ horizontal 50% selection=1
1014 ├─┐ vertical 70% selection=0
1015 │ ├─╼ vertical: 0x1400009
1016 │ └─╼ vertical:
1017 └─╼ max: 0x1a00009 [FOCUS]</code></pre>
1018 </div></div>
1019 <div class="paragraph"><p>Just play with it a bit to understand how it works. You also can permanently save the
1020 layout using the <code>dump</code> command:</p></div>
1021 <div class="listingblock">
1022 <div class="content">
1023 <pre><code>$ herbstclient dump
1024 (split horizontal:0.500000:1
1025 (split vertical:0.700000:0
1026 (clients vertical:0 0x1400009)
1027 (clients vertical:0))
1028 (clients max:0 0x1a00009))
1029 $ layout=$(herbstclient dump)</code></pre>
1030 </div></div>
1031 <div class="paragraph"><p>And after some changes you can rewind to the original layout with the <code>load</code>
1032 command:</p></div>
1033 <div class="listingblock">
1034 <div class="content">
1035 <pre><code>$ herbstclient load "$layout" # mind the quotes!</code></pre>
1036 </div></div>
1037 </div>
1038 </div>
1039 <div class="sect1">
1040 <h2 id="tags">Tags (or workspaces or virtual desktops or &#8230;.)</h2>
1041 <div class="sectionbody">
1042 <div class="paragraph"><p>A tag consists of a name and a frame layout with clients on it. With the default
1043 autostart, there are nine tags named 1 to 9. You can switch to the ith tag using
1044 Mod-i, e.g. Mod-4 to switch to tag 4 or with the command <code>use 4</code>. A window can
1045 be move to tag i via Mod-Shift-i, i.e. with the <code>move</code> command.</p></div>
1046 </div>
1047 </div>
1048 <div class="sect1">
1049 <h2 id="monitors">Monitors</h2>
1050 <div class="sectionbody">
1051 <div class="paragraph"><p>The notion of a monitor in herbstluftwm is treated much more abstract and
1052 general than in other window managers: A monitor just is a rectangular part of
1053 your screen which shows exactly one tag on it.</p></div>
1054 <div class="paragraph"><p>Initially there is only one large monitor ranging over your entire screen:</p></div>
1055 <div class="listingblock">
1056 <div class="content">
1057 <pre><code>$ herbstclient list_monitors
1058 0: 1440x900+0+0 with tag "1" [FOCUS]</code></pre>
1059 </div></div>
1060 <div class="paragraph"><p>The output shows that there is only one monitor with index 0 at position +0+0 of
1061 size 1440x900 showing tag 1. In most cases, the herbstluftwm monitors will match
1062 the list of physical monitors. So to add another physical monitor, you have to
1063 perform several steps:</p></div>
1064 <div class="olist arabic"><ol class="arabic">
1065 <li>
1066 <p>
1067 Enable it, such that it shows a part of your screen. You can use <code>xrandr</code>,
1068 <code>xinerama</code> or any other tool you like.
1069 </p>
1070 </li>
1071 <li>
1072 <p>
1073 Register it in herbstluftwm: Lets assume your new monitor has the resolution
1074 1024x768 and is right of your main screen, then you can activate it via:
1075 </p>
1076 <div class="listingblock">
1077 <div class="content">
1078 <pre><code>$ herbstclient set_monitors 1440x900+0+0 1024x768+1440+0</code></pre>
1079 </div></div>
1080 <div class="paragraph"><p>Alternatively, if <code>xinerama</code> or <code>xrandr</code> works for your setup, simply run:</p></div>
1081 <div class="listingblock">
1082 <div class="content">
1083 <pre><code>$ herbstclient detect_monitors</code></pre>
1084 </div></div>
1085 </li>
1086 </ol></div>
1087 <div class="paragraph"><p>For even more automation, you can enable the setting <code>auto_detect_monitors</code>.
1088 For more advanced examples, look at the <code>q3terminal.sh</code> example script, which
1089 implements a drop-down-terminal like monitor where you can put any application
1090 you like.</p></div>
1091 </div>
1092 </div>
1093 </div>
1094 <div id="footnotes"><hr /></div>
1095 <div id="footer">
1096 <div id="footer-text">
1097 Last updated
1098 2021-04-17 13:13:47 CEST
1099 </div>
1100 </div>
1101 </body>
1102 </html>