README
1KDiff3-Readme
2=============
3
4Author: Joachim Eibl (joachim.eibl at gmx.de)
5Port to KF5/Qt5 by Michael Reeves (reeves.87@gmail.com)
6KDiff3-Version: 1.9.3
7
8Now requires Qt 5.8 or later and KF5 5.37+. Legacy 0.9.98 and earlier builds are not supported.
9MacOS X build is 64-bit only unfortunately I can't test build locally. The Konqueror specific plug-in
10is not ported and no longer maintained. This plug-in would only apply to KDE before 4.6. As of 1/13/17
11cmake 3.1+ is the targeted cmake version.
12
13cmake is now the only build system supported. KF5/Qt5 was big jump. A lot changed besides just the API.
14I am not against a Qt5-only build variant but see no reason to maintain two separate build systems.
15At present KF5 is my focus.
16
17Known Issues:
18*Binary comparison has been temporarily disabled due to stability issues.
19*Network comparison operation via non file urls may fail for some configurations. This is under investigation.
20
21The current repository is at https://invent.kde.org/kde/kdiff3
22
23Bugs can be reported at https://bugs.kde.org
24
25The original pre KF5/Qt5 Readme follows old build instructions have been removed to avoid confusion:
26
27
28Copyright: (C) 2002-2014 by Joachim Eibl
29
30KDiff3 runs best on KDE but can be built without it, depending only on Qt-libs.
31These are available for Un*x, Windows, Mac.
32Thus there are many setup possibilities to consider.
33
34Supported Qt-versions: 4.8, 5.2 or higher.
35Supported KDE-version: 4, 5
36(For KDE3/Qt3 use KDiff3-0.9.92 or older.)
37
38Contents
39--------
40
41- Introduction
42- License
43- Additional hints
44
45
46Introduction
47------------
48
49KDiff3 is a program that
50- compares and merges two or three input files or directories,
51- shows the differences line by line and character by character (!),
52- provides an automatic merge-facility and
53- an integrated editor for comfortable solving of merge-conflicts
54- has support for KDE-KIO (ftp, sftp, http, fish, smb),
55- has an intuitive graphical user interface,
56- provides a context menu for KDE-Dolphin and Windows-Explorer,
57- supports 64 bit systems. (Some build issues are discussed in here.)
58- Support for many encodings and Unicode.
59
60Do you want help translating? Read the instructions on https://l10n.kde.org/ !
61
62
63License
64-------
65
66 GNU GENERAL PUBLIC LICENSE, Version 2, June 1991
67 This program is free software; you can redistribute it and/or modify
68 it under the terms of the GNU General Public License as published by
69 the Free Software Foundation; either version 2 of the License, or
70 (at your option) any later version.
71
72 This program is distributed in the hope that it will be useful,
73 but WITHOUT ANY WARRANTY; without even the implied warranty of
74 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
75 GNU General Public License for more details.
76
77 You should have received a copy of the GNU General Public License
78 along with this program; if not, write to the Free Software
79 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1307
80 USA
81
82 For details see file "COPYING".
83
84
85------------------------------------------------------------------------
86
87Additional hints
88----------------
89
90 Start from commandline:
91 - Comparing 2 files: kdiff3 file1 file2
92 - Merging 2 files: kdiff3 file1 file2 -o outputfile
93 - Comparing 3 files: kdiff3 file1 file2 file3
94 - Merging 3 files: kdiff3 file1 file2 file3 -o outputfile
95 Note that file1 will be treated as base of file2 and file3.
96
97 If all files have the same name but are in different directories, you can
98 reduce typework by specifying the filename only for the first file. E.g.:
99 - Comparing 3 files: kdiff3 dir1/filename dir2 dir3
100 (This also works in the open-dialog.)
101
102 If you start without arguments, then a dialog will appear where you can
103 select your files via a filebrowser.
104
105 For more documentation, see the help-menu or the subdirectory doc.
106
107 Have fun!
108