update from Cael
authorKeith Bostic <bostic@ucbvax.Berkeley.EDU>
Fri, 24 Jul 1992 01:22:22 +0000 (17:22 -0800)
committerKeith Bostic <bostic@ucbvax.Berkeley.EDU>
Fri, 24 Jul 1992 01:22:22 +0000 (17:22 -0800)
SCCS-vsn: usr.bin/xargs/xargs.1 5.7

usr/src/usr.bin/xargs/xargs.1

index 50dbb18..ef086f1 100644 (file)
-.\" Copyright (c) 1990 The Regents of the University of California.
+.\" Copyright (c) 1990, 1991 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.
 .\"
 .\" 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.
 .\"
-.\" %sccs.include.redist.man%
+.\" %sccs.include.redist.roff%
 .\"
 .\"
-.\"    @(#)xargs.1     5.6 (Berkeley) %G%
+.\"    @(#)xargs.1     5.7 (Berkeley) %G%
 .\"
 .\"
-.TH XARGS 1 ""
-.UC 7
-.SH NAME
-xargs \- construct argument list(s) and execute utility.
-.SH SYNOPSIS
-.ft B
-xargs [\-t] [[\-x] \-n number] [\-s size] [utility [arg ...]]
-.ft R
-.SH DESCRIPTION
+.Dd 
+.Dt XARGS 1
+.Os
+.Sh NAME
+.Nm xargs
+.Nd "construct argument list(s) and execute utility"
+.Sh SYNOPSIS
+.Nm xargs
+.Op Fl t
+.Oo Op Fl x
+.Fl n Ar number
+.Oc
+.Op Fl s Ar size
+.Op Ar utility Op Ar arguments ...
+.Sh DESCRIPTION
 The
 The
-.I xargs
+.Nm xargs
 utility reads space, tab, newline and end-of-file delimited arguments
 from the standard input and executes the specified
 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
+.Ar utility
+with them as
+arguments.
+.Pp
 The utility and any arguments specified on the command line are given
 to the
 The utility and any arguments specified on the command line are given
 to the
-.I utility
+.Ar utility
 upon each invocation, followed by some number of the arguments read
 from standard input.
 The
 upon each invocation, followed by some number of the arguments read
 from standard input.
 The
-.I utility
+.Ar utility
 is repeatedly executed until standard input is exhausted.
 is repeatedly executed until standard input is exhausted.
-.PP
-Spaces, tabs and newlines may be embedded in arguments using single (`` ' '')
+.Pp
+Spaces, tabs and newlines may be embedded in arguments using single
+(``\ '\ '')
+.Ek
 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.
 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
+.Pp
 The options are as follows:
 The options are as follows:
-.TP
-\-n number
+.Bl -tag -width indent
+.It Fl n Ar number
 Set the maximum number of arguments taken from standard input for each
 invocation of the utility.
 An invocation of
 Set the maximum number of arguments taken from standard input for each
 invocation of the utility.
 An invocation of
-.I utility
+.Ar utility
 will use less than
 will use less than
-.I number
+.Ar number
 standard input arguments if the number of bytes accumulated (see the
 standard input arguments if the number of bytes accumulated (see the
-.I \-s
+.Fl s
 option) exceeds the specified
 option) exceeds the specified
-.I size
+.Ar size
 or there are fewer than
 or there are fewer than
-.I number
+.Ar number
 arguments remaining for the last invocation of
 arguments remaining for the last invocation of
-.IR utility .
+.Ar utility .
 The current default value for
 The current default value for
-.I number
+.Ar number
 is 5000.
 is 5000.
-.TP
-\-s size
+.It Fl s Ar size
 Set the maximum number of bytes for the command line length provided to
 Set the maximum number of bytes for the command line length provided to
-.IR utility .
+.Ar utility .
 The sum of the length of the utility name and the arguments passed to
 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.
+.Ar utility
+(including
+.Dv NULL
+terminators) will be less than or equal to this number.
 The current default value for
 The current default value for
-.I size
-is ARG_MAX - 2048.
-.TP
-\-t
+.Ar size
+is
+.Dv ARG_MAX
+- 2048.
+.It Fl t
 Echo the command to be executed to standard error immediately before it
 is executed.
 Echo the command to be executed to standard error immediately before it
 is executed.
-.TP
-\-x
+.It Fl x
 Force
 Force
-.I xargs
+.Nm xargs
 to terminate immediately if a command line containing
 to terminate immediately if a command line containing
-.I number
+.Ar number
 arguments will not fit in the specified (or default) command line length.
 arguments will not fit in the specified (or default) command line length.
-.PP
+.El
+.Pp
 If no
 If no
-.I utility
+.Ar utility
 is specified,
 is specified,
-.IR echo (1)
+.Xr echo 1
 is used.
 is used.
-.PP
+.Pp
 Undefined behavior may occur if
 Undefined behavior may occur if
-.I utility
+.Ar utility
 reads from the standard input.
 reads from the standard input.
-.PP
+.Pp
 The
 The
-.I xargs
+.Nm xargs
 utility exits immediately (without processing any further input) if a
 command line cannot be assembled,
 utility exits immediately (without processing any further input) if a
 command line cannot be assembled,
-.I utility
+.Ar utility
 cannot be invoked, an invocation of the utility is terminated by a signal
 or an invocation of the utility exits with a value of 255.
 cannot be invoked, an invocation of the utility is terminated by a signal
 or an invocation of the utility exits with a value of 255.
-.PP
+.Pp
 The
 The
-.I xargs
+.Nm xargs
 utility exits with a value of 0 if no error occurs.
 If
 utility exits with a value of 0 if no error occurs.
 If
-.I utility
+.Ar utility
 cannot be invoked,
 cannot be invoked,
-.I xargs
+.Nm xargs
 exits with a value of 127.
 If any other error occurs,
 exits with a value of 127.
 If any other error occurs,
-.I xargs
+.Nm xargs
 exits with a value of 1.
 exits with a value of 1.
-.SH "SEE ALSO"
-.IR echo (1),
-.IR find (1)
-.SH STANDARDS
+.Sh SEE ALSO
+.Xr echo 1 ,
+.Xr find 1
+.Sh STANDARDS
 The
 The
-.I xargs
-utility is expected to be POSIX 1003.2 compliant.
+.Nm xargs
+utility is expected to be
+.St -p1003.2
+compliant.