Skip to main content

Efficiently manage the differences between two files using vim.

Project description

Opens two files in vimdiff and provides single-stroke key mappings to make moving differences between two files efficient. Up to two additional files may be opened at the same time, but these are generally used for reference purposes.

Usage

vdiff [options] <file1> <file2> [<file3> [<file4>]]

Options

-v, --vim

Use vim (rather than default).

-g, --gvim

Use gvim (rather than default).

-f, --force

Edit the files even if they are the same.

-q, --quiet

Issue only error messages.

-h, --help

Print this helpful message.

Relevant Key Mappings

Ctrl-j

Move down to next difference

Ctrl-k

Move up to previous difference

Ctrl-o

Obtain difference

Ctrl-p

Push difference

{

Update file1 to match file2

}

Update file2 to match file1

S

Save any changes in all files and quit

Q

Quit without saving any file

=

Make all panes the same size and rotate between them

+

Update differences

Defaults

Defaults will be read from ~/.config/vdiff/config if it exists. This is a Python file that is evaluated to determine the value of three variables: vimdiff, gvimdiff, and gui. The first two are the strings used to invoke vimdiff and gvimdiff. The third is a boolean that indicates which should be the default. If gui is true, gvimdiff is used by default, otherwise vimdiff is the default. An example file might contain:

vimdiff = 'gvimdiff -v'
gvimdiff = 'gvimdiff -f'
gui = True

These values also happen to be the default defaults.

As a Package

You can also use vdiff in your own Python programs. To do so, you would do something like the following:

from inform import Error
from vdiff import Vdiff

vdiff = Vdiff(lfile, rfile)

try:
    vdiff.edit()
except KeyboardInterrupt:
    vdiff.cleanup()
except Error as err:
    err.report()

Installation

Runs only on Unix systems. Requires Python 3.5 or later. Install by running ‘./install’ or ‘pip3 install vdiff’.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vdiff-2.4.0.tar.gz (5.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page