man/man8/raddebug.8

   1 .TH RADDEBUG 8 "1 September 2010" "" "FreeRADIUS Daemon"
   2 .SH NAME
   3 raddebug - Display debugging output from a running server.
   4 .SH SYNOPSIS
   5 .B raddebug
   6 .RB [ \-c
   7 .IR condition ]
   8 .RB [ \-d
   9 .IR config_directory ]
  10 .RB [ \-i
  11 .IR ipv4-address ]
  12 .RB [ \-I
  13 .IR ipv6-address ]
  14 .RB [ \-f
  15 .IR socket_file ]
  16 .RB [ \-t
  17 .IR timeout ]
  18 .RB [ \-u
  19 .IR user-name ]
  20 .SH DESCRIPTION
  21 \fBraddebug\fP is a shell script wrapper around \fBradmin\fP that
  22 automates the process of obtaining debugging output from a running
  23 server.  It does this without impacting service availability, unlike
  24 using \fBradiusd -X\fP.  There are a number of prerequisites that are
  25 required for its proper operation:
  26 .PP
  27 .in +0.3i
  28 * \fBradmin\fP must be available in the PATH.
  29 .br
  30 * The user running \fBraddebug\fP must have permission to connect to
  31   the server control socket.
  32 .br
  33 * The control socket must be configured.  For instructions, see
  34   raddb/sites-available/control-socket
  35 .br
  36 * The control socket must be marked as "mode = rw".
  37 .br
  38 * The user running \fBraddebug\fP must have permission to read and
  39   write files in the "logdir" directory.  This is usually
  40   /var/log/radiusd.
  41 .in -0.3i
  42 .PP
  43 For a number of reasons, the debugging output is placed in an
  44 intermediate file, rather than being sent directly to standard output.
  45 In order to prevent this file from growing too large, the
  46 \fBraddebug\fP program is automatically terminated after 10 seconds.
  47 This timeout can be changed via the "-t" parameter.
  48 .PP
  49 When the script exits, debug mode in the server is disabled, and the
  50 intermediate file is deleted.
  51 .PP
  52 Debug output from a live server can be redirected to only one
  53 location.  If a second instance of \fIraddebug\fP is started while the
  54 first one is still running, the later one will over-ride the first
  55 one, and the first will stop producing output.
  56 .SH OPTIONS
  57
  58 .IP \-c\ \fIcondition\fP
  59 Set a specific debug condition.  The format of the condition is as
  60 specified in the CONDITIONS section of the \fIunlang\fP manual page.
  61 .IP \-f\ \fIsocket_file\fP
  62 The path to the control socket.  See the \fIradmin\fP manual page for
  63 more description of this option.
  64 .IP \-i\ \fIipv4-address\fP
  65 Show debug output for the client having the given IPv4 address.  This
  66 option is equivalent to using:
  67 .br
  68 .in +0.3i
  69 -c '(Packet-Src-IP-Address == ipv4-address)'
  70 .in -0.3i
  71 .IP "\-d \fIconfig directory\fP"
  72 The radius configuration directory, usually /etc/raddb.  See the
  73 \fIradmin\fP manual page for more description of this option.
  74 .IP \-I\ \fIipv6-address\fP
  75 Show debug output for the client having the given IPv6 address.  This
  76 option is equivalent to using:
  77 .br
  78 .in +0.3i
  79 -c '(Packet-Src-IPv6-Address == ipv6-address)'
  80 .in -0.3i
  81 .IP \-t\ \fItimeout\fP
  82 Stop printing debug output after "timeout" seconds.  The default
  83 timeout is sixty (60) seconds.  Use "-t 0" to print debugging output forever,
  84 or until the script exits.
  85 .IP \-u\ \fIname\fP
  86 Show debug output for users having the given name.  This
  87 option is equivalent to using:
  88 .br
  89 .in +0.3i
  90 -c '(User-Name == name)'
  91 .in -0.3i
  92
  93 .SH SEE ALSO
  94 radmin(8),  raddb/sites-available/control-socket, unlang(5), radiusd.conf(5)
  95 .SH AUTHORS
  96 Alan DeKok <aland@freeradius.org>