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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
|
<!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY debian "<productname>Debian GNU/Linux</productname>">
<!ENTITY docbook "<productname>DocBook</productname>">
]>
<!-- Manual page for debchanges, DocBook source file
(C) 2000 Matt Zimmerman <mdz@debian.org>
Based on the example page docbook-to-man.sgml from docbook-to-man
$Id: apt-listchanges.sgml,v 1.29 2004/02/27 06:43:18 mdz Exp $
-->
<refentry>
<docinfo>
<address>
<email>mdz@debian.org</email>
</address>
<author>
<firstname>Matt</firstname>
<surname>Zimmerman</surname>
</author>
<date>2003-07-07</date>
</docinfo>
<refmeta>
<refentrytitle>apt-listchanges</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>apt-listchanges</refname> <refpurpose>Show new changelog
entries from Debian package archives
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>apt-listchanges</command>
<group choice=opt>
<arg rep=repeat><replaceable>options</replaceable></arg>
</group>
<group choice=req>
<arg><option>--apt</option></arg>
<arg rep=repeat><replaceable>package.deb</replaceable></arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>apt-listchanges</command> is a tool to show what
has been changed in a new version of a Debian package, as
compared to the version currently installed on the
system.</para>
<para>It does this by extracting the relevant entries from both the
NEWS.Debian and changelog<optional>.Debian</optional> files, usually found in
<filename>/usr/share/doc/</filename><replaceable>package</replaceable>,
from Debian package archives.
</para>
<para>
Given a set of filenames as arguments (or read from apt when
using <option>--apt</option>),
<command>apt-listchanges</command> will scan the files (assumed
to be Debian package archives) for the relevant changelog
entries, and display them all in a summary, sorted by urgency.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<VARIABLELIST>
<VARLISTENTRY>
<TERM><option>--apt</option>
</TERM>
<LISTITEM>
<PARA>Read filenames from a specially-formatted pipeline (as
provided by apt), rather than from command line arguments,
and honor certain apt-specific options in the config
file. This pipeline must be in "version 2" format,
specified in the apt configuration.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM><option>-v, --verbose</option>
</TERM>
<LISTITEM>
<PARA>Display additional (usually unwanted) information.
For instance, print a message when a package of the same
or older version is to be installed, or when a package is
to be newly installed.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM><option>-f, --frontend</option>
</TERM>
<LISTITEM>
<PARA>
Select which frontend to use to display information to the
user. Current frontends include:
</PARA>
<VARIABLELIST>
<VARLISTENTRY>
<TERM>pager</TERM>
<LISTITEM>
<PARA>
Uses your favorite pager to display output. By
default, the PAGER environment variable will be
used. The "pager" option may be specified in the
configuration file to select a specific pager for
use with apt-listchanges.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<varlistentry>
<term>browser</term>
<listitem>
<para>
Displays an HTML-formatted changelog using a web
browser, with hyperlinks for bugs and email
addresses. By default, the BROWSER environment
variable will be used. The
"browser" option may be specified in the
configuration file to select a specific browser for
use with apt-listchanges.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>xterm-pager</TERM>
<LISTITEM>
<PARA>
Uses your favorite pager to display output, but does
so in an xterm (using the x-terminal-emulator
alternative) in the background. This allows you
to go on with the upgrade if you like, and continue
to browse the changelogs. You can override the
terminal emulator to be used with the "xterm"
configuration option.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<varlistentry>
<term>xterm-browser</term>
<listitem>
<para>
The logical combination of xterm-pager and browser.
Only appropriate for text-mode browsers.
</para>
</listitem>
</varlistentry>
<VARLISTENTRY>
<TERM>text</TERM>
<LISTITEM>
<PARA>
Dumps output to stdout, with no pauses.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM>mail</TERM>
<LISTITEM>
<PARA>
Sends mail to the address specified with
--email-address, and does not display changelogs.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM>none</TERM>
<LISTITEM>
<PARA>
Does nothing. Can be used to prevent
apt-listchanges from running when configured to run
automatically from apt.
</PARA>
</LISTITEM>
</VARLISTENTRY>
</VARIABLELIST>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM><OPTION>--email-address=address</OPTION></TERM>
<LISTITEM>
<PARA>
In addition to displaying it, mail a copy of the changelog
data to the specified address. To only mail changelog
entries, use this option with the special frontend 'mail'.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM><OPTION>-c, --confirm</OPTION></TERM>
<LISTITEM>
<PARA>
Once changelogs have been displayed, ask the user whether
or not to proceed. If the user chooses not to proceed, a
nonzero exit status will be returned, and apt will abort.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM><OPTION>-a, --all</OPTION></TERM>
<LISTITEM>
<PARA>
Rather than trying to display changelog entries that are
newer than the currently installed version of the package,
simply display all changelog entries for all packages.
This is useful for viewing the entire changelog of a .deb
before extracting it.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM><OPTION>--save_seen=file</OPTION></TERM>
<LISTITEM>
<PARA>
This option will cause apt-listchanges to keep track of
the last version of a package for which changelogs have
been displayed, to avoid redisplaying the same changelogs
in a future invocation. The database is stored in the
named file. Specify 'none' to disable this feature.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM><OPTION>--which={news|changelogs|both}</OPTION></TERM>
<LISTITEM>
<PARA>
This option selects whether news (from NEWS.Debian et
al.), changelogs (from changelog.Debian et al.) or both
should be displayed. The default is to display both.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM><OPTION>--help</OPTION></TERM>
<LISTITEM>
<PARA>
Displays syntax information.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM><OPTION>-h, --headers</OPTION></TERM>
<LISTITEM>
<PARA>
These options will cause apt-listchanges to insert a
header before each package's changelog showing the name of
the package, and the names of the binary packages which
are being upgraded (if there is more than one, or it
differs from the source package name).
</PARA>
</LISTITEM>
</VARLISTENTRY>
<varlistentry>
<term><option>--debug</option></term>
<listitem>
<para>Display some debugging information
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--profile=<replaceable>name</replaceable></option></term>
<listitem>
<para>Select an option profile.
<replaceable>name</replaceable> corresponds to a section in
<filename>/etc/apt/listchanges.conf</filename>. The default
when invoked from apt is "apt", and "cmdline" otherwise.
</para>
</listitem>
</varlistentry>
</VARIABLELIST>
</refsect1>
<refsect1>
<title>ENVIRONMENT</title>
<variablelist>
<varlistentry>
<term>APT_LISTCHANGES_FRONTEND</term>
<listitem><para>Frontend to use</para></listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>BROWSER</term>
<listitem><para>Used by
the browser frontend, should be set to a command expecting a
file: URL for an HTML file to display.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term>/etc/apt/listchanges.conf</term>
<listitem>
<para>Configuration file. Most options have the same names
as command-line options, with hyphens translated to
underscores.</para>
<example>
<title>Example configuration file</title>
<programlisting>
[cmdline]
frontend=pager
[apt]
frontend=xterm-pager
email_address=root
confirm=1
[custom]
frontend=browser
browser=mozilla
</programlisting>
</example>
<para>The above configuration file specifies that in
command-line mode, the default frontend should be "pager".
In apt mode, the xterm-pager frontend is default, a copy
of the changelogs (if any) should be emailed to root, and
apt-listchanges should ask for confirmation. If
apt-listchanges is invoked with --profile=custom, the
browser frontend will be used, and invoke mozilla.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>/var/lib/apt/listchanges.db</term>
<listitem><para>Database used for save-seen</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<PARA>
apt-listchanges was written by Matt Zimmerman
<mdz@debian.org>
</PARA>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>apt.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</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:
-->
|
