Changeset View
Standalone View
usr.bin/sponge/sponge.1
- This file was added.
Property | Old Value | New Value |
---|---|---|
svn:eol-style | null | native \ No newline at end of property |
svn:keywords | null | FreeBSD=%H \ No newline at end of property |
svn:mime-type | null | text/plain \ No newline at end of property |
.\" Eitan Adler. All rights reserved. | |||||
.\" | |||||
.\" Redistribution and use in source and binary forms, with or without | |||||
.\" modification, are permitted provided that the following conditions | |||||
.\" are met: | |||||
.\" 1. Redistributions of source code must retain the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer. | |||||
.\" 2. Redistributions in binary form must reproduce the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer in the | |||||
.\" documentation and/or other materials provided with the distribution. | |||||
.\" | |||||
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |||||
.\" SUCH DAMAGE. | |||||
.\" | |||||
.\" $FreeBSD$ | |||||
.\" | |||||
.Dd November 01, 2017 | |||||
.Dt SPONGE 1 | |||||
jilles: Convention seems to be not to add the leading zero here. | |||||
.Os | |||||
.Sh NAME | |||||
.Nm sponge | |||||
.Nd buffer stdin and write to stdout | |||||
.Sh SYNOPSIS | |||||
.Nm | |||||
.Op Fl a | |||||
.Ar filename | |||||
.Sh DESCRIPTION | |||||
The | |||||
.Nm | |||||
utility reads standard in until complete, and then opens | |||||
the output file, and then writes to it. | |||||
The following options are available: | |||||
Done Inline ActionsRedundant. utility reads standard in until complete, then opens the output file and writes to it. wblock: Redundant.
```utility reads standard in until complete, then opens
the output file and writes… | |||||
.Bl -tag -width indent | |||||
Done Inline ActionsI would say "useful" instead of "valuable". wblock: I would say "useful" instead of "valuable". | |||||
.It Fl a | |||||
Done Inline ActionsThis makes it useful in pipelines that read a file and then write to it. wblock: ```This makes it useful in pipelines that read a file and then write to it.``` | |||||
Opens | |||||
Done Inline Actionss/The following/These/ wblock: s/The following/These/ | |||||
.Ar filename | |||||
in append mode. | |||||
.El | |||||
Done Inline Actionss/Opens/Open/ wblock: s/Opens/Open/ | |||||
.Sh SEE ALSO | |||||
impUnsubmitted Done Inline ActionsIt might be useful to specify what happens when memory can't be allocated for the entire file. imp: It might be useful to specify what happens when memory can't be allocated for the entire file. | |||||
.Xr builtin 1 , | |||||
.Xr csh 1 , | |||||
.Xr getrusage 2 , | |||||
.Xr tee 1 | |||||
Done Inline Actionss/In the event that/If/ If an attempt to allocate memory fails, wblock: s/In the event that/If/
and this needs a comma and some other stuff. I doubt you are referring… | |||||
.Xr wait 2 | |||||
.Sh EXIT STATUS | |||||
Done Inline ActionsWe should perhaps add a warning that the file will be written even if earlier components of the pipeline failed. jilles: We should perhaps add a warning that the file will be written even if earlier components of the… | |||||
Done Inline ActionsIts the same for all unix commands, but its likely worth adding a reminder here. eadler: Its the same for all unix commands, but its likely worth adding a reminder here. | |||||
Done Inline Actionsmissing space in iswritten jilles: missing space in `iswritten` | |||||
.Ex -std | |||||
Done Inline Actionss/will be/is/ wblock: s/will be/is/ | |||||
Done Inline ActionsSeems like this ought to be in a BUGS section at the end. wblock: Seems like this ought to be in a BUGS section at the end. | |||||
Done Inline Actionsthis isn't a bug. Its statement on how shells work. eadler: this isn't a bug. Its statement on how shells work. | |||||
.Sh HISTORY | |||||
Done Inline Actionss/have// wblock: s/have// | |||||
A | |||||
.Nm | |||||
utility appeared in | |||||
.At v3 . | |||||
Done Inline ActionsThis should use double quotes. Too bad we don't have a macro for air quotes, because that's pretty much what this is. wblock: This should use double quotes. Too bad we don't have a macro for air quotes, because that's… | |||||
Done Inline Actions.Cm sort file | sponge file wblock: ```.Cm sort file | sponge file``` |
Convention seems to be not to add the leading zero here.