Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

inplace (3)

Name

inplace - place editing

Synopsis

gawk -i inplace ...

Description

INPLACE(3)                 GNU Awk Extension Modules                INPLACE(3)



NAME
       inplace - emulate sed/perl/ruby in-place editing

SYNOPSIS
       gawk -i inplace ...

DESCRIPTION
       The  inplace  extension  adds  two  functions named inplace_begin() and
       inplace_end().  These functions  are  meant  to  be  invoked  from  the
       inplace.awk wrapper which is installed when gawk is.

       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 inplace::suffix in
       a BEGIN rule or on the command line, then the  inplace  extension  con-
       catenates that suffix onto the original filename and uses the result as
       a filename for renaming the original.

       For backwards compatibility, the variable will also check  INPLACE_SUF-
       FIX  (in the awk namespace) for the suffix to use if inplace::suffix is
       not set.

       One   can   disable   inplace   editing    selectively    by    placing
       inplace::enable=0  on  the  command  line prior to files that should be
       processed normally.   One  can  reenable  inplace  editing  by  placing
       inplace::enable=1  prior  to  files  that  should be subject to inplace
       editing.

BUGS
       While the extension does attempt to preserve ownership and permissions,
       it makes no attempt to copy the ACLs from the original file.

       If the program dies prematurely, as might happen if an unhandled signal
       is received, a temporary file may be left behind.

EXAMPLE
       gawk -i inplace 'script' files ...
       gawk -i inplace -f scriptfile files ...


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | text/gawk        |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+

SEE ALSO
       GAWK: Effective AWK  Programming,  filefuncs(3),  fnmatch(3),  fork(3),
       ordchr(3), readdir(3), readfile(3), revoutput(3), rwarray(3).

AUTHOR
       Andrew Schorr, schorr@telemetry-investments.com.

COPYING PERMISSIONS
       Copyright  (C)  2012, 2013, 2015, 2018, 2019, Free Software Foundation,
       Inc.

       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.

       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.

       Permission  is granted to copy and distribute translations of this man-
       ual page into another language, under the above conditions for modified
       versions,  except that this permission notice may be stated in a trans-
       lation approved by the Foundation.



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source                was                downloaded                from
       https://ftp.gnu.org/gnu/gawk/gawk-5.1.1.tar.xz.

       Further information about this software can be found on the open source
       community website at https://www.gnu.org/software/gawk.



Free Software Foundation          Jun 26 2018                       INPLACE(3)