doc/man/sgmldiff.1

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "SGMLDIFF" "1" "11 February 2004" "" ""
   7
   8 .SH NAME
   9 sgmldiff \- Find differences in the markup of two SGML files
  10 .SH SYNOPSIS
  11
  12 \fBsgmldiff\fR [ \fBoptions \fR\fI ...\fR ] \fB\fIfile1\fB\fR \fB\fIfile2\fB\fR [ \fB-a\fR | \fB--attributes\fR
  13     | \fB-c  [ attributes | nesting | textpos ]\fR | \fB--context  [ attributes | nesting | textpos ]\fR
  14     | \fB-s\fR | \fB--statistics\fR
  15     | \fB-h\fR | \fB--help\fR
  16     | \fB-v\fR | \fB--version\fR ]
  17
  18 .SH "DESCRIPTION"
  19 .PP
  20 This perl script allows to determine the structural differences
  21 between two SGML files. It compares the files, regardless of what
  22 is in between the tags, to only focus on the markup. Its output
  23 is similar to \fBdiff\fR(1)\&.
  24 .PP
  25 The typical use of \fBsgmldiff\fR is to
  26 compare an SGML file with its translation into another language. If
  27 the translation was done cleanly, \fBsgmldiff\fR
  28 returns without finding any difference in the markup.
  29 .PP
  30 An example of a typical call to sgmldiff is:
  31
  32 .nf
  33       sgmldiff english.sgml italiano.sgml
  34
  35 .fi
  36 .PP
  37 If there are differences in markup between both files,
  38 \fBsgmldiff\fR will output a series of differences
  39 reports summarized with lines of the form:
  40 .TP
  41 \fB169a164\fR
  42 At line 169 of the first file, line 164 of the
  43 second file has been added.
  44 .TP
  45 \fB8a12,15\fR
  46 At line 8 of the first file, lines 12 to 15
  47 of the second file have been added.
  48 .TP
  49 \fB41d28\fR
  50 Line 41 of the first file has been destroyed, to
  51 obtain line 28 of the second file.
  52 .TP
  53 \fB63,66d61\fR
  54 Lines 63 to 66 of the first file have been
  55 destroyed. to obtain line 61 of the second file.
  56 .TP
  57 \fB52c51\fR
  58 Line 52 of the first file has been changed into
  59 line 51 of the second file.
  60 .TP
  61 \fB5,7c8,10\fR
  62 Lines 5 to 7 of the first file have been changed
  63 into lines 8 to 10 of the second line.
  64 In addition to those summaries, the lines of the first file are
  65 shown preceeded by '<' and the lines of the second file are
  66 shown preceeded by '>".
  67 .SH "OPTIONS"
  68 .PP
  69 Here is the list of actions that can be requested to
  70 sgmldiff:
  71 .TP
  72 \fB             [ -a | --attributes ]  \fR
  73 Include the attribute values in the difference tests.
  74 Don't set this value if the attributes are likely to be
  75 translated. Set this value if the attributes value shouldn't
  76 change between both files. Default is to don't include the
  77 attributes in the difference tests.
  78 .TP
  79 \fB             [ -c  [ attributes | nesting | textpos ] | --context  [ attributes | nesting | textpos ] ]  \fR
  80 Add more context to the difference. Since every test between the tags is removed before testing the differences, \fBsgmldiff\fR is likely to resynchronize itself at the wrong place, by thinking the location in both files correspond, while it's not true. By adding more context to the compared area, such risk is disminished.
  81
  82 The allowed values for the \fB--context\fR option are:
  83 .RS
  84 .TP
  85 \fBattributes\fR
  86 Take into account the attribute
  87 \fBnames\fR\&. The attribute
  88 \fBvalues\fR are controlled by the
  89 \fBattributes\fR option.
  90 .TP
  91 \fBnesting\fR
  92 Take into account the nesting level of all the compared tags.
  93 .TP
  94 \fBtextpos\fR
  95 Take into account the position in the text.
  96 .RE
  97 .TP
  98 \fB             [ -s | --statistics ]  \fR
  99 Print some SGML information at the end.
 100 .TP
 101 \fB             [ -h | --help ]  \fR
 102 Print a short help message and exit
 103 .TP
 104 \fB             [ -v | --version ]  \fR
 105 Print the version identifier and exit
 106 .SH "FILES"
 107 .PP
 108 .SH "AUTHORS"
 109 .TP
 110 \fB          Frederik Fouvry \fR
 111 Developer of \fBsgmldiff\fR\&.
 112 .SH "SEE ALSO"
 113 .TP
 114 \fB          jw(1) \fR
 115 conversion from a SGML file to other file formats
 116 .TP
 117 \fB   nsgmls(1) \fR
 118 a base component of \fBJade\fR DSSSL engine
 119 .TP
 120 \fB   http://sources.redhat.com/docbook-tools/ <URL:http://sources.redhat.com/docbook-tools/> \fR
 121 the home page of the DocBook tools, a compendium of
 122 all tools necessary to process DocBook files, including
 123 the DocBook-utils