modules/FvwmDebug/FvwmGtkDebug.1

   1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.02)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" Escape single quotes in literal strings from groff's Unicode transform.
  52 .ie \n(.g .ds Aq \(aq
  53 .el       .ds Aq '
  54 .\"
  55 .\" If the F register is turned on, we'll generate index entries on stderr for
  56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  58 .\" output yourself in some meaningful fashion.
  59 .ie \nF \{\
  60 .    de IX
  61 .    tm Index:\\$1\t\\n%\t"\\$2"
  62 ..
  63 .    nr % 0
  64 .    rr F
  65 .\}
  66 .el \{\
  67 .    de IX
  68 ..
  69 .\}
  70 .\"
  71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  73 .    \" fudge factors for nroff and troff
  74 .if n \{\
  75 .    ds #H 0
  76 .    ds #V .8m
  77 .    ds #F .3m
  78 .    ds #[ \f1
  79 .    ds #] \fP
  80 .\}
  81 .if t \{\
  82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  83 .    ds #V .6m
  84 .    ds #F 0
  85 .    ds #[ \&
  86 .    ds #] \&
  87 .\}
  88 .    \" simple accents for nroff and troff
  89 .if n \{\
  90 .    ds ' \&
  91 .    ds ` \&
  92 .    ds ^ \&
  93 .    ds , \&
  94 .    ds ~ ~
  95 .    ds /
  96 .\}
  97 .if t \{\
  98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 104 .\}
 105 .    \" troff and (daisy-wheel) nroff accents
 106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 113 .ds ae a\h'-(\w'a'u*4/10)'e
 114 .ds Ae A\h'-(\w'A'u*4/10)'E
 115 .    \" corrections for vroff
 116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 118 .    \" for low resolution devices (crt and lpr)
 119 .if \n(.H>23 .if \n(.V>19 \
 120 \{\
 121 .    ds : e
 122 .    ds 8 ss
 123 .    ds o a
 124 .    ds d- d\h'-1'\(ga
 125 .    ds D- D\h'-1'\(hy
 126 .    ds th \o'bp'
 127 .    ds Th \o'LP'
 128 .    ds ae ae
 129 .    ds Ae AE
 130 .\}
 131 .rm #[ #] #H #V #F C
 132 .\" ========================================================================
 133 .\"
 134 .IX Title "FvwmGtkDebug 1"
 135 .TH FvwmGtkDebug 1 "2009-03-22" "2.5.28 (from cvs)" "Fvwm Modules"
 136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 137 .\" way too many mistakes in technical documents.
 138 .if n .ad l
 139 .nh
 140 .SH "NAME"
 141 FvwmGtkDebug \- graphical interactive fvwm module debugger
 142 .SH "SYNOPSIS"
 143 .IX Header "SYNOPSIS"
 144 FvwmGtkDebug should be spawned by \fIfvwm\fR\|(1).
 145 .PP
 146 To run this module, place this command somewhere in the configuration:
 147 .PP
 148 .Vb 1
 149 \&    Module FvwmGtkDebug
 150 .Ve
 151 .PP
 152 To stop this module, just close the \s-1GUI\s0 window, the usual KillModule works too.
 153 .PP
 154 You may also run this application as a regular program from the command line shell.\  But the communication with \fIfvwm\fR is not established in this dummy mode, so commands are not really sent and there are no real events received.\  However certain activity is emulated using dummy events.
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 This module monitors all fvwm event information and shows it nicely in the interactive gtk+ application. Good for debugging and educational purposes.
 158 .PP
 159 Among the features: command console with history and auto command help, requesting to send back ConfigInfo (configuration of \fIfvwm\fR and all modules), WindowList (information about all windows) or custom Reply.
 160 .PP
 161 The fvwm commands may be executed within the context of some window. The context window may be optionally set on invocation, like: \*(L"Next (Navigator) FvwmGtkDebug\*(R", and be set/unset interactively at any time.
 162 .SH "INVOCATION"
 163 .IX Header "INVOCATION"
 164 There are several command line switches:
 165 .PP
 166 \&\fBFvwmGtkDebug\fR [ \fB\-\-mask\fR \fImask\fR ] [ \fB\-\-xmask\fR \fImask\fR ] [ \fB\-\-debug\fR \fIlevel\fR ]
 167 .PP
 168 Long switches may be abbreviated to shorter switches.
 169 .PP
 170 \&\fB\-m\fR|\fB\-\-mask\fR \fImask\fR \- set the initial module mask, 31 bit integer. This mask may be changed interactively at any time. By default almost all events are monitored (except for some flood events like \fI\s-1CONFIGURE_WINDOW\s0\fR or \fI\s-1FOCUS_WINDOW\s0\fR. The special value of \fI\-1\fR sets the maximal mask.
 171 .PP
 172 \&\fB\-x\fR|\fB\-\-xmask\fR \fImask\fR \- set the initial module extended mask, 31 bit integer. This mask may be changed interactively at any time. By default almost all events are monitored (except for some flood events like \fI\s-1ENTER_WINDOW\s0\fR or \fI\s-1LEAVE_WINDOW\s0\fR. The special value of \fI\-1\fR sets the maximal extended mask.
 173 .PP
 174 \&\fB\-d\fR|\fB\-\-debug\fR \fIlevel\fR \- use the Perl library debugging mechanism. The useful \fIlevel\fRs are 2 to 4.
 175 .SH "SEE ALSO"
 176 .IX Header "SEE ALSO"
 177 See also FvwmDebug, \*(L"fvwm-perllib man events\*(R".
 178 .SH "AUTHOR"
 179 .IX Header "AUTHOR"
 180 Mikhael Goikhman <migo@homemail.com>.