← Back to branch summary

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

« back to all changes in this revision

Viewing changes to lib/stdlib/doc/src/erl_tar.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/stdlib/doc/src/erl_tar.xml
4
4
<erlref>
5
5
  <header>
6
6
    <copyright>
7
 
      <year>2003</year>
8
 
      <year>2007</year>
9
 
      <holder>Ericsson AB, All Rights Reserved</holder>
 
7
      <year>2003</year><year>2009</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>erl_tar</title>
331
329
    </func>
332
330
    <func>
333
331
      <name>open(Name, OpenModeList) -> RetValue</name>
334
 
      <fsummary>Open a tar file.</fsummary>
 
332
      <fsummary>Open a tar file for writing.</fsummary>
335
333
      <type>
336
334
        <v>Name = filename()</v>
337
335
        <v>OpenModeList = [OpenMode]</v>
338
 
        <v>Mode = read|write|compressed|cooked</v>
339
 
        <v>RetValue = {ok,TarDescriptor}|{error,{Name,Reason}} &lt;V>TarDescriptor = term()</v>
 
336
        <v>Mode = write|compressed|cooked</v>
 
337
        <v>RetValue = {ok,TarDescriptor}|{error,{Name,Reason}}</v>
 
338
        <v>TarDescriptor = term()</v>
340
339
        <v>Reason = term()</v>
341
340
      </type>
342
341
      <desc>
343
342
        <p>The           <marker id="open"></marker>
344
 
<c>open/2</c> function opens a tar file.</p>
 
343
<c>open/2</c> function creates a tar file for writing.
 
344
        (Any existing file with the same name will be truncated.)</p>
345
345
        <p>By convention, the name of a tar file should end in "<c>.tar</c>".
346
346
          To abide to the convention, you'll need to add "<c>.tar</c>" yourself
347
347
          to the name.</p>
348
 
        <p>Note that there is currently no function for reading
349
 
          from an opened tar file, meaning that opening a tar file for reading is
350
 
          not very useful.</p>
351
 
        <p>Except for <c>read</c> and <c>write</c> (which are mutually
352
 
          exclusive), the following atoms may be added to <c>OpenModeList</c>:
353
 
          </p>
 
348
        <p>Except for the <c>write</c> atom the following atoms
 
349
        may be added to <c>OpenModeList</c>:</p>
354
350
        <taglist>
355
351
          <tag><c>compressed</c></tag>
356
352
          <item>