From 1ef24e1b307bab335ba7794915aefc6b92577958 Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Wed, 9 May 2001 03:24:55 +0000 Subject: Note that when inplace=1 existing backup files will be removed silently. Closes SF bug #420230. --- Doc/lib/libfileinput.tex | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/Doc/lib/libfileinput.tex b/Doc/lib/libfileinput.tex index 97caaf9..c66501f 100644 --- a/Doc/lib/libfileinput.tex +++ b/Doc/lib/libfileinput.tex @@ -47,7 +47,9 @@ The following function is the primary interface of this module: inplace\optional{, backup}}}} Create an instance of the \class{FileInput} class. The instance will be used as global state for the functions of this module, and - is also returned to use during iteration. + is also returned to use during iteration. The parameters to this + function will be passed along to the constructor of the + \class{FileInput} class. \end{funcdesc} @@ -118,7 +120,8 @@ module is available for subclassing as well: \strong{Optional in-place filtering:} if the keyword argument \code{\var{inplace}=1} is passed to \function{input()} or to the \class{FileInput} constructor, the file is moved to a backup file and -standard output is directed to the input file. +standard output is directed to the input file (if a file of the same +name as the backup file already exists, it will be replaced silently). This makes it possible to write a filter that rewrites its input file in place. If the keyword argument \code{\var{backup}='.'} is also given, it specifies the extension for the backup -- cgit v0.12