2010-10-19 19:59:40 +00:00
|
|
|
# NAME
|
|
|
|
|
|
|
|
|
|
git-annex - manage files with git, without checking their contents in
|
|
|
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
|
2010-12-30 20:52:24 +00:00
|
|
|
git annex command [params ...]
|
2010-10-19 19:59:40 +00:00
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
2010-10-09 18:06:25 +00:00
|
|
|
git-annex allows managing files with git, without checking the file
|
2010-10-15 23:32:33 +00:00
|
|
|
contents into git. While that may seem paradoxical, it is useful when
|
|
|
|
|
dealing with files larger than git can currently easily handle, whether due
|
|
|
|
|
to limitations in memory, checksumming time, or disk space.
|
|
|
|
|
|
|
|
|
|
Even without file content tracking, being able to manage files with git,
|
|
|
|
|
move files around and delete files with versioned directory trees, and use
|
|
|
|
|
branches and distributed clones, are all very handy reasons to use git. And
|
|
|
|
|
annexed files can co-exist in the same git repository with regularly
|
|
|
|
|
versioned files, which is convenient for maintaining documents, Makefiles,
|
|
|
|
|
etc that are associated with annexed files but that benefit from full
|
|
|
|
|
revision control.
|
2010-10-09 18:06:25 +00:00
|
|
|
|
2010-10-19 19:59:40 +00:00
|
|
|
When a file is annexed, its content is moved into a key-value store, and
|
|
|
|
|
a symlink is made that points to the content. These symlinks are checked into
|
2014-01-18 06:30:01 +00:00
|
|
|
git and versioned like regular files. You can move them around, delete
|
2010-10-19 19:59:40 +00:00
|
|
|
them, and so on. Pushing to another git repository will make git-annex
|
|
|
|
|
there aware of the annexed file, and it can be used to retrieve its
|
|
|
|
|
content from the key-value store.
|
|
|
|
|
|
|
|
|
|
# EXAMPLES
|
|
|
|
|
|
|
|
|
|
# git annex get video/hackity_hack_and_kaxxt.mov
|
2014-12-20 12:18:24 +00:00
|
|
|
get video/hackity_hack_and_kaxxt.mov (not available)
|
2010-10-19 19:59:40 +00:00
|
|
|
I was unable to access these remotes: server
|
|
|
|
|
Try making some of these repositories available:
|
|
|
|
|
5863d8c0-d9a9-11df-adb2-af51e6559a49 -- my home file server
|
|
|
|
|
58d84e8a-d9ae-11df-a1aa-ab9aa8c00826 -- portable USB drive
|
|
|
|
|
ca20064c-dbb5-11df-b2fe-002170d25c55 -- backup SATA drive
|
|
|
|
|
failed
|
|
|
|
|
# sudo mount /media/usb
|
|
|
|
|
# git remote add usbdrive /media/usb
|
|
|
|
|
# git annex get video/hackity_hack_and_kaxxt.mov
|
2011-06-09 22:54:49 +00:00
|
|
|
get video/hackity_hack_and_kaxxt.mov (from usbdrive...) ok
|
2010-10-19 19:59:40 +00:00
|
|
|
|
|
|
|
|
# git annex add iso
|
|
|
|
|
add iso/Debian_5.0.iso ok
|
|
|
|
|
|
2010-10-23 16:41:13 +00:00
|
|
|
# git annex drop iso/Debian_4.0.iso
|
|
|
|
|
drop iso/Debian_4.0.iso ok
|
2010-10-21 21:59:32 +00:00
|
|
|
|
2010-10-23 16:41:13 +00:00
|
|
|
# git annex move iso --to=usbdrive
|
2010-10-26 00:48:32 +00:00
|
|
|
move iso/Debian_5.0.iso (moving to usbdrive...) ok
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2011-09-16 02:22:43 +00:00
|
|
|
# COMMONLY USED COMMANDS
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2014-01-18 06:30:01 +00:00
|
|
|
Like many git commands, git-annex can be passed a path that
|
2010-10-19 19:59:40 +00:00
|
|
|
is either a file or a directory. In the latter case it acts on all relevant
|
2011-09-16 02:22:43 +00:00
|
|
|
files in the directory. When no path is specified, most git-annex commands
|
2011-01-14 03:36:58 +00:00
|
|
|
default to acting on all relevant files in the current directory (and
|
|
|
|
|
subdirectories).
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2015-03-23 21:35:39 +00:00
|
|
|
* `help`
|
|
|
|
|
|
|
|
|
|
Display built-in help.
|
|
|
|
|
|
|
|
|
|
For help on a specific command, use `git annex help command`
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `add [path ...]`
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2014-03-26 18:52:07 +00:00
|
|
|
Adds files in the path to the annex. If no path is specified, adds
|
2015-03-23 19:36:10 +00:00
|
|
|
files from the current directory and below.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-add]](1) for details.
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `get [path ...]`
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
Makes the content of annexed files available in this repository.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-get]](1) for details.
|
2011-10-27 23:04:12 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `drop [path ...]`
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2014-01-18 06:30:01 +00:00
|
|
|
Drops the content of annexed files from this repository.
|
2015-03-23 19:36:10 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-drop]](1) for details.
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
* `move [path ...] [--from=remote|--to=remote]`
|
2010-10-21 21:59:32 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
Moves the content of files from or to another remote.
|
2010-11-27 21:02:53 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
See [[git-annex-move]](1) for details.
|
2011-03-27 22:34:30 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
* `copy [path ...] [--from=remote|--to=remote]`
|
2010-11-27 21:02:53 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
Copies the content of files from or to another remote.
|
2013-12-02 19:41:20 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
See [[git-annex-copy]](1) for details.
|
2010-11-27 21:02:53 +00:00
|
|
|
|
2013-12-26 21:08:43 +00:00
|
|
|
* `status [path ...]`
|
2013-11-07 17:55:36 +00:00
|
|
|
|
|
|
|
|
Similar to `git status --short`, displays the status of the files in the
|
2015-03-23 19:36:10 +00:00
|
|
|
working tree. Particularly useful in direct mode.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-status]](1) for details.
|
2013-11-07 17:55:36 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `unlock [path ...]`
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
Unlock annexed files for modification.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-unlock]](1) for details.
|
2011-03-03 20:58:52 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `edit [path ...]`
|
2011-03-03 20:58:52 +00:00
|
|
|
|
|
|
|
|
This is an alias for the unlock command. May be easier to remember,
|
|
|
|
|
if you think of this as allowing you to edit an annexed file.
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `lock [path ...]`
|
2010-11-08 01:02:25 +00:00
|
|
|
|
2010-11-09 19:11:45 +00:00
|
|
|
Use this to undo an unlock command if you don't want to modify
|
|
|
|
|
the files, or have made modifications you want to discard.
|
2015-03-23 19:36:10 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-lock]](1) for details.
|
2010-11-08 01:02:25 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `sync [remote ...]`
|
2011-12-10 00:27:22 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
Synchronize local repository with remotes.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-sync]](1) for details.
|
2013-08-20 19:46:35 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
* `mirror [path ...] [--to=remote|--from=remote]`
|
2013-08-20 19:46:35 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
Mirror content of files to/from another repository.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-mirror]](1) for details.
|
2014-01-01 21:39:33 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `addurl [url ...]`
|
2011-09-16 02:22:43 +00:00
|
|
|
|
2012-02-08 19:35:18 +00:00
|
|
|
Downloads each url to its own file, which is added to the annex.
|
2015-03-23 19:36:10 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-addurl]](1) for details.
|
2015-03-05 18:46:08 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `rmurl file url`
|
2013-04-22 21:18:53 +00:00
|
|
|
|
|
|
|
|
Record that the file is no longer available at the url.
|
2015-03-23 19:36:10 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-rmurl]](1) for details.
|
2013-04-22 21:18:53 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `import [path ...]`
|
2012-05-31 23:47:18 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
Move and add files from outside git working copy into the annex.
|
2015-02-06 19:58:06 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
See [[git-annex-import]](1) for details.
|
2013-08-11 16:56:26 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `importfeed [url ...]`
|
2013-07-28 19:27:36 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
Imports the contents of podcast feeds into the annex.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-importfeed]](1) for details.
|
2013-07-28 19:27:36 +00:00
|
|
|
|
2017-08-29 17:25:48 +00:00
|
|
|
* `export treeish --to remote`
|
|
|
|
|
|
|
|
|
|
Export content to a remote.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-export]](1) for details.
|
|
|
|
|
|
2014-11-13 20:41:21 +00:00
|
|
|
* `undo [filename|directory] ...`
|
|
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
Undo last change to a file or directory.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-undo]](1) for details.
|
2014-11-13 20:41:21 +00:00
|
|
|
|
2017-03-30 23:32:58 +00:00
|
|
|
* `multicast`
|
|
|
|
|
|
|
|
|
|
Multicast file distribution.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-multicast]](1) for details.
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `watch`
|
2012-06-07 03:27:20 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
Watch for changes and autocommit.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-watch]](1) for details.
|
2012-06-07 03:27:20 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `assistant`
|
2012-06-22 17:04:03 +00:00
|
|
|
|
2015-04-01 23:50:17 +00:00
|
|
|
Automatically sync folders between devices.
|
2012-07-26 01:26:13 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
See [[git-annex-assistant]](1) for details.
|
2012-12-29 18:43:53 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `webapp`
|
2012-07-26 01:26:13 +00:00
|
|
|
|
2013-04-08 19:04:35 +00:00
|
|
|
Opens a web app, that allows easy setup of a git-annex repository,
|
2014-03-12 19:40:20 +00:00
|
|
|
and control of the git-annex assistant. If the assistant is not
|
|
|
|
|
already running, it will be started.
|
2012-06-22 17:04:03 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
See [[git-annex-webapp]](1) for details.
|
2013-04-08 19:04:35 +00:00
|
|
|
|
2011-09-16 02:22:43 +00:00
|
|
|
# REPOSITORY SETUP COMMANDS
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `init [description]`
|
2011-08-17 18:43:38 +00:00
|
|
|
|
|
|
|
|
Until a repository (or one of its remotes) has been initialized,
|
2013-12-04 06:10:18 +00:00
|
|
|
git-annex will refuse to operate on it, to avoid accidentally
|
2011-08-17 18:43:38 +00:00
|
|
|
using it in a repository that was not intended to have an annex.
|
2015-03-23 22:20:42 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-init]](1) for details.
|
2011-03-03 20:58:52 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `describe repository description`
|
2011-03-03 20:58:52 +00:00
|
|
|
|
2011-03-29 02:05:11 +00:00
|
|
|
Changes the description of a repository.
|
2015-03-23 22:20:42 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-describe]](1) for details.
|
2011-03-03 20:58:52 +00:00
|
|
|
|
2015-03-23 22:20:42 +00:00
|
|
|
* `initremote name type=value [param=value ...]`
|
2011-03-28 06:12:05 +00:00
|
|
|
|
2014-01-18 06:30:01 +00:00
|
|
|
Creates a new special remote, and adds it to `.git/config`.
|
2013-07-11 12:11:47 +00:00
|
|
|
|
2015-03-23 22:20:42 +00:00
|
|
|
See [[git-annex-initremote]](1) for details.
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `enableremote name [param=value ...]`
|
2013-04-26 22:22:44 +00:00
|
|
|
|
2015-03-23 22:20:42 +00:00
|
|
|
Enables use of an existing special remote in the current repository.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-enableremote]](1) for details.
|
2013-09-01 18:12:00 +00:00
|
|
|
|
2016-11-20 18:39:26 +00:00
|
|
|
* `enable-tor`
|
|
|
|
|
|
|
|
|
|
Sets up tor hidden service.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-enable-tor]](1) for details.
|
|
|
|
|
|
2014-01-20 20:47:56 +00:00
|
|
|
* `numcopies [N]`
|
|
|
|
|
|
2015-03-23 22:20:42 +00:00
|
|
|
Configure desired number of copies.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-numcopies]](1) for details.
|
2014-01-20 20:47:56 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `trust [repository ...]`
|
2011-09-16 02:22:43 +00:00
|
|
|
|
|
|
|
|
Records that a repository is trusted to not unexpectedly lose
|
|
|
|
|
content. Use with care.
|
2015-03-23 22:20:42 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-trust]](1) for details.
|
2011-09-16 02:22:43 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `untrust [repository ...]`
|
2011-09-16 02:22:43 +00:00
|
|
|
|
|
|
|
|
Records that a repository is not trusted and could lose content
|
|
|
|
|
at any time.
|
2015-03-23 22:20:42 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-untrust]](1) for details.
|
2011-09-16 02:22:43 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `semitrust [repository ...]`
|
2011-09-16 02:22:43 +00:00
|
|
|
|
|
|
|
|
Returns a repository to the default semi trusted state.
|
2015-03-23 22:20:42 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-semitrust]](1) for details.
|
2011-09-16 02:22:43 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `group repository groupname`
|
2012-10-01 19:12:04 +00:00
|
|
|
|
2015-03-23 22:20:42 +00:00
|
|
|
Add a repository to a group.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-group]](1) for details.
|
2014-05-16 18:43:40 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `ungroup repository groupname`
|
2012-10-01 19:12:04 +00:00
|
|
|
|
|
|
|
|
Removes a repository from a group.
|
2015-03-23 22:20:42 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-ungroup]](1) for details.
|
2012-10-01 19:12:04 +00:00
|
|
|
|
2013-10-28 18:08:38 +00:00
|
|
|
* `wanted repository [expression]`
|
2015-03-23 22:20:42 +00:00
|
|
|
|
|
|
|
|
Get or set preferred content expression.
|
2013-05-25 16:44:58 +00:00
|
|
|
|
2015-03-23 22:20:42 +00:00
|
|
|
See [[git-annex-wanted]](1) for details.
|
2013-05-25 16:44:58 +00:00
|
|
|
|
2015-02-06 19:12:42 +00:00
|
|
|
* `groupwanted groupname [expression]`
|
|
|
|
|
|
2015-04-18 20:04:25 +00:00
|
|
|
Get or set groupwanted expression.
|
|
|
|
|
|
2015-03-23 22:20:42 +00:00
|
|
|
See [[git-annex-groupwanted]](1) for details.
|
2015-02-06 19:12:42 +00:00
|
|
|
|
2015-04-18 20:04:25 +00:00
|
|
|
* `required repository [expression]`
|
|
|
|
|
|
|
|
|
|
Get or set required content expression.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-required]](1) for details.
|
|
|
|
|
|
2013-10-13 19:40:38 +00:00
|
|
|
* `schedule repository [expression]`
|
|
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
Get or set scheduled jobs.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-schedule]](1) for details.
|
2013-10-13 19:40:38 +00:00
|
|
|
|
2017-01-30 20:41:29 +00:00
|
|
|
* `config`
|
|
|
|
|
|
|
|
|
|
Get and set other configuration stored in git-annex branch.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-config]](1) for details.
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `vicfg`
|
2012-10-03 21:04:52 +00:00
|
|
|
|
|
|
|
|
Opens EDITOR on a temp file containing most of the above configuration
|
2014-03-15 20:17:01 +00:00
|
|
|
settings, as well as a few others, and when it exits, stores any changes
|
|
|
|
|
made back to the git-annex branch.
|
2015-03-23 22:20:42 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-vicfg]](1) for details.
|
2012-10-03 21:04:52 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `direct`
|
2012-12-13 19:44:56 +00:00
|
|
|
|
|
|
|
|
Switches a repository to use direct mode, where rather than symlinks to
|
2013-01-06 21:26:22 +00:00
|
|
|
files, the files are directly present in the repository.
|
2015-03-23 22:20:42 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-direct]](1) for details.
|
2013-01-06 21:26:22 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `indirect`
|
2012-12-13 19:44:56 +00:00
|
|
|
|
|
|
|
|
Switches a repository back from direct mode to the default, indirect mode.
|
2015-03-23 22:20:42 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-indirect]](1) for details.
|
2012-12-13 19:44:56 +00:00
|
|
|
|
2016-03-29 15:33:26 +00:00
|
|
|
* `adjust`
|
|
|
|
|
|
|
|
|
|
Switches a repository to use an adjusted branch, which can automatically
|
|
|
|
|
unlock all files, etc.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-adjust]](1) for details.
|
|
|
|
|
|
2011-09-16 02:22:43 +00:00
|
|
|
# REPOSITORY MAINTENANCE COMMANDS
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `fsck [path ...]`
|
2010-11-15 22:04:19 +00:00
|
|
|
|
2015-03-24 19:23:59 +00:00
|
|
|
Checks the annex consistency, and warns about or fixes any problems found.
|
|
|
|
|
This is a good complement to `git fsck`.
|
2010-11-15 22:04:19 +00:00
|
|
|
|
2015-03-24 19:23:59 +00:00
|
|
|
See [[git-annex-fsck]](1) for details.
|
2013-07-11 12:11:46 +00:00
|
|
|
|
2015-04-05 16:50:02 +00:00
|
|
|
* `expire [repository:]time ...`
|
|
|
|
|
|
|
|
|
|
Expires repositories that have not recently performed an activity
|
|
|
|
|
(such as a fsck).
|
|
|
|
|
|
2015-05-29 16:12:11 +00:00
|
|
|
See [[git-annex-expire]](1) for details.
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `unused`
|
2010-11-15 22:04:19 +00:00
|
|
|
|
2011-06-23 16:23:25 +00:00
|
|
|
Checks the annex for data that does not correspond to any files present
|
2011-09-28 21:48:45 +00:00
|
|
|
in any tag or branch, and prints a numbered list of the data.
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-unused]](1) for details.
|
2013-07-03 19:26:59 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `dropunused [number|range ...]`
|
2010-11-15 22:04:19 +00:00
|
|
|
|
|
|
|
|
Drops the data corresponding to the numbers, as listed by the last
|
2010-11-15 22:22:50 +00:00
|
|
|
`git annex unused`
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-dropunused]](1) for details.
|
2011-04-03 00:59:41 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `addunused [number|range ...]`
|
2012-05-02 18:59:05 +00:00
|
|
|
|
|
|
|
|
Adds back files for the content corresponding to the numbers or ranges,
|
2015-03-24 19:23:59 +00:00
|
|
|
as listed by the last `git annex unused`.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-addunused]](1) for details.
|
2012-05-02 18:59:05 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `fix [path ...]`
|
2011-09-16 02:22:43 +00:00
|
|
|
|
|
|
|
|
Fixes up symlinks that have become broken to again point to annexed content.
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-fix]](1) for details.
|
2011-09-16 02:22:43 +00:00
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
* `merge`
|
|
|
|
|
|
|
|
|
|
Automatically merge changes from remotes.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-merge]](1) for details.
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `upgrade`
|
2011-09-16 02:22:43 +00:00
|
|
|
|
|
|
|
|
Upgrades the repository to current layout.
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-upgrade]](1) for details.
|
2011-09-16 02:22:43 +00:00
|
|
|
|
2015-06-09 18:52:05 +00:00
|
|
|
* `dead [repository ...] [--key key]`
|
|
|
|
|
|
|
|
|
|
Indicates that a repository or a single key has been irretrievably lost.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-dead]](1) for details.
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `forget`
|
2013-08-28 19:57:42 +00:00
|
|
|
|
|
|
|
|
Causes the git-annex branch to be rewritten, throwing away historical
|
2015-03-24 19:23:59 +00:00
|
|
|
data about past locations of files.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-forget]](1) for details.
|
2013-08-28 19:57:42 +00:00
|
|
|
|
2013-10-23 16:21:59 +00:00
|
|
|
* `repair`
|
|
|
|
|
|
2013-12-04 06:10:18 +00:00
|
|
|
This can repair many of the problems with git repositories that `git fsck`
|
2013-10-23 16:21:59 +00:00
|
|
|
detects, but does not itself fix. It's useful if a repository has become
|
2013-12-04 06:10:18 +00:00
|
|
|
badly damaged. One way this can happen is if a repository used by git-annex
|
2013-10-23 16:21:59 +00:00
|
|
|
is on a removable drive that gets unplugged at the wrong time.
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-repair]](1) for details.
|
2013-10-23 16:21:59 +00:00
|
|
|
|
2016-11-29 21:31:10 +00:00
|
|
|
* `p2p`
|
|
|
|
|
|
|
|
|
|
Configure peer-2-Peer links between repositories.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-p2p]](1) for details.
|
2016-11-20 18:39:26 +00:00
|
|
|
|
2011-09-16 02:22:43 +00:00
|
|
|
# QUERY COMMANDS
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `find [path ...]`
|
2010-11-15 22:04:19 +00:00
|
|
|
|
2011-12-22 17:53:06 +00:00
|
|
|
Outputs a list of annexed files in the specified path. With no path,
|
|
|
|
|
finds files in the current directory and its subdirectories.
|
2010-11-15 22:04:19 +00:00
|
|
|
|
2015-03-24 19:23:59 +00:00
|
|
|
See [[git-annex-find]](1) for details.
|
2011-11-22 18:06:31 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `whereis [path ...]`
|
2011-03-05 21:23:55 +00:00
|
|
|
|
2015-02-25 18:31:17 +00:00
|
|
|
Displays information about where the contents of files are located.
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-whereis]](1) for details.
|
2011-03-05 21:23:55 +00:00
|
|
|
|
2013-09-19 18:16:28 +00:00
|
|
|
* `list [path ...]`
|
2013-09-12 16:21:21 +00:00
|
|
|
|
|
|
|
|
Displays a table of remotes that contain the contents of the specified
|
2015-03-24 19:23:59 +00:00
|
|
|
files. This is similar to whereis but a more compact display.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-list]](1) for details.
|
2013-09-12 16:21:21 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `log [path ...]`
|
2012-01-06 19:40:04 +00:00
|
|
|
|
|
|
|
|
Displays the location log for the specified file or files,
|
|
|
|
|
showing each repository they were added to ("+") and removed from ("-").
|
|
|
|
|
|
2015-03-24 19:23:59 +00:00
|
|
|
See [[git-annex-log]](1) for details.
|
2012-01-07 22:13:12 +00:00
|
|
|
|
2015-01-13 22:11:03 +00:00
|
|
|
* `info [directory|file|remote|uuid ...]`
|
2011-05-17 01:18:34 +00:00
|
|
|
|
2014-10-21 17:24:15 +00:00
|
|
|
Displays statistics and other information for the specified item,
|
2015-01-13 22:11:03 +00:00
|
|
|
which can be a directory, or a file, or a remote, or the uuid of a
|
|
|
|
|
repository.
|
|
|
|
|
|
2014-10-21 18:36:09 +00:00
|
|
|
When no item is specified, displays statistics and information
|
2014-10-21 17:44:17 +00:00
|
|
|
for the repository as a whole.
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-info]](1) for details.
|
2014-01-18 06:30:01 +00:00
|
|
|
|
2013-11-07 17:55:36 +00:00
|
|
|
* `version`
|
|
|
|
|
|
|
|
|
|
Shows the version of git-annex, as well as repository version information.
|
2015-03-24 19:23:59 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-version]](1) for details.
|
2013-03-11 05:22:56 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `map`
|
2011-02-03 22:55:12 +00:00
|
|
|
|
2015-03-24 19:23:59 +00:00
|
|
|
Generate map of repositories.
|
2011-02-03 22:55:12 +00:00
|
|
|
|
2015-03-24 19:23:59 +00:00
|
|
|
See [[git-annex-map]](1) for details.
|
2011-02-03 22:55:12 +00:00
|
|
|
|
2017-12-28 15:46:39 +00:00
|
|
|
* `inprogress`
|
|
|
|
|
|
|
|
|
|
Access files while they're being downloaded.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-inprogress]](1) for details.
|
|
|
|
|
|
2014-02-19 18:55:34 +00:00
|
|
|
# METADATA COMMANDS
|
2011-09-16 02:22:43 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
* `metadata [path ...]`
|
2014-02-13 01:12:22 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
The content of an annexed file can have any number of metadata fields
|
2014-03-26 20:55:29 +00:00
|
|
|
attached to it to describe it. Each metadata field can in turn
|
2014-08-19 05:22:24 +00:00
|
|
|
have any number of values.
|
|
|
|
|
|
2014-03-15 21:29:40 +00:00
|
|
|
This command can be used to set metadata, or show the currently set
|
|
|
|
|
metadata.
|
2014-08-19 05:22:24 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
See [[git-annex-metadata]](1) for details.
|
2014-02-13 01:12:22 +00:00
|
|
|
|
2014-03-02 18:53:19 +00:00
|
|
|
* `view [tag ...] [field=value ...] [field=glob ...] [!tag ...] [field!=value ...]`
|
2014-02-19 18:55:34 +00:00
|
|
|
|
|
|
|
|
Uses metadata to build a view branch of the files in the current branch,
|
|
|
|
|
and checks out the view branch. Only files in the current branch whose
|
|
|
|
|
metadata matches all the specified field values and tags will be
|
|
|
|
|
shown in the view.
|
2014-08-19 05:22:24 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
See [[git-annex-view]](1) for details.
|
2014-02-19 18:55:34 +00:00
|
|
|
|
|
|
|
|
* `vpop [N]`
|
|
|
|
|
|
|
|
|
|
Switches from the currently active view back to the previous view.
|
|
|
|
|
Or, from the first view back to original branch.
|
2015-03-25 16:09:49 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-vpop]](1) for details.
|
2014-02-19 18:55:34 +00:00
|
|
|
|
2014-03-02 18:53:19 +00:00
|
|
|
* `vfilter [tag ...] [field=value ...] [!tag ...] [field!=value ...]`
|
add tip about metadata driven views (and more flexible view filtering)
While writing this documentation, I realized that there needed to be a way
to stay in a view like tag=* while adding a filter like tag=work that
applies to the same field.
So, there are really two ways a view can be refined. It can have a new
"field=explicitvalue" filter added to it, which does not change the
"shape" of the view, but narrows the files it shows.
Or, it can have a new view added, which adds another level of
subdirectories.
So, added a vfilter command, which takes explicit values to add to the
filter, and rejects changes that would change the shape of the view.
And, made vadd only accept changes that change the shape of the view.
And, changed the View data type slightly; now components that can match
multiple metadata values can be visible, or not visible.
This commit was sponsored by Stelian Iancu.
2014-02-19 19:10:18 +00:00
|
|
|
|
|
|
|
|
Filters the current view to only the files that have the
|
2014-03-02 18:53:19 +00:00
|
|
|
specified field values and tags.
|
2015-03-25 16:09:49 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-vfilter]](1) for details.
|
add tip about metadata driven views (and more flexible view filtering)
While writing this documentation, I realized that there needed to be a way
to stay in a view like tag=* while adding a filter like tag=work that
applies to the same field.
So, there are really two ways a view can be refined. It can have a new
"field=explicitvalue" filter added to it, which does not change the
"shape" of the view, but narrows the files it shows.
Or, it can have a new view added, which adds another level of
subdirectories.
So, added a vfilter command, which takes explicit values to add to the
filter, and rejects changes that would change the shape of the view.
And, made vadd only accept changes that change the shape of the view.
And, changed the View data type slightly; now components that can match
multiple metadata values can be visible, or not visible.
This commit was sponsored by Stelian Iancu.
2014-02-19 19:10:18 +00:00
|
|
|
|
2014-03-02 19:46:58 +00:00
|
|
|
* `vadd [field=glob ...] [field=value ...] [tag ...]`
|
2014-02-19 18:55:34 +00:00
|
|
|
|
add tip about metadata driven views (and more flexible view filtering)
While writing this documentation, I realized that there needed to be a way
to stay in a view like tag=* while adding a filter like tag=work that
applies to the same field.
So, there are really two ways a view can be refined. It can have a new
"field=explicitvalue" filter added to it, which does not change the
"shape" of the view, but narrows the files it shows.
Or, it can have a new view added, which adds another level of
subdirectories.
So, added a vfilter command, which takes explicit values to add to the
filter, and rejects changes that would change the shape of the view.
And, made vadd only accept changes that change the shape of the view.
And, changed the View data type slightly; now components that can match
multiple metadata values can be visible, or not visible.
This commit was sponsored by Stelian Iancu.
2014-02-19 19:10:18 +00:00
|
|
|
Changes the current view, adding an additional level of directories
|
|
|
|
|
to categorize the files.
|
2015-03-25 16:09:49 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-vfilter]](1) for details.
|
2014-02-19 18:55:34 +00:00
|
|
|
|
|
|
|
|
* `vcycle`
|
|
|
|
|
|
|
|
|
|
When a view involves nested subdirectories, this cycles the order.
|
2015-03-25 16:09:49 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-vcycle]](1) for details.
|
2014-02-19 18:55:34 +00:00
|
|
|
|
|
|
|
|
# UTILITY COMMANDS
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `migrate [path ...]`
|
2011-09-16 02:22:43 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Changes the specified annexed files to use a different key-value backend.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-migrate]](1) for details.
|
2011-09-16 02:22:43 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `reinject src dest`
|
2011-10-31 16:33:41 +00:00
|
|
|
|
2011-10-31 19:18:41 +00:00
|
|
|
Moves the src file into the annex as the content of the dest file.
|
|
|
|
|
This can be useful if you have obtained the content of a file from
|
|
|
|
|
elsewhere and want to put it in the local annex.
|
2011-10-31 16:33:41 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
See [[git-annex-reinject]](1) for details.
|
2011-10-31 16:33:41 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `unannex [path ...]`
|
2010-10-21 21:59:32 +00:00
|
|
|
|
2013-10-28 20:56:01 +00:00
|
|
|
Use this to undo an accidental `git annex add` command. It puts the
|
|
|
|
|
file back how it was before the add.
|
2015-03-25 16:09:49 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-unannex]](1) for details.
|
2011-07-04 20:06:28 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `uninit`
|
2010-12-03 04:33:41 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
De-initialize git-annex and clean out repository.
|
|
|
|
|
|
2015-05-29 16:12:11 +00:00
|
|
|
See [[git-annex-uninit]](1) for details.
|
2010-12-03 04:33:41 +00:00
|
|
|
|
2014-04-16 00:13:35 +00:00
|
|
|
* `reinit uuid|description`
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Initialize repository, reusing old UUID.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-reinit]](1) for details.
|
2014-04-16 00:13:35 +00:00
|
|
|
|
2011-09-16 02:22:43 +00:00
|
|
|
# PLUMBING COMMANDS
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `pre-commit [path ...]`
|
2010-10-27 18:33:44 +00:00
|
|
|
|
2013-11-05 20:42:59 +00:00
|
|
|
This is meant to be called from git's pre-commit hook. `git annex init`
|
|
|
|
|
automatically creates a pre-commit hook using this.
|
2015-03-25 16:09:49 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-pre-commit]](1) for details.
|
2010-10-27 18:33:44 +00:00
|
|
|
|
2017-02-17 18:04:43 +00:00
|
|
|
* `post-receive`
|
|
|
|
|
|
|
|
|
|
This is meant to be called from git's post-receive hook. `git annex init`
|
|
|
|
|
automatically creates a post-receive hook using this.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-post-receive]](1) for details.
|
|
|
|
|
|
2013-12-15 18:02:23 +00:00
|
|
|
* `lookupkey [file ...]`
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Looks up key used for file.
|
2013-12-15 18:46:29 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
See [[git-annex-lookupkey]](1) for details.
|
2013-12-15 18:46:29 +00:00
|
|
|
|
2016-04-20 17:49:42 +00:00
|
|
|
* `calckey [file ...]`
|
|
|
|
|
|
|
|
|
|
Calculates the key that would be used to refer to a file.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-calckey]](1) for details.
|
|
|
|
|
|
2015-04-09 19:34:47 +00:00
|
|
|
* `contentlocation [key ..]`
|
|
|
|
|
|
|
|
|
|
Looks up location of annexed content for a key.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-contentlocation]](1) for details.
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
* `examinekey [key ...]`
|
2014-01-18 06:30:01 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Print information that can be determined purely by looking at the key.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-examinekey]](1) for details.
|
2013-12-15 18:46:29 +00:00
|
|
|
|
2016-01-25 20:16:18 +00:00
|
|
|
* `matchexpression`
|
|
|
|
|
|
|
|
|
|
Checks if a preferred content expression matches provided data.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-matchexpression]](1) for details.
|
|
|
|
|
|
2015-03-15 18:07:43 +00:00
|
|
|
* `fromkey [key file]`
|
2010-10-21 20:30:16 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Manually set up a file in the git repository to link to a specified key.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-fromkey]](1) for details.
|
2015-03-15 18:07:43 +00:00
|
|
|
|
2015-03-15 18:37:33 +00:00
|
|
|
* `registerurl [key url]`
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Registers an url for a key.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-registerurl]](1) for details.
|
2015-03-15 18:37:33 +00:00
|
|
|
|
2015-07-02 21:44:25 +00:00
|
|
|
* `setkey key file`
|
|
|
|
|
|
|
|
|
|
Moves a file into the annex as the content of a key.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-setkey]](1) for details.
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `dropkey [key ...]`
|
2010-10-25 22:32:29 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Drops annexed content for specified keys.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-dropkey]](1) for details.
|
2010-10-25 22:32:29 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
* `transferkey key [--from=remote|--to=remote]`
|
2013-12-15 17:48:26 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Transfers a key from or to a remote.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-transferkey]](1) for details.
|
2012-08-24 21:23:58 +00:00
|
|
|
|
2013-12-19 20:51:57 +00:00
|
|
|
* `transferkeys`
|
2015-03-25 16:09:49 +00:00
|
|
|
|
|
|
|
|
Used internally by the assistant.
|
2013-12-19 20:51:57 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
See [[git-annex-transferkey]](1) for details.
|
2013-12-19 20:51:57 +00:00
|
|
|
|
2014-12-29 19:16:40 +00:00
|
|
|
* `setpresentkey key uuid [1|0]`
|
|
|
|
|
|
|
|
|
|
This plumbing-level command changes git-annex's records about whether
|
2015-03-20 15:22:27 +00:00
|
|
|
the specified key's content is present in a remote with the specified uuid.
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
See [[git-annex-setpresentkey]](1) for details.
|
|
|
|
|
|
2015-03-20 15:22:27 +00:00
|
|
|
* `readpresentkey key uuid`
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Read records of where key is present.
|
2015-03-20 15:22:27 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
See [[git-annex-readpresentkey]](1) for details.
|
2014-12-29 19:16:40 +00:00
|
|
|
|
2015-03-20 15:44:46 +00:00
|
|
|
* `checkpresentkey key remote`
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Check if key is present in remote.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-checkpresentkey]](1) for details.
|
2015-03-20 15:44:46 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `rekey [file key ...]`
|
2013-07-11 12:11:47 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Change keys used for files.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-rekey]](1) for details.
|
2012-02-16 20:36:35 +00:00
|
|
|
|
2014-04-17 22:41:24 +00:00
|
|
|
* `findref [ref]`
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
Lists files in a git ref.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-findref]](1) for details.
|
2014-04-17 22:41:24 +00:00
|
|
|
|
2014-11-13 17:59:00 +00:00
|
|
|
* `proxy -- git cmd [options]`
|
|
|
|
|
|
|
|
|
|
Only useful in a direct mode repository, this runs the specified git
|
|
|
|
|
command with a temporary work tree, and updates the working tree to
|
|
|
|
|
reflect any changes staged or committed by the git command.
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
See [[git-annex-proxy]](1) for details.
|
2014-11-13 17:59:00 +00:00
|
|
|
|
2014-07-11 20:45:18 +00:00
|
|
|
* `resolvemerge`
|
|
|
|
|
|
|
|
|
|
Resolves a conflicted merge, by adding both conflicting versions of the
|
|
|
|
|
file to the tree, using variants of their filename. This is done
|
|
|
|
|
automatically when using `git annex sync` or `git annex merge`.
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
See [[git-annex-resolvemerge]](1) for details.
|
2014-07-11 20:45:18 +00:00
|
|
|
|
2014-11-24 20:14:01 +00:00
|
|
|
* `diffdriver`
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
This can be used to make `git diff` use an external diff driver with
|
|
|
|
|
annexed files.
|
2014-11-24 20:14:01 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
See [[git-annex-diffdriver]](1) for details.
|
2014-11-24 20:14:01 +00:00
|
|
|
|
2015-12-04 19:30:06 +00:00
|
|
|
* `smudge`
|
2015-12-04 17:02:56 +00:00
|
|
|
|
2015-12-04 19:30:06 +00:00
|
|
|
This command lets git-annex be used as a git filter driver, allowing
|
|
|
|
|
annexed files in the git repository to be unlocked at all times, instead
|
|
|
|
|
of being symlinks.
|
2015-12-04 17:02:56 +00:00
|
|
|
|
2015-12-04 19:30:06 +00:00
|
|
|
See [[git-annex-smudge]](1) for details.
|
2015-12-04 17:02:56 +00:00
|
|
|
|
2014-04-06 23:06:03 +00:00
|
|
|
* `remotedaemon`
|
|
|
|
|
|
2014-04-14 18:14:54 +00:00
|
|
|
Detects when network remotes have received git pushes and fetches from them.
|
2014-04-06 23:06:03 +00:00
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
See [[git-annex-remotedaemon]](1) for details.
|
|
|
|
|
|
2014-08-01 16:49:26 +00:00
|
|
|
# TESTING COMMANDS
|
|
|
|
|
|
|
|
|
|
* `test`
|
|
|
|
|
|
|
|
|
|
This runs git-annex's built-in test suite.
|
2015-03-25 16:09:49 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-test]](1) for details.
|
2014-08-01 16:49:26 +00:00
|
|
|
|
2014-08-01 19:09:49 +00:00
|
|
|
* `testremote remote`
|
|
|
|
|
|
|
|
|
|
This tests a remote by generating some random objects and sending them to
|
|
|
|
|
the remote, then redownloading them, removing them from the remote, etc.
|
|
|
|
|
|
|
|
|
|
It's safe to run in an existing repository (the repository contents are
|
|
|
|
|
not altered), although it may perform expensive data transfers.
|
2015-03-25 16:09:49 +00:00
|
|
|
|
|
|
|
|
See [[git-annex-testremote]](1) for details.
|
2014-08-01 21:52:40 +00:00
|
|
|
|
2014-08-01 16:49:26 +00:00
|
|
|
* `fuzztest`
|
|
|
|
|
|
|
|
|
|
Generates random changes to files in the current repository,
|
2015-03-25 16:09:49 +00:00
|
|
|
for use in testing the assistant.
|
|
|
|
|
|
|
|
|
|
See [[git-annex-fuzztest]](1) for details.
|
2014-08-01 16:49:26 +00:00
|
|
|
|
2016-01-12 17:01:44 +00:00
|
|
|
* `benchmark`
|
|
|
|
|
|
|
|
|
|
This runs git-annex's built-in benchmarks, if it was built with
|
|
|
|
|
benchmarking support.
|
|
|
|
|
|
2015-03-25 16:09:49 +00:00
|
|
|
# COMMON OPTIONS
|
|
|
|
|
|
|
|
|
|
These common options are accepted by all git-annex commands, and
|
|
|
|
|
may not be explicitly listed on their individual man pages.
|
|
|
|
|
(Many commands also accept the [[git-annex-matching-options]](1).)
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `--force`
|
2010-10-19 19:59:40 +00:00
|
|
|
|
|
|
|
|
Force unsafe actions, such as dropping a file's content when no other
|
2011-06-29 15:42:00 +00:00
|
|
|
source of it can be verified to still exist, or adding ignored files.
|
|
|
|
|
Use with care.
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `--fast`
|
2011-03-22 21:41:06 +00:00
|
|
|
|
2014-01-18 06:30:01 +00:00
|
|
|
Enable less expensive, but also less thorough versions of some commands.
|
2011-03-27 22:34:30 +00:00
|
|
|
What is avoided depends on the command.
|
2011-03-22 21:41:06 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `--quiet`
|
2010-10-25 22:32:29 +00:00
|
|
|
|
2015-04-03 20:48:30 +00:00
|
|
|
Avoid the default verbose display of what is done; only show errors.
|
2010-10-25 22:32:29 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `--verbose`
|
2010-10-28 18:04:22 +00:00
|
|
|
|
2011-09-01 19:16:31 +00:00
|
|
|
Enable verbose display.
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `--debug`
|
2011-05-21 15:52:13 +00:00
|
|
|
|
|
|
|
|
Show debug messages.
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `--no-debug`
|
2013-06-18 00:41:17 +00:00
|
|
|
|
|
|
|
|
Disable debug messages.
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `--numcopies=n`
|
2011-06-01 20:49:17 +00:00
|
|
|
|
2014-01-20 20:47:56 +00:00
|
|
|
Overrides the numcopies setting, forcing git-annex to ensure the
|
2014-01-18 06:30:01 +00:00
|
|
|
specified number of copies exist.
|
2012-10-28 23:26:18 +00:00
|
|
|
|
|
|
|
|
Note that setting numcopies to 0 is very unsafe.
|
2011-06-01 20:49:17 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `--time-limit=time`
|
2012-09-25 20:48:24 +00:00
|
|
|
|
|
|
|
|
Limits how long a git-annex command runs. The time can be something
|
|
|
|
|
like "5h", or "30m" or even "45s" or "10d".
|
|
|
|
|
|
|
|
|
|
Note that git-annex may continue running a little past the specified
|
|
|
|
|
time limit, in order to finish processing a file.
|
|
|
|
|
|
2014-01-18 06:30:01 +00:00
|
|
|
Also, note that if the time limit prevents git-annex from doing all it
|
2012-09-25 20:48:24 +00:00
|
|
|
was asked to, it will exit with a special code, 101.
|
|
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `--trust=repository`
|
|
|
|
|
* `--semitrust=repository`
|
|
|
|
|
* `--untrust=repository`
|
2011-06-01 21:49:37 +00:00
|
|
|
|
|
|
|
|
Overrides trust settings for a repository. May be specified more than once.
|
2013-07-11 12:11:47 +00:00
|
|
|
|
2011-06-14 02:19:44 +00:00
|
|
|
The repository should be specified using the name of a configured remote,
|
|
|
|
|
or the UUID or description of a repository.
|
2011-06-01 21:49:37 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `--trust-glacier-inventory`
|
2012-11-20 20:43:58 +00:00
|
|
|
|
|
|
|
|
Amazon Glacier inventories take hours to retrieve, and may not represent
|
|
|
|
|
the current state of a repository. So git-annex does not trust that
|
|
|
|
|
files that the inventory claims are in Glacier are really there.
|
|
|
|
|
This switch can be used to allow it to trust the inventory.
|
|
|
|
|
|
|
|
|
|
Be careful using this, especially if you or someone else might have recently
|
|
|
|
|
removed a file from Glacier. If you try to drop the only other copy of the
|
2014-01-18 06:30:01 +00:00
|
|
|
file, and this switch is enabled, you could lose data!
|
2012-11-20 20:43:58 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `--backend=name`
|
2010-11-15 22:04:19 +00:00
|
|
|
|
2011-03-16 02:53:14 +00:00
|
|
|
Specifies which key-value backend to use. This can be used when
|
|
|
|
|
adding a file to the annex, or migrating a file. Once files
|
|
|
|
|
are in the annex, their backend is known and this option is not
|
|
|
|
|
necessary.
|
2010-11-15 22:04:19 +00:00
|
|
|
|
2013-09-28 18:35:21 +00:00
|
|
|
* `--user-agent=value`
|
|
|
|
|
|
|
|
|
|
Overrides the User-Agent to use when downloading files from the web.
|
|
|
|
|
|
2014-03-22 14:42:38 +00:00
|
|
|
* `--notify-finish`
|
|
|
|
|
|
|
|
|
|
Caused a desktop notification to be displayed after each successful
|
|
|
|
|
file download and upload.
|
|
|
|
|
|
2014-08-19 05:22:24 +00:00
|
|
|
(Only supported on some platforms, e.g. Linux with dbus. A no-op when
|
2014-03-22 14:42:38 +00:00
|
|
|
not supported.)
|
|
|
|
|
|
|
|
|
|
* `--notify-start`
|
|
|
|
|
|
|
|
|
|
Caused a desktop notification to be displayed when a file upload
|
2014-03-22 19:01:48 +00:00
|
|
|
or download has started, or when a file is dropped.
|
2014-03-22 14:42:38 +00:00
|
|
|
|
2013-09-11 01:12:30 +00:00
|
|
|
* `-c name=value`
|
2011-07-14 20:44:23 +00:00
|
|
|
|
2014-01-18 06:30:01 +00:00
|
|
|
Overrides git configuration settings. May be specified multiple times.
|
2011-07-14 20:44:23 +00:00
|
|
|
|
2013-10-13 19:40:38 +00:00
|
|
|
# CONFIGURATION VIA .git/config
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2010-11-28 21:54:42 +00:00
|
|
|
Like other git commands, git-annex is configured via `.git/config`.
|
2010-11-01 04:17:26 +00:00
|
|
|
Here are all the supported configuration settings.
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2010-12-10 21:30:13 +00:00
|
|
|
* `annex.uuid`
|
|
|
|
|
|
|
|
|
|
A unique UUID for this repository (automatically set).
|
|
|
|
|
|
2017-05-09 19:04:07 +00:00
|
|
|
* `annex.backend`
|
2010-12-10 21:30:13 +00:00
|
|
|
|
2017-05-09 19:04:07 +00:00
|
|
|
Name of the default key-value backend to use when adding new files
|
|
|
|
|
to the repository.
|
2010-12-10 21:30:13 +00:00
|
|
|
|
2016-02-02 19:18:17 +00:00
|
|
|
This is overridden by annex annex.backend configuration in the
|
2017-05-09 19:04:07 +00:00
|
|
|
.gitattributes files, and by the --backend option.
|
|
|
|
|
|
|
|
|
|
(This used to be named `annex.backends`, and that will still be used
|
|
|
|
|
if set.)
|
2016-02-02 19:18:17 +00:00
|
|
|
|
2017-02-27 17:50:00 +00:00
|
|
|
* `annex.securehashesonly`
|
|
|
|
|
|
|
|
|
|
Set to true to indicate that the repository should only use
|
|
|
|
|
cryptographically secure hashes
|
|
|
|
|
(SHA2, SHA3) and not insecure hashes (MD5, SHA1) for content.
|
|
|
|
|
|
|
|
|
|
When this is set, the contents of files using cryptographically
|
|
|
|
|
insecure hashes will not be allowed to be added to the repository.
|
|
|
|
|
|
|
|
|
|
Also, git-annex fsck` will complain about any files present in
|
|
|
|
|
the repository that use insecure hashes.
|
2017-02-27 20:08:16 +00:00
|
|
|
|
|
|
|
|
To configure the behavior in new clones of the repository,
|
|
|
|
|
this can be set in [[git-annex-config]].
|
2017-02-27 17:50:00 +00:00
|
|
|
|
2011-10-14 22:23:17 +00:00
|
|
|
* `annex.diskreserve`
|
|
|
|
|
|
|
|
|
|
Amount of disk space to reserve. Disk space is checked when transferring
|
|
|
|
|
content to avoid running out, and additional free space can be reserved
|
|
|
|
|
via this option, to make space for more important content (such as git
|
|
|
|
|
commit logs). Can be specified with any commonly used units, for example,
|
2013-12-23 17:50:51 +00:00
|
|
|
"0.5 gb", "500M", or "100 KiloBytes"
|
2011-10-14 22:23:17 +00:00
|
|
|
|
|
|
|
|
The default reserve is 1 megabyte.
|
|
|
|
|
|
2013-03-29 20:17:13 +00:00
|
|
|
* `annex.largefiles`
|
|
|
|
|
|
2016-02-02 20:50:58 +00:00
|
|
|
Used to configure which files are large enough to be added to the annex.
|
|
|
|
|
Default: All files.
|
|
|
|
|
|
|
|
|
|
Overrides any annex.largefiles attributes in `.gitattributes` files.
|
|
|
|
|
|
|
|
|
|
See <https://git-annex.branchable.com/tips/largefiles> for details.
|
2013-03-29 20:17:13 +00:00
|
|
|
|
2016-01-28 18:04:32 +00:00
|
|
|
* `annex.addsmallfiles`
|
|
|
|
|
|
|
|
|
|
Controls whether small files (not matching annex.largefiles)
|
|
|
|
|
should be checked into git by `git annex add`. Defaults to true;
|
|
|
|
|
set to false to instead make small files be skipped.
|
|
|
|
|
|
2016-02-16 18:43:43 +00:00
|
|
|
* `annex.addunlocked`
|
|
|
|
|
|
|
|
|
|
Set to true to make commands like `git-annex add` that add files to the
|
|
|
|
|
repository add them in unlocked form. The default is to add files in
|
|
|
|
|
locked form. This only has effect in version 6 repositories.
|
|
|
|
|
|
|
|
|
|
When a repository has core.symlinks set to false, it implicitly
|
|
|
|
|
sets annex.addunlocked to true.
|
|
|
|
|
|
2014-01-20 20:47:56 +00:00
|
|
|
* `annex.numcopies`
|
|
|
|
|
|
|
|
|
|
This is a deprecated setting. You should instead use the
|
|
|
|
|
`git annex numcopies` command to configure how many copies of files
|
2016-02-02 19:18:17 +00:00
|
|
|
are kept across all repositories, or the annex.numcopies .gitattributes
|
|
|
|
|
setting.
|
2014-01-20 20:47:56 +00:00
|
|
|
|
|
|
|
|
This config setting is only looked at when `git annex numcopies` has
|
2016-02-02 19:18:17 +00:00
|
|
|
never been configured, and when there's no annex.numcopies setting in the
|
|
|
|
|
.gitattributes file.
|
2014-01-20 20:47:56 +00:00
|
|
|
|
|
|
|
|
Note that setting numcopies to 0 is very unsafe.
|
|
|
|
|
|
2014-02-23 04:08:29 +00:00
|
|
|
* `annex.genmetadata`
|
|
|
|
|
|
|
|
|
|
Set this to `true` to make git-annex automatically generate some metadata
|
2014-08-19 05:22:24 +00:00
|
|
|
when adding files to the repository.
|
|
|
|
|
|
2017-10-25 19:11:12 +00:00
|
|
|
In particular, it stores year, month, and day metadata, from the file's
|
import metadata from feeds
When annex.genmetadata is set, metadata from the feed is added to files
that are imported from it.
Reused the same feedtitle and itemtitle, feedauthor, itemauthor, etc names
that are used in --template.
Also added title and author, which are the item title/author if available,
falling back to the feed title/author. These are more likely to be common
metadata fields.
(There is a small bit of dupication here, but once git gets
around to packing the object, it will compress it away.)
The itempubdate field is not included in the metadata as a string; instead
it is used to generate year and month fields, same as is done when adding
files with annex.genmetadata set.
This commit was sponsored by Amitai Schlair, who cooincidentially
is responsible for ikiwiki generating nice feed metadata!
2014-07-03 17:46:09 +00:00
|
|
|
modification date.
|
|
|
|
|
|
2015-03-31 17:29:51 +00:00
|
|
|
When importfeed is used, it stores additional metadata from the feed,
|
|
|
|
|
such as the author, title, etc.
|
2014-02-23 04:08:29 +00:00
|
|
|
|
2015-05-14 19:44:08 +00:00
|
|
|
* `annex.used-refspec`
|
|
|
|
|
|
|
|
|
|
This controls which refs `git-annex unused` considers to be used.
|
|
|
|
|
See REFSPEC FORMAT in [[git-annex-unused]](1) for details.
|
|
|
|
|
|
2012-02-15 15:13:13 +00:00
|
|
|
* `annex.queuesize`
|
|
|
|
|
|
|
|
|
|
git-annex builds a queue of git commands, in order to combine similar
|
|
|
|
|
commands for speed. By default the size of the queue is limited to
|
|
|
|
|
10240 commands; this can be used to change the size. If you have plenty
|
|
|
|
|
of memory and are working with very large numbers of files, increasing
|
|
|
|
|
the queue size can speed it up.
|
|
|
|
|
|
2012-03-12 20:18:14 +00:00
|
|
|
* `annex.bloomcapacity`
|
|
|
|
|
|
2015-06-16 21:58:15 +00:00
|
|
|
The `git annex unused` and `git annex sync --content` commands use
|
|
|
|
|
a bloom filter to determine what files are present in eg, the work tree.
|
|
|
|
|
The default bloom filter is sized to handle
|
|
|
|
|
up to 500000 files. If your repository is larger than that,
|
|
|
|
|
you should increase this value. Larger values will
|
|
|
|
|
make `git-annex unused` and `git annex sync --content` consume more memory;
|
2013-11-07 16:45:59 +00:00
|
|
|
run `git annex info` for memory usage numbers.
|
2012-03-12 20:18:14 +00:00
|
|
|
|
|
|
|
|
* `annex.bloomaccuracy`
|
|
|
|
|
|
|
|
|
|
Adjusts the accuracy of the bloom filter used by
|
2015-06-16 21:58:15 +00:00
|
|
|
`git annex unused` and `git annex sync --content`.
|
|
|
|
|
The default accuracy is 10000000 -- 1 unused file out of 10000000
|
|
|
|
|
will be missed by `git annex unused`. Increasing the accuracy will make
|
|
|
|
|
`git annex unused` consume more memory; run `git annex info`
|
|
|
|
|
for memory usage numbers.
|
2012-03-12 20:18:14 +00:00
|
|
|
|
2012-01-20 21:13:36 +00:00
|
|
|
* `annex.sshcaching`
|
|
|
|
|
|
2014-02-02 23:27:47 +00:00
|
|
|
By default, git-annex caches ssh connections using ssh's
|
|
|
|
|
ControlMaster and ControlPersist settings
|
2012-02-25 23:15:29 +00:00
|
|
|
(if built using a new enough ssh). To disable this, set to `false`.
|
2012-01-20 21:13:36 +00:00
|
|
|
|
2012-02-25 19:23:17 +00:00
|
|
|
* `annex.alwayscommit`
|
|
|
|
|
|
|
|
|
|
By default, git-annex automatically commits data to the git-annex branch
|
2014-07-14 18:37:14 +00:00
|
|
|
after each command is run. If you have a series
|
2014-08-19 05:22:24 +00:00
|
|
|
of commands that you want to make a single commit, you can
|
2014-07-14 18:37:14 +00:00
|
|
|
run the commands with `-c annex.alwayscommit=false`. You can later
|
|
|
|
|
commit the data by running `git annex merge` (or by automatic merges)
|
|
|
|
|
or `git annex sync`.
|
2012-02-25 19:23:17 +00:00
|
|
|
|
2018-02-22 17:55:09 +00:00
|
|
|
You should beware running `git gc` when using this configuration,
|
2015-07-02 19:21:25 +00:00
|
|
|
since it could garbage collect objects that are staged in git-annex's
|
|
|
|
|
index but not yet committed.
|
|
|
|
|
|
2018-02-22 18:25:32 +00:00
|
|
|
* `annex.merge-annex-branches`
|
|
|
|
|
|
|
|
|
|
By default, git-annex branches that have been pulled from remotes
|
|
|
|
|
are automatically merged into the local git-annex branch, so that
|
|
|
|
|
git-annex has the most up-to-date possible knowledge.
|
|
|
|
|
|
|
|
|
|
To avoid that merging, set this to "false". This can be useful
|
|
|
|
|
particularly when you don't have write permission to the repository.
|
|
|
|
|
|
2014-09-05 17:44:09 +00:00
|
|
|
* `annex.hardlink`
|
|
|
|
|
|
2015-09-14 16:13:38 +00:00
|
|
|
Set this to `true` to make file contents be hard linked between the
|
|
|
|
|
repository and its remotes when possible, instead of a more expensive copy.
|
2014-09-05 17:44:09 +00:00
|
|
|
|
|
|
|
|
Use with caution -- This can invalidate numcopies counting, since
|
|
|
|
|
with hard links, fewer copies of a file can exist. So, it is a good
|
|
|
|
|
idea to mark a repository using this setting as untrusted.
|
|
|
|
|
|
|
|
|
|
When a repository is set up using `git clone --shared`, git-annex init
|
|
|
|
|
will automatically set annex.hardlink and mark the repository as
|
|
|
|
|
untrusted.
|
|
|
|
|
|
2015-12-27 19:59:59 +00:00
|
|
|
* `annex.thin`
|
|
|
|
|
|
|
|
|
|
Set this to `true` to make unlocked files be a hard link to their content
|
|
|
|
|
in the annex, rather than a second copy. (Only when supported by the file
|
|
|
|
|
system, and only in repository version 6.) This can save considerable
|
2016-04-13 17:34:24 +00:00
|
|
|
disk space, but when a modification is made to a file, you will lose the
|
|
|
|
|
local (and possibly only) copy of the old version. So, enable with care.
|
2015-12-27 19:59:59 +00:00
|
|
|
|
2016-04-13 16:48:44 +00:00
|
|
|
After setting (or unsetting) this, you should run `git annex fix` to
|
|
|
|
|
fix up the annexed files in the work tree to be hard links (or copies).
|
|
|
|
|
|
|
|
|
|
Note that `annex.thin` is not honored when git updates an annexed file
|
|
|
|
|
in the working tree. So when `git checkout` or `git merge` updates the
|
|
|
|
|
working tree, a second copy of annexed files will result. You can run
|
|
|
|
|
`git-annex fix` to fix up the hard links after running such git commands.
|
|
|
|
|
|
2012-09-19 17:30:25 +00:00
|
|
|
* `annex.delayadd`
|
|
|
|
|
|
|
|
|
|
Makes the watch and assistant commands delay for the specified number of
|
|
|
|
|
seconds before adding a newly created file to the annex. Normally this
|
|
|
|
|
is not needed, because they already wait for all writers of the file
|
2012-12-28 20:42:11 +00:00
|
|
|
to close it. On Mac OSX, when not using direct mode this defaults to
|
|
|
|
|
1 second, to work around a bad interaction with software there.
|
2012-09-19 17:30:25 +00:00
|
|
|
|
assistant unused file handling
Make sanity checker run git annex unused daily, and queue up transfers
of unused files to any remotes that will have them. The transfer retrying
code works for us here, so eg when a backup disk remote is plugged in,
any transfers to it are done. Once the unused files reach a remote,
they'll be removed locally as unwanted.
If the setup does not cause unused files to go to a remote, they'll pile
up, and the sanity checker detects this using some heuristics that are
pretty good -- 1000 unused files, or 10% of disk used by unused files,
or more disk wasted by unused files than is left free. Once it detects
this, it pops up an alert in the webapp, with a button to take action.
TODO: Webapp UI to configure this, and also the ability to launch an
immediate cleanup of all unused files.
This commit was sponsored by Simon Michael.
2014-01-23 02:48:56 +00:00
|
|
|
* `annex.expireunused`
|
|
|
|
|
|
|
|
|
|
Controls what the assistant does about unused file contents
|
|
|
|
|
that are stored in the repository.
|
2014-08-19 05:22:24 +00:00
|
|
|
|
assistant unused file handling
Make sanity checker run git annex unused daily, and queue up transfers
of unused files to any remotes that will have them. The transfer retrying
code works for us here, so eg when a backup disk remote is plugged in,
any transfers to it are done. Once the unused files reach a remote,
they'll be removed locally as unwanted.
If the setup does not cause unused files to go to a remote, they'll pile
up, and the sanity checker detects this using some heuristics that are
pretty good -- 1000 unused files, or 10% of disk used by unused files,
or more disk wasted by unused files than is left free. Once it detects
this, it pops up an alert in the webapp, with a button to take action.
TODO: Webapp UI to configure this, and also the ability to launch an
immediate cleanup of all unused files.
This commit was sponsored by Simon Michael.
2014-01-23 02:48:56 +00:00
|
|
|
The default is `false`, which causes
|
|
|
|
|
all old and unused file contents to be retained, unless the assistant
|
|
|
|
|
is able to move them to some other repository (such as a backup repository).
|
|
|
|
|
|
|
|
|
|
Can be set to a time specification, like "7d" or "1m", and then
|
|
|
|
|
file contents that have been known to be unused for a week or a
|
|
|
|
|
month will be deleted.
|
|
|
|
|
|
2013-10-29 20:48:06 +00:00
|
|
|
* `annex.fscknudge`
|
|
|
|
|
|
|
|
|
|
When set to false, prevents the webapp from reminding you when using
|
|
|
|
|
repositories that lack consistency checks.
|
|
|
|
|
|
2013-11-22 20:04:20 +00:00
|
|
|
* `annex.autoupgrade`
|
|
|
|
|
|
|
|
|
|
When set to ask (the default), the webapp will check for new versions
|
|
|
|
|
and prompt if they should be upgraded to. When set to true, automatically
|
|
|
|
|
upgrades without prompting (on some supported platforms). When set to
|
|
|
|
|
false, disables any upgrade checking.
|
|
|
|
|
|
|
|
|
|
Note that upgrade checking is only done when git-annex is installed
|
|
|
|
|
from one of the prebuilt images from its website. This does not
|
2013-12-04 06:10:18 +00:00
|
|
|
bypass e.g., a Linux distribution's own upgrade handling code.
|
2013-11-22 20:04:20 +00:00
|
|
|
|
|
|
|
|
This setting also controls whether to restart the git-annex assistant
|
|
|
|
|
when the git-annex binary is detected to have changed. That is useful
|
|
|
|
|
no matter how you installed git-annex.
|
|
|
|
|
|
2013-02-14 18:10:36 +00:00
|
|
|
* `annex.autocommit`
|
|
|
|
|
|
2015-07-07 20:36:11 +00:00
|
|
|
Set to false to prevent the git-annex assistant and git-annex sync
|
|
|
|
|
from automatically committing changes to files in the repository.
|
2013-02-14 18:10:36 +00:00
|
|
|
|
2017-02-03 17:40:14 +00:00
|
|
|
To configure the behavior in all clones of the repository,
|
2017-06-01 16:46:36 +00:00
|
|
|
this can be set in [[git-annex-config]].
|
|
|
|
|
|
|
|
|
|
* `annex.resolvemerge`
|
|
|
|
|
|
2018-02-22 18:25:32 +00:00
|
|
|
Set to false to prevent merge conflicts in the checked out branch
|
|
|
|
|
being automatically resolved by the git-annex assitant,
|
|
|
|
|
git-annex sync, git-annex merge,
|
2017-06-01 16:46:36 +00:00
|
|
|
and the git-annex post-receive hook.
|
|
|
|
|
|
|
|
|
|
To configure the behavior in all clones of the repository,
|
2017-02-03 17:40:14 +00:00
|
|
|
this can be set in [[git-annex-config]].
|
2017-01-30 20:41:29 +00:00
|
|
|
|
2017-02-03 18:31:17 +00:00
|
|
|
* `annex.synccontent`
|
|
|
|
|
|
|
|
|
|
Set to true to make git-annex sync default to syncing content.
|
|
|
|
|
|
|
|
|
|
To configure the behavior in all clones of the repository,
|
|
|
|
|
this can be set in [[git-annex-config]].
|
|
|
|
|
|
2014-03-05 21:44:14 +00:00
|
|
|
* `annex.startupscan`
|
|
|
|
|
|
|
|
|
|
Set to false to prevent the git-annex assistant from scanning the
|
|
|
|
|
repository for new and changed files on startup. This will prevent it
|
|
|
|
|
from noticing changes that were made while it was not running, but can be
|
|
|
|
|
a useful performance tweak for a large repository.
|
|
|
|
|
|
2014-03-01 04:31:17 +00:00
|
|
|
* `annex.listen`
|
|
|
|
|
|
|
|
|
|
Configures which address the webapp listens on. The default is localhost.
|
|
|
|
|
Can be either an IP address, or a hostname that resolves to the desired
|
|
|
|
|
address.
|
|
|
|
|
|
2013-06-18 00:41:17 +00:00
|
|
|
* `annex.debug`
|
|
|
|
|
|
|
|
|
|
Set to true to enable debug logging by default.
|
|
|
|
|
|
2013-03-29 20:17:13 +00:00
|
|
|
* `annex.version`
|
|
|
|
|
|
|
|
|
|
Automatically maintained, and used to automate upgrades between versions.
|
|
|
|
|
|
2012-12-07 17:17:13 +00:00
|
|
|
* `annex.direct`
|
|
|
|
|
|
2013-03-29 17:33:56 +00:00
|
|
|
Set to true when the repository is in direct mode. Should not be set
|
|
|
|
|
manually; use the "git annex direct" and "git annex indirect" commands
|
|
|
|
|
instead.
|
2012-12-07 17:17:13 +00:00
|
|
|
|
2013-02-14 18:10:36 +00:00
|
|
|
* `annex.crippledfilesystem`
|
2013-01-27 11:43:05 +00:00
|
|
|
|
2013-02-14 18:10:36 +00:00
|
|
|
Set to true if the repository is on a crippled filesystem, such as FAT,
|
|
|
|
|
which does not support symbolic links, or hard links, or unix permissions.
|
|
|
|
|
This is automatically probed by "git annex init".
|
2013-01-27 11:43:05 +00:00
|
|
|
|
2015-11-12 21:47:31 +00:00
|
|
|
* `annex.pidlock`
|
|
|
|
|
|
|
|
|
|
Normally, git-annex uses fine-grained lock files to allow multiple
|
|
|
|
|
processes to run concurrently without getting in each others' way.
|
|
|
|
|
That works great, unless you are using git-annex on a filesystem that
|
|
|
|
|
does not support POSIX fcntl locks. This is sometimes the case when
|
|
|
|
|
using NFS or Lustre filesystems.
|
|
|
|
|
|
|
|
|
|
To support such situations, you can set annex.pidlock to true, and it
|
|
|
|
|
will fall back to a single top-level pid file lock.
|
|
|
|
|
|
2015-11-13 19:55:16 +00:00
|
|
|
Although, often, you'd really be better off fixing your networked
|
|
|
|
|
filesystem configuration to support POSIX locks.. And, some networked
|
|
|
|
|
filesystems are so inconsistent that one node can't reliably tell when
|
|
|
|
|
the other node is holding a pid lock. Caveat emptor.
|
2015-11-12 21:47:31 +00:00
|
|
|
|
|
|
|
|
* `annex.pidlocktimeout`
|
|
|
|
|
|
|
|
|
|
When using pid lock files, it's possible for a stale lock file to get
|
|
|
|
|
left behind by previous run of git-annex that crashed or was interrupted.
|
|
|
|
|
This is mostly avoided, but can occur especially when using a network
|
|
|
|
|
file system.
|
|
|
|
|
|
|
|
|
|
git-annex will wait up to this many seconds for the pid lock
|
|
|
|
|
file to go away, and will then abort if it cannot continue. Default: 300
|
|
|
|
|
|
2010-12-10 21:30:13 +00:00
|
|
|
* `remote.<name>.annex-cost`
|
|
|
|
|
|
|
|
|
|
When determining which repository to
|
2010-10-09 18:06:25 +00:00
|
|
|
transfer annexed files from or to, ones with lower costs are preferred.
|
2010-10-13 00:26:02 +00:00
|
|
|
The default cost is 100 for local repositories, and 200 for remote
|
2010-11-01 04:26:47 +00:00
|
|
|
repositories.
|
2010-12-10 21:30:13 +00:00
|
|
|
|
2011-08-18 16:20:47 +00:00
|
|
|
* `remote.<name>.annex-cost-command`
|
|
|
|
|
|
|
|
|
|
If set, the command is run, and the number it outputs is used as the cost.
|
2017-08-17 16:26:14 +00:00
|
|
|
This allows varying the cost based on e.g., the current network.
|
2011-08-18 16:20:47 +00:00
|
|
|
|
2012-03-04 20:00:24 +00:00
|
|
|
* `remote.<name>.annex-start-command`
|
|
|
|
|
|
|
|
|
|
A command to run when git-annex begins to use the remote. This can
|
|
|
|
|
be used to, for example, mount the directory containing the remote.
|
|
|
|
|
|
2012-03-16 20:03:04 +00:00
|
|
|
The command may be run repeatedly when multiple git-annex processes
|
2012-03-04 20:00:24 +00:00
|
|
|
are running concurrently.
|
|
|
|
|
|
|
|
|
|
* `remote.<name>.annex-stop-command`
|
|
|
|
|
|
|
|
|
|
A command to run when git-annex is done using the remote.
|
|
|
|
|
|
|
|
|
|
The command will only be run once *all* running git-annex processes
|
|
|
|
|
are finished using the remote.
|
|
|
|
|
|
2014-05-16 11:34:43 +00:00
|
|
|
* `remote.<name>.annex-shell`
|
|
|
|
|
|
|
|
|
|
Specify an alternative git-annex-shell executable on the remote
|
|
|
|
|
instead of looking for "git-annex-shell" on the PATH.
|
|
|
|
|
|
|
|
|
|
This is useful if the git-annex-shell program is outside the PATH
|
|
|
|
|
or has a non-standard name.
|
|
|
|
|
|
2010-12-10 21:30:13 +00:00
|
|
|
* `remote.<name>.annex-ignore`
|
|
|
|
|
|
|
|
|
|
If set to `true`, prevents git-annex
|
2013-04-22 18:57:09 +00:00
|
|
|
from storing file contents on this remote by default.
|
2013-09-11 00:47:13 +00:00
|
|
|
(You can still request it be used by the `--from` and `--to` options.)
|
2011-01-25 22:54:34 +00:00
|
|
|
|
2011-03-03 19:59:16 +00:00
|
|
|
This is, for example, useful if the remote is located somewhere
|
2011-04-09 19:57:45 +00:00
|
|
|
without git-annex-shell. (For example, if it's on GitHub).
|
2011-03-03 19:59:16 +00:00
|
|
|
Or, it could be used if the network connection between two
|
|
|
|
|
repositories is too slow to be used normally.
|
2010-12-10 21:30:13 +00:00
|
|
|
|
2013-04-22 18:57:09 +00:00
|
|
|
This does not prevent git-annex sync (or the git-annex assistant) from
|
|
|
|
|
syncing the git repository to the remote.
|
|
|
|
|
|
2017-08-17 16:26:14 +00:00
|
|
|
* `remote.<name>.annex-ignore-command`
|
|
|
|
|
|
|
|
|
|
If set, the command is run, and if it exits nonzero, that's the same
|
|
|
|
|
as setting annex-ignore to true. This allows controlling behavior based
|
|
|
|
|
on e.g., the current network.
|
|
|
|
|
|
2012-10-11 22:39:21 +00:00
|
|
|
* `remote.<name>.annex-sync`
|
|
|
|
|
|
|
|
|
|
If set to `false`, prevents git-annex sync (and the git-annex assistant)
|
Added remote.<name>.annex-push and remote.<name>.annex-pull
The former can be useful to make remotes that don't get fully synced with
local changes, which comes up in a lot of situations.
The latter was mostly added for symmetry, but could be useful (though less
likely to be).
Implementing `remote.<name>.annex-pull` was a bit tricky, as there's no one
place where git-annex pulls/fetches from remotes. I audited all
instances of "fetch" and "pull". A few cases were left not checking this
config:
* Git.Repair can try to pull missing refs from a remote, and if the local
repo is corrupted, that seems a reasonable thing to do even though
the config would normally prevent it.
* Assistant.WebApp.Gpg and Remote.Gcrypt and Remote.Git do fetches
as part of the setup process of a remote. The config would probably not
be set then, and having the setup fail seems worse than honoring it if it
is already set.
I have not prevented all the code that does a "merge" from merging branches
from remotes with remote.<name>.annex-pull=false. That could perhaps
be done, but it would need a way to map from branch name to remote name,
and the way refspecs work makes that hard to get really correct. So if the
user fetches manually, the git-annex branch will get merged, for example.
Anther way of looking at/justifying this is that the setting is called
"annex-pull", not "annex-merge".
This commit was supported by the NSF-funded DataLad project.
2017-04-05 17:04:02 +00:00
|
|
|
from syncing with this remote by default. However, `git annex sync <name>`
|
|
|
|
|
can still be used to sync with the remote.
|
|
|
|
|
|
2017-08-17 16:26:14 +00:00
|
|
|
* `remote.<name>.annex-sync-command`
|
|
|
|
|
|
|
|
|
|
If set, the command is run, and if it exits nonzero, that's the same
|
|
|
|
|
as setting annex-sync to false. This allows controlling behavior based
|
|
|
|
|
on e.g., the current network.
|
|
|
|
|
|
Added remote.<name>.annex-push and remote.<name>.annex-pull
The former can be useful to make remotes that don't get fully synced with
local changes, which comes up in a lot of situations.
The latter was mostly added for symmetry, but could be useful (though less
likely to be).
Implementing `remote.<name>.annex-pull` was a bit tricky, as there's no one
place where git-annex pulls/fetches from remotes. I audited all
instances of "fetch" and "pull". A few cases were left not checking this
config:
* Git.Repair can try to pull missing refs from a remote, and if the local
repo is corrupted, that seems a reasonable thing to do even though
the config would normally prevent it.
* Assistant.WebApp.Gpg and Remote.Gcrypt and Remote.Git do fetches
as part of the setup process of a remote. The config would probably not
be set then, and having the setup fail seems worse than honoring it if it
is already set.
I have not prevented all the code that does a "merge" from merging branches
from remotes with remote.<name>.annex-pull=false. That could perhaps
be done, but it would need a way to map from branch name to remote name,
and the way refspecs work makes that hard to get really correct. So if the
user fetches manually, the git-annex branch will get merged, for example.
Anther way of looking at/justifying this is that the setting is called
"annex-pull", not "annex-merge".
This commit was supported by the NSF-funded DataLad project.
2017-04-05 17:04:02 +00:00
|
|
|
* `remote.<name>.annex-pull`
|
|
|
|
|
|
|
|
|
|
If set to `false`, prevents git-annex sync (and the git-annex assistant
|
|
|
|
|
etc) from ever pulling (or fetching) from the remote.
|
|
|
|
|
|
|
|
|
|
* `remote.<name>.annex-push`
|
|
|
|
|
|
|
|
|
|
If set to `false`, prevents git-annex sync (and the git-annex assistant
|
|
|
|
|
etc) from ever pushing to the remote.
|
2012-10-11 22:39:21 +00:00
|
|
|
|
2014-01-02 17:12:32 +00:00
|
|
|
* `remote.<name>.annex-readonly`
|
|
|
|
|
|
|
|
|
|
If set to `true`, prevents git-annex from making changes to a remote.
|
|
|
|
|
This both prevents git-annex sync from pushing changes, and prevents
|
|
|
|
|
storing or removing files from read-only remote.
|
|
|
|
|
|
Do verification of checksums of annex objects downloaded from remotes.
* When annex objects are received into git repositories, their checksums are
verified then too.
* To get the old, faster, behavior of not verifying checksums, set
annex.verify=false, or remote.<name>.annex-verify=false.
* setkey, rekey: These commands also now verify that the provided file
matches the key, unless annex.verify=false.
* reinject: Already verified content; this can now be disabled by
setting annex.verify=false.
recvkey and reinject already did verification, so removed now duplicate
code from them. fsck still does its own verification, which is ok since it
does not use getViaTmp, so verification doesn't happen twice when using fsck
--from.
2015-10-01 19:54:37 +00:00
|
|
|
* `remote.<name>.annex-verify`, `annex.verify`
|
|
|
|
|
|
|
|
|
|
By default, git-annex will verify the checksums of objects downloaded
|
|
|
|
|
from remotes. If you trust a remote and don't want the overhead
|
|
|
|
|
of these checksums, you can set this to `false`.
|
|
|
|
|
|
2018-03-13 18:50:49 +00:00
|
|
|
Note that even when this is set to `false`, git-annex does verification
|
|
|
|
|
in some edge cases, where it's likely the case than an
|
|
|
|
|
object was downloaded incorrectly.
|
|
|
|
|
|
2017-09-19 17:05:43 +00:00
|
|
|
* `remote.<name>.annex-export-tracking`
|
|
|
|
|
|
|
|
|
|
When set to a branch name or other treeish, this makes what's exported
|
|
|
|
|
to the special remote track changes to the branch. See
|
|
|
|
|
[[git-annex-export]](1). `git-annex sync --content` and the
|
|
|
|
|
git-annex assistant update exports when changes have been
|
|
|
|
|
committed to the tracking branch.
|
|
|
|
|
|
2011-10-14 22:17:46 +00:00
|
|
|
* `remote.<name>.annexUrl`
|
|
|
|
|
|
|
|
|
|
Can be used to specify a different url than the regular `remote.<name>.url`
|
|
|
|
|
for git-annex to use when talking with the remote. Similar to the `pushUrl`
|
|
|
|
|
used by git-push.
|
|
|
|
|
|
2010-12-10 21:30:13 +00:00
|
|
|
* `remote.<name>.annex-uuid`
|
|
|
|
|
|
2011-03-29 02:05:11 +00:00
|
|
|
git-annex caches UUIDs of remote repositories here.
|
2010-12-10 21:30:13 +00:00
|
|
|
|
2018-03-24 14:37:25 +00:00
|
|
|
* `remote.<name>.annex-retry`, `annex.retry`
|
|
|
|
|
|
|
|
|
|
Configure retries of failed transfers on a per-remote and general
|
|
|
|
|
basis, respectively. The value is the number of retries that can be
|
|
|
|
|
made of the same transfer. (default 0)
|
|
|
|
|
|
|
|
|
|
* `remote.<name>.annex-retry-delay`, `annex.retry-delay`
|
|
|
|
|
|
|
|
|
|
Number of seconds to delay before the first retry of a transfer.
|
|
|
|
|
When making multiple retries of the same transfer, the delay
|
|
|
|
|
doubles after each retry. (default 1)
|
|
|
|
|
|
2018-03-08 16:54:56 +00:00
|
|
|
* `remote.<name>.annex-checkuuid`
|
2018-01-10 18:21:18 +00:00
|
|
|
|
|
|
|
|
This only affects remotes that have their url pointing to a directory on
|
|
|
|
|
the same system. git-annex normally checks the uuid of such
|
|
|
|
|
remotes each time it's run, which lets it transparently deal with
|
|
|
|
|
different drives being mounted to the location at different times.
|
|
|
|
|
|
|
|
|
|
Setting annex-checkuuid to false will prevent it from checking the uuid
|
|
|
|
|
at startup (although the uuid is still verified before making any
|
|
|
|
|
changes to the remote repository). This may be useful to set to prevent
|
|
|
|
|
unncessary spin-up or automounting of a drive.
|
|
|
|
|
|
2012-01-10 03:31:44 +00:00
|
|
|
* `remote.<name>.annex-trustlevel`
|
|
|
|
|
|
|
|
|
|
Configures a local trust level for the remote. This overrides the value
|
|
|
|
|
configured by the trust and untrust commands. The value can be any of
|
|
|
|
|
"trusted", "semitrusted" or "untrusted".
|
|
|
|
|
|
2014-01-26 17:03:25 +00:00
|
|
|
* `remote.<name>.annex-availability`
|
2014-01-13 18:41:10 +00:00
|
|
|
|
|
|
|
|
Can be used to tell git-annex whether a remote is LocallyAvailable
|
|
|
|
|
or GloballyAvailable. Normally, git-annex determines this automatically.
|
|
|
|
|
|
2014-01-26 17:03:25 +00:00
|
|
|
* `remote.<name>.annex-bare`
|
|
|
|
|
|
|
|
|
|
Can be used to tell git-annex if a remote is a bare repository
|
|
|
|
|
or not. Normally, git-annex determines this automatically.
|
|
|
|
|
|
2010-12-10 21:30:13 +00:00
|
|
|
* `remote.<name>.annex-ssh-options`
|
|
|
|
|
|
2011-03-29 02:05:11 +00:00
|
|
|
Options to use when using ssh to talk to this remote.
|
2010-12-10 21:30:13 +00:00
|
|
|
|
|
|
|
|
* `remote.<name>.annex-rsync-options`
|
|
|
|
|
|
|
|
|
|
Options to use when using rsync
|
2015-07-26 02:21:06 +00:00
|
|
|
to or from this remote. For example, to force IPv6, and limit
|
2013-09-11 01:02:55 +00:00
|
|
|
the bandwidth to 100Kbyte/s, set it to `-6 --bwlimit 100`
|
2010-12-10 21:30:13 +00:00
|
|
|
|
2017-05-09 18:02:48 +00:00
|
|
|
Note that git-annex-shell has a whitelist of allowed rsync options,
|
|
|
|
|
and others will not be be passed to the remote rsync. So using some
|
|
|
|
|
options may break the communication between the local and remote rsyncs.
|
|
|
|
|
|
2014-02-02 20:06:34 +00:00
|
|
|
* `remote.<name>.annex-rsync-upload-options`
|
|
|
|
|
|
|
|
|
|
Options to use when using rsync to upload a file to a remote.
|
|
|
|
|
|
|
|
|
|
These options are passed after other applicable rsync options,
|
|
|
|
|
so can be used to override them. For example, to limit upload bandwidth
|
2014-08-19 05:22:24 +00:00
|
|
|
to 10Kbyte/s, set `--bwlimit 10`.
|
2014-02-02 20:06:34 +00:00
|
|
|
|
|
|
|
|
* `remote.<name>.annex-rsync-download-options`
|
|
|
|
|
|
|
|
|
|
Options to use when using rsync to download a file from a remote.
|
|
|
|
|
|
|
|
|
|
These options are passed after other applicable rsync options,
|
|
|
|
|
so can be used to override them.
|
|
|
|
|
|
2013-04-13 22:10:49 +00:00
|
|
|
* `remote.<name>.annex-rsync-transport`
|
|
|
|
|
|
|
|
|
|
The remote shell to use to connect to the rsync remote. Possible
|
|
|
|
|
values are `ssh` (the default) and `rsh`, together with their
|
|
|
|
|
arguments, for instance `ssh -p 2222 -c blowfish`; Note that the
|
|
|
|
|
remote hostname should not appear there, see rsync(1) for details.
|
|
|
|
|
When the transport used is `ssh`, connections are automatically cached
|
|
|
|
|
unless `annex.sshcaching` is unset.
|
|
|
|
|
|
2011-04-08 18:56:57 +00:00
|
|
|
* `remote.<name>.annex-bup-split-options`
|
2010-12-10 21:30:13 +00:00
|
|
|
|
2011-04-08 18:56:57 +00:00
|
|
|
Options to pass to bup split when storing content in this remote.
|
2013-09-11 01:02:55 +00:00
|
|
|
For example, to limit the bandwidth to 100Kbyte/s, set it to `--bwlimit 100k`
|
2011-04-08 18:56:57 +00:00
|
|
|
(There is no corresponding option for bup join.)
|
|
|
|
|
|
2013-03-11 01:33:13 +00:00
|
|
|
* `remote.<name>.annex-gnupg-options`
|
2011-04-08 18:56:57 +00:00
|
|
|
|
2016-05-10 17:03:56 +00:00
|
|
|
Options to pass to GnuPG when it's encrypting data. For instance, to
|
2013-03-11 01:33:13 +00:00
|
|
|
use the AES cipher with a 256 bits key and disable compression, set it
|
2013-09-11 01:02:55 +00:00
|
|
|
to `--cipher-algo AES256 --compress-algo none`. (These options take
|
2013-03-11 01:33:13 +00:00
|
|
|
precedence over the default GnuPG configuration, which is otherwise
|
|
|
|
|
used.)
|
|
|
|
|
|
2016-05-10 17:03:56 +00:00
|
|
|
* `remote.<name>.annex-gnupg-decrypt-options`
|
|
|
|
|
|
|
|
|
|
Options to pass to GnuPG when it's decrypting data. (These options take
|
|
|
|
|
precedence over the default GnuPG configuration, which is otherwise
|
|
|
|
|
used.)
|
|
|
|
|
|
2014-02-02 20:06:34 +00:00
|
|
|
* `annex.ssh-options`, `annex.rsync-options`,
|
|
|
|
|
`annex.rsync-upload-options`, `annex.rsync-download-options`,
|
2016-05-10 17:03:56 +00:00
|
|
|
`annex.bup-split-options`, `annex.gnupg-options`,
|
|
|
|
|
`annex.gnupg-decrypt-options`
|
2013-03-11 01:33:13 +00:00
|
|
|
|
2014-02-02 20:06:34 +00:00
|
|
|
Default options to use if a remote does not have more specific options
|
|
|
|
|
as described above.
|
2010-12-10 21:30:13 +00:00
|
|
|
|
2012-03-22 03:41:01 +00:00
|
|
|
* `annex.web-options`
|
|
|
|
|
|
2018-04-06 21:00:46 +00:00
|
|
|
Setting this makes git-annex use curl to download urls
|
|
|
|
|
(rather than the default built-in url downloader).
|
|
|
|
|
|
|
|
|
|
For example, to force IPv4 only, set it to "-4".
|
|
|
|
|
Or to make curl use your ~/.netrc file, set it to "--netrc".
|
2012-03-22 03:41:01 +00:00
|
|
|
|
2017-11-28 18:05:58 +00:00
|
|
|
* `annex.youtube-dl-options`
|
2013-08-22 22:25:21 +00:00
|
|
|
|
2017-11-28 18:05:58 +00:00
|
|
|
Options to pass to youtube-dl when using it to find the url to download
|
|
|
|
|
for a video.
|
|
|
|
|
|
|
|
|
|
Some options may break git-annex's integration with youtube-dl. For
|
|
|
|
|
example, the --output option could cause it to store files somewhere
|
2017-11-30 00:07:03 +00:00
|
|
|
git-annex won't find them. Avoid setting here or in the youtube-dl config
|
|
|
|
|
file any options that cause youtube-dl to download more than one file,
|
|
|
|
|
or to store the file anywhere other than the current working directory.
|
2013-08-22 22:25:21 +00:00
|
|
|
|
2014-12-17 03:22:46 +00:00
|
|
|
* `annex.aria-torrent-options`
|
|
|
|
|
|
|
|
|
|
Options to pass to aria2c when using it to download a torrent.
|
|
|
|
|
|
2012-04-22 05:13:09 +00:00
|
|
|
* `annex.http-headers`
|
|
|
|
|
|
|
|
|
|
HTTP headers to send when downloading from the web. Multiple lines of
|
|
|
|
|
this option can be set, one per header.
|
|
|
|
|
|
|
|
|
|
* `annex.http-headers-command`
|
|
|
|
|
|
|
|
|
|
If set, the command is run and each line of its output is used as a HTTP
|
|
|
|
|
header. This overrides annex.http-headers.
|
|
|
|
|
|
2013-04-09 03:34:05 +00:00
|
|
|
* `annex.web-download-command`
|
|
|
|
|
|
|
|
|
|
Use to specify a command to run to download a file from the web.
|
|
|
|
|
|
|
|
|
|
In the command line, %url is replaced with the url to download,
|
|
|
|
|
and %file is replaced with the file that it should be saved to.
|
2014-01-24 16:58:52 +00:00
|
|
|
|
|
|
|
|
* `annex.secure-erase-command`
|
|
|
|
|
|
|
|
|
|
This can be set to a command that should be run whenever git-annex
|
|
|
|
|
removes the content of a file from the repository.
|
|
|
|
|
|
|
|
|
|
In the command line, %file is replaced with the file that should be
|
|
|
|
|
erased.
|
|
|
|
|
|
2014-08-19 05:22:24 +00:00
|
|
|
For example, to use the wipe command, set it to `wipe -f %file`.
|
2013-04-09 03:34:05 +00:00
|
|
|
|
2012-03-16 20:00:08 +00:00
|
|
|
* `remote.<name>.rsyncurl`
|
|
|
|
|
|
2012-03-22 03:41:01 +00:00
|
|
|
Used by rsync special remotes, this configures
|
2012-11-18 02:09:29 +00:00
|
|
|
the location of the rsync repository to use. Normally this is automatically
|
2012-03-16 20:00:08 +00:00
|
|
|
set up by `git annex initremote`, but you can change it if needed.
|
|
|
|
|
|
2011-04-09 19:57:45 +00:00
|
|
|
* `remote.<name>.buprepo`
|
|
|
|
|
|
|
|
|
|
Used by bup special remotes, this configures
|
2012-11-18 02:09:29 +00:00
|
|
|
the location of the bup repository to use. Normally this is automatically
|
2011-04-09 19:57:45 +00:00
|
|
|
set up by `git annex initremote`, but you can change it if needed.
|
|
|
|
|
|
2014-05-15 18:44:00 +00:00
|
|
|
* `remote.<name>.ddarrepo`
|
|
|
|
|
|
|
|
|
|
Used by ddar special remotes, this configures
|
|
|
|
|
the location of the ddar repository to use. Normally this is automatically
|
|
|
|
|
set up by `git annex initremote`, but you can change it if needed.
|
|
|
|
|
|
2011-04-09 19:57:45 +00:00
|
|
|
* `remote.<name>.directory`
|
|
|
|
|
|
|
|
|
|
Used by directory special remotes, this configures
|
|
|
|
|
the location of the directory where annexed files are stored for this
|
2012-11-18 02:09:29 +00:00
|
|
|
remote. Normally this is automatically set up by `git annex initremote`,
|
2011-04-09 19:57:45 +00:00
|
|
|
but you can change it if needed.
|
|
|
|
|
|
2018-03-27 16:41:57 +00:00
|
|
|
* `remote.<name>.adb`
|
|
|
|
|
|
|
|
|
|
Used to identify remotes on Android devices accessed via adb.
|
|
|
|
|
Normally this is automatically set up by `git annex initremote`.
|
|
|
|
|
|
|
|
|
|
* `remote.<name>.androiddirectory`
|
|
|
|
|
|
|
|
|
|
Used by adb special remotes, this is the directory on the Android
|
|
|
|
|
device where files are stored for this remote. Normally this is
|
|
|
|
|
automatically set up by `git annex initremote`, but you can change
|
|
|
|
|
it if needed.
|
|
|
|
|
|
|
|
|
|
* `remote.<name>.androidserial`
|
|
|
|
|
|
|
|
|
|
Used by adb special remotes, this is the serial number of the Android
|
|
|
|
|
device used by the remote. Normally this is automatically set up by
|
|
|
|
|
`git annex initremote`, but you can change it if needed, eg when
|
|
|
|
|
upgrading to a new Android device.
|
|
|
|
|
|
2011-04-09 19:57:45 +00:00
|
|
|
* `remote.<name>.s3`
|
|
|
|
|
|
|
|
|
|
Used to identify Amazon S3 special remotes.
|
2012-11-18 02:09:29 +00:00
|
|
|
Normally this is automatically set up by `git annex initremote`.
|
2011-03-28 06:12:05 +00:00
|
|
|
|
2012-11-20 20:43:58 +00:00
|
|
|
* `remote.<name>.glacier`
|
|
|
|
|
|
|
|
|
|
Used to identify Amazon Glacier special remotes.
|
|
|
|
|
Normally this is automatically set up by `git annex initremote`.
|
|
|
|
|
|
2012-11-15 19:42:07 +00:00
|
|
|
* `remote.<name>.webdav`
|
|
|
|
|
|
|
|
|
|
Used to identify webdav special remotes.
|
2012-11-18 02:09:29 +00:00
|
|
|
Normally this is automatically set up by `git annex initremote`.
|
2012-11-15 19:42:07 +00:00
|
|
|
|
2014-01-08 20:14:37 +00:00
|
|
|
* `remote.<name>.tahoe`
|
|
|
|
|
|
|
|
|
|
Used to identify tahoe special remotes.
|
|
|
|
|
Points to the configuration directory for tahoe.
|
|
|
|
|
|
2013-09-24 21:25:47 +00:00
|
|
|
* `remote.<name>.gcrypt`
|
|
|
|
|
|
|
|
|
|
Used to identify gcrypt special remotes.
|
|
|
|
|
Normally this is automatically set up by `git annex initremote`.
|
|
|
|
|
|
|
|
|
|
It is set to "true" if this is a gcrypt remote.
|
|
|
|
|
If the gcrypt remote is accessible over ssh and has git-annex-shell
|
2014-01-18 06:30:01 +00:00
|
|
|
available to manage it, it's set to "shell".
|
2013-09-24 21:25:47 +00:00
|
|
|
|
2013-12-29 17:41:53 +00:00
|
|
|
* `remote.<name>.hooktype`, `remote.<name>.externaltype`
|
|
|
|
|
|
|
|
|
|
Used by hook special remotes and external special remotes to record
|
|
|
|
|
the type of the remote.
|
|
|
|
|
|
2015-01-28 17:47:41 +00:00
|
|
|
* `annex.tune.objecthash1`, `annex.tune.objecthashlower`, `annex.tune.branchhash1`
|
2015-01-27 21:38:06 +00:00
|
|
|
|
|
|
|
|
These can be passed to `git annex init` to tune the repository.
|
2016-04-22 18:49:15 +00:00
|
|
|
They cannot be safely changed in a running repository and should never be
|
|
|
|
|
set in global git configuration.
|
2016-02-02 20:50:58 +00:00
|
|
|
For details, see <https://git-annex.branchable.com/tuning/>.
|
2015-01-27 21:38:06 +00:00
|
|
|
|
2010-12-10 21:30:13 +00:00
|
|
|
# CONFIGURATION VIA .gitattributes
|
2010-10-09 18:06:25 +00:00
|
|
|
|
2011-08-28 20:28:38 +00:00
|
|
|
The key-value backend used when adding a new file to the annex can be
|
|
|
|
|
configured on a per-file-type basis via `.gitattributes` files. In the file,
|
2010-11-28 22:58:03 +00:00
|
|
|
the `annex.backend` attribute can be set to the name of the backend to
|
2010-11-01 18:49:05 +00:00
|
|
|
use. For example, this here's how to use the WORM backend by default,
|
2012-09-12 17:22:16 +00:00
|
|
|
but the SHA256E backend for ogg files:
|
2010-11-01 18:49:05 +00:00
|
|
|
|
2010-11-28 22:58:03 +00:00
|
|
|
* annex.backend=WORM
|
2012-09-12 17:22:16 +00:00
|
|
|
*.ogg annex.backend=SHA256E
|
2010-11-01 18:49:05 +00:00
|
|
|
|
2016-02-02 20:50:58 +00:00
|
|
|
There is a annex.largefiles attribute; which is used to configure which
|
|
|
|
|
files are large enough to be added to the annex.
|
|
|
|
|
See <https://git-annex.branchable.com/tips/largefiles> for details.
|
2016-02-02 19:18:17 +00:00
|
|
|
|
2010-11-28 19:28:20 +00:00
|
|
|
The numcopies setting can also be configured on a per-file-type basis via
|
2013-04-02 05:20:15 +00:00
|
|
|
the `annex.numcopies` attribute in `.gitattributes` files. This overrides
|
2014-01-20 20:47:56 +00:00
|
|
|
other numcopies settings.
|
|
|
|
|
For example, this makes two copies be needed for wav files and 3 copies
|
|
|
|
|
for flac files:
|
2010-11-28 19:28:20 +00:00
|
|
|
|
2010-11-28 22:55:49 +00:00
|
|
|
*.wav annex.numcopies=2
|
2014-01-20 20:47:56 +00:00
|
|
|
*.flac annex.numcopies=3
|
2013-07-11 12:11:47 +00:00
|
|
|
|
2012-10-28 23:26:18 +00:00
|
|
|
Note that setting numcopies to 0 is very unsafe.
|
2010-11-28 19:28:20 +00:00
|
|
|
|
2014-02-20 18:45:17 +00:00
|
|
|
These settings are honored by git-annex whenever it's operating on a
|
|
|
|
|
matching file. However, when using --all, --unused, or --key to specify
|
|
|
|
|
keys to operate on, git-annex is operating on keys and not files, so will
|
2016-02-02 19:18:17 +00:00
|
|
|
not honor the settings from .gitattributes. For this reason, the `git annex
|
|
|
|
|
numcopies` command is useful to configure a global default for numcopies.
|
2014-02-20 18:45:17 +00:00
|
|
|
|
|
|
|
|
Also note that when using views, only the toplevel .gitattributes file is
|
|
|
|
|
preserved in the view, so other settings in other files won't have any
|
2014-08-19 05:22:24 +00:00
|
|
|
effect.
|
2014-02-20 18:45:17 +00:00
|
|
|
|
2015-06-23 16:56:03 +00:00
|
|
|
# EXIT STATUS
|
|
|
|
|
|
|
|
|
|
git-annex, when called as a git subcommand, may return exit codes 0 or 1
|
|
|
|
|
for success or failures, or, more rarely, 127 or 128 for certain very
|
|
|
|
|
specific failures. git-annex itself should return 0 on success and 1 on
|
|
|
|
|
failure, unless the `--time-limit=time` option is hit, in which case it
|
|
|
|
|
returns with exit code 101.
|
|
|
|
|
|
2017-03-17 20:02:47 +00:00
|
|
|
# ENVIRONMENT
|
|
|
|
|
|
|
|
|
|
These environment variables are used by git-annex when set:
|
|
|
|
|
|
|
|
|
|
* `GIT_WORK_TREE`, `GIT_DIR`
|
|
|
|
|
|
|
|
|
|
Handled the same as they are by git, see git(1)
|
|
|
|
|
|
|
|
|
|
* `GIT_SSH`, `GIT_SSH_COMMAND`
|
|
|
|
|
|
|
|
|
|
Handled similarly to the same as described in git(1).
|
|
|
|
|
The one difference is that git-annex will sometimes pass an additional
|
|
|
|
|
"-n" parameter to these, as the first parameter, to prevent ssh from
|
2017-04-07 15:35:20 +00:00
|
|
|
reading from stdin. Since that can break existing uses of these
|
|
|
|
|
environment variables that don't expect the extra parameter, you will
|
|
|
|
|
need to set `GIT_ANNEX_USE_GIT_SSH=1` to make git-annex support
|
|
|
|
|
these.
|
2017-03-17 20:02:47 +00:00
|
|
|
|
|
|
|
|
Note that setting either of these environment variables prevents
|
|
|
|
|
git-annex from automatically enabling ssh connection caching
|
|
|
|
|
(see `annex.sshcaching`), so it will slow down some operations with
|
|
|
|
|
remotes over ssh. It's up to you to enable ssh connection caching
|
|
|
|
|
if you need it; see ssh's documentation.
|
|
|
|
|
|
|
|
|
|
Also, `annex.ssh-options` and `remote.<name>.annex-ssh-options`
|
|
|
|
|
won't have any effect when these envionment variables are set.
|
|
|
|
|
|
|
|
|
|
Usually it's better to configure any desired options through your
|
|
|
|
|
~/.ssh/config file, or by setting `annex.ssh-options`.
|
|
|
|
|
|
2017-08-14 17:55:38 +00:00
|
|
|
* `GIT_ANNEX_VECTOR_CLOCK`
|
|
|
|
|
|
|
|
|
|
Normally git-annex timestamps lines in the log files committed to the
|
|
|
|
|
git-annex branch. Setting this environment variable to a number
|
|
|
|
|
will make git-annex use that rather than the current number of seconds
|
|
|
|
|
since the UNIX epoch. Note that decimal seconds are supported.
|
|
|
|
|
|
|
|
|
|
This is only provided for advanced users who either have a better way to
|
|
|
|
|
tell which commit is current than the local clock, or who need to avoid
|
|
|
|
|
embedding timestamps for policy reasons. Misuse of this environment
|
|
|
|
|
variable can confuse git-annex's book-keeping, sometimes in ways that
|
|
|
|
|
`git annex fsck` is unable to repair.
|
|
|
|
|
|
2017-03-17 20:02:47 +00:00
|
|
|
Some special remotes use additional environment variables
|
|
|
|
|
for authentication etc. For example, `AWS_ACCESS_KEY_ID`
|
|
|
|
|
and `GIT_ANNEX_P2P_AUTHTOKEN`. See special remote documentation.
|
|
|
|
|
|
2010-10-19 19:59:40 +00:00
|
|
|
# FILES
|
|
|
|
|
|
2012-08-02 04:42:33 +00:00
|
|
|
These files are used by git-annex:
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2012-08-02 04:42:33 +00:00
|
|
|
`.git/annex/objects/` in your git repository contains the annexed file
|
|
|
|
|
contents that are currently available. Annexed files in your git
|
|
|
|
|
repository symlink to that content.
|
|
|
|
|
|
|
|
|
|
`.git/annex/` in your git repository contains other run-time information
|
|
|
|
|
used by git-annex.
|
|
|
|
|
|
|
|
|
|
`~/.config/git-annex/autostart` is a list of git repositories
|
|
|
|
|
to start the git-annex assistant in.
|
2010-10-19 19:59:40 +00:00
|
|
|
|
2014-04-01 00:15:01 +00:00
|
|
|
`.git/hooks/pre-commit-annex` in your git repository will be run whenever
|
2015-03-20 18:52:58 +00:00
|
|
|
a commit is made to the HEAD branch, either by git commit, git-annex
|
|
|
|
|
sync, or the git-annex assistant.
|
|
|
|
|
|
|
|
|
|
`.git/hooks/post-update-annex` in your git repository will be run
|
|
|
|
|
whenever the git-annex branch is updated. You can make this hook run
|
|
|
|
|
`git update-server-info` when publishing a git-annex repository by http.
|
2014-03-02 22:01:07 +00:00
|
|
|
|
2010-10-27 18:40:50 +00:00
|
|
|
# SEE ALSO
|
|
|
|
|
|
2015-03-23 19:36:10 +00:00
|
|
|
More git-annex documentation is available on its web site,
|
2016-02-02 20:50:58 +00:00
|
|
|
<https://git-annex.branchable.com/>
|
2010-10-27 18:40:50 +00:00
|
|
|
|
|
|
|
|
If git-annex is installed from a package, a copy of its documentation
|
2014-01-18 06:30:01 +00:00
|
|
|
should be included, in, for example, `/usr/share/doc/git-annex/`.
|
2010-10-27 18:40:50 +00:00
|
|
|
|
2010-10-19 19:59:40 +00:00
|
|
|
# AUTHOR
|
|
|
|
|
|
2015-01-21 16:50:09 +00:00
|
|
|
Joey Hess <id@joeyh.name>
|
2010-10-16 19:58:42 +00:00
|
|
|
|
2016-02-02 20:50:58 +00:00
|
|
|
<https://git-annex.branchable.com/>
|
2010-10-19 20:17:29 +00:00
|
|
|
|
2014-01-18 06:30:01 +00:00
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|