blob: 61d2c5eacd5a2c7052deeeb5b644479bb91a7c94 (
plain)
1 .\" Title: awesomerc
2 .\" Author:
3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
4 .\" Date: 01/10/2009
5 .\" Manual:
6 .\" Source:
7 .\"
8 .TH "AWESOMERC" "5" "01/10/2009" "" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 awesomerc - Configuration file for the awesome window manager
15 .SH "SYNOPSIS"
16 \fBawesome\fR looks for this configuration file in this order:
17 .sp
18 .sp
19 .RS 4
20 \h'-04'\(bu\h'+03'$XDG_CONFIG_HOME/awesome/rc\.lua
21 .RE
22 .sp
23 .RS 4
24 \h'-04'\(bu\h'+03'$HOME/\.config/awesome/rc\.lua
25 .RE
26 .sp
27 .RS 4
28 \h'-04'\(bu\h'+03'XDG_CONFIG_DIRS/awesome/rc\.lua
29 .RE
30 .SH "DESCRIPTION"
31 The \fBrc\.lua\fR file contains configuration informations for \fBawesome\fR\. It can be used to configure the behaviour and look of awesome in a variety of ways\. It can be assimilated as a Lua program/script run at startup by \fBawesome\fR\. Therefore, it should use the awesome Lua API described in the API section\. This file is read at startup\.
32 .sp
33 .SH "AWESOME LUA API"
34 Documentation for the Lua API can be found in the luadoc directory\.
35 .sp
36 .SH "COLORS FORMAT"
37 Colors format in \fBawesome\fR are either standard X color names (blue, darkblue, lightred, etc) or hexadecimal formatted colors (#rrggbb or #rrggbbaa)\. By using hexadecimal format, you can also specifies an alpha channel: that means that #00ff00 will draw pure green, but #00ff00aa will set the alpha channel to \(oqaa\(cq and will blend the green with the color under it\.
38 .sp
39 .SH "TEXT FORMAT"
40 You can use and mix Pango markup and awesome markup in text string\. This allows to format the text rendered in widgets\. Pango markup documentation can be found in the Pango documentation at \fIhttp://library\.gnome\.org/devel/pango/stable/PangoMarkupFormat\.html\fR\.
41 .sp
42 List of \fBawesome\fR markup elements and their attributes:
43 .sp
44 .sp
45 .RS 4
46 \h'-04'\(bu\h'+03'bg
47 .sp
48 .RS 4
49 \h'-04'\(bu\h'+03'color: background color
50 .RE
51 .sp
52 .RS 4
53 \h'-04'\(bu\h'+03'image: path to a background image
54 .RE
55 .sp
56 .RS 4
57 \h'-04'\(bu\h'+03'align: background image alignment
58 .RE
59 .sp
60 .RS 4
61 \h'-04'\(bu\h'+03'resize: resize background image to text size
62 .RE
63 .RE
64 .sp
65 .RS 4
66 \h'-04'\(bu\h'+03'border
67 .sp
68 .RS 4
69 \h'-04'\(bu\h'+03'color: border color
70 .RE
71 .sp
72 .RS 4
73 \h'-04'\(bu\h'+03'width: border width
74 .RE
75 .RE
76 .sp
77 .RS 4
78 \h'-04'\(bu\h'+03'margin
79 .sp
80 .RS 4
81 \h'-04'\(bu\h'+03'left: left margin in pixel
82 .RE
83 .sp
84 .RS 4
85 \h'-04'\(bu\h'+03'right: right margin in pixel
86 .RE
87 .sp
88 .RS 4
89 \h'-04'\(bu\h'+03'top: top margin in pixel
90 .RE
91 .RE
92 .sp
93 .RS 4
94 \h'-04'\(bu\h'+03'text
95 .sp
96 .RS 4
97 \h'-04'\(bu\h'+03'align: text alignment
98 .RE
99 .sp
100 .RS 4
101 \h'-04'\(bu\h'+03'shadow: shadow color
102 .RE
103 .sp
104 .RS 4
105 \h'-04'\(bu\h'+03'shadow_offset: shadow color offset in pixel
106 .RE
107 .RE
108 A Pango markup example: <span weight="bold" foreground="#336699">\&...</span>\.
109 .sp
110 An \fBawesome\fR markup example: <text align="right"/>\.
111 .sp
112 .SH "SEE ALSO"
113 awesome(1) awesome\-client(1)
114 .sp
115 .SH "AUTHORS"
116 Written by Julien Danjou <\fIjulien@danjou\.info\fR\&[1]>\.
117 .sp
118 .SH "WWW"
119 \fIhttp://awesome\.naquadah\.org\fR
120 .sp
121 .SH "NOTES"
122 .IP " 1." 4
123 julien@danjou.info
124 .RS 4
125 \%mailto:julien@danjou.info
126 .RE
|
