~package-import/ubuntu/natty/apport/defunct

1369.1.32 by Martin Pitt
add README file
1
Apport crash detection/reporting
2
================================
3
4
Apport intercepts Program crashes, collects debugging information about the
5
crash and the operating system environment, and sends it to bug trackers in a
6
standardized form. It also offers the user to report a bug about a package,
7
with again collecting as much information about it as possible.
8
9
It currently supports
10
11
 - Crashes from standard signals (SIGSEGV, SIGILL, etc.) through the kernel
12
   coredump handler (in piping mode)
13
 - Unhandled Python exceptions
14
 - GTK, KDE, and command line user interfaces
15
 - Packages can ship hooks for collecting speficic data (such as
16
   /var/log/Xorg.0.log for X.org, or modified gconf settings for GNOME
17
   programs)
18
 - apt/dpkg and rpm backend (in production use in Ubuntu and OpenSUSE)
19
 - Reprocessing a core dump and debug symbols for post-mortem (and preferably
20
   server-side) generation of fully symbolic stack traces (apport-retrace)
21
 - Reporting bugs to Launchpad (more backends can be easily added)
22
1369.1.34 by Martin Pitt
README: link to homepage and point to doc/
23
Please see https://wiki.ubuntu.com/Apport for more details and further links.
24
The files in doc/ document particular details such as package hooks, crash
25
database configuration, or the internal data format.
26
1369.1.32 by Martin Pitt
add README file
27
Temporarily enabling apport
28
===========================
29
30
The automatic crash interception component of apport is disabled by default in
31
stable releases for a number of reasons [1].  To enable it just for the current
32
session, do
33
34
  sudo force_start=1 /etc/init.d/apport restart
35
36
Then you can simply trigger the crash again, and Apport's dialog will show up
37
with instructions to report a bug with traces. Apport will be automatically
38
disabled on next start.
39
40
If you are triaging bugs, this is the best way to get traces from bug reporters
41
that didn't use Apport in the first place.
42
43
To enable it permanently, do:
44
45
  sudo nano /etc/default/apport
46
47
and change enabled from "0" to "1".
48
49
[1] https://wiki.ubuntu.com/Apport#How%20to%20enable%20apport
50
51
Crash notification on servers
52
=============================
53
54
You can add
55
56
if [ -x /usr/bin/apport-cli ]; then 
57
    if groups | grep -qw admin && /usr/share/apport/apport-checkreports -s; then
58
	cat <<-EOF
59
	You have new problem reports waiting in /var/crash. 
60
	To take a look at them, run "sudo apport-cli".
61
62
	EOF
63
    elif /usr/share/apport/apport-checkreports; then
64
	cat <<-EOF
65
	You have new problem reports waiting in /var/crash. 
66
	To take a look at them, run "apport-cli".
67
68
	EOF
69
    fi
70
fi
71
72
to your ~/.bashrc to get automatic notification of problem reports.
73
74
Contributing
75
============
76
77
Please visit Apport's Launchpad homepage for links to the source code revision
78
control, the bug tracker, translations, downloads, etc.:
79
80
  https://launchpad.net/apport
81
82
The preferred mode of operation for Linux distribution packagers is to create
83
their own branch from 'trunk' and add the distro specific packaging and patches
84
to it. Please send patches which are applicable to trunk as merge requests or
85
bug reports, so that (1) other distributions can benefit from them as well, and
86
(2) you reduce the code delta to upstream.
87