Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / apply / apply.1
1 .\" Copyright (c) 1983, 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
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 .\"     @(#)apply.1     8.2 (Berkeley) 4/4/94
33 .\" $FreeBSD: src/usr.bin/apply/apply.1,v 1.8.2.4 2002/07/15 04:07:25 keramida Exp $
34 .\"
35 .Dd April 4, 1994
36 .Dt APPLY 1
37 .Os
38 .Sh NAME
39 .Nm apply
40 .Nd apply a command to a set of arguments
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl a Ar c
44 .Op Fl d
45 .Op Fl #
46 .Ar command argument ...
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility runs the named
51 .Ar command
52 on each
53 argument
54 .Ar argument
55 in turn.
56 .Pp
57 Character sequences of the form
58 .Dq Li \&%d
59 in
60 .Ar command ,
61 where
62 .Sq Li d
63 is a digit from 1 to 9, are replaced by the
64 .Li d Ns \'th
65 following unused
66 .Ar argument .
67 In this case, the largest digit number of arguments are discarded for
68 each execution of
69 .Ar command .
70 .Pp
71 The options are as follows:
72 .Bl -tag -width indent
73 .It Fl #
74 Normally arguments are taken singly; the optional number
75 .Fl #
76 specifies the number of arguments to be passed to
77 .Ar command .
78 If the number is zero,
79 .Ar command
80 is run, without arguments, once for each
81 .Ar argument .
82 .Pp
83 If any sequences of
84 .Dq Li \&%d
85 occur in
86 .Ar command ,
87 the
88 .Fl #
89 option is ignored.
90 .It Fl a Ar c
91 The use of the character
92 .Sq Li %
93 as a magic character may be changed with the
94 .Fl a
95 option.
96 .It Fl d
97 Display the commands that would have been executed, but do not actually
98 execute them.
99 .El
100 .Sh ENVIRONMENT
101 The following environment variable affects the execution of
102 .Nm :
103 .Bl -tag -width SHELL
104 .It Ev SHELL
105 Pathname of shell to use.
106 If this variable is not defined, the Bourne shell is used.
107 .El
108 .Sh EXAMPLES
109 .Bl -tag -width apply -compact
110 .It Li "apply echo a*"
111 is similar to
112 .Xr ls 1 ;
113 .It Li "apply \-2 cmp a1 b1 a2 b2 a3 b3"
114 compares the `a' files to the `b' files;
115 .It Li "apply \-0 who 1 2 3 4 5"
116 runs
117 .Xr who 1
118 5 times; and
119 .It Li "apply \'ln %1 /usr/joe\'" *
120 links all files in the current directory to the directory
121 .Pa /usr/joe .
122 .El
123 .Sh FILES
124 .Bl -tag -width /bin/sh -compact
125 .It Pa /bin/sh
126 default shell
127 .El
128 .Sh AUTHORS
129 .An Rob Pike
130 .Sh BUGS
131 Shell metacharacters in
132 .Ar command
133 may have bizarre effects; it is best to enclose complicated
134 commands in single quotes
135 .Pq '' .
136 .Sh HISTORY
137 The
138 .Nm
139 command appeared in
140 .Bx 4.2 .