usr.bin/xargs/xargs.1

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