dm6: fix inode naming for little-endian systems
[dupemerge] / dm6
1 #!/usr/bin/perl
2 use warnings;
3 use strict;
4 use Digest::SHA1 qw(sha1 sha1_hex sha1_base64);
5 use Fcntl qw(:DEFAULT :flock);
6 use File::Compare;
7 use File::Path;
8 use File::Temp;
9 use File::stat;
10 use MIME::Base64;
11
12 # Copyright (C) 2010 Zygo Blaxell <dm5@mailtoo.hungrycats.org>
13
14 # This program is free software; you can redistribute it and/or modify
15 # it under the terms of the GNU General Public License as published by
16 # the Free Software Foundation; either version 2 of the License, or
17 # (at your option) any later version.
18
19 # This program is distributed in the hope that it will be useful,
20 # but WITHOUT ANY WARRANTY; without even the implied warranty of
21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22 # GNU General Public License for more details.
23
24 # You should have received a copy of the GNU General Public License
25 # along with this program; if not, write to the Free Software
26 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27
28 sub digest {
29         my ($filename) = (@_);
30         die "'$filename' is not a plain file" if (-l $filename) || ! (-f _);
31         my $ctx = Digest::SHA1->new;
32         sysopen(FILE, $filename, O_RDONLY|O_NONBLOCK) or die "open: $filename: $!";
33         binmode(FILE);          # FIXME:  Necessary?  Probably harmless...
34         $ctx->addfile(\*FILE);
35         close(FILE) or die "close: $filename: $!";
36         return $ctx->b64digest;
37 }
38
39 sub usage {
40         die <<USAGE;
41 Usage: $0 link-dir
42 Hashes a NUL-separated list of files on stdin into link-dir.
43
44 Version: 0.20100514
45 USAGE
46 }
47
48 # Link files
49 sub link_files {
50         my ($from, $to) = (@_);
51
52         print STDERR 'T';
53         my $inode_dir = $to;
54         my $inode_base = $to;
55         $inode_dir =~ s:[^/]*$::o;
56         $inode_base =~ s:^.*/::os;
57         my $tmp_to = File::Temp::tempnam($inode_dir, ".$inode_base.");
58         print STDERR "\bL";
59         link($from, $tmp_to) or die "link: $from -> $tmp_to: $!";
60         print STDERR "\bR";
61         unless (rename($tmp_to, $to)) {
62                 my $saved_bang = $!;
63                 print STDERR "\bU";
64                 unlink($tmp_to) or warn "unlink: $tmp_to: $!";  # Try, possibly in vain, to clean up
65                 die "rename: $tmp_to -> $from: $saved_bang";
66         }
67         print STDERR "\b";
68 }
69
70 my $link_dir = shift @ARGV;
71 usage unless $link_dir;
72
73 my $prefix_length = 3;
74
75 sub slash_prefix {
76         my ($file) = @_;
77         $file .= '_' x (length($file) + 1 - $prefix_length) if length($file) + 1 < $prefix_length;
78         my $prefix = substr($file, 0, $prefix_length);
79         my $suffix = substr($file, $prefix_length);
80         $prefix =~ s:(.):$1/:osg;
81         chop($prefix);
82         return ($prefix, $suffix);
83 }
84
85 sub mkdir_p {
86         my ($dir) = @_;
87         return if -d $dir;
88         $dir =~ s:/+$::os;
89         my $parent;
90         ($parent = $dir) =~ s:[^/]+$::os;
91         if ($parent ne $dir) {
92                 mkdir_p($parent);
93                 print STDERR 'm';
94                 mkdir($dir) or die "mkdir: $dir: $!";
95         }
96         die "mkdir: $dir: $!" unless -d $dir;
97 }
98
99 sub prepare_parents {
100         my ($link_dir, $file) = @_;
101         my ($prefix, $suffix) = slash_prefix($file);
102         my $parent = "$link_dir/$prefix";
103         mkdir_p($parent);
104         return "$parent/$suffix";
105 }
106
107 sub name_quad {
108         my ($int64) = @_;
109         my $packed = pack('Q>', $int64);
110         $packed =~ s/^\0+//os;
111         my $base64_packed = encode_base64($packed, '');
112         # Don't strip off the trailing padding since it makes the string
113         # so short we end up just putting it back on again.
114         # $base64_packed =~ s/=+$//os;
115         return $base64_packed;
116 }
117
118 sub name_ino {
119         my ($ino) = @_;
120         return name_quad($ino) . 'I';
121 }
122
123 # ext3 cannot handle more than 32000 links to a file.  Leave some headroom.
124 # Arguably this should be configurable, but the losses are miniscule and
125 # the coding for option support is not.
126 my $link_count_max = 31990;
127
128 $/ = "\0";
129 while (<STDIN>) {
130         my $file = $_;
131         eval {
132                 for (1) {
133                         chomp $file;
134
135                         # Get file stat data
136                         print STDERR '.';
137                         my $st = lstat($file);
138                         die "lstat: $file: $!" unless $st;
139
140                         # Oops?
141                         next unless -f _;
142
143                         # Skip the file if it has far too many links already
144                         next if ($st->nlink > $link_count_max);
145
146                         # Check link to inode
147                         my $inode_link = prepare_parents($link_dir, name_ino($st->ino));
148                         print STDERR 'I';
149                         my $inode_st = lstat($inode_link);
150                         my $update_links;
151                         if ($inode_st) {
152                                 my $inode_dev = $inode_st->dev;
153                                 my $inode_ino = $inode_st->ino;
154                                 my $file_dev = $st->dev;
155                                 my $file_ino = $st->ino;
156                                 if ($inode_ino != $file_ino || $inode_dev != $file_dev) {
157                                         warn "inode link '$inode_link' is wrong (inode $inode_ino should be $file_ino)" if $inode_ino != $file_ino;
158                                         warn "inode link '$inode_link' is wrong (dev $inode_dev should be $file_dev)" if $inode_dev != $file_dev;
159                                         $update_links = 1;
160                                 }
161                         } else {
162                                 $update_links = 1;
163                         }
164                         print STDERR "\b";
165
166                         # If neither criteria for updating link is met, leave it as-is
167                         next unless $update_links;
168
169                         # Compute digest
170                         print STDERR 'd';
171                         my $digest = digest($file);
172                         print STDERR "\b";
173
174                         # Base64 uses /, we prefer _
175                         $digest =~ y:/:_:;
176
177                         # Check link to digest
178                         my $digest_link = prepare_parents($link_dir, "${digest}D");
179                         print STDERR 'D';
180                         my $digest_st = lstat($digest_link);
181                         if ($digest_st) {
182                                 my $digest_nlink = $digest_st->nlink;
183                                 if ($digest_nlink > 31990) {
184                                         print STDERR 'u';
185                                         unlink($digest_link) or die "unlink: $digest_link: $!";
186                                         undef $digest_st;
187                                 }
188                         }
189                         print STDERR "\b";
190
191                         # Which file are we keeping?
192                         my $keep_ino;
193
194                         # If digest link exists, link it to file
195                         if ($digest_st) {
196                                 print STDERR 'c';
197                                 die "NOT identical!" if compare($digest_link, $file);
198
199                                 # Old, replace input with old file
200                                 print STDERR '-';
201                                 link_files($digest_link, $file);
202                                 $keep_ino = $digest_st->ino;
203                         } else {
204                                 # New, add input to digest
205                                 print STDERR '+';
206                                 link_files($file, $digest_link);
207                                 $keep_ino = $st->ino;
208                         }
209
210                         # A link to the inode indicates we are done, so do it last
211                         $inode_link = prepare_parents($link_dir, name_ino($keep_ino));
212                         print STDERR ' ';
213                         link_files($digest_link, $inode_link);
214
215                 }
216         };
217         warn "$file: $@" if $@;
218 }
219
220 # Garbage collection
221 print STDERR "\nGarbage collection in '$link_dir'...";
222 chdir($link_dir) || die "chdir: $link_dir: $!";
223 print STDERR "\nRemoving files with link count < 3...";
224 system("find . -type f -links -3 -print0 | xargs -0rt rm -f") and die "system: exit status $?";
225 print STDERR "\nRemoving empty directories...";
226 system("find . -type d -empty -print0 | xargs -0rt rmdir -p --ignore-fail-on-non-empty") and die "system: exit status $?";
227 print STDERR "\nDone.\n";
228
229 exit(0);
230
231 __END__
232
233 #################################################################################
234 #                     GNU GENERAL PUBLIC LICENSE                                #
235 #                        Version 2, June 1991                                   #
236 #                                                                               #
237 #  Copyright (C) 1989, 1991 Free Software Foundation, Inc.                      #
238 #      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                  #
239 #  Everyone is permitted to copy and distribute verbatim copies                 #
240 #  of this license document, but changing it is not allowed.                    #
241 #                                                                               #
242 #                             Preamble                                          #
243 #                                                                               #
244 #   The licenses for most software are designed to take away your               #
245 # freedom to share and change it.  By contrast, the GNU General Public          #
246 # License is intended to guarantee your freedom to share and change free        #
247 # software--to make sure the software is free for all its users.  This          #
248 # General Public License applies to most of the Free Software                   #
249 # Foundation's software and to any other program whose authors commit to        #
250 # using it.  (Some other Free Software Foundation software is covered by        #
251 # the GNU Library General Public License instead.)  You can apply it to         #
252 # your programs, too.                                                           #
253 #                                                                               #
254 #   When we speak of free software, we are referring to freedom, not            #
255 # price.  Our General Public Licenses are designed to make sure that you        #
256 # have the freedom to distribute copies of free software (and charge for        #
257 # this service if you wish), that you receive source code or can get it         #
258 # if you want it, that you can change the software or use pieces of it          #
259 # in new free programs; and that you know you can do these things.              #
260 #                                                                               #
261 #   To protect your rights, we need to make restrictions that forbid            #
262 # anyone to deny you these rights or to ask you to surrender the rights.        #
263 # These restrictions translate to certain responsibilities for you if you       #
264 # distribute copies of the software, or if you modify it.                       #
265 #                                                                               #
266 #   For example, if you distribute copies of such a program, whether            #
267 # gratis or for a fee, you must give the recipients all the rights that         #
268 # you have.  You must make sure that they, too, receive or can get the          #
269 # source code.  And you must show them these terms so they know their           #
270 # rights.                                                                       #
271 #                                                                               #
272 #   We protect your rights with two steps: (1) copyright the software, and      #
273 # (2) offer you this license which gives you legal permission to copy,          #
274 # distribute and/or modify the software.                                        #
275 #                                                                               #
276 #   Also, for each author's protection and ours, we want to make certain        #
277 # that everyone understands that there is no warranty for this free             #
278 # software.  If the software is modified by someone else and passed on, we      #
279 # want its recipients to know that what they have is not the original, so       #
280 # that any problems introduced by others will not reflect on the original       #
281 # authors' reputations.                                                         #
282 #                                                                               #
283 #   Finally, any free program is threatened constantly by software              #
284 # patents.  We wish to avoid the danger that redistributors of a free           #
285 # program will individually obtain patent licenses, in effect making the        #
286 # program proprietary.  To prevent this, we have made it clear that any         #
287 # patent must be licensed for everyone's free use or not licensed at all.       #
288 #                                                                               #
289 #   The precise terms and conditions for copying, distribution and              #
290 # modification follow.                                                          #
291 #                                                                               #
292 #                     GNU GENERAL PUBLIC LICENSE                                #
293 #    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION            #
294 #                                                                               #
295 #   0. This License applies to any program or other work which contains         #
296 # a notice placed by the copyright holder saying it may be distributed          #
297 # under the terms of this General Public License.  The "Program", below,        #
298 # refers to any such program or work, and a "work based on the Program"         #
299 # means either the Program or any derivative work under copyright law:          #
300 # that is to say, a work containing the Program or a portion of it,             #
301 # either verbatim or with modifications and/or translated into another          #
302 # language.  (Hereinafter, translation is included without limitation in        #
303 # the term "modification".)  Each licensee is addressed as "you".               #
304 #                                                                               #
305 # Activities other than copying, distribution and modification are not          #
306 # covered by this License; they are outside its scope.  The act of              #
307 # running the Program is not restricted, and the output from the Program        #
308 # is covered only if its contents constitute a work based on the                #
309 # Program (independent of having been made by running the Program).             #
310 # Whether that is true depends on what the Program does.                        #
311 #                                                                               #
312 #   1. You may copy and distribute verbatim copies of the Program's             #
313 # source code as you receive it, in any medium, provided that you               #
314 # conspicuously and appropriately publish on each copy an appropriate           #
315 # copyright notice and disclaimer of warranty; keep intact all the              #
316 # notices that refer to this License and to the absence of any warranty;        #
317 # and give any other recipients of the Program a copy of this License           #
318 # along with the Program.                                                       #
319 #                                                                               #
320 # You may charge a fee for the physical act of transferring a copy, and         #
321 # you may at your option offer warranty protection in exchange for a fee.       #
322 #                                                                               #
323 #   2. You may modify your copy or copies of the Program or any portion         #
324 # of it, thus forming a work based on the Program, and copy and                 #
325 # distribute such modifications or work under the terms of Section 1            #
326 # above, provided that you also meet all of these conditions:                   #
327 #                                                                               #
328 #     a) You must cause the modified files to carry prominent notices           #
329 #     stating that you changed the files and the date of any change.            #
330 #                                                                               #
331 #     b) You must cause any work that you distribute or publish, that in        #
332 #     whole or in part contains or is derived from the Program or any           #
333 #     part thereof, to be licensed as a whole at no charge to all third         #
334 #     parties under the terms of this License.                                  #
335 #                                                                               #
336 #     c) If the modified program normally reads commands interactively          #
337 #     when run, you must cause it, when started running for such                #
338 #     interactive use in the most ordinary way, to print or display an          #
339 #     announcement including an appropriate copyright notice and a              #
340 #     notice that there is no warranty (or else, saying that you provide        #
341 #     a warranty) and that users may redistribute the program under             #
342 #     these conditions, and telling the user how to view a copy of this         #
343 #     License.  (Exception: if the Program itself is interactive but            #
344 #     does not normally print such an announcement, your work based on          #
345 #     the Program is not required to print an announcement.)                    #
346 #                                                                               #
347 # These requirements apply to the modified work as a whole.  If                 #
348 # identifiable sections of that work are not derived from the Program,          #
349 # and can be reasonably considered independent and separate works in            #
350 # themselves, then this License, and its terms, do not apply to those           #
351 # sections when you distribute them as separate works.  But when you            #
352 # distribute the same sections as part of a whole which is a work based         #
353 # on the Program, the distribution of the whole must be on the terms of         #
354 # this License, whose permissions for other licensees extend to the             #
355 # entire whole, and thus to each and every part regardless of who wrote it.     #
356 #                                                                               #
357 # Thus, it is not the intent of this section to claim rights or contest         #
358 # your rights to work written entirely by you; rather, the intent is to         #
359 # exercise the right to control the distribution of derivative or               #
360 # collective works based on the Program.                                        #
361 #                                                                               #
362 # In addition, mere aggregation of another work not based on the Program        #
363 # with the Program (or with a work based on the Program) on a volume of         #
364 # a storage or distribution medium does not bring the other work under          #
365 # the scope of this License.                                                    #
366 #                                                                               #
367 #   3. You may copy and distribute the Program (or a work based on it,          #
368 # under Section 2) in object code or executable form under the terms of         #
369 # Sections 1 and 2 above provided that you also do one of the following:        #
370 #                                                                               #
371 #     a) Accompany it with the complete corresponding machine-readable          #
372 #     source code, which must be distributed under the terms of Sections        #
373 #     1 and 2 above on a medium customarily used for software interchange; or,  #
374 #                                                                               #
375 #     b) Accompany it with a written offer, valid for at least three            #
376 #     years, to give any third party, for a charge no more than your            #
377 #     cost of physically performing source distribution, a complete             #
378 #     machine-readable copy of the corresponding source code, to be             #
379 #     distributed under the terms of Sections 1 and 2 above on a medium         #
380 #     customarily used for software interchange; or,                            #
381 #                                                                               #
382 #     c) Accompany it with the information you received as to the offer         #
383 #     to distribute corresponding source code.  (This alternative is            #
384 #     allowed only for noncommercial distribution and only if you               #
385 #     received the program in object code or executable form with such          #
386 #     an offer, in accord with Subsection b above.)                             #
387 #                                                                               #
388 # The source code for a work means the preferred form of the work for           #
389 # making modifications to it.  For an executable work, complete source          #
390 # code means all the source code for all modules it contains, plus any          #
391 # associated interface definition files, plus the scripts used to               #
392 # control compilation and installation of the executable.  However, as a        #
393 # special exception, the source code distributed need not include               #
394 # anything that is normally distributed (in either source or binary             #
395 # form) with the major components (compiler, kernel, and so on) of the          #
396 # operating system on which the executable runs, unless that component          #
397 # itself accompanies the executable.                                            #
398 #                                                                               #
399 # If distribution of executable or object code is made by offering              #
400 # access to copy from a designated place, then offering equivalent              #
401 # access to copy the source code from the same place counts as                  #
402 # distribution of the source code, even though third parties are not            #
403 # compelled to copy the source along with the object code.                      #
404 #                                                                               #
405 #   4. You may not copy, modify, sublicense, or distribute the Program          #
406 # except as expressly provided under this License.  Any attempt                 #
407 # otherwise to copy, modify, sublicense or distribute the Program is            #
408 # void, and will automatically terminate your rights under this License.        #
409 # However, parties who have received copies, or rights, from you under          #
410 # this License will not have their licenses terminated so long as such          #
411 # parties remain in full compliance.                                            #
412 #                                                                               #
413 #   5. You are not required to accept this License, since you have not          #
414 # signed it.  However, nothing else grants you permission to modify or          #
415 # distribute the Program or its derivative works.  These actions are            #
416 # prohibited by law if you do not accept this License.  Therefore, by           #
417 # modifying or distributing the Program (or any work based on the               #
418 # Program), you indicate your acceptance of this License to do so, and          #
419 # all its terms and conditions for copying, distributing or modifying           #
420 # the Program or works based on it.                                             #
421 #                                                                               #
422 #   6. Each time you redistribute the Program (or any work based on the         #
423 # Program), the recipient automatically receives a license from the             #
424 # original licensor to copy, distribute or modify the Program subject to        #
425 # these terms and conditions.  You may not impose any further                   #
426 # restrictions on the recipients' exercise of the rights granted herein.        #
427 # You are not responsible for enforcing compliance by third parties to          #
428 # this License.                                                                 #
429 #                                                                               #
430 #   7. If, as a consequence of a court judgment or allegation of patent         #
431 # infringement or for any other reason (not limited to patent issues),          #
432 # conditions are imposed on you (whether by court order, agreement or           #
433 # otherwise) that contradict the conditions of this License, they do not        #
434 # excuse you from the conditions of this License.  If you cannot                #
435 # distribute so as to satisfy simultaneously your obligations under this        #
436 # License and any other pertinent obligations, then as a consequence you        #
437 # may not distribute the Program at all.  For example, if a patent              #
438 # license would not permit royalty-free redistribution of the Program by        #
439 # all those who receive copies directly or indirectly through you, then         #
440 # the only way you could satisfy both it and this License would be to           #
441 # refrain entirely from distribution of the Program.                            #
442 #                                                                               #
443 # If any portion of this section is held invalid or unenforceable under         #
444 # any particular circumstance, the balance of the section is intended to        #
445 # apply and the section as a whole is intended to apply in other                #
446 # circumstances.                                                                #
447 #                                                                               #
448 # It is not the purpose of this section to induce you to infringe any           #
449 # patents or other property right claims or to contest validity of any          #
450 # such claims; this section has the sole purpose of protecting the              #
451 # integrity of the free software distribution system, which is                  #
452 # implemented by public license practices.  Many people have made               #
453 # generous contributions to the wide range of software distributed              #
454 # through that system in reliance on consistent application of that             #
455 # system; it is up to the author/donor to decide if he or she is willing        #
456 # to distribute software through any other system and a licensee cannot         #
457 # impose that choice.                                                           #
458 #                                                                               #
459 # This section is intended to make thoroughly clear what is believed to         #
460 # be a consequence of the rest of this License.                                 #
461 #                                                                               #
462 #   8. If the distribution and/or use of the Program is restricted in           #
463 # certain countries either by patents or by copyrighted interfaces, the         #
464 # original copyright holder who places the Program under this License           #
465 # may add an explicit geographical distribution limitation excluding            #
466 # those countries, so that distribution is permitted only in or among           #
467 # countries not thus excluded.  In such case, this License incorporates         #
468 # the limitation as if written in the body of this License.                     #
469 #                                                                               #
470 #   9. The Free Software Foundation may publish revised and/or new versions     #
471 # of the General Public License from time to time.  Such new versions will      #
472 # be similar in spirit to the present version, but may differ in detail to      #
473 # address new problems or concerns.                                             #
474 #                                                                               #
475 # Each version is given a distinguishing version number.  If the Program        #
476 # specifies a version number of this License which applies to it and "any       #
477 # later version", you have the option of following the terms and conditions     #
478 # either of that version or of any later version published by the Free          #
479 # Software Foundation.  If the Program does not specify a version number of     #
480 # this License, you may choose any version ever published by the Free Software  #
481 # Foundation.                                                                   #
482 #                                                                               #
483 #   10. If you wish to incorporate parts of the Program into other free         #
484 # programs whose distribution conditions are different, write to the author     #
485 # to ask for permission.  For software which is copyrighted by the Free         #
486 # Software Foundation, write to the Free Software Foundation; we sometimes      #
487 # make exceptions for this.  Our decision will be guided by the two goals       #
488 # of preserving the free status of all derivatives of our free software and     #
489 # of promoting the sharing and reuse of software generally.                     #
490 #                                                                               #
491 #                             NO WARRANTY                                       #
492 #                                                                               #
493 #   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY    #
494 # FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN      #
495 # OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES        #
496 # PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED    #
497 # OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF          #
498 # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS     #
499 # TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE        #
500 # PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,      #
501 # REPAIR OR CORRECTION.                                                         #
502 #                                                                               #
503 #   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING   #
504 # WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR           #
505 # REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,    #
506 # INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING   #
507 # OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED     #
508 # TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY      #
509 # YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER    #
510 # PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE         #
511 # POSSIBILITY OF SUCH DAMAGES.                                                  #
512 #                                                                               #
513 #                      END OF TERMS AND CONDITIONS                              #
514 #                                                                               #
515 #             How to Apply These Terms to Your New Programs                     #
516 #                                                                               #
517 #   If you develop a new program, and you want it to be of the greatest         #
518 # possible use to the public, the best way to achieve this is to make it        #
519 # free software which everyone can redistribute and change under these terms.   #
520 #                                                                               #
521 #   To do so, attach the following notices to the program.  It is safest        #
522 # to attach them to the start of each source file to most effectively           #
523 # convey the exclusion of warranty; and each file should have at least          #
524 # the "copyright" line and a pointer to where the full notice is found.         #
525 #                                                                               #
526 #     <one line to give the program's name and a brief idea of what it does.>   #
527 #     Copyright (C) <year>  <name of author>                                    #
528 #                                                                               #
529 #     This program is free software; you can redistribute it and/or modify      #
530 #     it under the terms of the GNU General Public License as published by      #
531 #     the Free Software Foundation; either version 2 of the License, or         #
532 #     (at your option) any later version.                                       #
533 #                                                                               #
534 #     This program is distributed in the hope that it will be useful,           #
535 #     but WITHOUT ANY WARRANTY; without even the implied warranty of            #
536 #     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             #
537 #     GNU General Public License for more details.                              #
538 #                                                                               #
539 #     You should have received a copy of the GNU General Public License         #
540 #     along with this program; if not, write to the Free Software               #
541 #     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA #
542 #                                                                               #
543 #                                                                               #
544 # Also add information on how to contact you by electronic and paper mail.      #
545 #                                                                               #
546 # If the program is interactive, make it output a short notice like this        #
547 # when it starts in an interactive mode:                                        #
548 #                                                                               #
549 #     Gnomovision version 69, Copyright (C) year  name of author                #
550 #     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. #
551 #     This is free software, and you are welcome to redistribute it             #
552 #     under certain conditions; type `show c' for details.                      #
553 #                                                                               #
554 # The hypothetical commands `show w' and `show c' should show the appropriate   #
555 # parts of the General Public License.  Of course, the commands you use may     #
556 # be called something other than `show w' and `show c'; they could even be      #
557 # mouse-clicks or menu items--whatever suits your program.                      #
558 #                                                                               #
559 # You should also get your employer (if you work as a programmer) or your       #
560 # school, if any, to sign a "copyright disclaimer" for the program, if          #
561 # necessary.  Here is a sample; alter the names:                                #
562 #                                                                               #
563 #   Yoyodyne, Inc., hereby disclaims all copyright interest in the program      #
564 #   `Gnomovision' (which makes passes at compilers) written by James Hacker.    #
565 #                                                                               #
566 #   <signature of Ty Coon>, 1 April 1989                                        #
567 #   Ty Coon, President of Vice                                                  #
568 #                                                                               #
569 # This General Public License does not permit incorporating your program into   #
570 # proprietary programs.  If your program is a subroutine library, you may       #
571 # consider it more useful to permit linking proprietary applications with the   #
572 # library.  If this is what you want to do, use the GNU Library General         #
573 # Public License instead of this License.                                       #
574 #################################################################################