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