// Docs

Reports

Turning a comparison into HTML, text, a patch, XML or CSV — from the window, a script or the command line.

Every session can produce a report of what it is showing. Session › Report opens the dialog; the preview is a real one, paged as the output will be, and it is recomputed as you change the options.

What comes out

Type What it is
Side by side Both sides in two columns, the way the comparison shows them
Summary One line per difference, or per differing file
Interleaved One side after the other, difference by difference
Patch Normal, context or unified — the format patch and git apply read
Statistics (CSV) The counts, for a spreadsheet
XML The comparison as data, for another program to read

A folder comparison has its own set: side by side, summary, XML, and a report of the differing files whose names are links — each one opening that file’s own report, attached beside the index.

What goes in

“Include” takes all of it, the differences only, or a few lines of context around each difference; it can count or ignore what the rules call unimportant, show line numbers, mark character-level differences, and limit itself to the selected lines. For a folder report, “Include” follows the display filter or picks verdicts by hand (different, unimportant, left only, right only, same), and the columns on both sides can carry size, time, CRC32, version and attributes.

Where it goes

HTML in colour, HTML in monochrome (tints become grey bars and underlines, for printing), HTML with a stylesheet of your own (so the report takes the house style), or plain text. The destination is a file, the clipboard, or the printer — with a print preview of the pages as thumbnails, paper orientation, and how long lines are wrapped.

Title, header and footer take %title%, %left%, %right%, %date%, %page% and %pages%, expanded in the preview as you type.

Without the window

The dialog’s “Copy as script command” gives you the exact script line for the settings in front of you, which is the honest way to move a report into automation:

folder-report layout:side-by-side options:display-mismatches,column-crc &
    output-to:"%3/folders.html" output-options:html-color

text-report, table-report, hex-report and picture-report do the same for those sessions. From a terminal, save the settings and point --report at them:

geecompare --report=~/reports/folders.gcrs /srv/a /srv/b /tmp/report.html

No window opens, and the exit code says what the comparison found. See the command line and scripting.

Last updated: 2026-11-22