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