.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "urxvt-kuake 1"
.TH urxvt-kuake 1 2024-03-07 9.31 RXVT-UNICODE
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
kuake \- kuake\-like hotkey terminal
.SH EXAMPLES
.IX Header "EXAMPLES"
.Vb 1
\&  urxvt \-kuake\-hotkey F10
\&
\&  URxvt.kuake.hotkey: F10
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A very primitive quake-console-like extension. It was inspired by a
description of how the programs \f(CW\*(C`kuake\*(C'\fR and \f(CW\*(C`yakuake\*(C'\fR work: Whenever the
user presses a global accelerator key (by default \f(CW\*(C`F10\*(C'\fR), the terminal
will show or hide itself. Another press of the accelerator key will hide
or show it again.
.PP
Initially, the window will not be shown when using this extension.
.PP
This is useful if you need a single terminal that is not using any desktop
space most of the time but is quickly available at the press of a key.
.PP
The accelerator key is grabbed regardless of any modifiers, so this
extension will actually grab a physical key just for this function.
.PP
If you want a quake-like animation, tell your window manager to do so
(fvwm can do it).