modules/FvwmConsole/FvwmConsole.1.in

   1 .\" t
   2 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   3 .TH FvwmConsole 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
   4 .UC
   5
   6 .SH NAME
   7 FvwmConsole \- an fvwm command input interface
   8
   9 .SH SYNOPSIS
  10 Module FvwmConsole [options]
  11
  12 \fIFvwmConsole\fP can only be invoked by fvwm.
  13 Command line invocation of the \fIFvwmConsole\fP module will not work.
  14
  15 .SH DESCRIPTION
  16 FvwmConsole allows the user to type fvwm configuration commands
  17 interactively, and have them executed immediately.  This tool is
  18 particularly useful for testing new configuration ideas, or for
  19 implementing temporary changes to your environment.
  20
  21 .SH INVOCATION
  22 FvwmConsole must be spawned as a module by fvwm.  FvwmConsole takes all
  23 \fIxterm\fP(1) options.
  24 .PP
  25 FvwmConsole can be invoked by inserting the line 'Module FvwmConsole' in
  26 the .fvwm2rc file.  This can be placed on a line by itself, if
  27 FvwmConsole is to be spawned during fvwm's initialization, or can be
  28 bound to a menu or mouse button or keystroke to invoke it later.
  29
  30 .SH CONFIGURATION OPTIONS
  31 FvwmConsole uses \fIxterm\fP(1).  All resources set for xterm are
  32 inherited unless overridden by command line options.
  33
  34 .RS
  35 Module FvwmConsole -g 40x10 -fg black -bg green3
  36 .RE
  37
  38 A different terminal emulator can be specified with the -terminal
  39 option.  However, only terminal programs that understand the options
  40 -name, -title and -e can be used.
  41
  42 .RS
  43 Module FvwmConsole -terminal rxvt
  44 .RE
  45
  46 Previous versions of FvwmConsole supported a -e option to choose a
  47 different front-end.  Although this option is still provided for
  48 backwards compatibility its use is discouraged unless you know
  49 exactly what you are doing.
  50
  51 .RS
  52 Module FvwmConsole -e FvwmConsoleC.pl
  53 .RE
  54
  55 (see \fIFvwmConsoleC.pl\fP(1)).
  56 .PP
  57 Also X resources can be set in your ~/.Xdefaults file:
  58
  59 .RS
  60 FvwmConsole*VT100*geometry: 40x4
  61 .br
  62 FvwmConsole*font: 7x14
  63 .RE
  64
  65
  66 .SH "COMMAND EDITING"
  67
  68 There are a few options.  If the GNU readline library is available, it
  69 can be used.
  70 .PP
  71 If Perl5 is installed, FvwmConsoleC.pl can be used as a command editor.
  72 This can be accomplished by either copying FvwmConsoleC.pl
  73 to fvwmlib directory as FvwmConsoleC or
  74 invoking FvwmConsole with -e option.
  75 For example:
  76
  77 .RS
  78 Module FvwmConsole -e FvwmConsoleC.pl
  79 .RE
  80
  81 If neither one is installed, a simple input reading function which
  82 doesn't have editing capabilities is used.
  83 .P
  84 GNU readline and FvwmConsoleC.pl have some frequent used commands
  85 in common as default.
  86 These commands are similar to emacs.
  87 For more details, refer GNU readline man and info pages, and
  88 FvwmConsoleC.pl man page.
  89
  90 .RS
  91 .PD 0
  92 .TP 8
  93 Ctrl-A
  94 - beginning of line
  95 .TP
  96 Ctrl-B
  97 - previous char
  98 .TP
  99 Ctrl-D
 100 - delete char
 101 .TP
 102 Ctrl-E
 103 - end of line
 104 .TP
 105 Ctrl-F
 106 - next char
 107 .TP
 108 Ctrl-H
 109 - backspace
 110 .TP
 111 Ctrl-K
 112 - erase to the end of line
 113 .TP
 114 Ctrl-N
 115 - next line
 116 .TP
 117 Ctrl-P
 118 - previous line
 119 .TP
 120 Ctrl-R
 121 - search reverse
 122 .TP
 123 Ctrl-U
 124 - delete line
 125 .TP
 126 Meta-B
 127 - previous word
 128 .TP
 129 Meta-F
 130 - next word
 131 .TP
 132 Esc <
 133 - beginning of history
 134 .TP
 135 Esc >
 136 - end of history
 137 .RE
 138 .PD
 139
 140 .SH EXITING
 141
 142 FvwmConsole can be stopped by entering the EOF character (usually CTRL-D).
 143 .PP
 144 \fBNote!\fP Do not use the "quit" command, as this is an fvwm builtin:
 145 typing "quit" at the FvwmConsole command line will cause fvwm to exit.
 146
 147 .SH SEE ALSO
 148 \fIxterm\fP(1), \fIFvwmConsoleC.pl\fP(1), GNU Readline library
 149
 150 .SH AUTHOR
 151 FvwmConsole is the original work of Toshi Isogai.