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 wrapper shell script 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 by the exception handlers of the Bacula
  22 daemons during a crash.  It can also be called interactively to view
  23 the current state of the threads belonging to a process, but this is
  24 not recommended unless you are trying to debug a problem (see below).
  25
  26 .SH NOTES
  27 In order to work properly, debugging symbols must be available to the
  28 debugger on the system, and gdb, or dbx (on Solaris systems) must be
  29 available in the \fB$PATH\fR.
  30
  31 If the Director or Storage daemon runs under a non-root uid, you will
  32 probably need to be modify the \fBbtraceback\fR script to elevate
  33 privileges for the call to \fBgdb\fR/\fBdbx\fR, to ensure it has the proper
  34 permissions to debug when called by the daemon.
  35
  36 Although Bacula's use of \fBbtraceback\fR within its exception handlers is
  37 always safe, manual or interactive use of \fBbtraceback\fR is subject to the
  38 same risks than live debugging of any program, which means it could cause
  39 Bacula to crash under rare and abnormal circumstances.  Consequently we
  40 do not recommend manual use of \fBbtraceback\fR in production environments
  41 unless it is required for debugging a problem.
  42
  43 .SH ENVIRONMENT
  44 \fBbtracback\fR relies on \fB$PATH\fR to find the debugger.
  45
  46 .SH FILES
  47 .TP
  48 .I /usr/lib/bacula/btraceback
  49 .RS
  50 The script itself.
  51 .RE
  52 .TP
  53 .I /usr/sbin/btraceback
  54 .RS
  55 symbolic link to \fI/usr/lib/bacula/btraceback\fR
  56 .RE
  57 .TP
  58 .I /etc/bacula/scripts/btraceback.gdb
  59 .RS
  60 the GDB command batch used to output a stack trace
  61 .RE
  62
  63 .SH AUTHOR
  64 This manual page was written by Lucas B. Cohen
  65 .nh
  66 <lbc@members.fsf.org>
  67 .SH SEE ALSO
  68 .BR "bsmtp" "(1) "
  69 This man page document is released under the BSD 2-Clause license.