774b81116a88a0695a424d4121485577d5944ddb
[openafs.git] / src / man / fs_debug.1
1 fs debug                   AFS Commands                fs debug
2
3
4 NAME
5
6    fs debug -- enable/disable Cache Manager debugging trace.
7
8
9    fs debug  -debug <'on' or 'off'>  [-dafs <afs debug level>]
10            [-dnet <network debug level>]  [-syslog]  [-help]
11
12 ACCEPTABLE ABBREVIATIONS/ALIASES
13
14    fs de  -de <on> or <off>  [-da <afs debug level>]
15    [-dn <network debug level>]  [-s]  [-h]
16
17 DESCRIPTION
18
19    Determines  whether  the  Cache  Manager records information
20    about its activities that may prove helpful in debugging  or
21    other  trouble-shooting.    The  output  goes  into the file
22    /usr/vice/etc/AFSLog (unless an alternate directory or  name
23    is  specified  for  the file with the -logfile switch of the
24    afsd command).  See the ARGUMENTS  section  for  information
25    about  the  different  types of debugging output that can be
26    written to the file.
27
28    You can use the more command (or an equivalent command  such
29    as  the  pg  command  on  AIX systems) to read the debugging
30    output recorded in the AFSLog file.  You must be  logged  in
31    as  root  on the machine on which the AFSLog file resides to
32    read the file.  Interpreting the output requires familiarity
33    with the AFS source code.
34
35 ARGUMENTS
36
37    -debug
38          controls whether debugging  information  is  produced.
39          The  legal  values  are  on,  which  directs debugging
40          information into the AFSLog file, and off, which stops
41          the recording of information in the file.
42
43    -dafs determines  the  types  of  debugging  information the
44          Cache Manager produces  about  its  activities.    The
45          following  list  describes  the  legal values for this
46          switch and the type of debugging  output  each  causes
47          the Cache Manager to write to the AFSLog file:
48
49             - 1,  which  causes the Cache Manager to write
50               standard debugging information.  Using  this
51               value   provides  a  good  deal  of  general
52               output.
53
54             - 2, which causes the Cache Manager  to  write
55               low-level  debugging  information  about the
56               AFS network.  Use this value only if you are
57               convinced that network problems exist.
58
59             - 4,  which  causes the Cache Manager to write
60               debugging information about the RX protocol.
61
62             - 8, which causes the Cache Manager  to  write
63               debugging  information  about  the interface
64               layer to AFS.  This value is not  useful  on
65
66
67
68               machines running a Sun operating system.
69
70          In  addition,  if  a value of 1, 4, or 8 is specified,
71          the Cache Manager also records in the AFSLog file  the
72          AFS  UID  of  each  user who accesses data from a file
73          server machine.  It records the  appropriate  AFS  UID
74          with each operation that accesses data.
75
76          The  legal  values  can  be added to specify different
77          combinations of output.  For example, a  value  of  15
78          specifies  that all possible types of output are to be
79          provided.  The default value of 1 is used if no  value
80          is specified.
81
82          Note:  The AFSLog file also records the type of volume
83          (ReadWrite, ReadOnly, or Backup) accessed from a  file
84          server  machine.   The type of the volume is displayed
85          along with the volumeID in the "state" flag in  bitmap
86          form.  If a ReadWrite volume is accessed, the bits are
87          clear; if a ReadOnly volume is accessed, the 1 bit  is
88          set; if a Backup volume is accessed, the 4 bit is set.
89
90    -dnet is not currently implemented and should not be used.
91
92    -syslog
93          specifies that debugging output is to be redirected to
94          the  syslogd  daemon.    This flag can be used only on
95          machines running Sun OS 4.1 or higher.
96
97 EXAMPLES
98
99    The following turns on debugging using the default debugging
100    level of 1:
101
102    % fs de on
103
104 PRIVILEGE REQUIRED
105
106    None.
107
108 MORE INFORMATION
109
110    afsd