modules/FvwmConsole/FvwmConsoleC.pl.1.in

   1 .\" t
   2 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   3 .TH FvwmConsoleC.pl 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
   4 .UC
   5
   6 .SH NAME
   7 FvwmConsoleC.pl \- Command editor for fvwm command input interface
   8 .SH SYNOPSIS
   9 FvwmConsole -e /usr/X11/lib/fvwm/FvwmConsoleC.pl
  10
  11 .SH COPYRIGHT
  12 Copyright 1996, Toshi Isogai. No guarantees or warranties are provided.
  13 Use this program at your own risk. Permission to use this program for
  14 any purpose is given, as long as the copyright is kept intact.
  15
  16
  17 .SH DESCRIPTION
  18 FvwmConsoleC.pl offers editing capabilities  while  the  user  is
  19 entering  the line.  By default, the line editing commands
  20 are similar to those of emacs. It also offers
  21 .B substitution
  22 , which replaces a pattern to a string before it sends the command.
  23
  24 .SH FUNCTIONS
  25 Functions are bound to a key or key combination to be
  26 invoked. The followings are functions available and their
  27 default key bindings.
  28 .RS
  29 .IP \fBbind\fP
  30 \fIMeta-k, Ctrl-x Ctrl-b\fP
  31 .br
  32 .\"Bind key to function or bind pattern to string for substitution.
  33 List up key bindings and substitutions.
  34 .IP \fBboh\fP
  35 .br
  36 Move to the beginning of history.
  37 .IP "\fBboh_ign_mode\fP  \fIEsc-<\fP"
  38 .br
  39 Move to the beginning of history. If it is in search mode,
  40 continue.
  41 .IP \fBbol\fP
  42 \fIHome, Ctrl-a\fP
  43 .br
  44 Move cursor to the beginning of the line.
  45 .IP "\fBbs[(n)]\fP \fIBackSpace, Ctrl-h\fP"
  46 .br
  47 Backspace n times. default of n is 1.
  48 .IP \fBcancel\fP
  49 \fICtrl-x Ctrl-k\fP
  50 .br
  51 Cancel the current input.
  52 .IP \fBdel_back_line\fP
  53 .br
  54 Delete the line from the beginning to the cursor.
  55 .IP "\fBdel_back_word\fP \fICtrl-w\fP"
  56 .br
  57 Delete the word from the beginning to the cursor.
  58 .IP "\fBdel_char [(n)]\fP \fIDelete, Ctrl-d\fP"
  59 Delete n characters from the cursor to the right. Default of n
  60 is 1.
  61 .IP "\fBdel_forw_line\fP \fICtrl-k\fP"
  62 .br
  63 Delete the line from the cursor to the end.
  64 .IP "\fBdel_forw_word\fP \fIMeta-d\fP"
  65 .br
  66 Delete the word from the cursor to the end.
  67 .IP "\fBdel_line\fP \fICtrl-u\fP"
  68 .br
  69 Delete the entire line.
  70 .IP \fBenter\fP
  71 \fIEnter, Ctrl-j, Ctrl-m\fP
  72 .br
  73 Perform substitution if applicable and send the line to fvwm.
  74 .IP "\fBenter_wo_subst\fP \fIMeta-Enter\fP"
  75 .br
  76 Send the line to fvwm without any substitution.
  77 .IP \fBeoh\fP
  78 .br
  79 Move to the end of history.
  80 .IP "\fBeoh_ign_mode\fP \fIEsc->\fP"
  81 .br
  82 Move to the end of history. If it is in search mode, continue.
  83 .IP \fBeol\fP
  84 \fIEnd, Ctrl-e\fP
  85 .br
  86 Move the cursor to the end of line.
  87 .IP "\fBins_char (str)\fP"
  88 .br
  89 Insert string at the cursor.
  90 .IP "\fBins_last_word\fP \fIEsc-.\fP"
  91 .br
  92 Insert the last argument of the previous command at the cursor.
  93 .IP "\fBins_nth_word\fP \fIMeta-[1..9]\fP"
  94 .br
  95 Insert the n-th argument of the previous command at the cursor.
  96 .IP "\fBlist_func\fP \fIMeta-l\fP"
  97 .br
  98 List up available editing functions.
  99 .IP "\fBnext_char\fP \fIRight, Ctrl-f\fP"
 100 .br
 101 Move the cursor to the next character.
 102 .IP "\fBnext_line\fP \fIDown, Ctrl-n\fP"
 103 .br
 104 Move to the next line in history.
 105 .IP "\fBnext_word\fP \fIMeta-f\fP"
 106 .br
 107 Move the cursor to the next word.
 108 .IP \fBprefix\fP
 109 .br
 110 Wait for the next character typed in  for multi-key binding.
 111 .IP "\fBprev_char\fP \fILeft, Ctrl-b\fP"
 112 .br
 113 Move the cursor to the previous character.
 114 .IP "\fBprev_line\fP \fIUp, Ctrl-p\fP"
 115 .br
 116 Move to the previous line in history.
 117 .IP "\fBprev_word\fP \fIMeta-b\fP"
 118 .br
 119 Move the cursor to the previous word.
 120 .IP \fBquote\fP
 121 \fICtrl-q\fP
 122 .br
 123 Insert the next character  typed  into  the  buffer literally.
 124 .IP \fBsearch\fP
 125 \fICtrl-s\fP
 126 .br
 127 Search pattern in history.
 128 .IP "\fBsearch_rev\fP \fICtrl-r\fP"
 129 .br
 130 Search pattern in history in reverse order.
 131 .IP \fBsubst\fP
 132 \fIMeta-s\fP
 133 .br
 134 Substitute all patterns to strings and reprint the line.
 135 The substitutions are not nested and performed in the order
 136 that they are defined.
 137 .RE
 138
 139 .SH CONFIGURATION
 140 The key binding can be overridden or defined
 141 in fvwm module configuration.
 142
 143 .RS
 144 *FvwmConsole: Key \\ck prev_line
 145 .RE
 146
 147 Non-space character sequence need not be quoted.
 148 In order to undefine, omit the last argument.
 149
 150 .RS
 151 *FvwmConsole: Key \\ck
 152 .RE
 153
 154 Note that non-meta character is case sensitive.
 155 \\c means control key, \\e means escape, and \\m is alt key.
 156 .br
 157 It also accepts Subst configuration. Users often input long fvwm command
 158 repeatedly. Subst will replace particular input sequence to user defined
 159 string. Example:
 160
 161 .RS
 162 *FvwmConsole: Subst '^bigx' 'Exec xterm -g 120x60+0+0 -fn 10x20 -fg black -bg lemonchiffon'
 163 .RE
 164
 165 Typing 'bigx<return>' in FvwmConsole will launch xterm. '^' denotes
 166 the beginning of line in
 167 .B regular expression.
 168 \'pl\' in the middle
 169 of the command will not be replaced. Although the format looks different,
 170 it takes Perl regular expression.
 171 It just uses single or double quote as the delimiter.
 172 Single or double quotes have no difference, although they have to match,
 173 and cannot include itself in the string.
 174
 175 .RS
 176 *FvwmConsole: Subst '^g\\s*(\\d+)' 'Desk 0 0\\nGotoPage 0 $1\\nFocus'
 177 .RE
 178
 179 Entering 'g4' or 'g  4' will jump to desk 0 page 0 4 and focus.
 180
 181 .SH INVOCATION
 182 FvwmConsoleC.pl should be invoked by FvwmConsole.
 183
 184 .SH SEE ALSO
 185 FvwmConsole(1x), perlre(1)
 186
 187 .SH AUTHOR
 188 Toshi Isogai