File: ReadMe.tt

package info (click to toggle)
vbindiff 3.0-beta5-2
  • links: PTS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 1,220 kB
  • sloc: cpp: 2,374; sh: 1,003; perl: 110; makefile: 96; lisp: 13
file content (151 lines) | stat: -rw-r--r-- 4,351 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
[% IF Win32 %]
   [% outputFile = 'ReadMe.txt' %]
[% ELSE %]
   [% outputFile = 'README' %]
[% END %]
>../[% outputFile %]


===============================================================================
[% PERL %]
# Generate title line:
# ReadMe.txt                Visual Binary Diff 0.xx                 DD-Mmm-YYYY

use Date::Format 'time2str';

my $line   = $stash->get('outputFile');
my $center = sprintf '%s %s', $stash->get('name'), $stash->get('version');
my $date   = time2str('%e-%b-%Y', time);

$line .= (' ' x (int((79 - length $center) / 2) - length $line)) . $center;
$line .= (' ' x (79 - length($line) - length($date))) . $date . "\n";

print $line

[% END %]
===============================================================================
                                      Copyright 2000-2017 Christopher J. Madsen
CONTENTS
========
[% PERL %]
# Generate the table of contents:

my $Win32 = $stash->get('Win32');

my @sections = (
  'About Visual Binary Diff',
  'System Requirements',
  'Installation',
  ($Win32 ? 'Removal' : ()),
  'License',
  ($Win32 ? 'History' : ()),
  'Author',
);

my %section;
my $num = 0;
foreach (@sections) {
  $section{$_} = sprintf "[\%d] %s", ++$num, $_;
  print "  $section{$_}\n";
}

$stash->set(section => sub {
  my $s = $section{$_[0]};
  sprintf "%s\n%s", $s, '-' x length($s),
});
[% END %]

[% section('About Visual Binary Diff') %]

Visual Binary Diff (VBinDiff) displays files in hexadecimal and ASCII
(or EBCDIC).  It can also display two files at once, and highlight the
differences between them.  Unlike diff, it works well with large files
(up to 4 GB).

VBinDiff was inspired by the Compare Files function of the ProSel
utilities by Glen Bredon, for the Apple II.  When I couldn't find a
similar utility for the PC, I wrote it myself.

The single-file mode was inspired by the LIST utility of 4DOS and
friends (http://www.jpsoft.com/4ntdes.htm).  While less
(http://www.greenwoodsoftware.com/less/) provides a good line-oriented
display, it has no equivalent to LIST's hex display.  (True, you can
pipe the file through hexdump, but that's incredibly inefficient on
multi-gigabyte files.)


[% section('System Requirements') %]

Windows 95, Windows NT 4.0, or later
  or
A POSIX-compatible system with ncurses (eg, Linux)

It should be possible to port the ncurses version to work with other
curses libraries (as long as they provide the panel library), but I
don't have access to such a system.  Patches are welcome.


[% section('Installation') %]

[% IF Win32 %]
Copy VBinDiff.exe to a folder on your path.  If you don't know what a path
is, you can put it in your C:\Windows directory.  Then read VBinDiff.txt to
find out how to use it.
[% ELSE %]
VBinDiff uses the standard GNU autoconf system.  See the file INSTALL if
you're not familiar with that.
[% END %]


[% IF Win32 %]
[% section('Removal') %]

To remove VBinDiff, just delete it.  It makes no registry changes or INI
files.

The following files are included with VBinDiff (and should be deleted):
  ReadMe.txt	This file
  AUTHORS.txt   Credits
  COPYING.txt   The GNU General Public License
  VBinDiff.exe	The main program
  VBinDiff.txt	The documentation
  Source.zip    The source code for VBinDiff


[% END %]
[% section('License') %]

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, see <https://www.gnu.org/licenses/>.

The GNU General Public License can be found in the file COPYING[% '.txt' IF Win32 %].

The file putty.src is not part of VBinDiff and can be distributed
under the same terms as ncurses.


[% IF Win32 %]
[% section('History') %]
[% INCLUDE NEWS.tt %]


[% END %]
[% section('Author') %]

Christopher J. Madsen           vbindiff AT cjmweb.net

VBinDiff Home Page:
https://www.cjmweb.net/vbindiff/

VBinDiff Development on GitHub:
https://github.com/madsen/vbindiff