Initial import from FreeBSD RELENG_4:
[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 .\"
38 .Dd July 9, 2002
39 .Dt MV 1
40 .Os
41 .Sh NAME
42 .Nm mv
43 .Nd move files
44 .Sh SYNOPSIS
45 .Nm
46 .Op Fl f | i | n
47 .Op Fl v
48 .Ar source target
49 .Nm
50 .Op Fl f | i | n
51 .Op Fl v
52 .Ar source ... directory
53 .Sh DESCRIPTION
54 In its first form, the
55 .Nm
56 utility renames the file named by the
57 .Ar source
58 operand to the destination path named by the
59 .Ar target
60 operand.
61 This form is assumed when the last operand does not name an already
62 existing directory.
63 .Pp
64 In its second form,
65 .Nm
66 moves each file named by a
67 .Ar source
68 operand to a destination file in the existing directory named by the
69 .Ar directory
70 operand.
71 The destination path for each operand is the pathname produced by the
72 concatenation of the last operand, a slash, and the final pathname
73 component of the named file.
74 .Pp
75 The following options are available:
76 .Bl -tag -width indent
77 .It Fl f
78 Do not prompt for confirmation before overwriting the destination
79 path.
80 (The
81 .Fl f
82 option overrides any previous
83 .Fl i
84 or
85 .Fl n
86 options.)
87 .It Fl i
88 Cause
89 .Nm
90 to write a prompt to standard error before moving a file that would
91 overwrite an existing file.
92 If the response from the standard input begins with the character
93 .Ql y
94 or
95 .Ql Y ,
96 the move is attempted.
97 (The
98 .Fl i
99 option overrides any previous
100 .Fl f
101 or
102 .Fl n
103 options.)
104 .It Fl n
105 Do not overwrite an existing file.
106 (The
107 .Fl n
108 option overrides any previous
109 .Fl f
110 or
111 .Fl i
112 options.)
113 .It Fl v
114 Cause
115 .Nm
116 to be verbose, showing files after they are moved.
117 .El
118 .Pp
119 It is an error for either the
120 .Ar source
121 operand or the destination path to specify a directory unless both do.
122 .Pp
123 If the destination path does not have a mode which permits writing,
124 .Nm
125 prompts the user for confirmation as specified for the
126 .Fl i
127 option.
128 .Pp
129 As the
130 .Xr rename 2
131 call does not work across file systems,
132 .Nm
133 uses
134 .Xr cp 1
135 and
136 .Xr rm 1
137 to accomplish the move.
138 The effect is equivalent to:
139 .Bd -literal -offset indent
140 rm -f destination_path && \e
141 cp -pRP source_file destination && \e
142 rm -rf source_file
143 .Ed
144 .Sh DIAGNOSTICS
145 .Ex -std
146 .Sh SEE ALSO
147 .Xr cp 1 ,
148 .Xr rm 1 ,
149 .Xr symlink 7
150 .Sh COMPATIBILITY
151 The
152 .Fl n
153 and
154 .Fl v
155 options are non-standard and their use in scripts is not recommended.
156 .Sh STANDARDS
157 The
158 .Nm
159 utility is expected to be
160 .St -p1003.2
161 compatible.
162 .Sh HISTORY
163 A
164 .Nm
165 command appeared in
166 .At v1 .