chiark / gitweb /
Add 'stg cp' command.
[stgit] / Documentation / stg-cp.txt
CommitLineData
d5ae2173
YD
1stg-cp(1)
2=========
3Yann Dirson <ydirson@altern.org>
4v0.13, March 2007
5
6NAME
7----
8stg-cp - stgdesc:cp[]
9
10SYNOPSIS
11--------
12stg cp [OPTIONS] <file|dir> <newname>
13
14stg cp [OPTIONS] <files|dirs...> <dir>
15
16DESCRIPTION
17-----------
18
19Make git-controlled copies of git-controlled files. The copies are
20added to the Git index, so you can add them to a patch with
21stglink:refresh[].
22
23In the first form, copy a single file or a single directory, with a
24new name. The parent directory of <newname> must already exist;
25<newname> itself must not already exist, or the command will be
26interpreted as one of the second form.
27
28In the second form, copy one or several files and/or directories, into
29an existing directory.
30
31Directories are copied recursively. Only the git-controlled files
32under the named directories are copied and added to the index. Any
33file not known to Git will not be copied.
34
35CAVEATS
36-------
37
38The first form doesn't allow yet to overwrite an existing file
39(whether it could be recovered from Git or not), and the second form
40does not check before overwriting any file, possibly leading to loss
41of non-committed modifications.
42
43FUTURE OPTIONS
44--------------
45
46--all::
47 Also copy files not known to Git when copying a directory.
48
49--force::
50 Force overwriting of target files, even if overwritten files
51 have non-committed changes or are not known to Git.
52
53--dry-run::
54 Show which files would be added, and which would be modified
55 if --force would be added.
56
57StGIT
58-----
59Part of the StGIT suite - see gitlink:stg[7].