modules/FvwmScroll/FvwmScroll.1.in

   1 .\" t
   2 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   3 .TH FvwmScroll 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
   4 .UC
   5 .SH NAME
   6 FvwmScroll \- the fvwm scroll-bar module
   7 .SH SYNOPSIS
   8 FvwmScroll is spawned by fvwm, so no command line invocation will work.
   9
  10 .SH DESCRIPTION
  11 The FvwmScroll module prompts the user to select a target window, if
  12 the module was not launched from within a window context in Fvwm.
  13 After that, it adds scroll bars to the selected window, to reduce the
  14 total desktop space consumed by the window.
  15
  16 FvwmScroll should not be used with windows which move or resize
  17 themselves, nor should it be used with windows which set the
  18 WM_COLORMAP_WINDOWS property. Operation is fine with windows that have
  19 a private colormap.
  20
  21 .SH COPYRIGHTS
  22 The FvwmScroll program, and the concept for
  23 interfacing this module to the Window Manager, are all original work
  24 by Robert Nation.
  25
  26 Copyright 1994, Robert Nation. No guarantees or
  27 warranties or anything
  28 are provided or implied in any way whatsoever. Use this program at your
  29 own risk. Permission to use this program for any purpose is given,
  30 as long as the copyright is kept intact.
  31
  32
  33 .SH INITIALIZATION
  34 During initialization, \fIFvwmScroll\fP gets config info from \fBfvwm\fP's
  35 module configuration database (see
  36 .IR fvwm (1),
  37 section
  38 .BR "MODULE COMMANDS" )
  39 to determine which colors to use.
  40
  41 If the FvwmScroll executable is linked to another name, ie ln -s
  42 FvwmScroll MoreScroll, then another module called MoreScroll can be
  43 started, with a completely different configuration than FvwmScroll,
  44 simply by changing the keyword  FvwmScroll to MoreScroll.
  45
  46 .SH INVOCATION
  47 FvwmScroll can be invoked by binding the action 'Module
  48 FvwmScroll x y' to a menu or key-stroke in the .fvwm2rc file.
  49 The parameter x and y are either integers or integers immediately followed by
  50 a p, which describe the horizontal and vertical size modification of the
  51 window.  An integer describe a size reduction. An integer followed by a
  52 p describe a size as a percentage of the height or the width of a full screen
  53 but the size is never larger than the original window size (0p will do
  54 nothing). Fvwm will search directory specified in the ModulePath
  55 configuration option to attempt to locate FvwmScroll. Although nothing
  56 keeps you from launching FvwmScroll at start-up time, you probably don't
  57 want to.
  58
  59 .SH CONFIGURATION OPTIONS
  60 .IP "*FvwmScroll: Colorset \fIn\fP"
  61 Tells the module to use colorset \fIn\fP. See FvwmTheme.
  62
  63 .IP "*FvwmScroll: Back \fIcolor\fP"
  64 Tells the module to use \fIcolor\fP instead of black for the window
  65 background. Switches off the Colorset option.
  66
  67 .SH BUGS
  68 When the scroll bars are removed by clicking on the button in the
  69 lower right corner, the window does not restore its location
  70 correctly.
  71
  72 .SH AUTHOR
  73 Robert Nation
  74