Merge branch 'cb/leading-path-removal'
[git/jnareb-git.git] / Documentation / git-mv.txt
blobbdcb58526ec2e838949e079891a420802df477db
1 git-mv(1)
2 =========
4 NAME
5 ----
6 git-mv - Move or rename a file, a directory, or a symlink
9 SYNOPSIS
10 --------
11 'git mv' <options>... <args>...
13 DESCRIPTION
14 -----------
15 This script is used to move or rename a file, directory or symlink.
17  git mv [-f] [-n] <source> <destination>
18  git mv [-f] [-n] [-k] <source> ... <destination directory>
20 In the first form, it renames <source>, which must exist and be either
21 a file, symlink or directory, to <destination>.
22 In the second form, the last argument has to be an existing
23 directory; the given sources will be moved into this directory.
25 The index is updated after successful completion, but the change must still be
26 committed.
28 OPTIONS
29 -------
30 -f::
31 --force::
32         Force renaming or moving of a file even if the target exists
33 -k::
34         Skip move or rename actions which would lead to an error
35         condition. An error happens when a source is neither existing nor
36         controlled by GIT, or when it would overwrite an existing
37         file unless '-f' is given.
38 -n::
39 --dry-run::
40         Do nothing; only show what would happen
43 Author
44 ------
45 Written by Linus Torvalds <torvalds@osdl.org>
46 Rewritten by Ryan Anderson <ryan@michonline.com>
47 Move functionality added by Josef Weidendorfer <Josef.Weidendorfer@gmx.de>
49 Documentation
50 --------------
51 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
53 GIT
54 ---
55 Part of the linkgit:git[1] suite