Documentation cherry-pick: Fix cut-and-paste error
[git/platforms/storm.git] / Documentation / git-mv.txt
blobbff3fbe7459dec090ddb5e5df5ff94cf4b030046
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 renaming or moving of a file even if the target exists
32 -k::
33         Skip move or rename actions which would lead to an error
34         condition. An error happens when a source is neither existing nor
35         controlled by GIT, or when it would overwrite an existing
36         file unless '-f' is given.
37 -n, \--dry-run::
38         Do nothing; only show what would happen
41 Author
42 ------
43 Written by Linus Torvalds <torvalds@osdl.org>
44 Rewritten by Ryan Anderson <ryan@michonline.com>
45 Move functionality added by Josef Weidendorfer <Josef.Weidendorfer@gmx.de>
47 Documentation
48 --------------
49 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
51 GIT
52 ---
53 Part of the linkgit:git[7] suite