git-annex/doc/git-annex-add.mdwn
Antoine Beaupré 21ec5872f4 expand manpages cross-references significantly
i found that most man pages only had references to the main git-annex
manpage, which i stillfind pretty huge and hard to navigate through.

i tried to sift through all the man pages and add cross-references
between relevant pages. my general rule of thumb is that links should
be both ways unless one of the pages is a more general page that would
become ridiculously huge if all backlinks would be added
(git-annex-preferred-content comes to mind).

i have also make the links one per line as this is how it was done in
the metadata pages so far.

i did everything but the plumbing, utility and test commands, although
some of those are linked from the other commands so cross-links were
added there as well.
2015-05-29 12:12:55 -04:00

63 lines
1.2 KiB
Markdown

# NAME
git-annex add - adds files to the git annex
# SYNOPSIS
git annex add `[path ...]`
# DESCRIPTION
Adds files in the path to the annex. If no path is specified, adds
files from the current directory and below.
Normally, files that are already checked into git, or that git has been
configured to ignore will be silently skipped.
If annex.largefiles is configured, and does not match a file that is being
added, `git annex add` will behave the same as `git add` and add the
non-large file directly to the git repository, instead of to the annex.
# OPTIONS
* `--include-dotfiles`
Dotfiles are skipped unless explicitly listed, or unless this option is
used.
* `--force`
Add gitignored files.
* `--backend`
Specifies which key-value backend to use.
* file matching options
Many of the [[git-annex-matching-options]](1)
can be used to specify files to add.
For example: `--largerthan=1GB`
# SEE ALSO
[[git-annex]](1)
[[git-annex-unlock]](1)
[[git-annex-lock]](1)
[[git-annex-undo]](1)
[[git-annex-import]](1)
[[git-annex-unannex]](1)
[[git-annex-reinject]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.