summaryrefslogtreecommitdiffstats
path: root/docs/source/configuration/segments.rst
blob: 63b4975ed39e90629410fab81761306a504329f5 (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
.. _config-segments:

*****************
Segment reference
*****************

Segments
========

Segments are written in Python, and the default segments provided with 
Powerline are located in :file:`powerline/segments/{extension}.py`.  
User-defined segments can be defined in any module in ``sys.path`` or 
:ref:`paths common configuration option <config-common-paths>`, import is 
always absolute.

Segments are regular Python functions, and they may accept arguments. All 
arguments should have a default value which will be used for themes that 
don’t provide an ``args`` dict.

More information is available in :ref:`Writing segments <dev-segments>` section.

Available segments
==================

.. toctree::
   :glob:

   segments/*