← Back to branch summary

~ubuntu-branches/ubuntu/trusty/erlang/trusty

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Clint Byrum
  • Date: 2011-05-05 15:48:43 UTC
  • mfrom: (3.5.13 sid)
  • Revision ID: james.westby@ubuntu.com-20110505154843-0om6ekzg6m7ugj27
Tags: 1:14.b.2-dfsg-3ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Drop libwxgtk2.8-dev build dependency. Wx isn't in main, and not
    supposed to.
  - Drop erlang-wx binary.
  - Drop erlang-wx dependency from -megaco, -common-test, and -reltool, they
    do not really need wx. Also drop it from -debugger; the GUI needs wx,
    but it apparently has CLI bits as well, and is also needed by -megaco,
    so let's keep the package for now.
  - debian/patches/series: Do what I meant, and enable build-options.patch
    instead.
* Additional changes:
  - Drop erlang-wx from -et
* Dropped Changes:
  - patches/pcre-crash.patch: CVE-2008-2371: outer level option with
    alternatives caused crash. (Applied Upstream)
  - fix for ssl certificate verification in newSSL: 
    ssl_cacertfile_fix.patch (Applied Upstream)
  - debian/patches/series: Enable native.patch again, to get stripped beam
    files and reduce the package size again. (build-options is what
    actually accomplished this)
  - Remove build-options.patch on advice from upstream and because it caused
    odd build failures.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/sasl/doc/src/rb.xml
4
4
<erlref>
5
5
  <header>
6
6
    <copyright>
7
 
      <year>1996</year>
8
 
      <year>2007</year>
9
 
      <holder>Ericsson AB, All Rights Reserved</holder>
 
7
      <year>1996</year><year>2010</year>
 
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
10
9
    </copyright>
11
10
    <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.
 
11
      The contents of this file are subject to the Erlang Public License,
 
12
      Version 1.1, (the "License"); you may not use this file except in
 
13
      compliance with the License. You should have received a copy of the
 
14
      Erlang Public License along with this software. If not, it can be
 
15
      retrieved online at http://www.erlang.org/.
 
16
 
 
17
      Software distributed under the License is distributed on an "AS IS"
 
18
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
19
      the License for the specific language governing rights and limitations
 
20
      under the License.
 
21
 
24
22
    </legalnotice>
25
23
 
26
24
    <title>rb</title>
43
41
  </description>
44
42
  <funcs>
45
43
    <func>
 
44
      <name>filter(Filters)</name>
 
45
      <name>filter(Filters, Dates)</name>
 
46
      <fsummary>Filter reports and displays them on the screen</fsummary>
 
47
      <type>
 
48
        <v>Filters = [filter()]</v>
 
49
        <v>filter() = {Key, Value} | {Key, Value, no} | {Key, RegExp, re} | {Key, RegExp, re, no}</v>
 
50
        <v>Key = term()</v>
 
51
        <v>Value = term()</v>
 
52
        <v>RegExp = string() | {string, Options} | mp(), {mp(), Options}</v>
 
53
        <v>Dates = {DateFrom, DateTo} | {DateFrom, from} | {DateTo, to}</v>
 
54
        <v>DateFrom = DateTo = {date(), time()}</v>
 
55
        <v>date() and time() are the same type as in the <c>calendar</c> module</v>
 
56
      </type>
 
57
      <desc>
 
58
        <p>This function displays the reports that match the provided filters.</p>
 
59
        <p>
 
60
          When a filter includes the <c>no</c> atom it will exclude the reports that match
 
61
          that filter.
 
62
        </p>
 
63
        <p>
 
64
          The reports are matched using the <c>proplists</c> module. The report must be a proplist
 
65
          to be matched against any of the <c>filters()</c>.
 
66
        </p>
 
67
        <p>
 
68
          If the filter is of the form <c>{Key, RegExp, re}</c> the report must contain an element with
 
69
          <c>key = Key</c> and <c>Value</c> must match the RegExp regular expression.
 
70
        </p>
 
71
        <p>
 
72
          If the Dates parameter is provided, then the reports are filtered according to the date
 
73
          when they occurred. If Dates is of the form <c>{DateFrom, from}</c> then reports that occurred
 
74
          after DateFrom are displayed.
 
75
        </p>
 
76
        <p>
 
77
          If Dates is of the form <c>{DateTo, to}</c> then reports that occurred before DateTo
 
78
          are displayed.
 
79
        </p>
 
80
        <p>
 
81
          If two Dates are provided, then reports that occurred between those dates are returned.
 
82
        </p>
 
83
        <p>
 
84
           If you only want to filter only by dates, then you can provide the empty list as the Filters
 
85
           parameter.
 
86
        </p>
 
87
        <p>
 
88
          See <c>rb:grep/1</c> for more information on the RegExp parameter.
 
89
        </p>
 
90
      </desc>
 
91
    </func>
 
92
    <func>
46
93
      <name>grep(RegExp)</name>
47
94
      <fsummary>Search the reports for a regular expression</fsummary>
48
95
      <type>
49
 
        <v>RegExp = string()</v>
 
96
        <v>RegExp = string() | {string, Options} | mp(), {mp(), Options}</v>
50
97
      </type>
51
98
      <desc>
52
99
        <p>All reports containing the regular expression <c>RegExp</c>
53
100
          are printed.
54
101
          </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>.
 
102
        <p><c>RegExp</c> can be a string containing the regular
 
103
          expression; a tuple with the string and the options for
 
104
          compilation; a compiled regular expression; a compiled
 
105
          regular expression and the options for running it.
 
106
          Refer to the module <c>re</c> and specially the function <c>re:run/3</c>
 
107
          for a definition of valid regular expressions and options.
60
108
          </p>
61
109
      </desc>
62
110
    </func>