| blob | a4076de0ddda1ce064bff74e9d0f616edcb5c32f |
1 .\"
2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\"
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
9 .\" documentation.
10 .\"
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
13 .\"
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document. The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
24 .\"
25 .\" This notice shall appear on any product containing this material.
26 .\"
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
30 .\"
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Copyright 1989 AT&T
44 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved
45 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
46 .\"
47 .TH MV 1 "Oct 25, 2017"
48 .SH NAME
49 mv \- move files
50 .SH SYNOPSIS
51 .LP
52 .nf
53 \fB/usr/bin/mv\fR [\fB-fi\fR] \fIsource\fR \fItarget_file\fR
54 .fi
56 .LP
57 .nf
58 \fB/usr/bin/mv\fR [\fB-fi\fR] \fIsource\fR... \fItarget_dir\fR
59 .fi
61 .SH DESCRIPTION
62 .sp
63 .LP
64 In the first synopsis form, the \fBmv\fR utility moves the file named by the
65 \fIsource\fR operand to the destination specified by the \fItarget_file\fR.
66 \fIsource\fR and \fItarget_file\fR can not have the same name. If
67 \fItarget_file\fR does not exist, \fBmv\fR creates a file named
68 \fItarget_file\fR. If \fItarget_file\fR exists, its contents are overwritten.
69 This first synopsis form is assumed when the final operand does not name an
70 existing directory.
71 .sp
72 .LP
73 In the second synopsis form, \fBmv\fR moves each file named by a \fIsource\fR
74 operand to a destination file in the existing directory named by the
75 \fItarget_dir\fR operand. The destination path for each \fIsource\fR is the
76 concatenation of the target directory, a single slash character (\fB/\fR), and
77 the last path name component of the \fIsource\fR. This second form is assumed
78 when the final operand names an existing directory.
79 .sp
80 .LP
81 If \fBmv\fR determines that the mode of \fItarget_file\fR forbids writing, it
82 prints the mode (see \fBchmod\fR(2)), ask for a response, and read the standard
83 input for one line. If the response is affirmative, the \fBmv\fR occurs, if
84 permissible; otherwise, the command exits. Notice that the mode displayed can
85 not fully represent the access permission if \fItarget\fR is associated with an
86 \fBACL\fR. When the parent directory of \fIsource\fR is writable and has the
87 sticky bit set, one or more of the following conditions must be true:
88 .RS +4
89 .TP
90 .ie t \(bu
91 .el o
92 the user must own the file
93 .RE
94 .RS +4
95 .TP
96 .ie t \(bu
97 .el o
98 the user must own the directory
99 .RE
100 .RS +4
101 .TP
102 .ie t \(bu
103 .el o
104 the file must be writable by the user
105 .RE
106 .RS +4
107 .TP
108 .ie t \(bu
109 .el o
110 the user must be a privileged user
111 .RE
112 .sp
113 .LP
114 If \fIsource\fR is a file and \fItarget_file\fR is a link to another file with
115 links, the other links remain and \fItarget_file\fR becomes a new file.
116 .sp
117 .LP
118 If \fIsource\fR and \fItarget_file\fR/\fItarget_dir\fR are on different file
119 systems, \fBmv\fR copies the source and deletes the original. Any hard links to
120 other files are lost. \fBmv\fR attempts to duplicate the source file
121 characteristics to the target, that is, the owner and group id, permission
122 modes, modification and access times, \fBACL\fRs, and extended attributes, if
123 applicable. For symbolic links, \fBmv\fR preserves only the owner and group of
124 the link itself.
125 .sp
126 .LP
127 If unable to preserve owner and group id, \fBmv\fR clears \fBS_ISUID\fR and
128 \fBS_ISGID\fR bits in the target. \fBmv\fR prints a diagnostic message to
129 stderr if unable to clear these bits, though the exit code is not affected.
130 \fBmv\fR might be unable to preserve extended attributes if the target file
131 system does not have extended attribute support. \fBmv\fR prints
132 a diagnostic message to stderr for all other failed attempts to duplicate file
133 characteristics. The exit code is not affected.
134 .sp
135 .LP
136 In order to preserve the source file characteristics, users must have the
137 appropriate file access permissions. This includes being super-user or having
138 the same owner id as the destination file.
139 .SH OPTIONS
140 .sp
141 .LP
142 The following options are supported:
143 .sp
144 .ne 2
145 .na
146 \fB\fB-f\fR\fR
147 .ad
148 .RS 6n
149 \fBmv\fR moves the file(s) without prompting even if it is writing over an
150 existing \fItarget\fR. Note that this is the default if the standard input is
151 not a terminal.
152 .RE
154 .sp
155 .ne 2
156 .na
157 \fB\fB-i\fR\fR
158 .ad
159 .RS 6n
160 \fBmv\fR prompts for confirmation whenever the move would overwrite an existing
161 \fItarget\fR. An affirmative answer means that the move should proceed. Any
162 other answer prevents \fBmv\fR from overwriting the \fItarget\fR.
163 .RE
165 .sp
166 .LP
167 Specifying both the \fB-f\fR and the \fB-i\fR options is not considered an
168 error. The last option specified determines the behavior of \fBmv\fR.
169 .SH OPERANDS
170 .sp
171 .LP
172 The following operands are supported:
173 .sp
174 .ne 2
175 .na
176 \fB\fIsource\fR\fR
177 .ad
178 .RS 15n
179 A path name of a file or directory to be moved.
180 .RE
182 .sp
183 .ne 2
184 .na
185 \fB\fItarget_file\fR\fR
186 .ad
187 .RS 15n
188 A new path name for the file or directory being moved.
189 .RE
191 .sp
192 .ne 2
193 .na
194 \fB\fItarget_dir\fR\fR
195 .ad
196 .RS 15n
197 A path name of an existing directory into which to move the input files.
198 .RE
200 .SH USAGE
201 .sp
202 .LP
203 See \fBlargefile\fR(5) for the description of the behavior of \fBmv\fR when
204 encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
205 .SH ENVIRONMENT VARIABLES
206 .sp
207 .LP
208 See \fBenviron\fR(5) for descriptions of the following environment variables
209 that affect the execution of \fBmv\fR: \fBLANG\fR, \fBLC_ALL\fR,
210 \fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
211 .sp
212 .LP
213 Affirmative responses are processed using the extended regular expression
214 defined for the \fByesexpr\fR keyword in the \fBLC_MESSAGES\fR category of the
215 user's locale. The locale specified in the \fBLC_COLLATE\fR category defines
216 the behavior of ranges, equivalence classes, and multi-character collating
217 elements used in the expression defined for \fByesexpr\fR. The locale specified
218 in \fBLC_CTYPE\fR determines the locale for interpretation of sequences of
219 bytes of text data a characters, the behavior of character classes used in the
220 expression defined for the \fByesexpr\fR. See \fBlocale\fR(5).
221 .SH EXIT STATUS
222 .sp
223 .LP
224 The following exit values are returned:
225 .sp
226 .ne 2
227 .na
228 \fB\fB0\fR\fR
229 .ad
230 .RS 6n
231 All input files were moved successfully.
232 .RE
234 .sp
235 .ne 2
236 .na
237 \fB\fB>0\fR\fR
238 .ad
239 .RS 6n
240 An error occurred.
241 .RE
243 .SH ATTRIBUTES
244 .sp
245 .LP
246 See \fBattributes\fR(5) for descriptions of the following attributes:
247 .SS "/usr/bin/mv"
248 .sp
250 .sp
251 .TS
252 box;
253 c | c
254 l | l .
255 ATTRIBUTE TYPE ATTRIBUTE VALUE
256 _
257 CSI Enabled
258 _
259 Interface Stability Standard
260 .TE
262 .SH SEE ALSO
263 .sp
264 .LP
265 \fBcp\fR(1), \fBcpio\fR(1), \fBln\fR(1), \fBrm\fR(1), \fBsetfacl\fR(1),
266 \fBchmod\fR(2), \fBattributes\fR(5), \fBenviron\fR(5), \fBfsattr\fR(5),
267 \fBlargefile\fR(5), \fBstandards\fR(5)
268 .SH NOTES
269 .sp
270 .LP
271 A \fB--\fR permits the user to mark explicitly the end of any command line
272 options, allowing \fBmv\fR to recognize filename arguments that begin with a
273 \fB-\fR. As an aid to BSD migration, \fBmv\fR accepts \fB-\fR as a synonym for
274 \fB--\fR. This migration aid might disappear in a future release.