2009-01-10 16:26:20 +01:00
. \" Title: awesomerc
2009-11-24 18:23:23 +01:00
. \" Author: [see the "AUTHORS" section]
. \" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
. \" Date: 11/09/2009
. \" Manual: \ \&
. \" Source: \ \&
. \" Language: English
2009-01-10 16:26:20 +01:00
. \"
2009-11-24 18:23:23 +01:00
.TH "AWESOMERC" "5" "11/09/2009" "\ \&" "\ \&"
. \" -----------------------------------------------------------------
. \" * (re)Define some macros
. \" -----------------------------------------------------------------
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
. \" toupper - uppercase a string (locale-aware)
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de toupper
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
\\ $*
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
. .
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
. \" SH-xref - format a cross-reference to an SH section
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de SH-xref
.ie n \{ \
. \}
.toupper \\ $*
.el \{ \
\\ $*
. \}
. .
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
. \" SH - level-one heading that works better for non-TTY output
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de1 SH
. \" put an extra blank line of space above the head in non-TTY output
.if t \{ \
.sp 1
. \}
.sp \\ n[PD]u
.nr an-level 1
.set -an-margin
.nr an-prevailing-indent \\ n[IN]
.fi
.in \\ n[an-margin]u
.ti 0
.HTML -TAG ".NH \\n[an-level]"
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
\. " make the size of the head bigger
.ps +3
.ft B
.ne (2v + 1 u)
.ie n \{ \
. \" if n (TTY output), use uppercase
.toupper \\ $*
. \}
.el \{ \
.nr an-break-flag 0
. \" if not n (not TTY), use normal case (not uppercase)
\\ $1
.in \\ n[an-margin]u
.ti 0
. \" if not n (not TTY), put a border/line under subheading
.sp -.6
\l '\n (.lu'
. \}
. .
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
. \" SS - level-two heading that works better for non-TTY output
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de1 SS
.sp \\ n[PD]u
.nr an-level 1
.set -an-margin
.nr an-prevailing-indent \\ n[IN]
.fi
.in \\ n[IN]u
.ti \\ n[SN]u
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.ps \\ n[PS-SS]u
\. " make the size of the head bigger
.ps +2
.ft B
.ne (2v + 1 u)
.if \\ n[.$] \& \\ $*
. .
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
. \" BB/BE - put background/screen (filled box) around block of text
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de BB
.if t \{ \
.sp -.5
.br
.in +2n
.ll -2n
.gcolor red
.di BX
. \}
. .
.de EB
.if t \{ \
.if "\\$2" adjust-for-leading-newline" \{ \
.sp -1
. \}
.br
.di
.in
.ll
.gcolor
.nr BW \\ n(.lu-\\n(.i
.nr BH \\ n(dn+.5v
.ne \\ n(BHu+.5v
.ie "\\$2" adjust-for-leading-newline" \{ \
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
. \}
.el \{ \
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
. \}
.in 0
.sp -.5v
.nf
.BX
.in
.sp .5v
.fi
. \}
. .
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
. \" BM/EM - put colored marker in margin next to block of text
. \" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de BM
.if t \{ \
.br
.ll -2n
.gcolor red
.di BX
. \}
. .
.de EM
.if t \{ \
.br
.di
.ll
.gcolor
.nr BH \\ n(dn
.ne \\ n(BHu
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
.in 0
.nf
.BX
.in
.fi
. \}
. .
. \" -----------------------------------------------------------------
. \" * set default formatting
. \" -----------------------------------------------------------------
2009-01-10 16:26:20 +01:00
. \" disable hyphenation
.nh
. \" disable justification (adjust text to left margin only)
.ad l
2009-11-24 18:23:23 +01:00
. \" -----------------------------------------------------------------
. \" * MAIN CONTENT STARTS HERE *
. \" -----------------------------------------------------------------
.SH "Name"
awesomerc \- Configuration file for the awesome window manager
.SH "Synopsis"
2009-01-10 16:26:20 +01:00
.sp
2009-11-24 18:23:23 +01:00
\fB awesome\fR looks for a configuration file in this order:
2009-01-10 16:26:20 +01:00
.sp
.RS 4
2009-11-24 18:23:23 +01:00
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
$XDG_CONFIG_HOME/awesome/rc\& .lua
2009-01-10 16:26:20 +01:00
.RE
.sp
.RS 4
2009-11-24 18:23:23 +01:00
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
$HOME/\& .config/awesome/rc\& .lua
2009-01-10 16:26:20 +01:00
.RE
.sp
.RS 4
2009-11-24 18:23:23 +01:00
.ie n \{ \
\h '-04'\(bu \h '+03'\c
. \}
.el \{ \
.sp -1
.IP \(bu 2 .3
. \}
XDG_CONFIG_DIRS/awesome/rc\& .lua
2009-01-10 16:26:20 +01:00
.RE
.SH "DESCRIPTION"
.sp
2009-11-24 18:23:23 +01:00
The \fB rc\& .lua\fR file contains configuration information for \fB awesome\fR \& . It can be used to configure the behavior and look of awesome in a variety of ways\& . It can be assimilated as a Lua program/script run at startup by \fB awesome\fR \& . Therefore, it should use the awesome Lua API described in the API section\& . This file is read at startup\& .
2009-01-10 16:26:20 +01:00
.SH "AWESOME LUA API"
.sp
2009-11-24 18:23:23 +01:00
Documentation for the Lua API can be found in the luadoc directory\& .
2009-01-10 16:26:20 +01:00
.SH "COLORS FORMAT"
.sp
2009-11-24 18:23:23 +01:00
The color format in \fB awesome\fR is either a standard X color name (blue, darkblue, lightred, etc) or a hexadecimal formatted color (#rrggbb or #rrggbbaa)\& . By using the hexadecimal format, you can also specify an alpha channel: that means that #00ff00 will draw pure green, but #00ff00aa will set the alpha channel to \(oq aa\(cq and will blend the green with the color under it\& .
2009-01-10 16:26:20 +01:00
.SH "TEXT FORMAT"
.sp
2009-11-24 18:23:23 +01:00
You can use Pango markup in a text string\& . This allows formating the text rendered inside widgets\& . Pango markup documentation can be found in the Pango documentation at \m[blue]\fBhttp://library\&.gnome\&.org/devel/pango/stable/PangoMarkupFormat\&.html\fR\m[] \& .
2009-01-10 16:26:20 +01:00
.sp
2009-11-24 18:23:23 +01:00
A Pango markup example: <span weight="bold" foreground="#336699">\& ...</span>\& .
2009-01-10 16:26:20 +01:00
.SH "SEE ALSO"
.sp
2009-11-24 18:23:23 +01:00
awesome(1) awesome\- client(1)
2009-01-10 16:26:20 +01:00
.SH "AUTHORS"
.sp
2009-11-24 18:23:23 +01:00
Written by Julien Danjou <\m[blue]\fBjulien@danjou\&.info\fR\m[]\&\s-2\u[1] \d \s +2>\& .
2009-01-10 16:26:20 +01:00
.SH "WWW"
.sp
2009-11-24 18:23:23 +01:00
\m[blue]\fBhttp://awesome\&.naquadah\&.org\fR\m[]
.SH "Notes"
2009-01-10 16:26:20 +01:00
.IP " 1." 4
julien@danjou.info
.RS 4
\% mailto:julien@danjou.info
.RE