sbase/xargs.1

64 lines
1.7 KiB
Groff
Raw Normal View History

.Dd January 30, 2015
.Dt XARGS 1
.Os sbase
.Sh NAME
.Nm xargs
2015-02-01 15:28:17 -05:00
.Nd construct argument list(s) and execute command
.Sh SYNOPSIS
.Nm
.Op Fl n Ar maxargs
.Op Fl r
.Op Fl E Ar eofstr
.Op Ar cmd Op Ar arg...
.Sh DESCRIPTION
2015-02-01 14:52:28 -05:00
.Nm
reads space, tab, newline and EOF delimited strings from stdin
and executes the specified
.Ar cmd
with the strings as
.Ar arguments .
.Pp
2014-01-03 06:52:47 -05:00
Any arguments specified on the command line are given to the command upon
each invocation, followed by some number of the arguments read from
2015-02-01 14:52:28 -05:00
stdin. The command is repeatedly executed one or more times until stdin
2014-01-03 06:52:47 -05:00
is exhausted.
.Pp
2014-01-03 06:52:47 -05:00
Spaces, tabs and newlines may be embedded in arguments using single (`'')
2015-02-06 09:43:46 -05:00
or double (`"') quotes or backslashes ('\\'). Single quotes escape all
2014-01-03 06:52:47 -05:00
non-single quote characters, excluding newlines, up to the matching single
2015-02-06 09:43:46 -05:00
quote. Double quotes escape all non-double quote characters, excluding
newlines, up to the matching double quote. Any single character, including
2014-01-03 06:52:47 -05:00
newlines, may be escaped by a backslash.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl n Ar maxargs
2015-02-01 14:52:28 -05:00
Use at most
.Ar maxargs
arguments per command line.
.It Fl r
2015-02-06 09:43:46 -05:00
Do not run the command if there are no arguments. Normally the command is
2014-01-03 06:52:47 -05:00
executed at least once even if there are no arguments.
.It Fl E Ar eofstr
2015-02-01 14:52:28 -05:00
Use
.Ar eofstr
as a logical EOF marker.
.El
.Sh EXIT STATUS
xargs exits with one of the following values:
.Bl -tag -width Ds
.It 0
All invocations of command returned a zero exit status.
.It 123
One or more invocations of command returned a nonzero exit status.
.It 124
The command exited with a 255 exit status.
.It 125
The command was killed or stopped by a signal.
.It 126
The command was found but could not be executed.
.It 127
The command could not be found.
.It 1
Some other error occurred.
.El