Merge from vendor branch LIBARCHIVE:
[dragonfly.git] / bin / mv / mv.1
1 .\" Copyright (c) 1989, 1990, 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 .\" the Institute of Electrical and Electronics Engineers, Inc.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by the University of
18 .\"     California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\"     @(#)mv.1        8.1 (Berkeley) 5/31/93
36 .\" $FreeBSD: src/bin/mv/mv.1,v 1.15.2.5 2003/01/24 02:29:13 keramida Exp $
37 .\" $DragonFly: src/bin/mv/mv.1,v 1.4 2006/11/11 12:05:36 victor Exp $
38 .\"
39 .Dd July 9, 2002
40 .Dt MV 1
41 .Os
42 .Sh NAME
43 .Nm mv
44 .Nd move files
45 .Sh SYNOPSIS
46 .Nm
47 .Op Fl f | i | n
48 .Op Fl v
49 .Ar source target
50 .Nm
51 .Op Fl f | i | n
52 .Op Fl v
53 .Ar source ... directory
54 .Sh DESCRIPTION
55 In its first form, the
56 .Nm
57 utility renames the file named by the
58 .Ar source
59 operand to the destination path named by the
60 .Ar target
61 operand.
62 This form is assumed when the last operand does not name an already
63 existing directory.
64 .Pp
65 In its second form,
66 .Nm
67 moves each file named by a
68 .Ar source
69 operand to a destination file in the existing directory named by the
70 .Ar directory
71 operand.
72 The destination path for each operand is the pathname produced by the
73 concatenation of the last operand, a slash, and the final pathname
74 component of the named file.
75 .Pp
76 The following options are available:
77 .Bl -tag -width indent
78 .It Fl f
79 Do not prompt for confirmation before overwriting the destination
80 path.
81 (The
82 .Fl f
83 option overrides any previous
84 .Fl i
85 or
86 .Fl n
87 options.)
88 .It Fl i
89 Cause
90 .Nm
91 to write a prompt to standard error before moving a file that would
92 overwrite an existing file.
93 If the response from the standard input begins with the character
94 .Ql y
95 or
96 .Ql Y ,
97 the move is attempted.
98 (The
99 .Fl i
100 option overrides any previous
101 .Fl f
102 or
103 .Fl n
104 options.)
105 .It Fl n
106 Do not overwrite an existing file.
107 (The
108 .Fl n
109 option overrides any previous
110 .Fl f
111 or
112 .Fl i
113 options.)
114 .It Fl v
115 Cause
116 .Nm
117 to be verbose, showing files after they are moved.
118 .El
119 .Pp
120 It is an error for either the
121 .Ar source
122 operand or the destination path to specify a directory unless both do.
123 .Pp
124 If the destination path does not have a mode which permits writing,
125 .Nm
126 prompts the user for confirmation as specified for the
127 .Fl i
128 option.
129 .Pp
130 As the
131 .Xr rename 2
132 call does not work across file systems,
133 .Nm
134 uses
135 .Xr cp 1
136 and
137 .Xr rm 1
138 to accomplish the move.
139 The effect is equivalent to:
140 .Bd -literal -offset indent
141 rm -f destination_path && \e
142 cp -pRP source_file destination && \e
143 rm -rf source_file
144 .Ed
145 .Pp
146 If
147 .Nm
148 receives a
149 .Dv SIGINFO
150 (see the
151 .Cm status
152 argument for
153 .Xr stty 1 )
154 signal, the current input and output file
155 will be written to standard error.
156 .Sh DIAGNOSTICS
157 .Ex -std
158 .Sh COMPATIBILITY
159 The
160 .Fl n
161 and
162 .Fl v
163 options are non-standard and their use in scripts is not recommended.
164 .Sh SEE ALSO
165 .Xr cp 1 ,
166 .Xr rm 1 ,
167 .Xr symlink 7
168 .Sh STANDARDS
169 The
170 .Nm
171 utility is expected to be
172 .St -p1003.2
173 compatible.
174 .Sh HISTORY
175 A
176 .Nm
177 command appeared in
178 .At v1 .