sbase/xargs.1
Hiltjo Posthuma a0998d0252 sbase: improve man pages and some warnings.
From ed5e4d34a16436a37c0e084666fcfb77cc4859c3 Mon Sep 17 00:00:00 2001
From: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Thu, 31 Jul 2025 14:42:59 +0200
Subject: [PATCH 4/4] improve man pages and some warnings.

Checking for warnings: mandoc -Tlint *.1

- Swap .St -p1003.1-2013 macro with text:
  mdoc does not support this macro and some texts were changed, like commit
  d4dfd42d3580ad36bedfdc5b8924ff6683981f53
- Typo fixes:
  exeption -> exception.
- xargs.1: document -P extension.
- sed.1: remove use of .Pp of .Ss.
- Wrap lines to less than 80 characters and use a new sentence for each line.
- find.1: Xr reference C library functions.
2025-09-19 09:16:25 +02:00

122 lines
2.8 KiB
Groff

.Dd July 30, 2025
.Dt XARGS 1
.Os sbase
.Sh NAME
.Nm xargs
.Nd construct argument lists and execute command
.Sh SYNOPSIS
.Nm
.Op Fl 0prtx
.Op Fl E Ar eofstr
.Op Fl I Ar replstr
.Op Fl n Ar num
.Op Fl P Ar maxprocs
.Op Fl s Ar num
.Op Ar cmd Op Ar arg ...
.Sh DESCRIPTION
.Nm
reads space, tab, newline and EOF delimited strings from stdin
and executes the specified
.Ar cmd
with the strings as
.Ar arguments .
.Pp
Any arguments specified on the command line are given to the command upon
each invocation, followed by some number of the arguments read from
stdin.
The command is repeatedly executed one or more times until stdin 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.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl 0
Change
.Nm
to expect NUL ('\e0') characters as separators, instead of spaces
and newlines.
The quoting mechanisms described above are not performed.
.It Fl E Ar eofstr
Use
.Ar eofstr
as a logical EOF marker.
.It Fl I Ar replstr
Use
.Ar replstr
as the placeholder for the argument.
Sets the arguments count to 1 per command line.
It also implies the option x.
.It Fl n Ar num
Use at most
.Ar num
arguments per command line.
.It Fl p
Prompt mode: the user is asked whether to execute
.Ar cmd
at each invocation.
Trace mode (-t) is turned on to write the command instance to be executed,
followed by a prompt to standard error.
An affirmative response read from
.Pa /dev/tty
executes the command, otherwise it is skipped.
.It Fl P Ar maxprocs
Parallel mode: run at most maxprocs invocations of
.Ar cmd
at once.
.It Fl r
Do not run the command if there are no arguments.
Normally the command is executed at least once even if there are no arguments.
.It Fl s Ar num
Use at most
.Ar num
bytes per command line.
.It Fl t
Enable trace mode.
Write the command line to stderr before executing it.
.It Fl x
Terminate if the command line exceeds the system limit or the number of bytes
given with the
.Op Fl s
flag.
.El
.Sh EXIT STATUS
.Nm
exits with one of the following values:
.Bl -tag -width Ds
.It 0
All invocations of
.Ar cmd
returned a zero exit status.
.It 123
One or more invocations of
.Ar cmd
returned a nonzero exit status.
.It 124
.Ar cmd
exited with a 255 exit status.
.It 125
.Ar cmd
was killed or stopped by a signal.
.It 126
.Ar cmd
was found but could not be executed.
.It 127
.Ar cmd
could not be found.
.It 1
Some other error occurred.
.El
.Sh STANDARDS
POSIX.1-2013.
.Pp
The
.Op Fl r
and
.Op Fl P
flag is an extension to that specification.