README 3.54 KB
Newer Older
Joachim Eibl's avatar
Joachim Eibl committed
1 2 3
KDiff3-Readme
=============

4
Author: Joachim Eibl  (joachim.eibl at gmx.de)
5
Port to KF5/Qt5 by Michael Reeves (reeves.87@gmail.com)
6
KDiff3-Version: 1.8
7

8
Now requires Qt 5.6 or later and KF5 5.14+. Legacy 0.9.98 and earlier builds are not supported.
9
MacOSX build is untested since port. The Konqueror specific plugin is not ported and no longer maintained.
10
This plugin would only apply to KDE before 4.6. Support as been removed from main CMakeLists.txt.
11
As of 1/13/17 cmake 3.1+ is the targeted cmake version.
12

13

14 15
cmake is now the only build system supported. KF5/Qt5 was big jump. A lot changed besides just the API.
I am not against a Qt5-only build variant but see no reason to maintain two separate build systems.
16 17
At present KF5 is my focus.

18
The original pre KF5/Qt5 Readme follows old build instructions have been removed to avoid confusion:
19

20 21

Copyright: (C) 2002-2014 by Joachim Eibl
Joachim Eibl's avatar
Joachim Eibl committed
22

Joachim Eibl's avatar
Joachim Eibl committed
23 24 25 26
KDiff3 runs best on KDE but can be built without it, depending only on Qt-libs.
These are available for Un*x, Windows, Mac.
Thus there are many setup possibilities to consider.

27
Supported Qt-versions: 4.8, 5.2 or higher.
28
Supported KDE-version: 4, 5
29
(For KDE3/Qt3 use KDiff3-0.9.92 or older.)
Joachim Eibl's avatar
Joachim Eibl committed
30 31 32 33 34 35 36 37 38 39 40

Contents
--------

- Introduction
- License
- Additional hints


Introduction
------------
Joachim Eibl's avatar
Joachim Eibl committed
41 42

KDiff3 is a program that
Joachim Eibl's avatar
Joachim Eibl committed
43
- compares and merges two or three input files or directories,
Joachim Eibl's avatar
Joachim Eibl committed
44 45 46
- shows the differences line by line and character by character (!),
- provides an automatic merge-facility and
- an integrated editor for comfortable solving of merge-conflicts
Joachim Eibl's avatar
Joachim Eibl committed
47 48
- has support for KDE-KIO (ftp, sftp, http, fish, smb),
- has an intuitive graphical user interface,
49
- provides a context menu for KDE-Dolphin and Windows-Explorer,
Joachim Eibl's avatar
Joachim Eibl committed
50
- supports 64 bit systems. (Some build issues are discussed in here.)
51
- Support for many encodings and Unicode.
Joachim Eibl's avatar
Joachim Eibl committed
52

53
Do you want help translating? Read the instructions on https://l10n.kde.org/ !
Joachim Eibl's avatar
Joachim Eibl committed
54 55


Joachim Eibl's avatar
Joachim Eibl committed
56 57 58
License
-------

Joachim Eibl's avatar
Joachim Eibl committed
59 60 61 62 63 64 65 66 67 68 69 70 71
    GNU GENERAL PUBLIC LICENSE, Version 2, June 1991
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
72
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1307
73
    USA
Joachim Eibl's avatar
Joachim Eibl committed
74 75 76

    For details see file "COPYING".

77

Joachim Eibl's avatar
Joachim Eibl committed
78 79
------------------------------------------------------------------------

Joachim Eibl's avatar
Joachim Eibl committed
80 81
Additional hints
----------------
Joachim Eibl's avatar
Joachim Eibl committed
82

Joachim Eibl's avatar
Joachim Eibl committed
83 84 85 86 87 88
   Start from commandline:
   - Comparing 2 files:     kdiff3 file1 file2
   - Merging 2 files:       kdiff3 file1 file2 -o outputfile
   - Comparing 3 files:     kdiff3 file1 file2 file3
   - Merging 3 files:       kdiff3 file1 file2 file3 -o outputfile
        Note that file1 will be treated as base of file2 and file3.
Joachim Eibl's avatar
Joachim Eibl committed
89

Joachim Eibl's avatar
Joachim Eibl committed
90 91 92 93
   If all files have the same name but are in different directories, you can
   reduce typework by specifying the filename only for the first file. E.g.:
   - Comparing 3 files:     kdiff3 dir1/filename dir2 dir3
   (This also works in the open-dialog.)
94

Joachim Eibl's avatar
Joachim Eibl committed
95 96
   If you start without arguments, then a dialog will appear where you can
   select your files via a filebrowser.
Joachim Eibl's avatar
Joachim Eibl committed
97

Joachim Eibl's avatar
Joachim Eibl committed
98
   For more documentation, see the help-menu or the subdirectory doc.
Joachim Eibl's avatar
Joachim Eibl committed
99

Joachim Eibl's avatar
Joachim Eibl committed
100
   Have fun!