Debian Codegraph @

docs/index.html

raw ◀ ▶
Source reconstructed at patch state 0 of 1 — not the installed (fully patched) source.
1 Debian patch touch this file
1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <meta charset="UTF-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0">
7 <meta name="generator" content="Asciidoctor 2.0.10">
8 <title>i3blocks</title>
9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
10 <style>
11 /* Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
12 /* Uncomment @import statement to use as custom stylesheet */
13 /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
14 article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}
15 audio,video{display:inline-block}
16 audio:not([controls]){display:none;height:0}
17 html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
18 a{background:none}
19 a:focus{outline:thin dotted}
20 a:active,a:hover{outline:0}
21 h1{font-size:2em;margin:.67em 0}
22 abbr[title]{border-bottom:1px dotted}
23 b,strong{font-weight:bold}
24 dfn{font-style:italic}
25 hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
26 mark{background:#ff0;color:#000}
27 code,kbd,pre,samp{font-family:monospace;font-size:1em}
28 pre{white-space:pre-wrap}
29 q{quotes:"\201C" "\201D" "\2018" "\2019"}
30 small{font-size:80%}
31 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
32 sup{top:-.5em}
33 sub{bottom:-.25em}
34 img{border:0}
35 svg:not(:root){overflow:hidden}
36 figure{margin:0}
37 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
38 legend{border:0;padding:0}
39 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
40 button,input{line-height:normal}
41 button,select{text-transform:none}
42 button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
43 button[disabled],html input[disabled]{cursor:default}
44 input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
45 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
46 textarea{overflow:auto;vertical-align:top}
47 table{border-collapse:collapse;border-spacing:0}
48 *,*::before,*::after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
49 html,body{font-size:100%}
50 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
51 a:hover{cursor:pointer}
52 img,object,embed{max-width:100%;height:auto}
53 object,embed{height:100%}
54 img{-ms-interpolation-mode:bicubic}
55 .left{float:left!important}
56 .right{float:right!important}
57 .text-left{text-align:left!important}
58 .text-right{text-align:right!important}
59 .text-center{text-align:center!important}
60 .text-justify{text-align:justify!important}
61 .hide{display:none}
62 img,object,svg{display:inline-block;vertical-align:middle}
63 textarea{height:auto;min-height:50px}
64 select{width:100%}
65 .center{margin-left:auto;margin-right:auto}
66 .stretch{width:100%}
67 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
68 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
69 a{color:#2156a5;text-decoration:underline;line-height:inherit}
70 a:hover,a:focus{color:#1d4b8f}
71 a img{border:0}
72 p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
73 p aside{font-size:.875em;line-height:1.35;font-style:italic}
74 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
75 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
76 h1{font-size:2.125em}
77 h2{font-size:1.6875em}
78 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
79 h4,h5{font-size:1.125em}
80 h6{font-size:1em}
81 hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
82 em,i{font-style:italic;line-height:inherit}
83 strong,b{font-weight:bold;line-height:inherit}
84 small{font-size:60%;line-height:inherit}
85 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
86 ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
87 ul,ol{margin-left:1.5em}
88 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
89 ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
90 ul.square{list-style-type:square}
91 ul.circle{list-style-type:circle}
92 ul.disc{list-style-type:disc}
93 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
94 dl dt{margin-bottom:.3125em;font-weight:bold}
95 dl dd{margin-bottom:1.25em}
96 abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
97 abbr{text-transform:none}
98 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
99 blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
100 blockquote cite::before{content:"\2014 \0020"}
101 blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
102 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
103 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
104 h1{font-size:2.75em}
105 h2{font-size:2.3125em}
106 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
107 h4{font-size:1.4375em}}
108 table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
109 table thead,table tfoot{background:#f7f8f7}
110 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
111 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
112 table tr.even,table tr.alt{background:#f8f8f7}
113 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
114 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
115 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
116 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
117 .clearfix::after,.float-group::after{clear:both}
118 :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
119 :not(pre)>code.nobreak{word-wrap:normal}
120 :not(pre)>code.nowrap{white-space:nowrap}
121 pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
122 pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
123 pre>code{display:block}
124 pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
125 em em{font-style:normal}
126 strong strong{font-weight:400}
127 .keyseq{color:rgba(51,51,51,.8)}
128 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
129 .keyseq kbd:first-child{margin-left:0}
130 .keyseq kbd:last-child{margin-right:0}
131 .menuseq,.menuref{color:#000}
132 .menuseq b:not(.caret),.menuref{font-weight:inherit}
133 .menuseq{word-spacing:-.02em}
134 .menuseq b.caret{font-size:1.25em;line-height:.8}
135 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
136 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
137 b.button::before{content:"[";padding:0 3px 0 2px}
138 b.button::after{content:"]";padding:0 2px 0 3px}
139 p a>code:hover{color:rgba(0,0,0,.9)}
140 #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
141 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
142 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
143 #content{margin-top:1.25em}
144 #content::before{content:none}
145 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
146 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
147 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
148 #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
149 #header .details span:first-child{margin-left:-.125em}
150 #header .details span.email a{color:rgba(0,0,0,.85)}
151 #header .details br{display:none}
152 #header .details br+span::before{content:"\00a0\2013\00a0"}
153 #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
154 #header .details br+span#revremark::before{content:"\00a0|\00a0"}
155 #header #revnumber{text-transform:capitalize}
156 #header #revnumber::after{content:"\00a0"}
157 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
158 #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
159 #toc>ul{margin-left:.125em}
160 #toc ul.sectlevel0>li>a{font-style:italic}
161 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
162 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
163 #toc li{line-height:1.3334;margin-top:.3334em}
164 #toc a{text-decoration:none}
165 #toc a:active{text-decoration:underline}
166 #toctitle{color:#7a2518;font-size:1.2em}
167 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
168 body.toc2{padding-left:15em;padding-right:0}
169 #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
170 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
171 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
172 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
173 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
174 body.toc2.toc-right{padding-left:0;padding-right:15em}
175 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
176 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
177 #toc.toc2{width:20em}
178 #toc.toc2 #toctitle{font-size:1.375em}
179 #toc.toc2>ul{font-size:.95em}
180 #toc.toc2 ul ul{padding-left:1.25em}
181 body.toc2.toc-right{padding-left:0;padding-right:20em}}
182 #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
183 #content #toc>:first-child{margin-top:0}
184 #content #toc>:last-child{margin-bottom:0}
185 #footer{max-width:100%;background:rgba(0,0,0,.8);padding:1.25em}
186 #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
187 #content{margin-bottom:.625em}
188 .sect1{padding-bottom:.625em}
189 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
190 .sect1{padding-bottom:1.25em}}
191 .sect1:last-child{padding-bottom:0}
192 .sect1+.sect1{border-top:1px solid #e7e7e9}
193 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
194 #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
195 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
196 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
197 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
198 details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
199 details>summary:first-of-type{cursor:pointer;display:list-item;outline:none;margin-bottom:.75em}
200 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
201 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
202 .paragraph.lead>p,#preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
203 table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p{font-size:inherit}
204 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
205 .admonitionblock>table td.icon{text-align:center;width:80px}
206 .admonitionblock>table td.icon img{max-width:none}
207 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
208 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6)}
209 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
210 .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
211 .exampleblock>.content>:first-child{margin-top:0}
212 .exampleblock>.content>:last-child{margin-bottom:0}
213 .sidebarblock{border-style:solid;border-width:1px;border-color:#dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;-webkit-border-radius:4px;border-radius:4px}
214 .sidebarblock>:first-child{margin-top:0}
215 .sidebarblock>:last-child{margin-bottom:0}
216 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
217 .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
218 .literalblock pre,.listingblock>.content>pre{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;overflow-x:auto;padding:1em;font-size:.8125em}
219 @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
220 @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
221 .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class="highlight"],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
222 .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
223 .listingblock>.content{position:relative}
224 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
225 .listingblock:hover code[data-lang]::before{display:block}
226 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
227 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
228 .listingblock pre.highlightjs{padding:0}
229 .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
230 .listingblock pre.prettyprint{border-width:0}
231 .prettyprint{background:#f7f7f8}
232 pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
233 pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
234 pre.prettyprint li code[data-lang]::before{opacity:1}
235 pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
236 table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
237 table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
238 table.linenotable td.code{padding-left:.75em}
239 table.linenotable td.linenos{border-right:1px solid currentColor;opacity:.35;padding-right:.5em}
240 pre.pygments .lineno{border-right:1px solid currentColor;opacity:.35;display:inline-block;margin-right:.75em}
241 pre.pygments .lineno::before{content:"";margin-right:-.125em}
242 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
243 .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
244 .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
245 .quoteblock blockquote{margin:0;padding:0;border:0}
246 .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
247 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
248 .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
249 .verseblock{margin:0 1em 1.25em}
250 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
251 .verseblock pre strong{font-weight:400}
252 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
253 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
254 .quoteblock .attribution br,.verseblock .attribution br{display:none}
255 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
256 .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
257 .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
258 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
259 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
260 .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
261 .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
262 .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
263 .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;text-align:left;margin-right:0}
264 table.tableblock{max-width:100%;border-collapse:separate}
265 p.tableblock:last-child{margin-bottom:0}
266 td.tableblock>.content>:last-child{margin-bottom:-1.25em}
267 td.tableblock>.content>:last-child.sidebarblock{margin-bottom:0}
268 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
269 table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
270 table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
271 table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
272 table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px}
273 table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0}
274 table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
275 table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
276 table.frame-all{border-width:1px}
277 table.frame-sides{border-width:0 1px}
278 table.frame-topbot,table.frame-ends{border-width:1px 0}
279 table.stripes-all tr,table.stripes-odd tr:nth-of-type(odd),table.stripes-even tr:nth-of-type(even),table.stripes-hover tr:hover{background:#f8f8f7}
280 th.halign-left,td.halign-left{text-align:left}
281 th.halign-right,td.halign-right{text-align:right}
282 th.halign-center,td.halign-center{text-align:center}
283 th.valign-top,td.valign-top{vertical-align:top}
284 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
285 th.valign-middle,td.valign-middle{vertical-align:middle}
286 table thead th,table tfoot th{font-weight:bold}
287 tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
288 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
289 p.tableblock>code:only-child{background:none;padding:0}
290 p.tableblock{font-size:1em}
291 ol{margin-left:1.75em}
292 ul li ol{margin-left:1.5em}
293 dl dd{margin-left:1.125em}
294 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
295 ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
296 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
297 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
298 ul.unstyled,ol.unstyled{margin-left:0}
299 ul.checklist{margin-left:.625em}
300 ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
301 ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
302 ul.inline{display:-ms-flexbox;display:-webkit-box;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
303 ul.inline>li{margin-left:1.25em}
304 .unstyled dl dt{font-weight:400;font-style:normal}
305 ol.arabic{list-style-type:decimal}
306 ol.decimal{list-style-type:decimal-leading-zero}
307 ol.loweralpha{list-style-type:lower-alpha}
308 ol.upperalpha{list-style-type:upper-alpha}
309 ol.lowerroman{list-style-type:lower-roman}
310 ol.upperroman{list-style-type:upper-roman}
311 ol.lowergreek{list-style-type:lower-greek}
312 .hdlist>table,.colist>table{border:0;background:none}
313 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
314 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
315 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
316 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
317 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
318 .colist td:not([class]):first-child img{max-width:none}
319 .colist td:not([class]):last-child{padding:.25em 0}
320 .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
321 .imageblock.left{margin:.25em .625em 1.25em 0}
322 .imageblock.right{margin:.25em 0 1.25em .625em}
323 .imageblock>.title{margin-bottom:0}
324 .imageblock.thumb,.imageblock.th{border-width:6px}
325 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
326 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
327 .image.left{margin-right:.625em}
328 .image.right{margin-left:.625em}
329 a.image{text-decoration:none;display:inline-block}
330 a.image object{pointer-events:none}
331 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
332 sup.footnote a,sup.footnoteref a{text-decoration:none}
333 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
334 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
335 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
336 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
337 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
338 #footnotes .footnote:last-of-type{margin-bottom:0}
339 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
340 .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
341 .gist .file-data>table td.line-data{width:99%}
342 div.unbreakable{page-break-inside:avoid}
343 .big{font-size:larger}
344 .small{font-size:smaller}
345 .underline{text-decoration:underline}
346 .overline{text-decoration:overline}
347 .line-through{text-decoration:line-through}
348 .aqua{color:#00bfbf}
349 .aqua-background{background:#00fafa}
350 .black{color:#000}
351 .black-background{background:#000}
352 .blue{color:#0000bf}
353 .blue-background{background:#0000fa}
354 .fuchsia{color:#bf00bf}
355 .fuchsia-background{background:#fa00fa}
356 .gray{color:#606060}
357 .gray-background{background:#7d7d7d}
358 .green{color:#006000}
359 .green-background{background:#007d00}
360 .lime{color:#00bf00}
361 .lime-background{background:#00fa00}
362 .maroon{color:#600000}
363 .maroon-background{background:#7d0000}
364 .navy{color:#000060}
365 .navy-background{background:#00007d}
366 .olive{color:#606000}
367 .olive-background{background:#7d7d00}
368 .purple{color:#600060}
369 .purple-background{background:#7d007d}
370 .red{color:#bf0000}
371 .red-background{background:#fa0000}
372 .silver{color:#909090}
373 .silver-background{background:#bcbcbc}
374 .teal{color:#006060}
375 .teal-background{background:#007d7d}
376 .white{color:#bfbfbf}
377 .white-background{background:#fafafa}
378 .yellow{color:#bfbf00}
379 .yellow-background{background:#fafa00}
380 span.icon>.fa{cursor:default}
381 a span.icon>.fa{cursor:inherit}
382 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
383 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
384 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
385 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
386 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
387 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
388 .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
389 .conum[data-value] *{color:#fff!important}
390 .conum[data-value]+b{display:none}
391 .conum[data-value]::after{content:attr(data-value)}
392 pre .conum[data-value]{position:relative;top:-.125em}
393 b.conum *{color:inherit!important}
394 .conum:not([data-value]):empty{display:none}
395 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
396 h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
397 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
398 p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
399 p{margin-bottom:1.25rem}
400 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
401 .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
402 .print-only{display:none!important}
403 @page{margin:1.25cm .75cm}
404 @media print{*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
405 html{font-size:80%}
406 a{color:inherit!important;text-decoration:underline!important}
407 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
408 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
409 abbr[title]::after{content:" (" attr(title) ")"}
410 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
411 thead{display:table-header-group}
412 svg{max-width:100%}
413 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
414 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
415 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
416 #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
417 body.book #header{text-align:center}
418 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
419 body.book #header .details{border:0!important;display:block;padding:0!important}
420 body.book #header .details span:first-child{margin-left:0!important}
421 body.book #header .details br{display:block}
422 body.book #header .details br+span::before{content:none!important}
423 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
424 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
425 .listingblock code[data-lang]::before{display:block}
426 #footer{padding:0 .9375em}
427 .hide-on-print{display:none!important}
428 .print-only{display:block!important}
429 .hide-for-print{display:none!important}
430 .show-for-print{display:inherit!important}}
431 @media print,amzn-kf8{#header>h1:first-child{margin-top:1.25rem}
432 .sect1{padding:0!important}
433 .sect1+.sect1{border:0}
434 #footer{background:none}
435 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
436 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
437 </style>
438 </head>
439 <body class="article toc2 toc-left">
440 <div id="header">
441 <h1>i3blocks</h1>
442 <div id="toc" class="toc2">
443 <div id="toctitle">Table of Contents</div>
444 <ul class="sectlevel1">
445 <li><a href="#_example">Example</a></li>
446 <li><a href="#_installation">Installation</a></li>
447 <li><a href="#_getting_started">Getting started</a></li>
448 <li><a href="#_blocks">Blocks</a></li>
449 <li><a href="#_i3bar_properties">i3bar properties</a></li>
450 <li><a href="#_i3blocks_properties">i3blocks properties</a>
451 <ul class="sectlevel2">
452 <li><a href="#_command">command</a></li>
453 <li><a href="#_interval">interval</a></li>
454 <li><a href="#_signal">signal</a></li>
455 <li><a href="#_format">format</a></li>
456 </ul>
457 </li>
458 <li><a href="#_click">Click</a></li>
459 <li><a href="#_faq">FAQ</a></li>
460 <li><a href="#_debugging">Debugging</a></li>
461 <li><a href="#_license">License</a></li>
462 </ul>
463 </div>
464 </div>
465 <div id="content">
466 <div id="preamble">
467 <div class="sectionbody">
468 <div class="paragraph">
469 <p>A feed generator for text based status bars</p>
470 </div>
471 <div class="paragraph">
472 <p>i3blocks executes your command lines and generates a status line from their output.
473 Commands are scheduled at configured time intervals, upon signal reception or on clicks.</p>
474 </div>
475 <div class="paragraph">
476 <p>The generated line is meant to be displayed by the <a href="https://i3wm.org">i3</a> window manager through its i3bar component, as an alternative to i3status.</p>
477 </div>
478 <div class="paragraph">
479 <p>i3blocks is meant to be highly flexible but intuitive.
480 No library package is required, just output what your status bar expects, from your favorite programming language and your preferred format.</p>
481 </div>
482 </div>
483 </div>
484 <div class="sect1">
485 <h2 id="_example">Example</h2>
486 <div class="sectionbody">
487 <div class="listingblock">
488 <div class="content">
489 <pre class="highlight"><code class="language-ini" data-lang="ini">[click]
490 full_text=Click me!
491 command=echo "Got clicked with button $button"
492 color=#F79494
493
494 # Guess the weather hourly
495 [weather]
496 command=curl -Ss 'https://wttr.in?0&amp;T&amp;Q' | cut -c 16- | head -2 | xargs echo
497 interval=3600
498 color=#A4C2F4
499
500 # Query my default IP address only on startup
501 [ip]
502 command=hostname -i | awk '{ print "IP:" $1 }'
503 interval=once
504 color=#91E78B
505
506 # Update time every 5 seconds
507 [time]
508 command=date +%T
509 interval=5</code></pre>
510 </div>
511 </div>
512 </div>
513 </div>
514 <div class="sect1">
515 <h2 id="_installation">Installation</h2>
516 <div class="sectionbody">
517 <div class="paragraph">
518 <p>i3blocks is already packaged for:</p>
519 </div>
520 <div class="ulist">
521 <ul>
522 <li>
523 <p>Archlinux: <a href="https://www.archlinux.org/packages/community/x86_64/i3blocks">i3blocks</a> in the community repository and <a href="https://aur.archlinux.org/packages/i3blocks-git">i3blocks-git</a> in the AUR</p>
524 </li>
525 <li>
526 <p>Gentoo: <a href="https://packages.gentoo.org/packages/x11-misc/i3blocks">x11-misc/i3blocks</a></p>
527 </li>
528 <li>
529 <p>Debian: <a href="https://packages.debian.org/i3blocks">i3blocks</a></p>
530 </li>
531 <li>
532 <p>Ubuntu: <a href="http://packages.ubuntu.com/i3blocks">i3blocks</a></p>
533 </li>
534 <li>
535 <p>Fedora (COPR): <a href="https://copr.fedorainfracloud.org/coprs/wyvie/i3blocks">i3blocks</a></p>
536 </li>
537 <li>
538 <p>Void Linux: <a href="https://github.com/void-linux/void-packages/tree/master/srcpkgs/i3blocks">i3blocks</a></p>
539 </li>
540 </ul>
541 </div>
542 <div class="paragraph">
543 <p>Or can be installed from source with:</p>
544 </div>
545 <div class="listingblock">
546 <div class="content">
547 <pre class="highlight"><code>git clone https://github.com/vivien/i3blocks
548 cd i3blocks
549 ./autogen.sh
550 ./configure
551 make
552 make install</code></pre>
553 </div>
554 </div>
555 </div>
556 </div>
557 <div class="sect1">
558 <h2 id="_getting_started">Getting started</h2>
559 <div class="sectionbody">
560 <div class="paragraph">
561 <p>In your i3 configuration file, define i3blocks as the <a href="https://i3wm.org/docs/userguide.html#status_command">status line command</a> of a new bar block:</p>
562 </div>
563 <div class="listingblock">
564 <div class="content">
565 <pre class="highlight"><code>bar {
566 status_command i3blocks
567 }</code></pre>
568 </div>
569 </div>
570 <div class="admonitionblock important">
571 <table>
572 <tr>
573 <td class="icon">
574 <div class="title">Important</div>
575 </td>
576 <td class="content">
577 The project&#8217;s repository does not include default scripts anymore.
578 </td>
579 </tr>
580 </table>
581 </div>
582 <div class="paragraph">
583 <p>For the lazy, you can start from <a href="https://github.com/vivien/i3blocks-contrib">our collection of scripts</a>:</p>
584 </div>
585 <div class="listingblock">
586 <div class="content">
587 <pre class="highlight"><code>git clone https://github.com/vivien/i3blocks-contrib ~/.config/i3blocks
588 cd !$
589 cp config.example config</code></pre>
590 </div>
591 </div>
592 <div class="paragraph">
593 <p>For the picky, you can start a configuration file in one of the following preferred paths:</p>
594 </div>
595 <div class="ulist">
596 <ul>
597 <li>
598 <p><code>$XDG_CONFIG_HOME/i3blocks/config</code> (or <code>~/.config/i3blocks/config</code>);</p>
599 </li>
600 <li>
601 <p><code>~/.i3blocks.conf</code>;</p>
602 </li>
603 <li>
604 <p><code>$XDG_CONFIG_DIRS/i3blocks/config</code> (or <code>/etc/xdg/i3blocks/config</code>);</p>
605 </li>
606 <li>
607 <p><code>/etc/i3blocks.conf</code>;</p>
608 </li>
609 <li>
610 <p>or any other path that you will specify using the <code>-c</code> option.</p>
611 </li>
612 </ul>
613 </div>
614 <div class="admonitionblock note">
615 <table>
616 <tr>
617 <td class="icon">
618 <div class="title">Note</div>
619 </td>
620 <td class="content">
621 By default <code>/etc</code> is prefixed by <code>/usr/local</code> when you installed from source.
622 </td>
623 </tr>
624 </table>
625 </div>
626 <div class="paragraph">
627 <p>Use the example above or dig in the configuration details below.</p>
628 </div>
629 <div class="paragraph">
630 <p>Now restart i3 with <code>i3-msg restart</code> to apply your changes.</p>
631 </div>
632 </div>
633 </div>
634 <div class="sect1">
635 <h2 id="_blocks">Blocks</h2>
636 <div class="sectionbody">
637 <div class="paragraph">
638 <p>The configuration file uses a simplified INI file format:</p>
639 </div>
640 <div class="listingblock">
641 <div class="content">
642 <pre class="highlight"><code class="language-ini" data-lang="ini"># Properties not preceded by a section are considered global
643 # and merged into every section declarations.
644 foo=bar
645
646 [block1]
647 baz=qux
648
649 # This is a comment
650 [block2]
651 quux= quuz</code></pre>
652 </div>
653 </div>
654 <div class="paragraph">
655 <p>In this example, <em>block2</em> contains a <em>foo</em> property equal to <em>"bar"</em> and a <em>quux</em> property equal to <em>" quuz"</em> (including the leading space).
656 Everything after the equal sign will be part of the value, thus inline comments won&#8217;t be stripped out.</p>
657 </div>
658 <div class="paragraph">
659 <p>At runtime, these properties are simply variables, that are passed along to the status bar program when printing is necessary.
660 However on startup, i3blocks checks some optional properties to eventually setup the scheduling of a command.</p>
661 </div>
662 <div class="paragraph">
663 <p>If a block specifies a command, then all of its properties are passed as environment variables at execution, which means that the <em>foo=bar</em> property will be available from a shell script with <code>$foo</code>.
664 The output of the command is used to update the values of these variables.
665 The values are reset to default (as defined in the configuration file) before the update, so that blocks get a consistent behavior at each execution.</p>
666 </div>
667 </div>
668 </div>
669 <div class="sect1">
670 <h2 id="_i3bar_properties">i3bar properties</h2>
671 <div class="sectionbody">
672 <div class="paragraph">
673 <p>In order to use i3blocks with i3, its status bar command <em>i3bar</em> expects specific keys.
674 To know how to customize the blocks of your status line, you must refer to the <a href="https://i3wm.org/docs/i3bar-protocol.html#_blocks_in_detail">i3bar protocol</a>.</p>
675 </div>
676 <div class="admonitionblock note">
677 <table>
678 <tr>
679 <td class="icon">
680 <div class="title">Note</div>
681 </td>
682 <td class="content">
683 <em>full_text</em> is the only mandatory key, the block will be skipped if this key is absent or empty.
684 </td>
685 </tr>
686 </table>
687 </div>
688 <div class="paragraph">
689 <p>Unless overriden, the section name of the block defines the <em>name</em> key.</p>
690 </div>
691 <div class="paragraph">
692 <p>Below are examples of static blocks interacting with <em>i3bar</em>.</p>
693 </div>
694 <div class="listingblock">
695 <div class="content">
696 <pre class="highlight"><code class="language-ini" data-lang="ini">[simple]
697 full_text=This is a looong white on red text
698 short_text=Short white on red text
699 background=#FF0000
700 color=#FFFFFF
701
702 # Block with a fixed width
703 [aligned]
704 full_text=Here.
705 min_width=100
706 align=center
707
708 # Fancy text with multiple colors and shapes
709 [funky]
710 full_text=&lt;span foreground="red" size="x-large"&gt;Roses&lt;/span&gt; and &lt;i&gt;&lt;span color="#EE37B8"&gt;violets&lt;/span&gt;&lt;/i&gt;!
711 markup=pango</code></pre>
712 </div>
713 </div>
714 </div>
715 </div>
716 <div class="sect1">
717 <h2 id="_i3blocks_properties">i3blocks properties</h2>
718 <div class="sectionbody">
719 <div class="paragraph">
720 <p>These are some special properties checked by i3blocks on startup.
721 These will be considered as simple variables at runtime.</p>
722 </div>
723 <div class="sect2">
724 <h3 id="_command">command</h3>
725 <div class="paragraph">
726 <p>The optional <em>command</em> property specifies a command line to be executed with <code>sh -c</code>.
727 The command can be relative to the configuration file where it is defined.
728 If the command outputs some text, it is used to update the block.</p>
729 </div>
730 <div class="paragraph">
731 <p>An exit code of 0 means success.
732 A special exit code of <em>33</em> will set the <em>urgent</em> i3bar key to true.
733 Any other exit code will raise an error.</p>
734 </div>
735 <div class="listingblock">
736 <div class="content">
737 <pre class="highlight"><code class="language-ini" data-lang="ini">[pacman]
738 full_text=c ·
739 command=echo "· ${full_text~~}"
740 color=#FFFF00</code></pre>
741 </div>
742 </div>
743 </div>
744 <div class="sect2">
745 <h3 id="_interval">interval</h3>
746 <div class="paragraph">
747 <p>The optional <em>interval</em> property specifies when the command must be scheduled.</p>
748 </div>
749 <div class="paragraph">
750 <p>A positive value represents the number of seconds to wait between exectutions.</p>
751 </div>
752 <div class="listingblock">
753 <div class="content">
754 <pre class="highlight"><code class="language-ini" data-lang="ini"># Print seconds since 1970-01-01
755 [epoch]
756 command=date +%s
757 interval=1</code></pre>
758 </div>
759 </div>
760 <div class="paragraph">
761 <p>A value of <em>0</em> (or undefined) means the command is not timed whatsoever and will not be executed on startup.
762 This is useful to trigger the command only on user input (e.g. signal or click), not before.</p>
763 </div>
764 <div class="listingblock">
765 <div class="content">
766 <pre class="highlight"><code class="language-ini" data-lang="ini"># Restart i3 on click
767 [restart]
768 full_text=Restart
769 command=i3-msg -q restart
770 #interval=0</code></pre>
771 </div>
772 </div>
773 <div class="paragraph">
774 <p>The interval value <em>once</em> (or <em>-1</em>) will schedule the command only on startup.
775 This tells i3blocks not to schedule the command again on a time basis.
776 But events such as signals and clicks will execute the command again of course.</p>
777 </div>
778 <div class="listingblock">
779 <div class="content">
780 <pre class="highlight"><code class="language-ini" data-lang="ini"># Fetch the public IP address only on startup
781 [public-ip]
782 command=wget -qO - icanhazip.com
783 interval=once</code></pre>
784 </div>
785 </div>
786 <div class="paragraph">
787 <p>The interval value <em>repeat</em> (or <em>-2</em>) will respawn the command as soon as it terminates.
788 This is convenient for blocking programs which exit as soon as the awaited event arises.</p>
789 </div>
790 <div class="admonitionblock note">
791 <table>
792 <tr>
793 <td class="icon">
794 <div class="title">Note</div>
795 </td>
796 <td class="content">
797 clicks are not supported with this value, since such commands are unlikely to expect data on their standard input.
798 </td>
799 </tr>
800 </table>
801 </div>
802 <div class="listingblock">
803 <div class="content">
804 <pre class="highlight"><code class="language-ini" data-lang="ini"># Print the last command entered in Bash
805 [history]
806 command=inotifywait -qq -e close_write ~/.bash_history; tail -1 ~/.bash_history
807 interval=repeat</code></pre>
808 </div>
809 </div>
810 <div class="paragraph">
811 <p>The interval value <em>persist</em> (or <em>-3</em>) expects the command to be an infinite loop.
812 Each line of the output will trigger an update of the block.</p>
813 </div>
814 <div class="listingblock">
815 <div class="content">
816 <pre class="highlight"><code class="language-ini" data-lang="ini">[window]
817 command=xtitle -s
818 interval=persist</code></pre>
819 </div>
820 </div>
821 </div>
822 <div class="sect2">
823 <h3 id="_signal">signal</h3>
824 <div class="paragraph">
825 <p>Blocks can be scheduled upon reception of a real-time signal (think prioritized and queueable).
826 The range of available signal numbers is <em>1</em> to <em>N</em>, where <em>SIGRTMIN+N = SIGRTMAX</em>.
827 (Note: there are 31 real-time signals in Linux.)</p>
828 </div>
829 <div class="listingblock">
830 <div class="content">
831 <pre class="highlight"><code class="language-ini" data-lang="ini">[caps-lock]
832 command=xset -q | grep Caps | awk '{ print $2, $3, $4 }'
833 interval=once
834 signal=10</code></pre>
835 </div>
836 </div>
837 <div class="paragraph">
838 <p>This example block above will be scheduled once i3blocks handles the <em>SIGRTMIN+10</em> signal.
839 This can be sent directly from an i3 binding on Caps Lock release with the following configuration:</p>
840 </div>
841 <div class="listingblock">
842 <div class="content">
843 <pre class="highlight"><code>bindsym --release Caps_Lock exec pkill -SIGRTMIN+10 i3blocks</code></pre>
844 </div>
845 </div>
846 </div>
847 <div class="sect2">
848 <h3 id="_format">format</h3>
849 <div class="paragraph">
850 <p>There are several formats supported to specify which variables i3blocks must update.
851 Some favor simplicity over flexibility but thus can be limited.</p>
852 </div>
853 <div class="paragraph">
854 <p>When undefined, a raw format is assumed.
855 Each line of the output corresponds to an i3bar key, in the order of definition found in the <a href="https://i3wm.org/docs/i3bar-protocol.html#_blocks_in_detail">i3bar protocol</a>:</p>
856 </div>
857 <div class="ulist">
858 <ul>
859 <li>
860 <p>the 1st line updates the <em>full_text</em>;</p>
861 </li>
862 <li>
863 <p>the 2nd line updates the <em>short_text</em>;</p>
864 </li>
865 <li>
866 <p>the 3rd line updates the <em>color</em>;</p>
867 </li>
868 <li>
869 <p>the 4th line updates the <em>background</em>.</p>
870 </li>
871 </ul>
872 </div>
873 <div class="paragraph">
874 <p>Excess lines are considered an error.
875 Below is an example of a simple battery script.</p>
876 </div>
877 <div class="listingblock">
878 <div class="title">battery.sh</div>
879 <div class="content">
880 <pre class="highlight"><code class="language-sh" data-lang="sh">#!/bin/bash
881
882 BAT=$(acpi -b | grep -E -o '[0-9][0-9]?%')
883
884 # Full and short texts
885 echo "Battery: $BAT"
886 echo "BAT: $BAT"
887
888 # Set urgent flag below 5% or use orange below 20%
889 [ ${BAT%?} -le 5 ] &amp;&amp; exit 33
890 [ ${BAT%?} -le 20 ] &amp;&amp; echo "#FF8000"
891
892 exit 0</code></pre>
893 </div>
894 </div>
895 <div class="listingblock">
896 <div class="content">
897 <pre class="highlight"><code class="language-ini" data-lang="ini">[battery]
898 command=battery.sh
899 interval=10</code></pre>
900 </div>
901 </div>
902 <div class="paragraph">
903 <p>The <em>json</em> format can update any variable.</p>
904 </div>
905 <div class="listingblock">
906 <div class="content">
907 <pre class="highlight"><code class="language-ini" data-lang="ini">[counter]
908 _count=0
909 command=printf '{"full_text":"Counter: %s", "_count":%d}\n' $_count $((_count + 1))
910 format=json
911 interval=1</code></pre>
912 </div>
913 </div>
914 </div>
915 </div>
916 </div>
917 <div class="sect1">
918 <h2 id="_click">Click</h2>
919 <div class="sectionbody">
920 <div class="paragraph">
921 <p>When you click on a block, data such as the button number and coordinates are merged into the block variables.</p>
922 </div>
923 <div class="admonitionblock note">
924 <table>
925 <tr>
926 <td class="icon">
927 <div class="title">Note</div>
928 </td>
929 <td class="content">
930 <em>name</em> and <em>instance</em> are the two keys used by i3bar to identify a block.
931 </td>
932 </tr>
933 </table>
934 </div>
935 <div class="paragraph">
936 <p>The data sent on click is detailed in the <a href="https://i3wm.org/docs/i3bar-protocol.html#_click_events">i3bar protocol</a>.</p>
937 </div>
938 <div class="paragraph">
939 <p>If the block command isn&#8217;t already spawned, it is executed again.</p>
940 </div>
941 <div class="listingblock">
942 <div class="content">
943 <pre class="highlight"><code class="language-ini" data-lang="ini"># Print click data
944 [clickme]
945 align=center
946 full_text=Click me!
947 min_width=Button=? x=? y=?
948 command=echo "Button=$button x=$x y=$y"</code></pre>
949 </div>
950 </div>
951 <div class="paragraph">
952 <p>If the value of the block&#8217;s interval is <em>persist</em>, then the data is written on the command standard input, one line per click.
953 What gets written depends on the block&#8217;s format.
954 The raw format only gets the click button.
955 The JSON format gets all block variables.</p>
956 </div>
957 <div class="listingblock">
958 <div class="content">
959 <pre class="highlight"><code class="language-ini" data-lang="ini">[click-loop]
960 full_text=Click me!
961 command=while read button; do echo "Got click $button"; done
962 interval=persist
963
964 [click-loop-json]
965 full_text=Click me!
966 command=ruby -r json -n -e '$_ = JSON.parse($_)' -e '$_["full_text"] = "Click %s at (%d,%d)" % $_.slice("button", "x", "y").values' -e 'puts JSON.dump($_)' -e 'STDOUT.flush'
967 interval=persist
968 format=json</code></pre>
969 </div>
970 </div>
971 </div>
972 </div>
973 <div class="sect1">
974 <h2 id="_faq">FAQ</h2>
975 <div class="sectionbody">
976 <div class="paragraph">
977 <p>Frequently Asked Questions and Troubleshooting.</p>
978 </div>
979 <div class="qlist qanda">
980 <ol>
981 <li>
982 <p><em>What is a blocklet?</em></p>
983 <p>A blocklet is the configuration of a single block, part of the status line.
984 There are plenty listed in the <a href="https://vivien.github.io/i3blocks/blocklets">blocklets page</a>.</p>
985 </li>
986 <li>
987 <p><em>Can I use my own variables?</em></p>
988 <p>Yes, any variable defined in the block is exported as is to the environment of its command.
989 The <code>foo=bar</code> property can be accessed with <code>$foo</code> from a shell script, <code>ENV["foo"]</code> from Ruby, and so on.</p>
990 <div class="paragraph">
991 <p>The IEEE and The Open Group state that <a href="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html">"The name space of environment variable names containing lowercase letters is reserved for applications."</a>.
992 i3bar suggests to prefix your own keys with an underscore (<code>_</code>), but it might be more intuitive to use uppercase environment variables, so it is your call to define your own naming convention.</p>
993 </div>
994 </li>
995 <li>
996 <p><em>Why <code>$foo</code> doesn&#8217;t work from the configuration file?</em></p>
997 <p>i3blocks does not do string interpolation of any sort.
998 The definitions found in the configuration file are just raw strings, this means that <code>bar=$baz</code> defines a <em>bar</em> variable equal to literally <code>$baz</code> (a dollar sign followed by "baz").</p>
999 <div class="paragraph">
1000 <p>String interpolation does work in the <em>command</em> property though, since it is interpreted by a shell which has access to the environment variables.</p>
1001 </div>
1002 </li>
1003 <li>
1004 <p><em>How can I simulate a button?</em></p>
1005 <p>This is pretty straightforward actually.
1006 Just make sure not to override the <em>full_text</em>, for example:</p>
1007 <div class="listingblock">
1008 <div class="content">
1009 <pre class="highlight"><code class="language-ini" data-lang="ini">[calc-button]
1010 full_text=Calculator
1011 command=gnome-calculator &gt;/dev/null</code></pre>
1012 </div>
1013 </div>
1014 </li>
1015 <li>
1016 <p><em>Can a block start a GUI application?</em></p>
1017 <p>Sure.
1018 And if you do not wish your command to block until the application is closed, ask i3 to start it for you with <code>i3-msg -q exec myapp</code>.</p>
1019 </li>
1020 <li>
1021 <p><em>Why Pango isn&#8217;t working?</em></p>
1022 <p>The Pango markup requires a Pango font.
1023 Make sure you configured <a href="https://i3wm.org/docs/userguide.html#_font">i3bar</a> to use a Pango font.
1024 For example:</p>
1025 <div class="listingblock">
1026 <div class="content">
1027 <pre class="highlight"><code>font pango:Inconsolata, Icons 12</code></pre>
1028 </div>
1029 </div>
1030 </li>
1031 <li>
1032 <p><em>Why is the output from my persistent block not displayed?</em></p>
1033 <p>Make sure to flush stdout, for example:</p>
1034 <div class="listingblock">
1035 <div class="content">
1036 <pre class="highlight"><code class="language-ini" data-lang="ini">[ruby-loop]
1037 full_text=Click me
1038 command=ruby -p -e '$_.prepend("Got button ")' -e 'STDOUT.flush'
1039 interval=persist</code></pre>
1040 </div>
1041 </div>
1042 </li>
1043 <li>
1044 <p><em>Can I use a time interval below 1 second?</em></p>
1045 <p>No, the time unit for interval is the second.</p>
1046 <div class="paragraph">
1047 <p>But even though I wouldn&#8217;t recommend it, you can still update faster than that with loops:</p>
1048 </div>
1049 <div class="listingblock">
1050 <div class="content">
1051 <pre class="highlight"><code class="language-ini" data-lang="ini">[nano1]
1052 command=sleep .5; date +%N
1053 interval=repeat
1054
1055 [nano2]
1056 command=while sleep .5; do date +%N; done
1057 interval=persist</code></pre>
1058 </div>
1059 </div>
1060 </li>
1061 <li>
1062 <p><em>Can I change the block separator?</em></p>
1063 <p>Not with i3blocks itself, separators are drawn by i3bar.
1064 You can change the <em>separator_symbol</em> in the <a href="https://i3wm.org/docs/userguide.html#_custom_separator_symbol">i3bar configuration</a>.</p>
1065 <div class="paragraph">
1066 <p>Alternatively, you can define static blocks as custom separators in your i3blocks configuration.
1067 In the example below, we use the <em>"\xe3\x80\x89"</em> UTF-8 character:</p>
1068 </div>
1069 <div class="listingblock">
1070 <div class="content">
1071 <pre class="highlight"><code class="language-ini" data-lang="ini"># Define the custom separator in global properties for boilerplate
1072 full_text=〉
1073 align=center
1074 color=#666666
1075 separator=false
1076 separator_block_width=7
1077
1078 [time]
1079 instance=la
1080 TZ=America/Los_Angeles
1081 command=date +%T
1082 interval=5
1083
1084 [separator]
1085
1086 [time]
1087 instance=nc
1088 TZ=Pacific/Noumea
1089 command=date +%T
1090 interval=5
1091
1092 [separator]
1093
1094 [time]
1095 instance=mtl
1096 TZ=America/Montreal
1097 command=date +%T
1098 interval=5</code></pre>
1099 </div>
1100 </div>
1101 </li>
1102 </ol>
1103 </div>
1104 </div>
1105 </div>
1106 <div class="sect1">
1107 <h2 id="_debugging">Debugging</h2>
1108 <div class="sectionbody">
1109 <div class="paragraph">
1110 <p>The log level can be increased with the <code>-v</code> option.</p>
1111 </div>
1112 <div class="paragraph">
1113 <p>If your window manager (and thus this program) is run via systemd, you can inspect the program outputs with <code>journalctl -t &lt;identifier&gt; -f</code>.
1114 You may also use this in conjonction with running the program manually with <code>systemd-cat -t &lt;identifier&gt; ./i3blocks</code>.</p>
1115 </div>
1116 <div class="paragraph">
1117 <p>Alternatively you can redirect the standard output and error streams from the program invokation with:</p>
1118 </div>
1119 <div class="listingblock">
1120 <div class="content">
1121 <pre class="highlight"><code>bar {
1122 status_command 2&gt;/tmp/i3blocks.err /path/to/i3blocks -vvv -c /path/to/config | tee /tmp/i3blocks.out
1123 }</code></pre>
1124 </div>
1125 </div>
1126 <div class="paragraph">
1127 <p>And inspect the log with <code>tail -f /tmp/i3blocks.err</code>.</p>
1128 </div>
1129 <div class="paragraph">
1130 <p>See the <a href="i3blocks.1.html">manpage</a> for details about the command line options and i3blocks usage.</p>
1131 </div>
1132 </div>
1133 </div>
1134 <div class="sect1">
1135 <h2 id="_license">License</h2>
1136 <div class="sectionbody">
1137 <div class="paragraph">
1138 <p>i3blocks is Copyright &#169; Vivien Didelot</p>
1139 </div>
1140 <div class="paragraph">
1141 <p>See the file COPYING for information of licensing and distribution.</p>
1142 </div>
1143 </div>
1144 </div>
1145 </div>
1146 <div id="footer">
1147 <div id="footer-text">
1148 </div>
1149 </div>
1150 </body>
1151 </html>