modules/FvwmBanner/FvwmBanner.1.in

   1 .\" t
   2
   3 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   4 .de EX          \"Begin example
   5 .ne 5
   6 .if n .sp 1
   7 .if t .sp .5
   8 .nf
   9 .in +.5i
  10 ..
  11 .de EE
  12 .fi
  13 .in -.5i
  14 .if n .sp 1
  15 .if t .sp .5
  16 ..
  17 .TH FvwmBanner 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
  18 .UC
  19 .SH NAME
  20 FvwmBanner \- the Fvwm Banner module
  21 .SH SYNOPSIS
  22 Module FvwmBanner
  23
  24 \fIFvwmBanner\fP can only be invoked by fvwm.
  25 Command line invocation of the \fIFvwmBanner\fP module will not work.
  26
  27 .SH DESCRIPTION
  28 FvwmBanner displays an Fvwm Logo in the center of the screen
  29 for 3 seconds.
  30
  31 .SH COPYRIGHTS
  32 None.
  33
  34 .SH INITIALIZATION
  35 Nothing interesting.
  36
  37 .SH INVOCATION
  38 FvwmBanner can be invoked by the command 'Module FvwmBanner'.
  39 This can be bound to
  40 a menu or key-stroke in the .fvwm2rc file,
  41 but more likely you would do this in the StartFunction or InitFunction,
  42 for example:
  43 .EX
  44 AddToFunc InitFunction "I" Module FvwmBanner
  45 .EE
  46
  47 You can also give it an
  48 optional file parameter, like 'FvwmBanner doomface.xpm' or specify an
  49 alternate default pixmap via configuration options
  50 (see "*FvwmBanner: Pixmap" below).
  51 Fvwm will search the ImagePath
  52 to find the image, or you can use the full path to the image.
  53
  54 .SH CONFIGURATION OPTIONS
  55
  56 .IP "*FvwmBanner: NoDecor"
  57 Tells FvwmBanner to create a window that Fvwm will not manage and not decorate.
  58
  59 .IP "*FvwmBanner: Pixmap \fIfile\fP"
  60 Tells FvwmBanner to display \fIfile\fP instead of the built in pixmap.
  61
  62 .IP "*FvwmBanner: Timeout \fIsec\fP"
  63 Tells FvwmBanner to display for \fIsec\fP seconds instead of default
  64 of 3 seconds.
  65
  66 .SH AUTHOR
  67 Robert Nation