sponge.docbook

   1 <?xml version="1.0" encoding="utf-8"?>
   2
   3 <!--
   4
   5 Copyright ©    2006    Joey Hess
   6
   7 This program is free software; you can redistribute it and/or
   8 modify it under the terms of the GNU General Public License
   9 version 2 as published by the Free Software Foundation.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.    See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19 USA
  20
  21 -->
  22
  23 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
  24 "file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd"
  25 []>
  26
  27 <refentry>
  28
  29         <refentryinfo>
  30                 <author>
  31                         <firstname>Joey</firstname>
  32                         <surname>Hess</surname>
  33                 </author>
  34                 <date>2006-02-19</date>
  35         </refentryinfo>
  36
  37         <refmeta>
  38                 <refentrytitle>sponge</refentrytitle>
  39                 <manvolnum>1</manvolnum>
  40         </refmeta>
  41
  42         <refnamediv>
  43                 <refname>sponge</refname>
  44                 <refpurpose>soak up standard input and write to a file</refpurpose>
  45         </refnamediv>
  46
  47         <refsynopsisdiv>
  48                 <cmdsynopsis>
  49                         <command>sed '...' file | grep '...' | sponge file</command>
  50                 </cmdsynopsis>
  51         </refsynopsisdiv>
  52
  53         <refsect1>
  54                 <title>DESCRIPTION</title>
  55
  56                 <para><command>sponge</command> reads standard input and
  57                         writes it out to the specified file. Unlike a shell
  58                         redirect, sponge soaks up all its input before
  59                         opening the output file. This allows constricting
  60                         pipelines that read from and write to
  61                         the same file. </para>
  62                 <para>If no output file is specified, sponge outputs to
  63                         stdout.</para>
  64
  65         </refsect1>
  66 </refentry>