diff options
Diffstat (limited to 'extension/inplace.3am')
-rw-r--r-- | extension/inplace.3am | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/extension/inplace.3am b/extension/inplace.3am new file mode 100644 index 00000000..5ca04be2 --- /dev/null +++ b/extension/inplace.3am @@ -0,0 +1,92 @@ +.TH INPLACE 3am "Jan 15 2013" "Free Software Foundation" "GNU Awk Extension Modules" +.SH NAME +inplace \- emulate sed/perl/ruby in-place editing +.SH SYNOPSIS +.ft CW +.nf +@load "inplace" + +# Please set INPLACE_SUFFIX to make a backup copy. For example, you may +# want to set INPLACE_SUFFIX to .bak on the command line or in a BEGIN rule. + +BEGINFILE { + inplace_begin(FILENAME, INPLACE_SUFFIX) +} + +ENDFILE { + inplace_end(FILENAME, INPLACE_SUFFIX) +} +.fi +.ft R +.SH DESCRIPTION +The +.I inplace +extension adds two functions named +.B inplace_begin() +and +.BR inplace_end() . +These functions are meant to be invoked from the +.I inplace.awk +wrapper (whose contents are displayed above) +which is installed when +.I gawk +is. +.PP +By default, each named file on the command line is +replaced with a new file of the same name whose contents +are the results of running the AWK program. +If the user supplies an AWK variable named +.B INPLACE_SUFFIX +in a +.B BEGIN +rule or on the command line, then the +.I inplace +extension concatenates that suffix onto the original +filename and uses the result as a filename for renaming +the original. +... .SH NOTES +... .SH BUGS +.SH EXAMPLE +.ft CW +.nf +gawk -i inplace '\f(CIscript\fP' files ... +.br +gawk -i inplace -f \f(CIscriptfile\fP files ... +.fi +.ft R +.SH "SEE ALSO" +.IR "GAWK: Effective AWK Programming" , +.IR filefuncs (3am), +.IR fnmatch (3am), +.IR fork (3am), +.IR ordchr (3am), +.IR readdir (3am), +.IR readfile (3am), +.IR revoutput (3am), +.IR rwarray (3am). +.SH AUTHOR +Andrew Schorr, +.BR schorr@telemetry-investments.com . +.SH COPYING PERMISSIONS +Copyright \(co 2012, 2013, +Free Software Foundation, Inc. +.PP +Permission is granted to make and distribute verbatim copies of +this manual page provided the copyright notice and this permission +notice are preserved on all copies. +.ig +Permission is granted to process this file through troff and print the +results, provided the printed document carries copying permission +notice identical to this one except for the removal of this paragraph +(this paragraph not being relevant to the printed manual page). +.. +.PP +Permission is granted to copy and distribute modified versions of this +manual page under the conditions for verbatim copying, provided that +the entire resulting derived work is distributed under the terms of a +permission notice identical to this one. +.PP +Permission is granted to copy and distribute translations of this +manual page into another language, under the above conditions for +modified versions, except that this permission notice may be stated in +a translation approved by the Foundation. |