'\" t
.\"     Title: shellex
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 12/11/2018
.\"    Manual: shellex Manual
.\"    Source: shellex 0.3
.\"  Language: English
.\"
.TH "SHELLEX" "1" "12/11/2018" "shellex 0\&.3" "shellex Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
shellex \- shell\-based launcher
.SH "SYNOPSIS"
.sp
\fBshellex\fR [\&...]
.SH "OPTIONS"
.sp
All command\-line parameters (together with some shellex\-specific) are passed on to urxvt\&. This means, you can you e\&.g\&. \fI\-bg grey20\fR for a lighter background\&. Using it for more than just customizing the appearance (for example adding own extensions) might stop shellex from working, so be careful\&.
.sp
See urxvt(1) for a full list of options\&.
.SH "DESCRIPTION"
.sp
\fBshellex\fR is a shell\-based launcher with a lot more features and a lot simpler design\&. It launches a shell (currently zsh(1)) and shows it in a small terminal (currently urxvt(1)), wrapping every command with a little bit of extra magic (redirecting stdout, stderr, disowning and closing the shell) to get more typical launcher\-behaviour\&.
.sp
This gives you a simple launcher with tab\-completion and other shell\-features, configurable in shell\&.
.SH "RESOURCES"
.sp
\fBshellex\fR uses two X\-Resources at the moment, to manipulate its behaviour:
.PP
shellex\&.pos
.RS 4
If pointer, shellex shows the window on the window, the mousepointer is on\&. If focus, it uses the output, where most of the currently focused window is\&. Defaults to focus\&.
.RE
.PP
shellex\&.edge
.RS 4
On what screen edge to show the launcher (top or bottom)\&. Defaults to top\&.
.RE
.sp
Additionally all resources defined by urxvt (with class \fIshellex\fR instead of \fIurxvt\fR) can be used to customize the appearance or behaviour of the used terminal window\&.
.SH "CONFIGURATION"
.sp
\fBshellex\fR configuration snippets can be found in \fB/usr/lib/shellex/\fR\&.
.sp
On start, \fBshellex\fR assembles a list of snippet basenames by looking at all of the paths listed below\&. For each snippet basename, \fBshellex\fR loads the first file it finds when looking through the paths in order:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
$XDG_CONFIG_HOME/\&.shellex\&. Typically unset, defaulting to $HOME/\&.config/shellex\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
$HOME/\&.shellex
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  3." 4.2
.\}
/etc/shellex (shellex defaults, symlinks to
\fB/usr/lib/shellex/conf/\fR)
.RE
.sp
To customize shellex, you can do the following things in \fB$XDG_CONFIG_HOME/\&.shellex\fR or \fB$HOME/\&.shellex/\fR:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
Overwrite a default by creating a new snippet of the same name
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
Not include a default by creating a symlink to
\fB/dev/null\fR
of the same same
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  3." 4.2
.\}
Include an example\-snippet not used by default, by creating a symlink to
\fB/usr/lib/shellex/snippet\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 4.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  4." 4.2
.\}
Write you own snippets with a currently unused name
.RE
.sp
To avoid naming\-conflicts in the future, you should add a common suffix to all your own snippets\&. Snippets are run in ascending order\&. By choosing a number which sorts between/after the existing snippet(s) you can ensure it runs at the desired time\&. E\&.g\&. if your snippet beeps on errors, name it 15\-errorbeep so that it sorts before 20\-nobeep\&.
.SH "AUTHORS"
.sp
Axel Wagner <mail@merovius\&.de> and contributors