modules/FvwmSaveDesk/FvwmSaveDesk.1.in

   1 .\" t
   2 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   3 .TH FvwmSaveDesk 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
   4 .UC
   5 .SH NAME
   6 FvwmSaveDesk \- another fvwm desktop-layout saving module
   7 .SH SYNOPSIS
   8 FvwmSaveDesk is spawned by fvwm, so no command line invocation will work.
   9
  10 .SH DESCRIPTION
  11 When called, this module will attempt to save your current desktop
  12 layout as a definition of extra lines for the function InitFunction
  13 into the file
  14 .I .fvwm2desk
  15 in your home directory. As explain in the other documentation, this
  16 function is called at startup of fvwm.
  17 You have to include this file in
  18 .I .fvwm2rc
  19 after the definition of the Function Initfunction.
  20 You can do this by using the module
  21 .I FvwmM4
  22 or
  23 .I FvwmCpp.
  24
  25 Your applications must supply certain hints to the X window system.
  26 .I Emacs
  27 and \fINetscape\fP, for example, does not, so FvwmSaveDesk can't get any
  28 information from it.
  29
  30 Also, FvwmSaveDesk assumes that certain command line options are
  31 globally accepted by applications, which may not be the case.
  32
  33 .SH SETUP USING FVWMM4 MODULE
  34 The M4 Macro processor substitutes its macros even in the middle of a
  35 word. Because of that you may have problems with predefined macros
  36 such as include or define. To avoid this the GNU M4 has an extra
  37 option to prefix all builtins with 'm4_'. FvwmM4 can be called with
  38 option -m4-prefix and then will provide the option -P to M4.
  39 I personally use the FvwmM4 module this way.
  40 .nf
  41 .sp
  42 fvwm -cmd "FvwmM4 -m4-prefix -m4opt -I$HOME $HOME/.fvwm2rc"
  43 .sp
  44 .fi
  45 Simply add the following line to the end of .fvwm2rc:
  46 .nf
  47 .sp
  48 m4_include(`.fvwm2desk') .
  49 .sp
  50 .fi
  51 .SH SETUP USING FVWMCPP MODULE
  52 With the FvwmCpp you may have the problem that the preprocessor
  53 directives starts with the comment character '#' and will
  54 complain about unknown directives, if you have comments in your .fvwm2rc.
  55 .nf
  56 .sp
  57 fvwm -cmd "FvwmCpp -C-I$HOME $HOME/.fvwm2rc"
  58 .sp
  59 .fi
  60 Simply add the following line to the end of .fvwm2rc:
  61 .nf
  62 .sp
  63 #include ".fvwm2desk"
  64 .sp
  65 .fi
  66 .SH INVOCATION
  67 FvwmSaveDesk can be invoked by adding it to a menu or binding it to a
  68 mouse button or key stroke in
  69 the
  70 .I .fvwm2rc
  71 file.
  72 Fvwm will search directory specified in the ModulePath
  73 configuration option to locate FvwmSaveDesk.
  74
  75 To insert it to a menu, add the line
  76 .nf
  77 .sp
  78 +       "Save Desktop" Module FvwmSaveDesk
  79 .sp
  80 .fi
  81 to the menu definition.
  82 I thing binding it to a mouse button is not very useful, but you can
  83 do that, by adding for example this line.
  84 .nf
  85 .sp
  86 Mouse 3         R       CS      Module FvwmSaveDesk
  87 .sp
  88 .fi
  89 Than FvwmSaveDesk will be called if you hit the right mouse button
  90 on the root window while holding the shift and control button down.
  91
  92 You can bind FvwmSaveDesk to a function key F10 for example you have
  93 to insert the following line:
  94 .nf
  95 .sp
  96 Key     F10     A       Module FvwmSaveDesk
  97 .sp
  98 .fi
  99 I personally add it as a Button to the module FvwmButtons:
 100 .nf
 101 .sp
 102 *FvwmButtons SaveDesc desk.xpm   Module FvwmSaveDesk
 103 .sp
 104 .fi
 105 .SH AUTHOR
 106 Carsten Paeth (calle@calle.in-berlin.de)