git-lfs/docs/man/git-lfs-track.1.ronn
Antoine Beaupré 2e22042f90
point to gitignore in track manpage
We point to the online manual for gitignore, but it's not very useful
when reading the manual pages with man or another offline manpage
viewer. A more useful pointer is in the SEE ALSO section at the
bottom.
2018-06-13 17:26:30 -04:00

65 lines
1.9 KiB
Markdown

git-lfs-track(1) - View or add Git LFS paths to Git attributes
==============================================================
## SYNOPSIS
`git lfs track` [options] [<pattern>...]
## DESCRIPTION
Start tracking the given patterns(s) through Git LFS. The <pattern> argument
is written to .gitattributes. If no paths are provided, simply list the
currently-tracked paths.
The [gitattributes documentation](https://git-scm.com/docs/gitattributes) states
that patterns use the [gitignore pattern rules](https://git-scm.com/docs/gitignore)
to match paths.
## OPTIONS
* `--verbose` `-v`:
If enabled, have `git lfs track` log files which it will touch. Disabled by
default.
* `--dry-run` `-d`:
If enabled, have `git lfs track` log all actions it would normally take
(adding entries to .gitattributes, touching files on disk, etc) without
performing any mutative operations to the disk.
`git lfs track --dry-run [files]` also implicitly mocks the behavior of
passing the `--verbose`, and will log in greater detail what it is doing.
Disabled by default.
* `--lockable` `-l`
Make the paths 'lockable', meaning they should be locked to edit them, and
will be made read-only in the working copy when not locked.
* `--not-lockable`
Remove the lockable flag from the paths so they are no longer read-only unless
locked.
* `--no-modify-attrs`
Makes matched entries stat-dirty so that Git can re-index files you wish to
convert to LFS. Does not modify any `.gitattributes` file(s).
## EXAMPLES
* List the patterns that Git LFS is currently tracking:
`git lfs track`
* Configure Git LFS to track GIF files:
`git lfs track "*.gif"`
* Configure Git LFS to track PSD files and make them read-only unless locked:
`git lfs track --lockable "*.psd"`
## SEE ALSO
git-lfs-untrack(1), git-lfs-install(1), gitattributes(5), gitignore(5).
Part of the git-lfs(1) suite.