Metadata-Version: 1.1
Name: vdiff
Version: 2.3.3
Summary: Efficiently manage the differences between two files using vim.
Home-page: http://nurdletech.com/linux-utilities/vdiff
Author: Ken Kundert
Author-email: vdiff@nurdletech.com
License: GPLv3+
Download-URL: https://github.com/kenkundert/vdiff/tarball/master
Description: Vdiff
        =====
        
        Opens two files in vimdiff and provides single-stroke key mappings to make 
        moving differences between two files efficient.
        
        Usage
        -----
        
        ``vdiff`` [options] <lfile> <rfile>
        
        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 the file on the left to match the one on the right
        ``}``         Update the file on the right to match the one on the left
        ``S``         Save any changes in both files and quit
        ``Q``         Quit without saving either file
        ``=``         Make both windows the same size and toggle between them
        ``+``         Update differences
        ==========    =========================================================
        
        
        Defaults
        --------
        
        Defaults will be read from ~/.config/vdiff/config if it exists. This is a YAML 
        file that may contain 3 settings: vim, gvim, 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::
        
            vim: gvimdiff -v
            gvim: gvimdiff -f
            gui: yes
        
        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="...", useGUI=True)
        
            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'.
        
Keywords: vim,diff
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Utilities
