Debian Codegraph @

docs/index.html

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