Fix compiler warnings.
[fvwm.git] / bin / fvwm-convert-2.4.1.in
blob131af7a184d1b947cbe285d305e49c90d99c3848
1 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
2 .TH fvwm-convert-2.4 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
3 .SH NAME
5 fvwm-convert-2.4 \- convert fvwm 2.2.x configuration file to fvwm 2.4 syntax
6 .SH SYNOPSIS
8 .B fvwm-convert-2.4
9 .RI [ source ]
10 .RI [ dest ]
11 .SH DESCRIPTION
13 .B fvwm-convert-2.4
14 converts an fvwm 2.2.x configuration file into an fvwm 2.4
15 compatible syntax.  It is not suitable to convert older 1.x
16 configuration files.  Please use
17 .B fvwm-convert-2.2
18 to convert these to the 2.2.x format first.
19 .PP
20 By default,
21 .B fvwm-convert-2.4
22 converts
23 .I ~/.fvwm2rc,
24 saving the results in
25 .I ~/.fvwm/.fvwm2rc.
26 You must create the
27 .I ~/.fvwm
28 directory before running this command.
29 Starting with the 2.4 release, the directory
30 .I ~/.fvwm
31 is the default location for fvwm user configuration files.
32 Different source and destination files may be given.
33 If the destination file already exists, this program exits.
34 While the program runs it will generate a temporary file with
35 the same name as the destination file with the suffix ".pass1"
36 added.
37 .PP
38 .B fvwm-convert-2.4
39 makes the following changes:
40 .TP 4
41 .B PixmapPath/IconPath
42 In fvwm 2.4, the PixmapPath and IconPath commands are replaced by
43 the ImagePath command.  In addition, the ImagePath can be compiled into
44 fvwm.
45 .B fvwm-convert-2.4
46 changes the PixmapPath and IconPath commands
47 to ImagePath commands and removes any directories that are compiled
48 into fvwm.
49 Paths starting with a dollar sign are also removed.
50 .TP 4
51 .B ModulePath
52 In fvwm 2.4, the ModulePath is compiled into fvwm.
53 .B fvwm-convert-2.4
54 removes any ModulePath commands it finds.
55 If you are using your own modules, (not the ones that come with fvwm),
56 you will have to fix your configuration file after using
57 .BR fvwm-convert-2.4 .
58 .TP 4
59 .B HilightColor
60 In fvwm 2.4, the HighlightColor command is replaced by a Style command
61 using the HilightFore and HilightBack arguments.
62 .B fvwm-convert-2.4
63 makes these changes.
64 .TP 4
65 .B HilightColorset
66 In fvwm 2.4, the HighlightColorset command that was present in some of the
67 2.3.x beta releases is replaced by a Style command
68 using the HilightColorset style.
69 .B fvwm-convert-2.4
70 makes these changes.
71 .TP 4
72 .B WindowShadeAnimate
73 In fvwm 2.4, the WindowShadeAnimate command is replaced by the
74 WindowShadeSteps Style option.
75 .B fvwm-convert-2.4
76 makes this change.
77 .TP 4
78 .B WindowFont
79 In fvwm 2.4, the WindowFont command is replaced by a Style command
80 using the Font argument.
81 .B fvwm-convert-2.4
82 makes this change.
83 .TP 4
84 .B ColorLimit
85 In fvwm 2.4, the ColorLimit command is automatic.  If you have a limited
86 colormap, color limiting is the default.
87 .B fvwm-convert-2.4
88 removes any ColorLimit command that it finds.
89 .TP 4
90 .B GlobalOpts
91 The GlobalOpts command is converted to
92 .B Style
93 options and the
94 .B BugOpts
95 command.  Some options can not be converted automatically, though.
96 .TP 4
97 .B Read
98 Prints a message identifying any read commands found.  The files
99 being read may need to be converted also.
100 .TP 4
101 .B Placement Styles
102 Any of the old placement Styles found in the file can not be
103 converted automatically.  Instead,
104 .B fvwm-convert-2.4
105 prints a warning.  For details about the conversion, please refer to
106 the "Window manager placement" section of the fvwm man page.
107 .TP 4
108 .B FvwmConfig and FvwmPipe
109 These modules are no longer a part of the fvwm distribution.
110 .B fvwm-convert-2.4
111 prints a warning if these modules are found in the file.
112 .TP 4
113 .B FvwmButtons panels
114 The syntax of panels in FvwmButtons has changed.  The conversion
115 can not be done automatically.
116 .B fvwm-convert-2.4
117 prints a message when it encounters a potential panel definition.
118 For details about the conversion, please refer to the
119 "CONVERTING OLD PANEL CONFIGURATIONS" section of the FvwmButtons
120 man page.
121 .SH BUGS
123 You need Perl to be installed.
125 .I WindowFont
127 .I HilightColor
128 commands embedded in functions are not found.
129 If you have either of these commands in functions, they are not detected.
131 Known bugs can be found in the fvwm bug tracking system (accessible
132 from the fvwm home page).
134 Bug reports can be sent to the fvwm-workers mailing list (see the
135 .IR FAQ ).
137 .SH AUTHOR
138 Dan Espen <despen@telcordia.com>.