git.sur5r.net Git - bacula/bacula/blob - bacula/manpages/btraceback.8

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH BTRACEBACK 1 "6 December 2009" "Kern Sibbald" "Network backup, recovery and verification"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .SH NAME
   9  btraceback \- wrapper script around gdb and bsmtp
  10
  11 .SH SYNOPSIS
  12 .B btraceback
  13 .I /path/to/binary
  14 .I pid
  15
  16 .SH DESCRIPTION
  17 \fBbtraceback\fR is a simple wrapper shellscript around the \fBgdb\fR debugger
  18 (or \fBdbx\fR on Solaris systems) and \fBbsmtp\fR, provided for debugging purposes.
  19
  20 .SH USAGE
  21 \fBbtraceback\fR is called solely by the exception handlers of the Bacula daemons upon
  22 an imminent crash. It can also be called interactively to view the
  23 current state of the threads belonging to a process.
  24
  25 .SH NOTES
  26 In order to work properly, debugging symbols must be available to the
  27 debugger on the system, and gdb, or dbx (on Solaris systems) must be
  28 available in the \fB$PATH\fR.
  29
  30 If the Director or Storage daemon runs under a non-root uid, it will
  31 most likely be needed to modify the \fBbtraceback\fR script to elevate
  32 privileges for the call to \fBgdb\fR/\fBdbx\fR, to ensure it has the proper
  33 permissions to debug.
  34
  35 Interactive use of \fBbtraceback\fR is subject to the same risks than live
  36 debugging of any program, which means it could cause Bacula to crash under
  37 rare and abnormal circumstances. Interactive use is not recommended in
  38 production environments.
  39
  40 .SH ENVIRONMENT
  41 \fBbtracback\fR relies on \fB$PATH\fR to find the debugger.
  42
  43 .SH FILES
  44 .TP
  45 .I /usr/lib/bacula/btraceback
  46 .RS
  47 The script itself.
  48 .RE
  49 .TP
  50 .I /usr/sbin/btraceback
  51 .RS
  52 symbolic link to \fI/usr/lib/bacula/btraceback\fR
  53 .RE
  54 .TP
  55 .I /etc/bacula/scripts/btraceback.gdb
  56 .RS
  57 the GDB command batch used to output a stack trace
  58 .RE
  59
  60 .SH AUTHOR
  61 This manual page was written by Lucas B. Cohen
  62 .nh
  63 <lbc@members.fsf.org>
  64 .SH SEE ALSO
  65 .BR "bsmtp" "(1) "
  66