orbment.1.in

.TH ORBMENT 1 2015-09-30

.SH NAME

orbment \- dynamic wayland compositor

.SH SYNOPSIS

.SY orbment
[options]

.SH DESCRIPTION

Orbment is a dynamic window manager and compositor for Wayland built using the
wlc library.

.SH OPTIONS

.B \-\-log 
.I FILE
.RS
File in which the logging output is captured.
.RE

.SH KEYBINDINGS

N.B. These are a tentative set of keybindings created specifically to provide
basic usage until more flexible mechanisms are added.

Some plugins can also add their own keybinds.  These additional keybinds are
displayed in the log.  (See \fI\-\-log)

.B mod-return
.RS
Opens a new terminal emulator client.  (The client can be set via the
\fBTERMINAL\fR environment otherwise orbment will fallback on
\fBweston-terminal\fR).
.RE

.B mod-p
.RS
Opens \fBbemenu-run\fR (similar to \fBdmenu_run\fR) for starting applications.
.RE

.B mod-w
.RS
Rotates through available layouts.
.RE

.B mod-l
.RS
Rotates focus through available outputs.
.RE

.B mod-j, k
.RS
Rotates focus through clients.
.RE

.B mod-f
.RS
Toggles fullscreen for the focused client.
.RE

.B mod-[1..n]
.RS
Selects the \fInth\fP workspace, currently limited to 10.
.RE

.B mod-[F1..F10]
.RS
Moves the focused client to the corresponding workspace.
.RE

.B mod-z, x, c
.RS
Moves focused client to outputs 1, 2 and 3 respectively.
.RE

.B mod-h
.RS
Cycles the focused client.
.RE

.B mod-q
.RS
Closes the focused client.
.RE

.B mod-i, o
.RS
Shifts the cut of the nmaster layout to shrink or expand the view.
.RE

.B mod-s
.RS
Takes a screenshot in PNG format and stores it in the directory \fBorbment\fR
was started from.
.RE

.B mod-escape
.RS
Quits \fBorbment\fR.
.RE

.SH ENVIRONMENT

.TP
.B TERMINAL
.RS
\fBOrbment\fR will honor this environment variable when starting a new terminal
emulator.  If this is not set it will fall back on \fBweston-terminal\fR.
.RE

.B WLC_SHM
.RS
Takes a boolean \fI0\fR or \fI1\fR, true forces EGL clients to fallback to shm.
(Default: \fI0\fR)
.RE

.B WLC_DEBUG
.RS
Takes a comma-separated list of values which enable corresponding debug section
in wlc.  These include \fIrender\fR, \fIrender-loop\fR, \fIfocus\fR and
\fIxwm\fR.
.RE

.B WLC_DRM_DEVICE
.RS
The DRM device used when running under the DRM backend.  (Default: \fIcard0\fR)
.RE

.B WLC_XWAYLAND
.RS
Takes a boolean \fI0\fR or \fI1\fR which disables or enables the use of
xwayland respectively.  (Default: \fI1\fR)
.RE

.B WAYLAND_DEBUG
.RS
Enables message tracing in libwayland.  Possible values are \fI1\fR,
\fIclient\fR, \fIserver\fR.
.RE

.B XKB_DEFAULT_LAYOUT
.RS
This corresponds to the layout you might use in X11 such as \fBgb\fR.  Use this
if you want to select a non-us keyboard layout.
.RE

.B XKB_DEFAULT_OPTIONS
.RS
Sets the keyboard options. The syntax is the same (comma-separated values) as
within an \fIxorg.conf\fR or when used via \%\fBsetxkbmap -option\fR.  For
example \%\fBcompose:ralt,ctrl:nocaps\fR would set \fIralt\fR to the compose
key and cause the \fICaps Lock\fR key to mimic \fIctrl\fR.
.RE

.B XKB_DEFAULT_VARIANT

.B XKB_DEFAULT_RULES

.B XKB_DEFAULT_MODEL

.SH FILES

.B Orbment
will seek out any plugins in the following locations:
.RS

.IR XDG_DATA_HOME/orbment/plugins " (Fallback: "HOME/.local/share/orbment/plugins )

.I \fI@ORBMENT_PLUGINS_FULL_PATH@\fR
.RE

.SH SEE ALSO

.BR xkbcommon ,
.BR wayland ,
.BR weston

.SH AUTHORS

.MT http://cloudef.pw
Jari Vetoniemi
.ME