usr.bin/xargs/xargs.1

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)xargs.1     8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD$
  34 .\" $xMach: xargs.1,v 1.2 2002/02/23 05:23:37 tim Exp $
  35 .\"
  36 .Dd March 16, 2012
  37 .Dt XARGS 1
  38 .Os
  39 .Sh NAME
  40 .Nm xargs
  41 .Nd "construct argument list(s) and execute utility"
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl 0oprt
  45 .Op Fl E Ar eofstr
  46 .Oo
  47 .Fl I Ar replstr
  48 .Op Fl R Ar replacements
  49 .Op Fl S Ar replsize
  50 .Oc
  51 .Op Fl J Ar replstr
  52 .Op Fl L Ar number
  53 .Oo
  54 .Fl n Ar number
  55 .Op Fl x
  56 .Oc
  57 .Op Fl P Ar maxprocs
  58 .Op Fl s Ar size
  59 .Op Ar utility Op Ar argument ...
  60 .Sh DESCRIPTION
  61 The
  62 .Nm
  63 utility reads space, tab, newline and end-of-file delimited strings
  64 from the standard input and executes
  65 .Ar utility
  66 with the strings as
  67 arguments.
  68 .Pp
  69 Any arguments specified on the command line are given to
  70 .Ar utility
  71 upon each invocation, followed by some number of the arguments read
  72 from the standard input of
  73 .Nm .
  74 This is repeated until standard input is exhausted.
  75 .Pp
  76 Spaces, tabs and newlines may be embedded in arguments using single
  77 (``\ '\ '')
  78 or double (``"'') quotes or backslashes (``\e'').
  79 Single quotes escape all non-single quote characters, excluding newlines,
  80 up to the matching single quote.
  81 Double quotes escape all non-double quote characters, excluding newlines,
  82 up to the matching double quote.
  83 Any single character, including newlines, may be escaped by a backslash.
  84 .Pp
  85 The options are as follows:
  86 .Bl -tag -width indent
  87 .It Fl 0
  88 Change
  89 .Nm
  90 to expect NUL
  91 (``\\0'')
  92 characters as separators, instead of spaces and newlines.
  93 This is expected to be used in concert with the
  94 .Fl print0
  95 function in
  96 .Xr find 1 .
  97 .It Fl E Ar eofstr
  98 Use
  99 .Ar eofstr
 100 as a logical EOF marker.
 101 .It Fl I Ar replstr
 102 Execute
 103 .Ar utility
 104 for each input line, replacing one or more occurrences of
 105 .Ar replstr
 106 in up to
 107 .Ar replacements
 108 (or 5 if no
 109 .Fl R
 110 flag is specified) arguments to
 111 .Ar utility
 112 with the entire line of input.
 113 The resulting arguments, after replacement is done, will not be allowed to grow
 114 beyond
 115 .Ar replsize
 116 (or 255 if no
 117 .Fl S
 118 flag is specified)
 119 bytes; this is implemented by concatenating as much of the argument
 120 containing
 121 .Ar replstr
 122 as possible, to the constructed arguments to
 123 .Ar utility ,
 124 up to
 125 .Ar replsize
 126 bytes.
 127 The size limit does not apply to arguments to
 128 .Ar utility
 129 which do not contain
 130 .Ar replstr ,
 131 and furthermore, no replacement will be done on
 132 .Ar utility
 133 itself.
 134 Implies
 135 .Fl x .
 136 .It Fl J Ar replstr
 137 If this option is specified,
 138 .Nm
 139 will use the data read from standard input to replace the first occurrence of
 140 .Ar replstr
 141 instead of appending that data after all other arguments.
 142 This option will not affect how many arguments will be read from input
 143 .Pq Fl n ,
 144 or the size of the command(s)
 145 .Nm
 146 will generate
 147 .Pq Fl s .
 148 The option just moves where those arguments will be placed in the command(s)
 149 that are executed.
 150 The
 151 .Ar replstr
 152 must show up as a distinct
 153 .Ar argument
 154 to
 155 .Nm .
 156 It will not be recognized if, for instance, it is in the middle of a
 157 quoted string.
 158 Furthermore, only the first occurrence of the
 159 .Ar replstr
 160 will be replaced.
 161 For example, the following command will copy the list of files and
 162 directories which start with an uppercase letter in the current
 163 directory to
 164 .Pa destdir :
 165 .Pp
 166 .Dl /bin/ls -1d [A-Z]* | xargs -J % cp -Rp % destdir
 167 .It Fl L Ar number
 168 Call
 169 .Ar utility
 170 for every
 171 .Ar number
 172 lines read.
 173 If EOF is reached and fewer lines have been read than
 174 .Ar number
 175 then
 176 .Ar utility
 177 will be called with the available lines.
 178 .It Fl n Ar number
 179 Set the maximum number of arguments taken from standard input for each
 180 invocation of
 181 .Ar utility .
 182 An invocation of
 183 .Ar utility
 184 will use less than
 185 .Ar number
 186 standard input arguments if the number of bytes accumulated (see the
 187 .Fl s
 188 option) exceeds the specified
 189 .Ar size
 190 or there are fewer than
 191 .Ar number
 192 arguments remaining for the last invocation of
 193 .Ar utility .
 194 The current default value for
 195 .Ar number
 196 is 5000.
 197 .It Fl o
 198 Reopen stdin as
 199 .Pa /dev/tty
 200 in the child process before executing the command.
 201 This is useful if you want
 202 .Nm
 203 to run an interactive application.
 204 .It Fl P Ar maxprocs
 205 Parallel mode: run at most
 206 .Ar maxprocs
 207 invocations of
 208 .Ar utility
 209 at once.
 210 .It Fl p
 211 Echo each command to be executed and ask the user whether it should be
 212 executed.
 213 An affirmative response,
 214 .Ql y
 215 in the POSIX locale,
 216 causes the command to be executed, any other response causes it to be
 217 skipped.
 218 No commands are executed if the process is not attached to a terminal.
 219 .It Fl r
 220 Compatibility with GNU
 221 .Nm .
 222 The GNU version of
 223 .Nm
 224 runs the
 225 .Ar utility
 226 argument at least once, even if
 227 .Nm
 228 input is empty, and it supports a
 229 .Fl r
 230 option to inhibit this behavior.
 231 The
 232 .Fx
 233 version of
 234 .Nm
 235 does not run the
 236 .Ar utility
 237 argument on empty input, but it supports the
 238 .Fl r
 239 option for command-line compatibility with GNU
 240 .Nm ,
 241 but the
 242 .Fl r
 243 option does nothing in the
 244 .Fx
 245 version of
 246 .Nm .
 247 .It Fl R Ar replacements
 248 Specify the maximum number of arguments that
 249 .Fl I
 250 will do replacement in.
 251 If
 252 .Ar replacements
 253 is negative, the number of arguments in which to replace is unbounded.
 254 .It Fl S Ar replsize
 255 Specify the amount of space (in bytes) that
 256 .Fl I
 257 can use for replacements.
 258 The default for
 259 .Ar replsize
 260 is 255.
 261 .It Fl s Ar size
 262 Set the maximum number of bytes for the command line length provided to
 263 .Ar utility .
 264 The sum of the length of the utility name, the arguments passed to
 265 .Ar utility
 266 (including
 267 .Dv NULL
 268 terminators) and the current environment will be less than or equal to
 269 this number.
 270 The current default value for
 271 .Ar size
 272 is
 273 .Dv ARG_MAX
 274 - 4096.
 275 .It Fl t
 276 Echo the command to be executed to standard error immediately before it
 277 is executed.
 278 .It Fl x
 279 Force
 280 .Nm
 281 to terminate immediately if a command line containing
 282 .Ar number
 283 arguments will not fit in the specified (or default) command line length.
 284 .El
 285 .Pp
 286 If
 287 .Ar utility
 288 is omitted,
 289 .Xr echo 1
 290 is used.
 291 .Pp
 292 Undefined behavior may occur if
 293 .Ar utility
 294 reads from the standard input.
 295 .Pp
 296 If a command line cannot be assembled, or
 297 cannot be invoked, or if an invocation of
 298 .Ar utility
 299 is terminated by a signal,
 300 or an invocation of
 301 .Ar utility
 302 exits with a value of 255, the
 303 .Nm
 304 utility stops processing input and exits after all invocations of
 305 .Ar utility
 306 finish processing.
 307 .Sh EXIT STATUS
 308 The
 309 .Nm
 310 utility exits with a value of 0 if no error occurs.
 311 If
 312 .Ar utility
 313 cannot be found,
 314 .Nm
 315 exits with a value of 127, otherwise if
 316 .Ar utility
 317 cannot be executed,
 318 .Nm
 319 exits with a value of 126.
 320 If any other error occurs,
 321 .Nm
 322 exits with a value of 1.
 323 .Sh SEE ALSO
 324 .Xr echo 1 ,
 325 .Xr find 1 ,
 326 .Xr execvp 3
 327 .Sh STANDARDS
 328 The
 329 .Nm
 330 utility is expected to be
 331 .St -p1003.2
 332 compliant.
 333 The
 334 .Fl J , o , P, R
 335 and
 336 .Fl S
 337 options are non-standard
 338 .Fx
 339 extensions which may not be available on other operating systems.
 340 .Sh HISTORY
 341 The
 342 .Nm
 343 utility appeared in PWB UNIX.
 344 .Sh BUGS
 345 If
 346 .Ar utility
 347 attempts to invoke another command such that the number of arguments or the
 348 size of the environment is increased, it risks
 349 .Xr execvp 3
 350 failing with
 351 .Er E2BIG .
 352 .Pp
 353 The
 354 .Nm
 355 utility does not take multibyte characters into account when performing
 356 string comparisons for the
 357 .Fl I
 358 and
 359 .Fl J
 360 options, which may lead to incorrect results in some locales.