summaryrefslogtreecommitdiff
path: root/sponge.docbook
blob: ab2c42da784447c724981e3bb2ca6f82dad8796f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<?xml version="1.0" encoding="utf-8"?>

<!--

Copyright ©	2006	Joey Hess

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA

-->

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
"file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd"
[]>

<refentry>

	<refentryinfo>
		<author>
			<firstname>Joey</firstname>
			<surname>Hess</surname>
		</author>
		<date>2006-02-19</date>
	</refentryinfo>

	<refmeta>
		<refentrytitle>sponge</refentrytitle>
		<manvolnum>1</manvolnum>
	</refmeta>

	<refnamediv>
		<refname>sponge</refname>
		<refpurpose>soak up standard input and write to a file</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>sed '...' file | grep '...' | sponge file</command>
		</cmdsynopsis>
	</refsynopsisdiv>

	<refsect1>
		<title>DESCRIPTION</title>
		
		<para><command>sponge</command> reads standard input and
			writes it out to the specified file. Unlike a shell
			redirect, sponge soaks up all its input before
			opening the output file. This allows constricting
			pipelines that read from and write to
			the same file. It also creates the output file
	       		atomically by renaming a temp file into place.</para>
		<para>If no output file is specified, sponge outputs to
			stdout.</para>

	</refsect1>
	
	<refsect1>
		<title>AUTHOR</title>
		<para>
			Colin Watson and Tollef Fog Heen
		</para>
	</refsect1>
</refentry>