-
Notifications
You must be signed in to change notification settings - Fork 3
/
index.html
947 lines (895 loc) · 42 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>awesome API documentation</title>
<link rel="stylesheet" href="ldoc.css" type="text/css" />
<script>
function show_extra(id) {
var cur = document.getElementById("item"+id).className
if (cur == "hide_extra") {
document.getElementById("item"+id).className = "show_more"
document.getElementById("button"+id).className = "hide_extra"
}
}
</script>
</head>
<body>
<div id="container">
<div id="main">
<!-- Menu -->
<div id="navigation">
<h1>awesome</h1>
<div class="select">
<select name="theme" id="theme-select">
<option selected disabled>Choose a theme</option>
<option value="light">LDoc Light</option>
<option value="dark">Awesome Dark</option>
<option value="monokai">Monokai</option>
<option value="onedark">One Dark</option>
</select>
</div>
<h2>Core components</h2>
<ul class="nowrap">
<li><a href="core_components/awesome.html">awesome</a></li>
<li><a href="core_components/awful.keygrabber.html">awful.keygrabber</a></li>
<li><a href="core_components/client.html">client<span class='listplusign'> and awful.client</span></a></li>
<li><a href="core_components/drawable.html">drawable</a></li>
<li><a href="core_components/gears.timer.html">gears.timer</a></li>
<li><a href="core_components/mousegrabber.html">mousegrabber</a></li>
<li><a href="core_components/naughty.action.html">naughty.action</a></li>
<li><a href="core_components/naughty.notification.html">naughty.notification</a></li>
<li><a href="core_components/root.html">root</a></li>
<li><a href="core_components/screen.html">screen<span class='listplusign'> and awful.screen</span></a></li>
<li><a href="core_components/tag.html">tag<span class='listplusign'> and awful.tag</span></a></li>
</ul>
<h2>Input handling</h2>
<ul class="nowrap">
<li><a href="input_handling/awful.button.html">awful.button</a></li>
<li><a href="input_handling/awful.key.html">awful.key</a></li>
<li><a href="input_handling/awful.keyboard.html">awful.keyboard</a></li>
<li><a href="input_handling/mouse.html">mouse</a></li>
</ul>
<h2>Declarative rules</h2>
<ul class="nowrap">
<li><a href="declarative_rules/ruled.client.html">ruled.client</a></li>
<li><a href="declarative_rules/ruled.notifications.html">ruled.notifications</a></li>
</ul>
<h2>Widgets</h2>
<ul class="nowrap">
<li><a href="widgets/awful.widget.button.html">awful.widget.button</a></li>
<li><a href="widgets/awful.widget.clienticon.html">awful.widget.clienticon</a></li>
<li><a href="widgets/awful.widget.keyboardlayout.html">awful.widget.keyboardlayout</a></li>
<li><a href="widgets/awful.widget.launcher.html">awful.widget.launcher</a></li>
<li><a href="widgets/awful.widget.layoutbox.html">awful.widget.layoutbox</a></li>
<li><a href="widgets/awful.widget.layoutlist.html">awful.widget.layoutlist</a></li>
<li><a href="widgets/awful.widget.prompt.html">awful.widget.prompt</a></li>
<li><a href="widgets/awful.widget.taglist.html">awful.widget.taglist</a></li>
<li><a href="widgets/awful.widget.tasklist.html">awful.widget.tasklist</a></li>
<li><a href="widgets/awful.widget.watch.html">awful.widget.watch</a></li>
<li><a href="widgets/naughty.list.actions.html">naughty.list.actions</a></li>
<li><a href="widgets/naughty.list.notifications.html">naughty.list.notifications</a></li>
<li><a href="widgets/naughty.widget.icon.html">naughty.widget.icon</a></li>
<li><a href="widgets/naughty.widget.message.html">naughty.widget.message</a></li>
<li><a href="widgets/naughty.widget.title.html">naughty.widget.title</a></li>
<li><a href="widgets/wibox.widget.calendar.html">wibox.widget.calendar</a></li>
<li><a href="widgets/wibox.widget.checkbox.html">wibox.widget.checkbox</a></li>
<li><a href="widgets/wibox.widget.graph.html">wibox.widget.graph</a></li>
<li><a href="widgets/wibox.widget.imagebox.html">wibox.widget.imagebox</a></li>
<li><a href="widgets/wibox.widget.piechart.html">wibox.widget.piechart</a></li>
<li><a href="widgets/wibox.widget.progressbar.html">wibox.widget.progressbar</a></li>
<li><a href="widgets/wibox.widget.separator.html">wibox.widget.separator</a></li>
<li><a href="widgets/wibox.widget.slider.html">wibox.widget.slider</a></li>
<li><a href="widgets/wibox.widget.systray.html">wibox.widget.systray</a></li>
<li><a href="widgets/wibox.widget.textbox.html">wibox.widget.textbox</a></li>
<li><a href="widgets/wibox.widget.textclock.html">wibox.widget.textclock</a></li>
</ul>
<h2>Widget containers</h2>
<ul class="nowrap">
<li><a href="widget_containers/awful.widget.only_on_screen.html">awful.widget.only_on_screen</a></li>
<li><a href="widget_containers/naughty.widget.background.html">naughty.widget.background</a></li>
<li><a href="widget_containers/wibox.container.arcchart.html">wibox.container.arcchart</a></li>
<li><a href="widget_containers/wibox.container.background.html">wibox.container.background</a></li>
<li><a href="widget_containers/wibox.container.border.html">wibox.container.border</a></li>
<li><a href="widget_containers/wibox.container.constraint.html">wibox.container.constraint</a></li>
<li><a href="widget_containers/wibox.container.margin.html">wibox.container.margin</a></li>
<li><a href="widget_containers/wibox.container.mirror.html">wibox.container.mirror</a></li>
<li><a href="widget_containers/wibox.container.place.html">wibox.container.place</a></li>
<li><a href="widget_containers/wibox.container.radialprogressbar.html">wibox.container.radialprogressbar</a></li>
<li><a href="widget_containers/wibox.container.rotate.html">wibox.container.rotate</a></li>
<li><a href="widget_containers/wibox.container.scroll.html">wibox.container.scroll</a></li>
<li><a href="widget_containers/wibox.container.tile.html">wibox.container.tile</a></li>
</ul>
<h2>Widget layouts</h2>
<ul class="nowrap">
<li><a href="widget_layouts/wibox.layout.align.html">wibox.layout.align</a></li>
<li><a href="widget_layouts/wibox.layout.fixed.html">wibox.layout.fixed</a></li>
<li><a href="widget_layouts/wibox.layout.flex.html">wibox.layout.flex</a></li>
<li><a href="widget_layouts/wibox.layout.grid.html">wibox.layout.grid</a></li>
<li><a href="widget_layouts/wibox.layout.manual.html">wibox.layout.manual</a></li>
<li><a href="widget_layouts/wibox.layout.ratio.html">wibox.layout.ratio</a></li>
<li><a href="widget_layouts/wibox.layout.stack.html">wibox.layout.stack</a></li>
</ul>
<h2>Popups and bars</h2>
<ul class="nowrap">
<li><a href="popups_and_bars/awful.hotkeys_popup.widget.html">awful.hotkeys_popup.widget</a></li>
<li><a href="popups_and_bars/awful.menu.html">awful.menu</a></li>
<li><a href="popups_and_bars/awful.popup.html">awful.popup</a></li>
<li><a href="popups_and_bars/awful.titlebar.html">awful.titlebar</a></li>
<li><a href="popups_and_bars/awful.tooltip.html">awful.tooltip</a></li>
<li><a href="popups_and_bars/awful.wallpaper.html">awful.wallpaper</a></li>
<li><a href="popups_and_bars/awful.wibar.html">awful.wibar</a></li>
<li><a href="popups_and_bars/awful.widget.calendar_popup.html">awful.widget.calendar_popup</a></li>
<li><a href="popups_and_bars/menubar.html">menubar</a></li>
<li><a href="popups_and_bars/naughty.layout.box.html">naughty.layout.box</a></li>
<li><a href="popups_and_bars/naughty.layout.legacy.html">naughty.layout.legacy</a></li>
<li><a href="popups_and_bars/wibox.html">wibox</a></li>
</ul>
<h2>Utility libraries</h2>
<ul class="nowrap">
<li><a href="utility_libraries/gears.debug.html">gears.debug</a></li>
<li><a href="utility_libraries/gears.filesystem.html">gears.filesystem</a></li>
<li><a href="utility_libraries/gears.geometry.html">gears.geometry</a></li>
<li><a href="utility_libraries/gears.math.html">gears.math</a></li>
<li><a href="utility_libraries/gears.object.html">gears.object</a></li>
<li><a href="utility_libraries/gears.protected_call.html">gears.protected_call</a></li>
<li><a href="utility_libraries/gears.sort.html">gears.sort</a></li>
<li><a href="utility_libraries/gears.string.html">gears.string</a></li>
<li><a href="utility_libraries/gears.table.html">gears.table</a></li>
<li><a href="utility_libraries/gears.wallpaper.html">gears.wallpaper</a></li>
</ul>
<h2>Theme related libraries</h2>
<ul class="nowrap">
<li><a href="theme_related_libraries/beautiful.html">beautiful</a></li>
<li><a href="theme_related_libraries/gears.color.html">gears.color</a></li>
<li><a href="theme_related_libraries/gears.shape.html">gears.shape</a></li>
</ul>
<h2>Libraries</h2>
<ul class="nowrap">
<li><a href="libraries/awful.completion.html">awful.completion</a></li>
<li><a href="libraries/awful.hotkeys_popup.html">awful.hotkeys_popup</a></li>
<li><a href="libraries/awful.layout.html">awful.layout</a></li>
<li><a href="libraries/awful.permissions.html">awful.permissions</a></li>
<li><a href="libraries/awful.placement.html">awful.placement</a></li>
<li><a href="libraries/awful.prompt.html">awful.prompt</a></li>
<li><a href="libraries/awful.rules.html">awful.rules</a></li>
<li><a href="libraries/awful.spawn.html">awful.spawn</a></li>
<li><a href="libraries/awful.util.html">awful.util</a></li>
<li><a href="libraries/dbus.html">dbus</a></li>
<li><a href="libraries/gears.matcher.html">gears.matcher</a></li>
<li><a href="libraries/gears.surface.html">gears.surface</a></li>
<li><a href="libraries/menubar.menu_gen.html">menubar.menu_gen</a></li>
<li><a href="libraries/menubar.utils.html">menubar.utils</a></li>
<li><a href="libraries/naughty.html">naughty</a></li>
<li><a href="libraries/selection.html">selection</a></li>
<li><a href="libraries/wibox.widget.html">wibox.widget</a></li>
</ul>
<h2>Sample files</h2>
<ul class="nowrap">
<li><a href="sample files/rc.lua.html">rc.lua</a></li>
<li><a href="sample files/theme.lua.html">theme.lua</a></li>
</ul>
<h2>Classes</h2>
<ul class="nowrap">
<li><a href="classes/awful.screenshot.html">awful.screenshot</a></li>
<li><a href="classes/awful.widget.common.html">awful.widget.common</a></li>
<li><a href="classes/gears.cache.html">gears.cache</a></li>
<li><a href="classes/gears.matrix.html">gears.matrix</a></li>
<li><a href="classes/menubar.icon_theme.html">menubar.icon_theme</a></li>
<li><a href="classes/menubar.index_theme.html">menubar.index_theme</a></li>
<li><a href="classes/wibox.hierarchy.html">wibox.hierarchy</a></li>
<li><a href="classes/wibox.widget.base.html">wibox.widget.base</a></li>
<li><a href="classes/xproperties.html">xproperties</a></li>
</ul>
<h2>Documentation</h2>
<ul class="nowrap">
<li><a href="documentation/00-authors.md.html">Authors</a></li>
<li><a href="documentation/01-readme.md.html">Readme</a></li>
<li><a href="documentation/02-contributing.md.html">Contributing</a></li>
<li><a href="documentation/03-declarative-layout.md.html">The Widget system</a></li>
<li><a href="documentation/04-new-widgets.md.html">Creating new widget</a></li>
<li><a href="documentation/05-awesomerc.md.html">Default configuration file documentation</a></li>
<li><a href="documentation/06-appearance.md.html">Change Awesome appearance</a></li>
<li><a href="documentation/07-my-first-awesome.md.html">My first Awesome</a></li>
<li><a href="documentation/08-client-layout-system.md.html">The AwesomeWM client layout system</a></li>
<li><a href="documentation/09-options.md.html">Startup options</a></li>
<li><a href="documentation/10-building-and-testing.md.html">Building and Testing</a></li>
<li><a href="documentation/16-using-cairo.md.html">Using Cairo and LGI</a></li>
<li><a href="documentation/17-porting-tips.md.html">Tips for upgrading your configuration</a></li>
<li><a href="documentation/89-NEWS.md.html">NEWS</a></li>
<li><a href="documentation/90-FAQ.md.html">FAQ</a></li>
</ul>
</div>
<div id="content">
<h2>API documentation for awesome, a highly configurable X window manager (version master-gd53eb1b).</h2>
<p>
<p>Welcome to the documentation for the Awesome window manager. Below you find an
overview of the individual parts which links to the full documentation.</p>
<p>If you are a new user, you may want to read <a href="documentation/07-my-first-awesome.md.html#">07-my-first-awesome.md</a> to get
started. In <a href="documentation/05-awesomerc.md.html#">05-awesomerc.md</a>, the default configuration is explained.</p>
<p>If you already used awesome in the past, <a href="documentation/89-NEWS.md.html#">89-NEWS.md</a> and <a href="documentation/17-porting-tips.md.html#">17-porting-tips.md</a>
should be useful for you.</p>
<h3>Default configuration components name:</h3>
<p><center>
<object class="img-object" data="images/AUTOGEN_awful_popup_defaultconfig.svg" alt="" type="image/svg+xml"></object>
</center></p>
<h3>Guides</h3>
<div class="index_guides">
<div>
<a href="documentation/07-my-first-awesome.md.html#">Getting started</a>
<a href="documentation/90-FAQ.md.html#">FAQ</a>
<a href="documentation/01-readme.md.html#">Read Me</a>
<a href="documentation/89-NEWS.md.html#">NEWS</a>
</div>
<div>
<a href="documentation/03-declarative-layout.md.html#">The widget system</a>
<a href="documentation/09-options.md.html#">Startup options</a>
<a href="documentation/05-awesomerc.md.html#">The default rc.lua</a>
<a href="documentation/08-client-layout-system.md.html#">Window management</a>
</div>
</div>
<h2>Major libraries</h2>
<p>AwesomeWM ship multiple libraries. Here is an overview of the purpose and scope
of those libraries.</p>
<table class='widget_list' border=1>
<tr style='font-weight: bold;'>
<th align='center'>Library</th>
<th align='center'>Description</th>
</tr>
<tr><td><code>gears</code></td><td>Utilities such as color parsing and objects</td></tr>
<tr><td><a href="popups_and_bars/wibox.html#">wibox</a></td><td>Awesome own generic widget framework</td></tr>
<tr><td><code>awful</code></td><td>Everything related to window managment</td></tr>
<tr><td><code>awful.widget</code></td><td>Window management related widgets</td></tr>
<tr><td><a href="libraries/awful.layout.html#">awful.layout</a></td><td>The default stateless client tiling module.</td></tr>
<tr><td><code>ruled</code></td><td>Define declarative rules on various events</td></tr>
<tr><td><a href="libraries/naughty.html#">naughty</a></td><td>Notifications</td></tr>
<tr><td><a href="popups_and_bars/menubar.html#">menubar</a></td><td>XDG (application) menu implementation</td></tr>
<tr><td><a href="theme_related_libraries/beautiful.html#">beautiful</a></td><td>Awesome theme module</td></tr>
</table>
</p>
<h2>Core_components</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="core_components/awesome.html">awesome</a></td>
<td class="summary">AwesomeWM lifecycle and low-level APIs.</td>
</tr>
<tr>
<td class="name" ><a href="core_components/awful.keygrabber.html">awful.keygrabber</a></td>
<td class="summary">A keyboard grabbing and transaction object.</td>
</tr>
<tr>
<td class="name" ><a href="core_components/client.html">client</a></td>
<td class="summary">A process window managed by AwesomeWM.</td>
</tr>
<tr>
<td class="name" ><a href="core_components/drawable.html">drawable</a></td>
<td class="summary">Low-level API to allow Cairo to draw on clients and wiboxes.</td>
</tr>
<tr>
<td class="name" ><a href="core_components/gears.timer.html">gears.timer</a></td>
<td class="summary">Class to execute code at specific intervals.</td>
</tr>
<tr>
<td class="name" ><a href="core_components/mousegrabber.html">mousegrabber</a></td>
<td class="summary">Set a callback to process all mouse events.</td>
</tr>
<tr>
<td class="name" ><a href="core_components/naughty.action.html">naughty.action</a></td>
<td class="summary">A notification action.</td>
</tr>
<tr>
<td class="name" ><a href="core_components/naughty.notification.html">naughty.notification</a></td>
<td class="summary">Notification manipulation class.</td>
</tr>
<tr>
<td class="name" ><a href="core_components/root.html">root</a></td>
<td class="summary">APIs to interact with the root window.</td>
</tr>
<tr>
<td class="name" ><a href="core_components/screen.html">screen</a></td>
<td class="summary">A physical or virtual screen object.</td>
</tr>
<tr>
<td class="name" ><a href="core_components/tag.html">tag</a></td>
<td class="summary">Labelled container where <a href="core_components/client.html#">client</a> objects can be stored.</td>
</tr>
</table>
<h2>Input_handling</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="input_handling/awful.button.html">awful.button</a></td>
<td class="summary">Create easily new buttons objects ignoring certain modifiers.</td>
</tr>
<tr>
<td class="name" ><a href="input_handling/awful.key.html">awful.key</a></td>
<td class="summary">Create easily new key objects ignoring certain modifiers.</td>
</tr>
<tr>
<td class="name" ><a href="input_handling/awful.keyboard.html">awful.keyboard</a></td>
<td class="summary">Utilities related to the keyboard and keybindings.</td>
</tr>
<tr>
<td class="name" ><a href="input_handling/mouse.html">mouse</a></td>
<td class="summary">Manipulate and inspect the mouse cursor.</td>
</tr>
</table>
<h2>Declarative_rules</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="declarative_rules/ruled.client.html">ruled.client</a></td>
<td class="summary">Apply properties to a new client based on pre-determined rules.</td>
</tr>
<tr>
<td class="name" ><a href="declarative_rules/ruled.notifications.html">ruled.notifications</a></td>
<td class="summary">Apply properties to a new <a href="core_components/naughty.notification.html#">naughty.notification</a> based on pre-determined rules.</td>
</tr>
</table>
<h2>Widgets</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="widgets/awful.widget.button.html">awful.widget.button</a></td>
<td class="summary">A simple button widget based on a background image.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/awful.widget.clienticon.html">awful.widget.clienticon</a></td>
<td class="summary">Container showing the icon of a client.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/awful.widget.keyboardlayout.html">awful.widget.keyboardlayout</a></td>
<td class="summary">Display the current keyboard layout name in a widget.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/awful.widget.launcher.html">awful.widget.launcher</a></td>
<td class="summary">A button widget which hosts a menu or starts a command.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/awful.widget.layoutbox.html">awful.widget.layoutbox</a></td>
<td class="summary">Display the current client layout (<a href="libraries/awful.layout.html#">awful.layout</a>) icon or name.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/awful.widget.layoutlist.html">awful.widget.layoutlist</a></td>
<td class="summary">Display the available client layouts for a screen.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/awful.widget.prompt.html">awful.widget.prompt</a></td>
<td class="summary">The widget version of <a href="libraries/awful.prompt.html#">awful.prompt</a>.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/awful.widget.taglist.html">awful.widget.taglist</a></td>
<td class="summary">Taglist widget module for awful.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/awful.widget.tasklist.html">awful.widget.tasklist</a></td>
<td class="summary">Tasklist widget module for awful.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/awful.widget.watch.html">awful.widget.watch</a></td>
<td class="summary">Execute a command at a set interval and display its output.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/naughty.list.actions.html">naughty.list.actions</a></td>
<td class="summary">Manage a notification action list.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/naughty.list.notifications.html">naughty.list.notifications</a></td>
<td class="summary">Get a list of all currently active notifications.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/naughty.widget.icon.html">naughty.widget.icon</a></td>
<td class="summary">A notification square icon widget.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/naughty.widget.message.html">naughty.widget.message</a></td>
<td class="summary">A notification content message widget.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/naughty.widget.title.html">naughty.widget.title</a></td>
<td class="summary">A notification title widget.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/wibox.widget.calendar.html">wibox.widget.calendar</a></td>
<td class="summary">Display a monthly or yearly calendar.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/wibox.widget.checkbox.html">wibox.widget.checkbox</a></td>
<td class="summary">A boolean display widget.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/wibox.widget.graph.html">wibox.widget.graph</a></td>
<td class="summary">Display multiple values as a stream of bars.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/wibox.widget.imagebox.html">wibox.widget.imagebox</a></td>
<td class="summary">A widget to display an image.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/wibox.widget.piechart.html">wibox.widget.piechart</a></td>
<td class="summary">Display percentage in a circle.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/wibox.widget.progressbar.html">wibox.widget.progressbar</a></td>
<td class="summary">A progressbar widget.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/wibox.widget.separator.html">wibox.widget.separator</a></td>
<td class="summary">A flexible separator widget.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/wibox.widget.slider.html">wibox.widget.slider</a></td>
<td class="summary">An interactive mouse based slider widget.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/wibox.widget.systray.html">wibox.widget.systray</a></td>
<td class="summary">Container for the various system tray icons.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/wibox.widget.textbox.html">wibox.widget.textbox</a></td>
<td class="summary">A widget to display either plain or HTML text.</td>
</tr>
<tr>
<td class="name" ><a href="widgets/wibox.widget.textclock.html">wibox.widget.textclock</a></td>
<td class="summary">Display the time (and date) in a text box.</td>
</tr>
</table>
<h2>Widget_containers</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="widget_containers/awful.widget.only_on_screen.html">awful.widget.only_on_screen</a></td>
<td class="summary">A container that makes a widget display only on a specified screen.</td>
</tr>
<tr>
<td class="name" ><a href="widget_containers/naughty.widget.background.html">naughty.widget.background</a></td>
<td class="summary">A notification background widget.</td>
</tr>
<tr>
<td class="name" ><a href="widget_containers/wibox.container.arcchart.html">wibox.container.arcchart</a></td>
<td class="summary">A circular chart (arc chart) container.</td>
</tr>
<tr>
<td class="name" ><a href="widget_containers/wibox.container.background.html">wibox.container.background</a></td>
<td class="summary">A container capable of changing the background color, foreground color and
widget shape.</td>
</tr>
<tr>
<td class="name" ><a href="widget_containers/wibox.container.border.html">wibox.container.border</a></td>
<td class="summary">Place widgets or images on the sides, corner and back of another widget.</td>
</tr>
<tr>
<td class="name" ><a href="widget_containers/wibox.container.constraint.html">wibox.container.constraint</a></td>
<td class="summary">Restrict a widget size using one of multiple available strategies.</td>
</tr>
<tr>
<td class="name" ><a href="widget_containers/wibox.container.margin.html">wibox.container.margin</a></td>
<td class="summary">Add a margin around a widget.</td>
</tr>
<tr>
<td class="name" ><a href="widget_containers/wibox.container.mirror.html">wibox.container.mirror</a></td>
<td class="summary">Reflect a widget along one or both axis.</td>
</tr>
<tr>
<td class="name" ><a href="widget_containers/wibox.container.place.html">wibox.container.place</a></td>
<td class="summary">A container used to place smaller widgets into larger space.</td>
</tr>
<tr>
<td class="name" ><a href="widget_containers/wibox.container.radialprogressbar.html">wibox.container.radialprogressbar</a></td>
<td class="summary">A circular progressbar wrapper.</td>
</tr>
<tr>
<td class="name" ><a href="widget_containers/wibox.container.rotate.html">wibox.container.rotate</a></td>
<td class="summary">A container rotating the conained widget by 90 degrees.</td>
</tr>
<tr>
<td class="name" ><a href="widget_containers/wibox.container.scroll.html">wibox.container.scroll</a></td>
<td class="summary">This container scrolls its inner widget inside of the available space.</td>
</tr>
<tr>
<td class="name" ><a href="widget_containers/wibox.container.tile.html">wibox.container.tile</a></td>
<td class="summary">Replicate the content of the widget over and over.</td>
</tr>
</table>
<h2>Widget_layouts</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="widget_layouts/wibox.layout.align.html">wibox.layout.align</a></td>
<td class="summary">The <code>align</code> layout has three slots for child widgets.</td>
</tr>
<tr>
<td class="name" ><a href="widget_layouts/wibox.layout.fixed.html">wibox.layout.fixed</a></td>
<td class="summary">Place many widgets in a column or row, until the available space is used up.</td>
</tr>
<tr>
<td class="name" ><a href="widget_layouts/wibox.layout.flex.html">wibox.layout.flex</a></td>
<td class="summary">Split the space equally between multiple widgets.</td>
</tr>
<tr>
<td class="name" ><a href="widget_layouts/wibox.layout.grid.html">wibox.layout.grid</a></td>
<td class="summary">Place multiple widgets in multiple rows and columns.</td>
</tr>
<tr>
<td class="name" ><a href="widget_layouts/wibox.layout.manual.html">wibox.layout.manual</a></td>
<td class="summary">A layout with widgets added at specific positions.</td>
</tr>
<tr>
<td class="name" ><a href="widget_layouts/wibox.layout.ratio.html">wibox.layout.ratio</a></td>
<td class="summary">A layout filling all the available space.</td>
</tr>
<tr>
<td class="name" ><a href="widget_layouts/wibox.layout.stack.html">wibox.layout.stack</a></td>
<td class="summary">Place multiple widgets on top of each other.</td>
</tr>
</table>
<h2>Popups_and_bars</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="popups_and_bars/awful.hotkeys_popup.widget.html">awful.hotkeys_popup.widget</a></td>
<td class="summary">Popup widget which shows current hotkeys and their descriptions.</td>
</tr>
<tr>
<td class="name" ><a href="popups_and_bars/awful.menu.html">awful.menu</a></td>
<td class="summary">Create context menus, optionally with sub-menus.</td>
</tr>
<tr>
<td class="name" ><a href="popups_and_bars/awful.popup.html">awful.popup</a></td>
<td class="summary">An auto-resized, free floating or modal wibox built around a widget.</td>
</tr>
<tr>
<td class="name" ><a href="popups_and_bars/awful.titlebar.html">awful.titlebar</a></td>
<td class="summary">Create widget area on the edge of a client.</td>
</tr>
<tr>
<td class="name" ><a href="popups_and_bars/awful.tooltip.html">awful.tooltip</a></td>
<td class="summary">Tooltip module for awesome objects.</td>
</tr>
<tr>
<td class="name" ><a href="popups_and_bars/awful.wallpaper.html">awful.wallpaper</a></td>
<td class="summary">Allows to use the wibox widget system to draw the wallpaper.</td>
</tr>
<tr>
<td class="name" ><a href="popups_and_bars/awful.wibar.html">awful.wibar</a></td>
<td class="summary">The main AwesomeWM "bar" module.</td>
</tr>
<tr>
<td class="name" ><a href="popups_and_bars/awful.widget.calendar_popup.html">awful.widget.calendar_popup</a></td>
<td class="summary">A popup wibox containing a <a href="widgets/wibox.widget.calendar.html#">wibox.widget.calendar</a> widget.</td>
</tr>
<tr>
<td class="name" ><a href="popups_and_bars/menubar.html">menubar</a></td>
<td class="summary">Menubar module, which aims to provide a freedesktop menu alternative.</td>
</tr>
<tr>
<td class="name" ><a href="popups_and_bars/naughty.layout.box.html">naughty.layout.box</a></td>
<td class="summary">A notification popup widget.</td>
</tr>
<tr>
<td class="name" ><a href="popups_and_bars/naughty.layout.legacy.html">naughty.layout.legacy</a></td>
<td class="summary">A notification popup widget (deprecated implementation).</td>
</tr>
<tr>
<td class="name" ><a href="popups_and_bars/wibox.html">wibox</a></td>
<td class="summary">Box where widget can be displayed.</td>
</tr>
</table>
<h2>Utility_libraries</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="utility_libraries/gears.debug.html">gears.debug</a></td>
<td class="summary">Utility functions to make development easier.</td>
</tr>
<tr>
<td class="name" ><a href="utility_libraries/gears.filesystem.html">gears.filesystem</a></td>
<td class="summary">Various filesystem utility functions.</td>
</tr>
<tr>
<td class="name" ><a href="utility_libraries/gears.geometry.html">gears.geometry</a></td>
<td class="summary">Helper functions used to compute geometries.</td>
</tr>
<tr>
<td class="name" ><a href="utility_libraries/gears.math.html">gears.math</a></td>
<td class="summary">Various math related functions.</td>
</tr>
<tr>
<td class="name" ><a href="utility_libraries/gears.object.html">gears.object</a></td>
<td class="summary">The object oriented programming base class used by various Awesome
widgets and components.</td>
</tr>
<tr>
<td class="name" ><a href="utility_libraries/gears.protected_call.html">gears.protected_call</a></td>
<td class="summary">Safely call a function and handle errors using <a href="utility_libraries/gears.debug.html#">gears.debug</a>.</td>
</tr>
<tr>
<td class="name" ><a href="utility_libraries/gears.sort.html">gears.sort</a></td>
<td class="summary">Utilities to sort and arrange data.</td>
</tr>
<tr>
<td class="name" ><a href="utility_libraries/gears.string.html">gears.string</a></td>
<td class="summary">Various string manipulation and introspection fuctions.</td>
</tr>
<tr>
<td class="name" ><a href="utility_libraries/gears.table.html">gears.table</a></td>
<td class="summary">Various functions to work with tables.</td>
</tr>
<tr>
<td class="name" ><a href="utility_libraries/gears.wallpaper.html">gears.wallpaper</a></td>
<td class="summary">Functions for setting the wallpaper.</td>
</tr>
</table>
<h2>Theme_related_libraries</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="theme_related_libraries/beautiful.html">beautiful</a></td>
<td class="summary">Key+value based theme library and associated utility modules.</td>
</tr>
<tr>
<td class="name" ><a href="theme_related_libraries/gears.color.html">gears.color</a></td>
<td class="summary">This module simplifies the creation of cairo pattern objects.</td>
</tr>
<tr>
<td class="name" ><a href="theme_related_libraries/gears.shape.html">gears.shape</a></td>
<td class="summary">Module dedicated to gather common shape painters.</td>
</tr>
</table>
<h2>Libraries</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="libraries/awful.completion.html">awful.completion</a></td>
<td class="summary">Helper utilities for bash-like completion lists.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/awful.hotkeys_popup.html">awful.hotkeys_popup</a></td>
<td class="summary">Popup widget which shows current hotkeys and their descriptions.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/awful.layout.html">awful.layout</a></td>
<td class="summary">Deterministically lay the clients in a screen workarea.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/awful.permissions.html">awful.permissions</a></td>
<td class="summary">Default implementation of the various requests handers.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/awful.placement.html">awful.placement</a></td>
<td class="summary">Algorithms used to place various drawables.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/awful.prompt.html">awful.prompt</a></td>
<td class="summary">Convert a <a href="widgets/wibox.widget.textbox.html#">wibox.widget.textbox</a> into an input prompt.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/awful.rules.html">awful.rules</a></td>
<td class="summary">This module has been moved to <a href="declarative_rules/ruled.client.html#">ruled.client</a></td>
</tr>
<tr>
<td class="name" ><a href="libraries/awful.spawn.html">awful.spawn</a></td>
<td class="summary">Spawn sub-processes and optionally get their output.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/awful.util.html">awful.util</a></td>
<td class="summary">Various small utility functions not worth putting into new modules.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/dbus.html">dbus</a></td>
<td class="summary">A deprecated low-level D-Bus API <strong>DO NOT USE</strong>.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/gears.matcher.html">gears.matcher</a></td>
<td class="summary">A module to build a set of properties based on a graph of rules.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/gears.surface.html">gears.surface</a></td>
<td class="summary">Utilities to integrate and manipulate Cairo drawing surfaces.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/menubar.menu_gen.html">menubar.menu_gen</a></td>
<td class="summary">Menu generation module for menubar</td>
</tr>
<tr>
<td class="name" ><a href="libraries/menubar.utils.html">menubar.utils</a></td>
<td class="summary">Utility functions for the <a href="popups_and_bars/menubar.html#">menubar</a> module.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/naughty.html">naughty</a></td>
<td class="summary">Notification library.</td>
</tr>
<tr>
<td class="name" ><a href="libraries/selection.html">selection</a></td>
<td class="summary">awesome selection (clipboard) API</td>
</tr>
<tr>
<td class="name" ><a href="libraries/wibox.widget.html">wibox.widget</a></td>
<td class="summary">Utility function for working with widgets.</td>
</tr>
</table>
<h2>Sample files</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="sample%20files/rc.lua.html">rc.lua</a></td>
<td class="summary">The default rc.lua file.</td>
</tr>
<tr>
<td class="name" ><a href="sample%20files/theme.lua.html">theme.lua</a></td>
<td class="summary">The default theme file.</td>
</tr>
</table>
<h2>Classes</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="classes/awful.screenshot.html">awful.screenshot</a></td>
<td class="summary">Take screenshots of clients, screens, geometry and export to files or widgets.</td>
</tr>
<tr>
<td class="name" ><a href="classes/awful.widget.common.html">awful.widget.common</a></td>
<td class="summary">This module contains helper functions to manage a layout widgets.</td>
</tr>
<tr>
<td class="name" ><a href="classes/gears.cache.html">gears.cache</a></td>
<td class="summary">Cache object with data that can be garbage-collected.</td>
</tr>
<tr>
<td class="name" ><a href="classes/gears.matrix.html">gears.matrix</a></td>
<td class="summary">An implementation of matrices for describing and working with affine
transformations.</td>
</tr>
<tr>
<td class="name" ><a href="classes/menubar.icon_theme.html">menubar.icon_theme</a></td>
<td class="summary">(Deprecated) class module for icon lookup for menubar</td>
</tr>
<tr>
<td class="name" ><a href="classes/menubar.index_theme.html">menubar.index_theme</a></td>
<td class="summary">(Deprecated) class module for parsing an index.theme file</td>
</tr>
<tr>
<td class="name" ><a href="classes/wibox.hierarchy.html">wibox.hierarchy</a></td>
<td class="summary">Management of widget hierarchies.</td>
</tr>
<tr>
<td class="name" ><a href="classes/wibox.widget.base.html">wibox.widget.base</a></td>
<td class="summary">Base class of every widgets, containers and layouts,</td>
</tr>
<tr>
<td class="name" ><a href="classes/xproperties.html">xproperties</a></td>
<td class="summary">Handling of X properties.</td>
</tr>
</table>
<h2>Documentation</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="documentation/00-authors.md.html">00-authors.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/01-readme.md.html">01-readme.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/02-contributing.md.html">02-contributing.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/03-declarative-layout.md.html">03-declarative-layout.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/04-new-widgets.md.html">04-new-widgets.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/05-awesomerc.md.html">05-awesomerc.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/06-appearance.md.html">06-appearance.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/07-my-first-awesome.md.html">07-my-first-awesome.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/08-client-layout-system.md.html">08-client-layout-system.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/09-options.md.html">09-options.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/10-building-and-testing.md.html">10-building-and-testing.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/16-using-cairo.md.html">16-using-cairo.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/17-porting-tips.md.html">17-porting-tips.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/89-NEWS.md.html">89-NEWS.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" ><a href="documentation/90-FAQ.md.html">90-FAQ.md</a></td>
<td class="summary"></td>
</tr>
</table>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<script defer type="text/javascript">
// Theme selection and its local storage
var select = document.getElementById("theme-select");
var storedTheme = localStorage.getItem('theme') || (window.matchMedia("(prefers-color-scheme: dark)").matches ? "dark" : "light");
if (storedTheme) {
select.value = storedTheme;
document.documentElement.setAttribute('data-theme', storedTheme)
}
select.addEventListener("change", function() {
var targetTheme = this.value;
document.documentElement.setAttribute('data-theme', targetTheme)
localStorage.setItem('theme', targetTheme);
});
const $nav = document.querySelector("#navigation");
// When clicking the sidebar, open it
$nav.addEventListener("click", function(ev) {
if (document.body.clientWidth >= 768) {
return;
}
const target = $nav;
if (!target.classList.contains("open")) {
target.classList.add("open");
ev.stopPropagation();
}
});
// When clicking anywhere else than the sidebar, close it
document.querySelector("body").addEventListener("click", function(ev) {
if (document.body.clientWidth >= 768 || ev.target.contains($nav)) {
return;
}
const target = $nav;
if (target.classList.contains("open")) {
target.classList.remove("open");
}
});
const copyResultClasses = {
success : "copy-link--success",
failure: "copy-link--failure"
};
const removeCopyResultClasses = ($target) =>
Object.values(copyResultClasses).forEach(c => $target.classList.remove(c));
document.querySelectorAll(".js-copy-link").forEach(copyLink => {
copyLink.addEventListener("click", function(e) {
e.preventDefault();
const $target = e.target;
removeCopyResultClasses($target);
let link = $target.href;
if (!link) {
return;
}
if (link.startsWith("#")) {
const curr = window.location.pathname;
link = curr.substring(0, curr.indexOf("#")) + link;
}
// We need to create a fake element to copy the text from
const fakeElement = document.createElement("textarea");
fakeElement.value = link;
document.body.appendChild(fakeElement);
fakeElement.select();
let success = false;
try {
success = document.execCommand("copy");
} catch(err) {
success = false;
}
fakeElement.remove();
$target.classList.add(success ? copyResultClasses.success : copyResultClasses.failure);
setInterval(() => removeCopyResultClasses($target), 1500);
});
});
</script>
</body>
</html>