File: hdiff.1.xml

package info (click to toggle)
libhdf4 4.3.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 30,384 kB
  • sloc: ansic: 128,700; sh: 15,015; fortran: 12,444; java: 5,863; xml: 1,205; makefile: 794; yacc: 678; pascal: 418; perl: 360; javascript: 203; lex: 163; csh: 41
file content (194 lines) | stat: -rw-r--r-- 5,429 bytes parent folder | download | duplicates (6)
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<refentry id='hdiff'>

  <refmeta>
    <refentrytitle>hdiff</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>hdiff</refname>
    <refpurpose>compares two HDF files and reports the differences</refpurpose>
  </refnamediv>

  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>hdiff</command>
      <arg choice='opt'><option>-V</option></arg>
      <arg choice='opt'><option>-b</option></arg>
      <arg choice='opt'><option>-g</option></arg>
      <arg choice='opt'><option>-s</option></arg>
      <arg choice='opt'><option>-d</option></arg>
      <arg choice='opt'><option>-D</option></arg>
      <arg choice='opt'><option>-S</option></arg>
      <arg choice='opt'><option>-v</option> <replaceable>var1[,...]</replaceable></arg>
      <arg choice='opt'><option>-u</option> <replaceable>var1[,...]</replaceable></arg>
      <arg choice='opt'><option>-e</option> <replaceable>count</replaceable></arg>
      <arg choice='opt'><option>-t</option> <replaceable>limit</replaceable></arg>
      <arg choice='opt'><option>-p</option> <replaceable>relative</replaceable></arg>
      <arg choice='plain'><filename>file1</filename></arg>
      <arg choice='plain'><filename>file2</filename></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='description'>
    <title>DESCRIPTION</title>
    <para>
      <command>hdiff</command> compares two HDF files and reports the
      differences.
    </para>
  </refsect1>

  <refsect1 id='options'>
    <title>OPTIONS</title>
    <variablelist>

      <varlistentry>
        <term><option>-V</option></term>
        <listitem>
          <para>
            Display version of the HDF4 library and exit
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-b</option></term>
        <listitem>
          <para>
            Verbose mode
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-g</option></term>
        <listitem>
          <para>
            Compare global attributes only
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-s</option></term>
        <listitem>
          <para>
            Compare SD local attributes only
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-d</option></term>
        <listitem>
          <para>
            Compare SD data only
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-D</option></term>
        <listitem>
          <para>
            Compare Vdata data only
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-S</option></term>
        <listitem>
          <para>
            Print statistics
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-v</option> <replaceable>var1[,...]</replaceable></term>
        <listitem>
          <para>
            Compare SD data on variable(s) <replaceable>var1</replaceable>,...
            only
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-u</option> <replaceable>var1[,...]</replaceable></term>
        <listitem>
          <para>
            Compare vdata on variable(s) <replaceable>var1</replaceable>,... only
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-e</option> <replaceable>count</replaceable></term>
        <listitem>
          <para>
            Print difference up to count number for each variable
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-t</option> <replaceable>limit</replaceable></term>
        <listitem>
          <para>
            Print difference when it is greater than limit
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-p</option> <replaceable>relative</replaceable></term>
        <listitem>
          <para>
            Print difference when it is greater than a relative limit
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><filename>file1</filename></term>
        <listitem>
          <para>
            File name of the first HDF file
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><filename>file2</filename></term>
        <listitem>
          <para>
            File name of the second HDF file
          </para>
        </listitem>
      </varlistentry>

    </variablelist>
    <para>
      The '<replaceable>count</replaceable>' value must be a positive integer
    </para>
    <para>
      The '<replaceable>limit</replaceable>'
      and '<replaceable>relative</replaceable>'
      values must be positive numbers
    </para>
    <para>
      The <option>-t</option> compare criteria is |a - b| &gt; limit
    </para>
    <para>
      The <option>-p</option> compare criteria is |(b-a)/a| &gt; relative
    </para>
    <para>
      Return codes: 0 (no differences found), 1 (differences found)
    </para>
  </refsect1>

</refentry>