Update awesomerc.5 documentation
This commit is contained in:
Julien Danjou
parent
e971ab1b51
commit
e534111a39
|
|
@ -31,16 +31,18 @@ It is read at startup.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
--------
|
--------
|
||||||
Global sections
|
awesomerc contains 4 global sections: *screen*, *rules*, *keys* and *mouse* which
|
||||||
~~~~~~~~~~~~~~~
|
are described here.
|
||||||
awesomerc contains 4 global sections: *screen*, *rules*, *keys* and *mouse*.
|
|
||||||
|
screen
|
||||||
|
~~~~~~
|
||||||
|
This is the global section for a physical screen. It must have a title with screen number,
|
||||||
|
starting at 0. It contains several subsections, which are *general*, *tags*, *layouts*, *colors*,
|
||||||
|
*padding* and *statusbar*.
|
||||||
|
|
||||||
screen section
|
|
||||||
~~~~~~~~~~~~~~
|
|
||||||
general
|
general
|
||||||
^^^^^^^
|
^^^^^^^
|
||||||
General is a section containing some general option for this screen.
|
General is a section containing some general option for this screen.
|
||||||
It must have a title with screen number, starting at 0.
|
|
||||||
|
|
||||||
border::
|
border::
|
||||||
This defines the windows borders size in pixel.
|
This defines the windows borders size in pixel.
|
||||||
|
|
@ -70,23 +72,94 @@ floating_placement::
|
||||||
|
|
||||||
tags
|
tags
|
||||||
^^^^
|
^^^^
|
||||||
Tags is a section containing tag section, which defines tags.
|
Tags is a section containing one or more tag sections, which defines a tag.
|
||||||
|
|
||||||
|
tag
|
||||||
|
+++
|
||||||
|
Tag is a section which contains several options definining a tag.
|
||||||
|
|
||||||
|
layout::
|
||||||
|
Layout is a name of an available layout which will be set by default on this tag.
|
||||||
|
mwfact::
|
||||||
|
Set the default master width factor for this tag.
|
||||||
|
ncol::
|
||||||
|
Set the default number of column for non-master window for this tag.
|
||||||
|
nmaster::
|
||||||
|
Set the default number of window which will be treated as master for this tag.
|
||||||
|
|
||||||
layouts
|
layouts
|
||||||
^^^^^^^
|
^^^^^^^
|
||||||
Layouts is a section containing the layouts list.
|
Layouts is a section containing a layout list, where each layout is a layout section.
|
||||||
|
|
||||||
|
layout
|
||||||
|
++++++
|
||||||
|
Layout is a section which define a layout. It has a title which is the algorithm to use.
|
||||||
|
|
||||||
|
image::
|
||||||
|
Set the image path used to describe this layouts, useful in layoutinfo widget.
|
||||||
|
|
||||||
colors
|
colors
|
||||||
^^^^^^
|
^^^^^^
|
||||||
Colors is a section containing the colors parameters.
|
Colors is a section containing the colors parameters.
|
||||||
|
|
||||||
|
normal_fg::
|
||||||
|
Set the normal foreground color.
|
||||||
|
normal_bg::
|
||||||
|
Set the normal background color.
|
||||||
|
normal_border::
|
||||||
|
Set the unfocused window's border color.
|
||||||
|
focus_fg::
|
||||||
|
Set the focused foreground color.
|
||||||
|
focus_bg::
|
||||||
|
Set the focused background color.
|
||||||
|
focus_border::
|
||||||
|
Set the focused window's border color.
|
||||||
|
urgent_fg::
|
||||||
|
Set the foreground color to use for urgent flag. This is mostly useful
|
||||||
|
with the taglist widget which will use this color whenever a window set its
|
||||||
|
XUrgencyHint on a non-visible tag.
|
||||||
|
urgent_bg::
|
||||||
|
Set the background color to use for urgent flag.
|
||||||
|
|
||||||
padding
|
padding
|
||||||
^^^^^^^
|
^^^^^^^
|
||||||
Padding is a section containing screen padding parameters.
|
Padding is a section containing screen padding parameters.
|
||||||
|
|
||||||
|
top::
|
||||||
|
Set the top padding in pixel.
|
||||||
|
bottom::
|
||||||
|
Set the bottom padding in pixel.
|
||||||
|
left::
|
||||||
|
Set the left padding in pixel.
|
||||||
|
right::
|
||||||
|
Set the right padding in pixel.
|
||||||
|
|
||||||
statusbar
|
statusbar
|
||||||
^^^^^^^^^
|
^^^^^^^^^
|
||||||
Statusbar are sections containing statusbars parameters.
|
Statusbar are sections containing statusbars parameters. Each statusbar section
|
||||||
|
must have a title which is the statusbar name. Each statusbar can have none or
|
||||||
|
several widgets (see WIDGETS section for more details) each one identified by its
|
||||||
|
name.
|
||||||
|
|
||||||
|
position::
|
||||||
|
Default statusbar position.
|
||||||
|
height::
|
||||||
|
Statusbar height. By default, is auto computed with font size.
|
||||||
|
width::
|
||||||
|
Statusbar width. By default, it will be whole screen.
|
||||||
|
|
||||||
|
rules
|
||||||
|
~~~~~
|
||||||
|
|
||||||
|
No documentation yet.
|
||||||
|
|
||||||
|
keys
|
||||||
|
~~~~
|
||||||
|
No documentation yet.
|
||||||
|
|
||||||
|
mouse
|
||||||
|
~~~~~
|
||||||
|
No documentation yet.
|
||||||
|
|
||||||
UICB FUNCTIONS
|
UICB FUNCTIONS
|
||||||
--------------
|
--------------
|
||||||
|
|
@ -418,6 +491,7 @@ screen <integer> [MULTI]
|
||||||
spiral,tile,tileleft,tilebottom,tiletop}>
|
spiral,tile,tileleft,tilebottom,tiletop}>
|
||||||
mwfact = <float>
|
mwfact = <float>
|
||||||
nmaster = <integer>
|
nmaster = <integer>
|
||||||
|
ncol = <integer>
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
layouts
|
layouts
|
||||||
|
|
@ -428,7 +502,6 @@ screen <integer> [MULTI]
|
||||||
}
|
}
|
||||||
colors
|
colors
|
||||||
{
|
{
|
||||||
tab_border = <color>
|
|
||||||
normal_fg = <color>
|
normal_fg = <color>
|
||||||
normal_bg = <color>
|
normal_bg = <color>
|
||||||
normal_border = <color>
|
normal_border = <color>
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue