man/man1/xargs.1

   1 .\" Copyright (c) 1990 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" John B. Roll Jr. and the Institute of Electrical and Electronics
   6 .\" Engineers, Inc.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)xargs.1     5.5 (Berkeley) 6/27/91
  37 .\"
  38 .TH XARGS 1 "June 27, 1991"
  39 .UC 7
  40 .SH NAME
  41 xargs \- construct argument list(s) and execute utility.
  42 .SH SYNOPSIS
  43 .B xargs
  44 .RB [ \-ft0 ]
  45 .RB [[ \-x ]
  46 .B \-n
  47 .IR number ]
  48 .RB [ \-s
  49 .IR size ]
  50 .RI [ utility
  51 .RI [ argument " ...]]"
  52 .SH DESCRIPTION
  53 The
  54 .B xargs
  55 utility reads space, tab, newline and end-of-file delimited arguments
  56 from the standard input and executes the specified
  57 .I utility
  58 with them as arguments.
  59 .PP
  60 The utility and any arguments specified on the command line are given
  61 to the
  62 .I utility
  63 upon each invocation, followed by some number of the arguments read
  64 from standard input.
  65 The
  66 .I utility
  67 is repeatedly executed until standard input is exhausted.
  68 .PP
  69 Spaces, tabs and newlines may be embedded in arguments using single (`` ' '')
  70 or double (``"'') quotes or backslashes (``\e'').
  71 Single quotes escape all non-single quote characters, excluding newlines,
  72 up to the matching single quote.
  73 Double quotes escape all non-double quote characters, excluding newlines,
  74 up to the matching double quote.
  75 Any single character, including newlines, may be escaped by a backslash.
  76 .PP
  77 The options are as follows:
  78 .TP
  79 .BI \-n " number"
  80 Set the maximum number of arguments taken from standard input for each
  81 invocation of the utility.
  82 An invocation of
  83 .I utility
  84 will use less than
  85 .I number
  86 standard input arguments if the number of bytes accumulated (see the
  87 .I \-s
  88 option) exceeds the specified
  89 .I size
  90 or there are fewer than
  91 .I number
  92 arguments remaining for the last invocation of
  93 .IR utility .
  94 The current default value for
  95 .I number
  96 is 5000.
  97 .TP
  98 .BI \-s " size"
  99 Set the maximum number of bytes for the command line length provided to
 100 .IR utility .
 101 The sum of the length of the utility name and the arguments passed to
 102 .I utility
 103 (including NULL terminators) will be less than or equal to this number.
 104 The current default value for
 105 .I size
 106 is ARG_MAX - 2048.
 107 .TP
 108 .B \-t
 109 Echo the command to be executed to standard error immediately before it
 110 is executed.
 111 .TP
 112 .B \-x
 113 Force
 114 .B xargs
 115 to terminate immediately if a command line containing
 116 .I number
 117 arguments will not fit in the specified (or default) command line length.
 118 .TP
 119 .B \-0
 120 Read null-byte terminated pathnames from standard input as may have been
 121 produced by the
 122 .B \-print0
 123 option of
 124 .BR find (1).
 125 This is a MINIX 3 specific extension to
 126 .BR xargs .
 127 .PP
 128 If no
 129 .I utility
 130 is specified,
 131 .BR echo (1)
 132 is used.
 133 .PP
 134 Undefined behavior may occur if
 135 .I utility
 136 reads from the standard input.
 137 .PP
 138 .B Xargs
 139 exits with an exit status of 0 if no error occurs.
 140 If
 141 .I utility
 142 cannot be invoked, is terminated by a signal or terminates without
 143 calling
 144 .BR exit (2),
 145 .B xargs
 146 exits with an exit status of 127.
 147 If
 148 .I utility
 149 exits with an exit status other than 0,
 150 .B xargs
 151 exits with that exit status.
 152 Otherwise,
 153 .B xargs
 154 exits with an exit status of 1.
 155 .SH "SEE ALSO"
 156 .BR echo (1),
 157 .BR find (1).
 158 .SH STANDARDS
 159 The
 160 .B xargs
 161 utility is expected to be POSIX 1003.2 compliant.