← Back to branch summary

~rdoering/ubuntu/karmic/erlang/fix-535090

« back to all changes in this revision

Viewing changes to lib/sasl/doc/src/rb.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-02-15 16:42:52 UTC
  • mfrom: (3.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090215164252-q5x4rcf8a5pbesb1
Tags: 1:12.b.5-dfsg-2
Upload to unstable after lenny is released.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/sasl/doc/src/rb.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
 
3
 
 
4
<erlref>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>1996</year>
 
8
      <year>2007</year>
 
9
      <holder>Ericsson AB, All Rights Reserved</holder>
 
10
    </copyright>
 
11
    <legalnotice>
 
12
  The contents of this file are subject to the Erlang Public License,
 
13
  Version 1.1, (the "License"); you may not use this file except in
 
14
  compliance with the License. You should have received a copy of the
 
15
  Erlang Public License along with this software. If not, it can be
 
16
  retrieved online at http://www.erlang.org/.
 
17
 
 
18
  Software distributed under the License is distributed on an "AS IS"
 
19
  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
20
  the License for the specific language governing rights and limitations
 
21
  under the License.
 
22
 
 
23
  The Initial Developer of the Original Code is Ericsson AB.
 
24
    </legalnotice>
 
25
 
 
26
    <title>rb</title>
 
27
    <prepared>Martin Bj&ouml;rklund</prepared>
 
28
    <responsible>Martin Bj&ouml;rklund</responsible>
 
29
    <docno></docno>
 
30
    <approved>Bjarne D&auml;cker</approved>
 
31
    <checked></checked>
 
32
    <date>1996-10-16</date>
 
33
    <rev>A</rev>
 
34
    <file>rb.sgml</file>
 
35
  </header>
 
36
  <module>rb</module>
 
37
  <modulesummary>The Report Browser Tool</modulesummary>
 
38
  <description>
 
39
    <p>The Report Browser (RB) tool makes it possible to browse and
 
40
      format error reports written by the error logger handler
 
41
      <c>log_mf_h</c>.
 
42
      </p>
 
43
  </description>
 
44
  <funcs>
 
45
    <func>
 
46
      <name>grep(RegExp)</name>
 
47
      <fsummary>Search the reports for a regular expression</fsummary>
 
48
      <type>
 
49
        <v>RegExp = string()</v>
 
50
      </type>
 
51
      <desc>
 
52
        <p>All reports containing the regular expression <c>RegExp</c>
 
53
          are printed.
 
54
          </p>
 
55
        <p><c>RegExp</c> is a string containing the regular
 
56
          expression. Refer to the module <c>regexp</c> in the STDLIB 
 
57
          reference  manual
 
58
          for a definition of valid regular expressions. They are
 
59
          essentially the same as the UNIX command <c>egrep</c>.
 
60
          </p>
 
61
      </desc>
 
62
    </func>
 
63
    <func>
 
64
      <name>h()</name>
 
65
      <name>help()</name>
 
66
      <fsummary>Print help information</fsummary>
 
67
      <desc>
 
68
        <p>Prints the on-line help information.
 
69
          </p>
 
70
      </desc>
 
71
    </func>
 
72
    <func>
 
73
      <name>list()</name>
 
74
      <name>list(Type)</name>
 
75
      <fsummary>List all reports</fsummary>
 
76
      <type>
 
77
        <v>Type = type()</v>
 
78
        <v>type() = crash_report | supervisor_report | error | progress</v>
 
79
      </type>
 
80
      <desc>
 
81
        <p>This function lists all reports loaded in the
 
82
          <c>rb_server</c>. Each report is given a unique number that
 
83
          can be used as a reference to the report in the
 
84
          <c>show/1</c> function.
 
85
          </p>
 
86
        <p>If no <c>Type</c> is given, all reports are listed.
 
87
          </p>
 
88
      </desc>
 
89
    </func>
 
90
    <func>
 
91
      <name>rescan()</name>
 
92
      <name>rescan(Options)</name>
 
93
      <fsummary>Rescan the report directory</fsummary>
 
94
      <type>
 
95
        <v>Options = [opt()]</v>
 
96
      </type>
 
97
      <desc>
 
98
        <p>Rescans the report directory. <c>Options</c> is the same as
 
99
          for <c>start()</c>.
 
100
          </p>
 
101
      </desc>
 
102
    </func>
 
103
    <func>
 
104
      <name>show()</name>
 
105
      <name>show(Report)</name>
 
106
      <fsummary>Show reports</fsummary>
 
107
      <type>
 
108
        <v>Report = int() | type()</v>
 
109
      </type>
 
110
      <desc>
 
111
        <p>If a type argument is given, all loaded reports of this
 
112
          type are printed. If an integer argument is given, the
 
113
          report with this reference number is printed. If no argument
 
114
          is given, all reports are shown.
 
115
          </p>
 
116
      </desc>
 
117
    </func>
 
118
    <func>
 
119
      <name>start()</name>
 
120
      <name>start(Options)</name>
 
121
      <fsummary>Start the RB server</fsummary>
 
122
      <type>
 
123
        <v>Options = [opt()]</v>
 
124
        <v>opt() = {start_log, FileName} | {max, MaxNoOfReports} | {report_dir, DirString} | {type, ReportType} | {abort_on_error, Bool}</v>
 
125
        <v>FileName = string() | standard_io</v>
 
126
        <v>MaxNoOfReports = int() | all</v>
 
127
        <v>DirString = string()</v>
 
128
        <v>ReportType = type() | [type()] | all</v>
 
129
        <v>Bool = true | false</v>
 
130
      </type>
 
131
      <desc>
 
132
        <p>The function <c>start/1</c> starts the <c>rb_server</c>
 
133
          with the specified options, while <c>start/0</c> starts with
 
134
          default options. The <c>rb_server</c> must be started before
 
135
          reports can be browsed. When the <c>rb_server</c> is
 
136
          started, the files in the specified directory are
 
137
          scanned. The other functions assume that the server has
 
138
          started.
 
139
          </p>
 
140
        <p><c>{start_log, FileName}</c> starts logging to file. All
 
141
          reports will be printed to the named file. The default is
 
142
          <c>standard_io</c>.
 
143
          </p>
 
144
        <p><c>{max, MaxNoOfReports}</c>. Controls how many reports the
 
145
          <c>rb_server</c> should read on start-up. This option is
 
146
          useful as the directory may contain 20.000 reports. If this
 
147
          option is given, the <c>MaxNoOfReports</c> latest reports
 
148
          will be read. The default is 'all'.
 
149
          </p>
 
150
        <p><c>{report_dir, DirString}</c>. Defines the directory where
 
151
          the error log files are located. The default is <c>{sasl, error_logger_mf_dir}</c>.  </p>
 
152
        <p><c>{type, ReportType}</c>. Controls what kind of reports the
 
153
          <c>rb_server</c> should read on start-up.  <c>ReportType</c>
 
154
          is a supported type, 'all', or a list of supported
 
155
          types. The default is 'all'.
 
156
          </p>
 
157
        <p><c>{abort_on_error, Bool}</c>. This option specifies whether
 
158
          or not logging should be aborted if rb encounters an unprintable 
 
159
          report. (You may get a report on incorrect form if the 
 
160
          <c>error_logger</c> function <c>error_msg</c> or 
 
161
          <c>info_msg</c> has been called with an invalid format string).
 
162
          If <c>Bool</c> is <c>true</c>, rb will stop logging (and print an
 
163
          error message to stdout) if it encounters a badly formatted report.
 
164
          If logging to file is enabled, an error message will be appended to
 
165
          the log file as well. 
 
166
          If <c>Bool</c> is <c>false</c> (which is the default value), rb will 
 
167
          print an error message to stdout for every bad report it 
 
168
          encounters, but the logging process is never aborted. All printable 
 
169
          reports will be written. If logging to file is enabled, rb prints 
 
170
          <c>* UNPRINTABLE REPORT *</c> in the log file at the location of an 
 
171
          unprintable report.
 
172
          </p>
 
173
      </desc>
 
174
    </func>
 
175
    <func>
 
176
      <name>start_log(FileName)</name>
 
177
      <fsummary>Redirect all output to <c>FileName</c></fsummary>
 
178
      <type>
 
179
        <v>FileName = string()</v>
 
180
      </type>
 
181
      <desc>
 
182
        <p>Redirects all report output from the RB tool to the
 
183
          specified file.
 
184
          </p>
 
185
      </desc>
 
186
    </func>
 
187
    <func>
 
188
      <name>stop()</name>
 
189
      <fsummary>Stop the RB server</fsummary>
 
190
      <desc>
 
191
        <p>Stops the <c>rb_server</c>.
 
192
          </p>
 
193
      </desc>
 
194
    </func>
 
195
    <func>
 
196
      <name>stop_log()</name>
 
197
      <fsummary>Stop logging to file</fsummary>
 
198
      <desc>
 
199
        <p>Closes the log file. The output from the RB tool will be
 
200
          directed to <c>standard_io</c>.
 
201
          </p>
 
202
      </desc>
 
203
    </func>
 
204
  </funcs>
 
205
</erlref>
 
206