contrib/awesome/awesome.1

.\"     Title: awesome
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
.\"      Date: 11/09/2009
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "AWESOME" "1" "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 + 1u)
.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 + 1u)
.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
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "Name"
awesome \- awesome window manager
.SH "Synopsis"
.sp
\fBawesome\fR [\fB\-v\fR | \fB\-\-version\fR] [\fB\-h\fR | \fB\-\-help\fR] [\fB\-c\fR | \fB\-\-config\fR \fIFILE\fR] [\fB\-k\fR | \fB\-\-check\fR]
.SH "DESCRIPTION"
.sp
\fBawesome\fR is a window manager for X\&. It manages windows in different layouts, like floating or tiled\&. Any layout can be applied dynamically, optimizing the environment for the application in use and the task currently being performed\&.
.sp
In a tiled layout, windows are managed in a master and stacking area\&. The master area contains the windows which currently need the most attention, whereas the stacking area contains all other windows\&. In a floating layout windows can be resized and moved freely\&. Dialog windows are always managed as floating, regardless of the layout currently applied\&. The spiral and dwindle layouts are special cases of the tiled layout where the stacking area is arranged in a spiral for the former or as a rectangular fractal for the later\&.
.sp
Windows are grouped by tags in awesome\&. Each window can be tagged with one or more tags\&. Selecting certain tags displays all windows with these tags\&.
.sp
\fBawesome\fR can contain small wiboxes which can display anything you want: all available tags, the current layout, the title of the visible windows, text, etc\&.
.SH "OPTIONS"
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
Print version information to standard output, then exit\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Print help information, then exit\&.
.RE
.PP
\fB\-c\fR, \fB\-\-config\fR \fIFILE\fR
.RS 4
Use an alternate configuration file instead of
\fI$XDG_CONFIG_HOME/awesome/rc\&.lua\fR\&.
.RE
.PP
\fB\-k\fR, \fB\-\-check\fR
.RS 4
Check configuration file syntax\&.
.RE
.SH "DEFAULT MOUSE BINDINGS"
.SS "Navigation"
.PP
\fBButton1\fR on tag name
.RS 4
View tag\&.
.RE
.PP
\fBButton4\fR, \fBButton5\fR on tag name
.RS 4
Switch to previous or next tag\&.
.RE
.PP
\fBButton4\fR, \fBButton5\fR on root window
.RS 4
Switch to previous or next tag\&.
.RE
.PP
\fBButton1\fR, \fBButton3\fR, \fBButton4\fR, \fBButton5\fR on layout symbol
.RS 4
Switch to previous or next layout\&.
.RE
.SS "Layout modification"
.PP
\fBMod4 + Button1\fR on tag name
.RS 4
Tag current client with this tag only\&.
.RE
.PP
\fBMod4 + Button3\fR on tag name
.RS 4
Toggle this tag for client\&.
.RE
.PP
\fBButton3\fR on tag name
.RS 4
Add this tag to current view\&.
.RE
.PP
\fBMod4 + Button1\fR on client window
.RS 4
Move window\&.
.RE
.PP
\fBMod4 + Button3\fR on client window
.RS 4
Resize window\&.
.RE
.SH "DEFAULT KEY BINDINGS"
.SS "Window manager control"
.PP
\fBMod4 + Control + r\fR
.RS 4
Restart
\fBawesome\fR\&.
.RE
.PP
\fBMod4 + Shift + q\fR
.RS 4
Quit
\fBawesome\fR\&.
.RE
.PP
\fBMod4 + r\fR
.RS 4
Run prompt\&.
.RE
.PP
\fBMod4 + x\fR
.RS 4
Run Lua code prompt\&.
.RE
.PP
\fBMod4 + Return\fR
.RS 4
Spawn terminal emulator\&.
.RE
.PP
\fBMod4 + w\fR
.RS 4
Open main menu\&.
.RE
.SS "Clients"
.PP
\fBMod4 + Shift + r\fR
.RS 4
Redraw the focused window\&.
.RE
.PP
\fBMod4 + m\fR
.RS 4
Maximize client\&.
.RE
.PP
\fBMod4 + n\fR
.RS 4
Minimize client\&.
.RE
.PP
\fBMod4 + f\fR
.RS 4
Set client fullscreen\&.
.RE
.PP
\fBMod4 + Shift + c\fR
.RS 4
Kill focused client\&.
.RE
.PP
\fBMod4 + t\fR
.RS 4
Mark a client\&.
.RE
.SS "Navigation"
.PP
\fBMod4 + j\fR
.RS 4
Focus next client\&.
.RE
.PP
\fBMod4 + k\fR
.RS 4
Focus previous client\&.
.RE
.PP
\fBMod4 + u\fR
.RS 4
Focus first urgent client\&.
.RE
.PP
\fBMod4 + Left\fR
.RS 4
View previous tag\&.
.RE
.PP
\fBMod4 + Right\fR
.RS 4
View next tag\&.
.RE
.PP
\fBMod4 + 1\-9\fR
.RS 4
Switch to tag 1\-9\&.
.RE
.PP
\fBMod4 + Control + j\fR
.RS 4
Focus next screen\&.
.RE
.PP
\fBMod4 + Control + k\fR
.RS 4
Focus previous screen\&.
.RE
.PP
\fBMod4 + Escape\fR
.RS 4
Focus previously selected tag set\&.
.RE
.SS "Layout modification"
.PP
\fBMod4 + Shift + j\fR
.RS 4
Switch client with next client\&.
.RE
.PP
\fBMod4 + Shift + k\fR
.RS 4
Switch client with previous client\&.
.RE
.PP
\fBMod4 + o\fR
.RS 4
Send client to next screen\&.
.RE
.PP
\fBMod4 + h\fR
.RS 4
Decrease master width factor by 5%\&.
.RE
.PP
\fBMod4 + l\fR
.RS 4
Increase master width factor by 5%\&.
.RE
.PP
\fBMod4 + Shift + h\fR
.RS 4
Increase number of master windows by 1\&.
.RE
.PP
\fBMod4 + Shift + l\fR
.RS 4
Decrease number of master windows by 1\&.
.RE
.PP
\fBMod4 + Control + h\fR
.RS 4
Increase number of columns for non\-master windows by 1\&.
.RE
.PP
\fBMod4 + Control + l\fR
.RS 4
Decrease number of columns for non\-master windows by 1\&.
.RE
.PP
\fBMod4 + space\fR
.RS 4
Switch to next layout\&.
.RE
.PP
\fBMod4 + Shift + space\fR
.RS 4
Switch to previous layout\&.
.RE
.PP
\fBMod4 + Control + space\fR
.RS 4
Toggle client floating status\&.
.RE
.PP
\fBMod4 + Control + Return\fR
.RS 4
Swap focused client with master\&.
.RE
.PP
\fBMod4 + Control + 1\-9\fR
.RS 4
Toggle tag view\&.
.RE
.PP
\fBMod4 + Shift + 1\-9\fR
.RS 4
Tag client with tag\&.
.RE
.PP
\fBMod4 + Shift + Control + 1\-9\fR
.RS 4
Toggle tag on client\&.
.RE
.PP
\fBMod4 + Shift + F1\-9\fR
.RS 4
Tag marked clients with tag\&.
.RE
.SH "CUSTOMIZATION"
.sp
\fBawesome\fR is customized by creating a custom \fI$XDG_CONFIG_HOME/awesome/rc\&.lua\fR file\&.
.SH "SIGNALS"
.sp
\fBawesome\fR can be restarted by sending it a SIGHUP\&.
.SH "SEE ALSO"
.sp
\fBawesomerc\fR(5) \fBawesome\-client\fR(1)
.SH "BUGS"
.sp
Of course there\(cqs no bug in \fBawesome\fR\&. But there may be unexpected behaviors\&.
.SH "AUTHORS"
.sp
Julien Danjou <\m[blue]\fBjulien@danjou\&.info\fR\m[]\&\s-2\u[1]\d\s+2> and others\&.
.SH "WWW"
.sp
\m[blue]\fBhttp://awesome\&.naquadah\&.org\fR\m[]
.SH "Notes"
.IP " 1." 4
julien@danjou.info
.RS 4
\%mailto:julien@danjou.info
.RE