← Back to branch summary

~ubuntu-branches/debian/squeeze/erlang/squeeze

« back to all changes in this revision

Viewing changes to lib/toolbar/doc/src/toolbar.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-05-07 15:07:37 UTC
  • mfrom: (1.2.1 upstream) (5.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20090507150737-i4yb5elwinm7r0hc
Tags: 1:13.b-dfsg1-1
http://bugs.debian.org/527053
http://bugs.debian.org/526682
http://bugs.debian.org/526627
* Removed another bunch of non-free RFCs from original tarball
  (closes: #527053).
* Fixed build-dependencies list by adding missing comma. This requires
  libsctp-dev again. Also, added libsctp1 dependency to erlang-base and
  erlang-base-hipe packages because the shared library is loaded via
  dlopen now and cannot be added using dh_slibdeps (closes: #526682).
* Weakened dependency of erlang-webtool on erlang-observer to recommends
  to avoid circular dependencies (closes: #526627).
* Added solaris-i386 to HiPE enabled architectures.
* Made script sources in /usr/lib/erlang/erts-*/bin directory executable,
  which is more convenient if a user wants to create a target Erlang system.
* Shortened extended description line for erlang-dev package to make it
  fit 80x25 terminals.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/toolbar/doc/src/toolbar.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>toolbar</title>
 
27
    <prepared>Gunilla Hugosson</prepared>
 
28
    <docno></docno>
 
29
    <date>1997-04-21</date>
 
30
    <rev>A</rev>
 
31
    <file>toolbar.sgml</file>
 
32
  </header>
 
33
  <module>toolbar</module>
 
34
  <modulesummary>GUI for Starting Tools and User Contributions</modulesummary>
 
35
  <description>
 
36
    <p>Toolbar makes it easier to use
 
37
      the different Erlang tools - and the user contributions - which are provided.
 
38
      It has a graphical user interface with an icon for each tool.
 
39
      Clicking the icon activates the corresponding tool.
 
40
      </p>
 
41
    <p>All tools to be included on Toolbar must
 
42
      have a configuration file containing information about the tool,
 
43
      for example its start function and help information location.
 
44
      Configuration files must have the <c>.tool</c> suffix.
 
45
      </p>
 
46
    <p>When started, Toolbar automatically checks for <c>*.tool</c>
 
47
      files in the current path and adds the corresponding tools. For
 
48
      each <c>ebin</c> directory found in the path, it will also look
 
49
      in a <c>priv</c> directory next to it. This is a feature of the Erlang
 
50
      file structure.</p>
 
51
  </description>
 
52
  <funcs>
 
53
    <func>
 
54
      <name>start() -> ok | already_started</name>
 
55
      <fsummary>Start Toolbar</fsummary>
 
56
      <desc>
 
57
        <p>Creates a window containing tool icons.</p>
 
58
      </desc>
 
59
    </func>
 
60
    <func>
 
61
      <name>version() -> string()</name>
 
62
      <fsummary>Return current version number</fsummary>
 
63
      <desc>
 
64
        <p>Returns the current version number of Toolbar.</p>
 
65
      </desc>
 
66
    </func>
 
67
    <func>
 
68
      <name>update() -> ok | {error,not_started}</name>
 
69
      <fsummary>Update Toolbar</fsummary>
 
70
      <desc>
 
71
        <p>Makes a search for new tool files in the current path and
 
72
          adds the corresponding tools to Toolbar window.</p>
 
73
      </desc>
 
74
    </func>
 
75
    <func>
 
76
      <name>quit() -> ok | {error,not_started}</name>
 
77
      <fsummary>Quit Toolbar.</fsummary>
 
78
    </func>
 
79
    <func>
 
80
      <name>create_tool_file() -> ok | {error,not_started}</name>
 
81
      <fsummary>Create tool files</fsummary>
 
82
      <desc>
 
83
        <p>Starts the GUI used for creating and editing tool files.</p>
 
84
      </desc>
 
85
    </func>
 
86
    <func>
 
87
      <name>add_gs_contribs() -> ok | {error,not_started}</name>
 
88
      <fsummary>Add GS contributions</fsummary>
 
89
      <desc>
 
90
        <p>Adds the path to the directory where the GS contributions are
 
91
          situated and add the tools found there, if any.</p>
 
92
      </desc>
 
93
    </func>
 
94
  </funcs>
 
95
</erlref>
 
96