'\" t
.\"     Title: FvwmConsole
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2024-03-09
.\"    Manual: Fvwm Modules
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "FVWMCONSOLE" "1" "2024-03-09" "\ \&" "Fvwm Modules"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
FvwmConsole \- an fvwm command input interface
.SH "SYNOPSIS"
.sp
Module FvwmConsole [options]
.sp
\fIFvwmConsole\fP can only be invoked by fvwm. Command line invocation of
the \fIFvwmConsole\fP module will not work.
.SH "DESCRIPTION"
.sp
FvwmConsole allows the user to type fvwm configuration commands
interactively, and have them executed immediately. This tool is
particularly useful for testing new configuration ideas, or for
implementing temporary changes to your environment.
.SH "INVOCATION"
.sp
FvwmConsole must be spawned as a module by fvwm. FvwmConsole takes all
\fIxterm\fP(1) options.
.sp
FvwmConsole can be invoked by inserting the line \*(AqModule FvwmConsole\*(Aq in
the .fvwm2rc file. This can be placed on a line by itself, if
FvwmConsole is to be spawned during fvwm\(cqs initialization, or can be
bound to a menu or mouse button or keystroke to invoke it later.
.SH "CONFIGURATION OPTIONS"
.sp
FvwmConsole uses \fIxterm\fP(1). All resources set for xterm are inherited
unless overridden by command line options.
.RS 3
.ll -.6i
.sp
Module FvwmConsole \-g 40x10 \-fg black \-bg green3
.br
.RE
.ll
.sp
A different terminal emulator can be specified with the \-terminal
option. However, only terminal programs that understand the options
\-name, \-title and \-e can be used. Debian specific: hardcoded xterm
is changed to x\-terminal\-emulator. To be policy compliant \-name
option is removed from default options and \-title is change to \-T.
.RS 3
.ll -.6i
.sp
Module FvwmConsole \-terminal rxvt
.br
.RE
.ll
.sp
Previous versions of FvwmConsole supported a \-e option to choose a
different front\-end. Although this option is still provided for
backwards compatibility its use is discouraged unless you know exactly
what you are doing.
.sp
Also X resources can be set in your ~/.Xdefaults file:
.RS 3
.ll -.6i
.sp
FvwmConsole*VT100*geometry: 40x4
.br
FvwmConsole*font: 7x14
.br
.RE
.ll
.sp
Debian specific: Since \-name is not included by default, the
default resource will be set by the x\-terminal\-emulator used
and not FvwmConsole. You can change the resource to match the
terminal, or if supported by the terminal, run FvwmCConsole
with the \-name option:
.RS 3
.ll -.6i
.sp
Module FvwmConsole \-name FvwmConsole
.br
.RE
.ll
.SH "COMMAND EDITING"
.sp
If the GNU readline library is available, it can be used.
Overwise a simple input reading function which
doesn\(cqt have editing capabilities is used.
For more details, refer GNU readline man and info pages.
.RS 3
.ll -.6i
.sp
Ctrl\-A
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
beginning of line
.RE
.RE
.sp
Ctrl\-B
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
previous char
.RE
.RE
.sp
Ctrl\-D
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
delete char
.RE
.RE
.sp
Ctrl\-E
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
end of line
.RE
.RE
.sp
Ctrl\-F
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
next char
.RE
.RE
.sp
Ctrl\-H
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
backspace
.RE
.RE
.sp
Ctrl\-K
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
erase to the end of line
.RE
.RE
.sp
Ctrl\-N
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
next line
.RE
.RE
.sp
Ctrl\-P
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
previous line
.RE
.RE
.sp
Ctrl\-R
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
search reverse
.RE
.RE
.sp
Ctrl\-U
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
delete line
.RE
.RE
.sp
Meta\-B
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
previous word
.RE
.RE
.sp
Meta\-F
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
next word
.RE
.RE
.sp
Esc <
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
beginning of history
.RE
.RE
.sp
Esc >
.RS 4
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
end of history
.RE
.RE
.br
.RE
.ll
.SH "EXITING"
.sp
FvwmConsole can be stopped by entering the EOF character (usually
CTRL\-D).
.sp
\fBNote!\fP Do not use the "quit" command, as this is an fvwm builtin:
typing "quit" at the FvwmConsole command line will cause fvwm to exit.
.SH "SEE ALSO"
.sp
\fIxterm\fP(1), GNU Readline library
.SH "AUTHOR"
.sp
FvwmConsole is the original work of Toshi Isogai.