summaryrefslogtreecommitdiff
path: root/Doc/lib/libtarfile.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/lib/libtarfile.tex')
-rw-r--r--Doc/lib/libtarfile.tex8
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/lib/libtarfile.tex b/Doc/lib/libtarfile.tex
index 5f277dafef..96f835f539 100644
--- a/Doc/lib/libtarfile.tex
+++ b/Doc/lib/libtarfile.tex
@@ -36,7 +36,8 @@ Some facts and figures:
\lineii{'r:'}{Open for reading exclusively without compression.}
\lineii{'r:gz'}{Open for reading with gzip compression.}
\lineii{'r:bz2'}{Open for reading with bzip2 compression.}
- \lineii{'a' or 'a:'}{Open for appending with no compression.}
+ \lineii{'a' or 'a:'}{Open for appending with no compression. The file
+ is created if it does not exist.}
\lineii{'w' or 'w:'}{Open for uncompressed writing.}
\lineii{'w:gz'}{Open for gzip compressed writing.}
\lineii{'w:bz2'}{Open for bzip2 compressed writing.}
@@ -48,8 +49,8 @@ Some facts and figures:
avoid this. If a compression method is not supported,
\exception{CompressionError} is raised.
- If \var{fileobj} is specified, it is used as an alternative to
- a file object opened for \var{name}.
+ If \var{fileobj} is specified, it is used as an alternative to a file
+ object opened for \var{name}. It is supposed to be at position 0.
For special purposes, there is a second format for \var{mode}:
\code{'filemode|[compression]'}. \function{open()} will return a
@@ -160,6 +161,7 @@ tar archive several times. Each archive member is represented by a
If \var{fileobj} is given, it is used for reading or writing data.
If it can be determined, \var{mode} is overridden by \var{fileobj}'s mode.
+ \var{fileobj} will be used from position 0.
\begin{notice}
\var{fileobj} is not closed, when \class{TarFile} is closed.
\end{notice}