File: manpage.sgml

package info (click to toggle)
docdiff 0.3.3-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 1,076 kB
  • ctags: 589
  • sloc: ruby: 12,550; makefile: 91; lisp: 33
file content (322 lines) | stat: -rw-r--r-- 7,946 bytes parent folder | download | duplicates (9)
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>AKIRA</firstname>">
  <!ENTITY dhsurname   "<surname>YAMADA</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>5 15, 2004</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>akira@debian.org</email>">
  <!ENTITY dhusername  "akira yamada">
  <!ENTITY dhucpackage "<refentrytitle>DOCDIFF</refentrytitle>">
  <!ENTITY dhpackage   "docdiff">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2004</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>character/word-oriented diff</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>


      <arg><option>options</option></arg>

      <arg choice="req"><replaceable>file1</replaceable></arg>

      <arg choice="req"><replaceable>file2</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command>
      commands.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.
      Instead, it has documentation in the HTML
      format; see below.</para>

    <para><command>&dhpackage;</command> is a program that
      compares two files and shows the difference. 
      It can compare files word by word, char by char, or line by line. 
      It has several output formats such as 
      HTML/XHTML, tty, Manued, or user-defined markup.</para>

    <para>It supports several encodings and end-of-line characters, 
      including ASCII, UTF-8, EUC-JP, Shift_JIS, CR, LF, and CRLF.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
	<term><option>--resolution=<replaceable>RESOLUTION</replaceable></option></term>
	<listitem>
	  <para>specify resolution (granularity)
	    line|word|char (default is word)</para>
	</listitem>
      </varlistentry>
      
      <varlistentry>
	<term><option>--line</option></term>
	<listitem>
	  <para>set resolution to line</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--word</option></term>
	<listitem>
	  <para>set resolution to word</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--char</option></term>
	<listitem>
	  <para>set resolution to char</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--encoding=<replaceable>ENCODING</replaceable></option></term>
	<listitem>
	  <para>specify character encoding
	    ASCII|EUC-JP|Shift_JIS|UTF-8|auto
	    (default is auto)</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--ascii</option></term>
	<listitem>
	  <para>same as --encoding=ASCII</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--eucjp</option></term>
	<listitem>
	  <para>same as --encoding=EUC-JP</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--sjis</option></term>
	<listitem>
	  <para>same as --encoding=Shift_JIS</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--utf8</option></term>
	<listitem>
	  <para>same as --encoding=UTF-8</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--eol=<replaceable>EOL</replaceable></option></term>
	<listitem>
	  <para>specify end-of-line character
	    CR|LF|CRLF|auto
	    (default is auto)</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--cr</option></term>
	<listitem>
	  <para>same as --eol=CR</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--lf</option></term>
	<listitem>
	  <para>same as --eol=LF</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--crlf</option></term>
	<listitem>
	  <para>same as --eol=CRLF</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--format=FORMAT</option></term>
	<listitem>
	  <para>specify output format
	    tty|manued|html|wdiff|user
	    (default is html; 
	    user tags have to be described in config file)</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--tty</option></term>
	<listitem>
	  <para>same as --format=tty</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--manued</option></term>
	<listitem>
	  <para>same as --format=manued</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--html</option></term>
	<listitem>
	  <para>same as --format=html</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--wdiff</option></term>
	<listitem>
	  <para>same as --format=wdiff</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--digest</option></term>
	<listitem>
	  <para>digest output, do not show all</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--cache</option></term>
	<listitem>
	  <para>use file cache</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--no-config-file</option></term>
	<listitem>
	  <para>do not read config files</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--verbose</option></term>
	<listitem>
	  <para>run verbosely</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--help</option></term>
	<listitem>
	  <para>show usage</para>
	</listitem>
      </varlistentry>
                             
      <varlistentry>
	<term><option>--version</option></term>
	<listitem>
	  <para>show version</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--license</option></term>
	<listitem>
	  <para>show license</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--author</option></term>
	<listitem>
	  <para>show author(s)</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>/usr/share/doc/docdiff/readme.html.</para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->