summaryrefslogtreecommitdiffstats
path: root/docs/source/usage/wm-widgets.rst
blob: bc63da635575caca4af78598bc741bbf371723c7 (plain)
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
**********************
Window manager widgets
**********************

Awesome widget
==============

.. note:: Powerline currently only supports awesome 3.5 and 4+.

.. note:: The Powerline widget will spawn a shell script that runs in the 
   background and updates the statusline with ``awesome-client``.

Add the following to :file:`rc.lua`, where ``{repository_root}`` is the absolute 
path to Powerline installation directory (see :ref:`repository root 
<repository-root>`):

.. code-block:: lua

   package.path = package.path .. ';{repository_root}/powerline/bindings/awesome/?.lua'
   require('powerline')

Then add the ``powerline_widget`` to ``wibox``:

.. code-block:: lua

   -- awesome3.5
   right_layout:add(powerline_widget)
   
   -- awesome4+
   s.mywibox:setup {
   ...
     { -- Right widgets
       ...
       powerline_widget,
     },
   }

Qtile widget
============

Add the following to :file:`~/.config/qtile/config.py`:

.. code-block:: python

   from libqtile.bar import Bar
   from libqtile.config import Screen
   from libqtile.widget import Spacer

   from powerline.bindings.qtile.widget import PowerlineTextBox

   screens = [
       Screen(
           top=Bar([
                   PowerlineTextBox(update_interval=2, side='left'),
                   Spacer(),
                   PowerlineTextBox(update_interval=2, side='right'),
               ],
               35 # width
           ),
       ),
   ]

.. _lemonbar-usage:

lemonbar (formerly bar-aint-recursive)
======================================

To run the bar simply start the binding script:

    python /path/to/powerline/bindings/lemonbar/powerline-lemonbar.py

You can specify options to be passed to ``lemonbar`` after ``--``, like so:

    python /path/to/powerline/bindings/lemonbar/powerline-lemonbar.py --height 16 -- -f "Source Code Pro for Powerline-9"

to run with i3, simply ``exec`` this in the i3 config file and set the ``--i3`` switch:

    exec python /path/to/powerline/bindings/lemonbar/powerline-lemonbar.py --i3

Running the binding in i3-mode will require `i3ipc <https://github.com/acrisci/i3ipc-python>`_.

See the `lemonbar documentation <https://github.com/LemonBoy/bar>`_ for more 
information and options.

All ``powerline-lemonbar.py`` arguments:

.. automan:: powerline.commands.lemonbar
   :prog: powerline-lemonbar.py
   :minimal: true

I3 bar
======

Add the following to :file:`~/.config/i3/config`::

    bar {
        status_command python /path/to/powerline/bindings/i3/powerline-i3.py
        font pango:PowerlineFont 12
    }

where ``PowerlineFont`` is any system font with powerline support.