bin/fvwm-convert-2.6.1.in

   1 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   2 .TH fvwm-convert-2.6 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
   3 .SH NAME
   4 fvwm-convert-2.6 \- convert fvwm 2.4.x configuration file to fvwm 2.6 style
   5 .SH SYNOPSIS
   6 .B fvwm-convert-2.6
   7 .RI source
   8 .RI [ dest ]
   9 .SH DESCRIPTION
  10 .B fvwm-convert-2.6
  11 converts an fvwm 2.4.x configuration file into a fvwm 2.6
  12 file with compatible syntax.  It is not suitable to convert older 2.x
  13 configuration files.  Please use
  14 .B fvwm-convert-2.2
  15 to convert these to the 2.2.x format first, and then if necessary
  16 .B fvwm-convert-2.4
  17 .PP
  18 By default,
  19 .B fvwm-convert-2.6
  20 won't look for a given config file.  This must be specified as the first
  21 parameter to
  22 .B fvwm-convert-2.6
  23 Different source and destination files may be given.
  24 If the destination file already exists, this program exits.
  25 If no destination file is given, then the filename is
  26 the same name as the source file with the suffix ".converted"
  27 added.  Without an absolute path given as the destination path to the
  28 destination file, the program will create the destination file in the CWD.
  29 .PP
  30 .B fvwm-convert-2.6
  31 makes the following changes:
  32 .TP 4
  33 .B Style lines
  34 In fvwm 2.4, most style options could be negated from their counterparts
  35 using NoFoo -- fvwm-convert-2.6 corrects this by now using !Foo.
  36 .TP 4
  37 .B ModulePath
  38 In fvwm 2.4 and beyond, the ModulePath is compiled into fvwm.
  39 .B fvwm-convert-2.6
  40 removes any ModulePath commands it finds.
  41 If you are using your own modules, (not the ones that come with fvwm),
  42 you will have to fix your configuration file after using
  43 .BR fvwm-convert-2.6 .
  44 .TP 4
  45 .B Conditional command syntax
  46 In fvwm 2.4, the conditional command options were whitespace-separated --
  47 they should now be comma-separated instead.  In addition, the older syntax
  48 to Next and Prev of using [*] to denote all windows has been removed
  49 entirely.  Both these checks and conversions are done on function commands,
  50 key/mouse bindings.
  51 .TP 4
  52 .B WindowShadeSteps
  53 In fvwm 2.4, the WindowShadeSteps command is replaced by the
  54 WindowShadeSteps Style option.
  55 .B fvwm-convert-2.6
  56 makes this change.
  57 .TP 4
  58 .B FvwmTheme
  59 In fvwm 2.6, the FvwmTheme module is replaced by a series of Colorset
  60 commands.  Whilst
  61 .B fvwm-convert-2.6
  62 will try and make this change, it is still recommended that this is checked
  63 after conversion.
  64 .TP 4
  65 .B EdgeResistance
  66 In fvwm 2.6, the EdgeResistance command is has been split to include an
  67 additional style option for EdgeMoveResistance.
  68 .B fvwm-convert-2.6
  69 makes any changes necessary.
  70 .TP 4
  71 .B StartFunction / RestartFunction / InitFunction
  72 In fvwm 2.6, the need for using InitFunction and/or RestartFunction is
  73 redundant when StartFunction is read at both of these times.
  74 .B fvwm-convert-2.6
  75 attempts to convert this.
  76 .TP 4
  77 .B Read
  78 Any files
  79 .B fvwm-convert-2.6
  80 can detect and open will be converted automatically, else a warning is
  81 printed to STDERR.
  82 .TP 4
  83 .SH BUGS
  84
  85 .I InitFunction
  86 and
  87 .I RestartFunction
  88 and hence
  89 .I StartFunction
  90 are printed at the end of the files -- this slight reordering might put some
  91 comments before in an odd spot.
  92
  93 Continuation lines (those commands spanning multiple lines ending in a '\\')
  94 are not handled correctly.
  95
  96 When converting over FvwmTheme lines, the colorset definitions might well be
  97 broken, but these cannot easily be converted.
  98
  99 Bug reports can be sent to the fvwm-workers mailing list (see the
 100 .IR FAQ ).
 101 .SH AUTHOR
 102 Thomas Adam <thomas.adam22@gmail.com> .