minix/man/man1/xargs.1

.\" Copyright (c) 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" John B. Roll Jr. and the Institute of Electrical and Electronics
.\" Engineers, Inc.
.\"
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" 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.
.\"
.\"	@(#)xargs.1	5.5 (Berkeley) 6/27/91
.\"
.TH XARGS 1 "June 27, 1991"
.UC 7
.SH NAME
xargs \- construct argument list(s) and execute utility.
.SH SYNOPSIS
.B xargs
.RB [ \-ft0 ]
.RB [[ \-x ]
.B \-n
.IR number ]
.RB [ \-s
.IR size ]
.RI [ utility
.RI [ argument " ...]]"
.SH DESCRIPTION
The
.B xargs
utility reads space, tab, newline and end-of-file delimited arguments
from the standard input and executes the specified
.I utility
with them as arguments.
.PP
The utility and any arguments specified on the command line are given
to the
.I utility
upon each invocation, followed by some number of the arguments read
from standard input.
The
.I utility
is repeatedly executed until standard input is exhausted.
.PP
Spaces, tabs and newlines may be embedded in arguments using single (`` ' '')
or double (``"'') quotes or backslashes (``\e'').
Single quotes escape all non-single quote characters, excluding newlines,
up to the matching single quote.
Double quotes escape all non-double quote characters, excluding newlines,
up to the matching double quote.
Any single character, including newlines, may be escaped by a backslash.
.PP
The options are as follows:
.TP
.B \-f
Force
.B xargs
to ignore the exit status returned by
.IR utility .
By default,
.B xargs
will exit immediately if
.I utility
exits with a non-zero exit status.
This does not include ignoring
.I utility
exiting due to a signal or without calling
.BR exit (2).
.TP
.BI \-n " number"
Set the maximum number of arguments taken from standard input for each
invocation of the utility.
An invocation of
.I utility
will use less than
.I number
standard input arguments if the number of bytes accumulated (see the
.I \-s
option) exceeds the specified
.I size
or there are fewer than
.I number
arguments remaining for the last invocation of
.IR utility .
The current default value for
.I number
is 5000.
.TP
.BI \-s " size"
Set the maximum number of bytes for the command line length provided to
.IR utility .
The sum of the length of the utility name and the arguments passed to
.I utility
(including NULL terminators) will be less than or equal to this number.
The current default value for
.I size
is ARG_MAX - 2048.
.TP
.B \-t
Echo the command to be executed to standard error immediately before it
is executed.
.TP
.B \-x
Force
.B xargs
to terminate immediately if a command line containing
.I number
arguments will not fit in the specified (or default) command line length.
.TP
.B \-0
Read null-byte terminated pathnames from standard input as may have been
produced by the
.B \-print0
option of
.BR find (1).
This is a Minix specific extension to
.BR xargs .
.PP
If no
.I utility
is specified,
.BR echo (1)
is used.
.PP
Undefined behavior may occur if
.I utility
reads from the standard input.
.PP
.B Xargs
exits with an exit status of 0 if no error occurs.
If
.I utility
cannot be invoked, is terminated by a signal or terminates without
calling
.BR exit (2),
.B xargs
exits with an exit status of 127.
If
.I utility
exits with an exit status other than 0,
.B xargs
exits with that exit status.
Otherwise,
.B xargs
exits with an exit status of 1.
.SH "SEE ALSO"
.BR echo (1),
.BR find (1).
.SH STANDARDS
The
.B xargs
utility is expected to be POSIX 1003.2 compliant.