add backticks to all options
This commit is contained in:
Antoine Beaupré
parent
8fbbf11233
commit
375a942dc9
1 changed files with 92 additions and 92 deletions
|
|
@ -60,14 +60,14 @@ files in the directory. When no path is specified, most git-annex commands
|
||||||
default to acting on all relevant files in the current directory (and
|
default to acting on all relevant files in the current directory (and
|
||||||
subdirectories).
|
subdirectories).
|
||||||
|
|
||||||
* add [path ...]
|
* `add [path ...]`
|
||||||
|
|
||||||
Adds files in the path to the annex. Files that are already checked into
|
Adds files in the path to the annex. Files that are already checked into
|
||||||
git, or that git has been configured to ignore will be silently skipped.
|
git, or that git has been configured to ignore will be silently skipped.
|
||||||
(Use `--force` to add ignored files.) Dotfiles are skipped unless explicitly
|
(Use `--force` to add ignored files.) Dotfiles are skipped unless explicitly
|
||||||
listed.
|
listed.
|
||||||
|
|
||||||
* get [path ...]
|
* `get [path ...]`
|
||||||
|
|
||||||
Makes the content of annexed files available in this repository. This
|
Makes the content of annexed files available in this repository. This
|
||||||
will involve copying them from another repository, or downloading them,
|
will involve copying them from another repository, or downloading them,
|
||||||
|
|
@ -76,7 +76,7 @@ subdirectories).
|
||||||
Normally git-annex will choose which repository to copy the content from,
|
Normally git-annex will choose which repository to copy the content from,
|
||||||
but you can override this using the `--from` option.
|
but you can override this using the `--from` option.
|
||||||
|
|
||||||
* drop [path ...]
|
* `drop [path ...]`
|
||||||
|
|
||||||
Drops the content of annexed files from this repository.
|
Drops the content of annexed files from this repository.
|
||||||
|
|
||||||
|
|
@ -85,7 +85,7 @@ subdirectories).
|
||||||
|
|
||||||
To drop content from a remote, specify `--from`.
|
To drop content from a remote, specify `--from`.
|
||||||
|
|
||||||
* move [path ...]
|
* `move [path ...]`
|
||||||
|
|
||||||
When used with the `--from` option, moves the content of annexed files
|
When used with the `--from` option, moves the content of annexed files
|
||||||
from the specified repository to the current one.
|
from the specified repository to the current one.
|
||||||
|
|
@ -93,7 +93,7 @@ subdirectories).
|
||||||
When used with the `--to` option, moves the content of annexed files from
|
When used with the `--to` option, moves the content of annexed files from
|
||||||
the current repository to the specified one.
|
the current repository to the specified one.
|
||||||
|
|
||||||
* copy [path ...]
|
* `copy [path ...]`
|
||||||
|
|
||||||
When used with the `--from` option, copies the content of annexed files
|
When used with the `--from` option, copies the content of annexed files
|
||||||
from the specified repository to the current one.
|
from the specified repository to the current one.
|
||||||
|
|
@ -103,7 +103,7 @@ subdirectories).
|
||||||
|
|
||||||
To avoid contacting the remote to check if it has every file, specify `--fast`
|
To avoid contacting the remote to check if it has every file, specify `--fast`
|
||||||
|
|
||||||
* unlock [path ...]
|
* `unlock [path ...]`
|
||||||
|
|
||||||
Normally, the content of annexed files is protected from being changed.
|
Normally, the content of annexed files is protected from being changed.
|
||||||
Unlocking a annexed file allows it to be modified. This replaces the
|
Unlocking a annexed file allows it to be modified. This replaces the
|
||||||
|
|
@ -111,17 +111,17 @@ subdirectories).
|
||||||
You can then modify it and `git annex add` (or `git commit`) to inject
|
You can then modify it and `git annex add` (or `git commit`) to inject
|
||||||
it back into the annex.
|
it back into the annex.
|
||||||
|
|
||||||
* edit [path ...]
|
* `edit [path ...]`
|
||||||
|
|
||||||
This is an alias for the unlock command. May be easier to remember,
|
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.
|
if you think of this as allowing you to edit an annexed file.
|
||||||
|
|
||||||
* lock [path ...]
|
* `lock [path ...]`
|
||||||
|
|
||||||
Use this to undo an unlock command if you don't want to modify
|
Use this to undo an unlock command if you don't want to modify
|
||||||
the files, or have made modifications you want to discard.
|
the files, or have made modifications you want to discard.
|
||||||
|
|
||||||
* sync [remote ...]
|
* `sync [remote ...]`
|
||||||
|
|
||||||
Use this command when you want to synchronize the local repository with
|
Use this command when you want to synchronize the local repository with
|
||||||
one or more of its remotes. You can specifiy the remotes to sync with;
|
one or more of its remotes. You can specifiy the remotes to sync with;
|
||||||
|
|
@ -148,7 +148,7 @@ subdirectories).
|
||||||
Note that sync does not transfer any file contents from or to the remote
|
Note that sync does not transfer any file contents from or to the remote
|
||||||
repositories.
|
repositories.
|
||||||
|
|
||||||
* merge
|
* `merge`
|
||||||
|
|
||||||
This performs the same merging that is done by the sync command, but
|
This performs the same merging that is done by the sync command, but
|
||||||
without pushing or pulling any data.
|
without pushing or pulling any data.
|
||||||
|
|
@ -157,7 +157,7 @@ subdirectories).
|
||||||
post-receive hook. Then any syncs to the repository will update its working
|
post-receive hook. Then any syncs to the repository will update its working
|
||||||
copy automatically.
|
copy automatically.
|
||||||
|
|
||||||
* mirror [path ...]
|
* `mirror [path ...]`
|
||||||
|
|
||||||
This causes a destination repository to mirror a source repository.
|
This causes a destination repository to mirror a source repository.
|
||||||
|
|
||||||
|
|
@ -175,7 +175,7 @@ subdirectories).
|
||||||
Note that mirror does not sync the git repository, but only the file
|
Note that mirror does not sync the git repository, but only the file
|
||||||
contents.
|
contents.
|
||||||
|
|
||||||
* addurl [url ...]
|
* `addurl [url ...]`
|
||||||
|
|
||||||
Downloads each url to its own file, which is added to the annex.
|
Downloads each url to its own file, which is added to the annex.
|
||||||
|
|
||||||
|
|
@ -198,11 +198,11 @@ subdirectories).
|
||||||
When quvi is installed, urls are automatically tested to see if they
|
When quvi is installed, urls are automatically tested to see if they
|
||||||
are on a video hosting site, and the video is downloaded instead.
|
are on a video hosting site, and the video is downloaded instead.
|
||||||
|
|
||||||
* rmurl file url
|
* `rmurl file url`
|
||||||
|
|
||||||
Record that the file is no longer available at the url.
|
Record that the file is no longer available at the url.
|
||||||
|
|
||||||
* import [path ...]
|
* `import [path ...]`
|
||||||
|
|
||||||
Moves files from somewhere outside the git working copy, and adds them to
|
Moves files from somewhere outside the git working copy, and adds them to
|
||||||
the annex. Individual files to import can be specified.
|
the annex. Individual files to import can be specified.
|
||||||
|
|
@ -233,7 +233,7 @@ subdirectories).
|
||||||
(Note that using `--deduplicate` or `--clean-duplicates` with the WORM
|
(Note that using `--deduplicate` or `--clean-duplicates` with the WORM
|
||||||
backend does not look at file content, but filename and mtime.)
|
backend does not look at file content, but filename and mtime.)
|
||||||
|
|
||||||
* importfeed [url ...]
|
* `importfeed [url ...]`
|
||||||
|
|
||||||
Imports the contents of podcast feeds. Only downloads files whose
|
Imports the contents of podcast feeds. Only downloads files whose
|
||||||
urls have not already been added to the repository before, so you can
|
urls have not already been added to the repository before, so you can
|
||||||
|
|
@ -246,7 +246,7 @@ subdirectories).
|
||||||
|
|
||||||
The `--relaxed` and `--fast` options behave the same as they do in addurl.
|
The `--relaxed` and `--fast` options behave the same as they do in addurl.
|
||||||
|
|
||||||
* watch
|
* `watch`
|
||||||
|
|
||||||
Watches for changes to files in the current directory and its subdirectories,
|
Watches for changes to files in the current directory and its subdirectories,
|
||||||
and takes care of automatically adding new files, as well as dealing with
|
and takes care of automatically adding new files, as well as dealing with
|
||||||
|
|
@ -257,7 +257,7 @@ subdirectories).
|
||||||
To not daemonize, run with `--foreground` ; to stop a running daemon,
|
To not daemonize, run with `--foreground` ; to stop a running daemon,
|
||||||
run with `--stop`
|
run with `--stop`
|
||||||
|
|
||||||
* assistant
|
* `assistant`
|
||||||
|
|
||||||
Like watch, but also automatically syncs changes to other remotes.
|
Like watch, but also automatically syncs changes to other remotes.
|
||||||
Typically started at boot, or when you log in.
|
Typically started at boot, or when you log in.
|
||||||
|
|
@ -265,7 +265,7 @@ subdirectories).
|
||||||
With the `--autostart` option, the assistant is started in any repositories
|
With the `--autostart` option, the assistant is started in any repositories
|
||||||
it has created. These are listed in `~/.config/git-annex/autostart`
|
it has created. These are listed in `~/.config/git-annex/autostart`
|
||||||
|
|
||||||
* webapp
|
* `webapp`
|
||||||
|
|
||||||
Opens a web app, that allows easy setup of a git-annex repository,
|
Opens a web app, that allows easy setup of a git-annex repository,
|
||||||
and control of the git-annex assistant.
|
and control of the git-annex assistant.
|
||||||
|
|
@ -281,7 +281,7 @@ subdirectories).
|
||||||
|
|
||||||
# REPOSITORY SETUP COMMANDS
|
# REPOSITORY SETUP COMMANDS
|
||||||
|
|
||||||
* init [description]
|
* `init [description]`
|
||||||
|
|
||||||
Until a repository (or one of its remotes) has been initialized,
|
Until a repository (or one of its remotes) has been initialized,
|
||||||
git-annex will refuse to operate on it, to avoid accidentially
|
git-annex will refuse to operate on it, to avoid accidentially
|
||||||
|
|
@ -291,7 +291,7 @@ subdirectories).
|
||||||
of a repository with its own description. If you don't provide one,
|
of a repository with its own description. If you don't provide one,
|
||||||
one will be generated.
|
one will be generated.
|
||||||
|
|
||||||
* describe repository description
|
* `describe repository description`
|
||||||
|
|
||||||
Changes the description of a repository.
|
Changes the description of a repository.
|
||||||
|
|
||||||
|
|
@ -299,7 +299,7 @@ subdirectories).
|
||||||
by uuid. To change the description of the current repository, use
|
by uuid. To change the description of the current repository, use
|
||||||
"here".
|
"here".
|
||||||
|
|
||||||
* initremote name [param=value ...]
|
* `initremote name [param=value ...]`
|
||||||
|
|
||||||
Creates a new special remote, and adds it to `.git/config`.
|
Creates a new special remote, and adds it to `.git/config`.
|
||||||
|
|
||||||
|
|
@ -332,7 +332,7 @@ subdirectories).
|
||||||
|
|
||||||
git annex initremote mys3 type=S3 encryption=hybrid keyid=me@example.com datacenter=EU
|
git annex initremote mys3 type=S3 encryption=hybrid keyid=me@example.com datacenter=EU
|
||||||
|
|
||||||
* enableremote name [param=value ...]
|
* `enableremote name [param=value ...]`
|
||||||
|
|
||||||
Enables use of an existing special remote in the current repository,
|
Enables use of an existing special remote in the current repository,
|
||||||
which may be a different repository than the one in which it was
|
which may be a different repository than the one in which it was
|
||||||
|
|
@ -369,37 +369,37 @@ subdirectories).
|
||||||
keyid+= and keyid-= with such remotes should be used with care, and
|
keyid+= and keyid-= with such remotes should be used with care, and
|
||||||
make little sense except in cases like the revoked key example above.
|
make little sense except in cases like the revoked key example above.
|
||||||
|
|
||||||
* trust [repository ...]
|
* `trust [repository ...]`
|
||||||
|
|
||||||
Records that a repository is trusted to not unexpectedly lose
|
Records that a repository is trusted to not unexpectedly lose
|
||||||
content. Use with care.
|
content. Use with care.
|
||||||
|
|
||||||
To trust the current repository, use "here".
|
To trust the current repository, use "here".
|
||||||
|
|
||||||
* untrust [repository ...]
|
* `untrust [repository ...]`
|
||||||
|
|
||||||
Records that a repository is not trusted and could lose content
|
Records that a repository is not trusted and could lose content
|
||||||
at any time.
|
at any time.
|
||||||
|
|
||||||
* semitrust [repository ...]
|
* `semitrust [repository ...]`
|
||||||
|
|
||||||
Returns a repository to the default semi trusted state.
|
Returns a repository to the default semi trusted state.
|
||||||
|
|
||||||
* dead [repository ...]
|
* `dead [repository ...]`
|
||||||
|
|
||||||
Indicates that the repository has been irretrevably lost.
|
Indicates that the repository has been irretrevably lost.
|
||||||
(To undo, use semitrust.)
|
(To undo, use semitrust.)
|
||||||
|
|
||||||
* group repository groupname
|
* `group repository groupname`
|
||||||
|
|
||||||
Adds a repository to a group, such as "archival", "enduser", or "transfer".
|
Adds a repository to a group, such as "archival", "enduser", or "transfer".
|
||||||
The groupname must be a single word.
|
The groupname must be a single word.
|
||||||
|
|
||||||
* ungroup repository groupname
|
* `ungroup repository groupname`
|
||||||
|
|
||||||
Removes a repository from a group.
|
Removes a repository from a group.
|
||||||
|
|
||||||
* content repository [expression]
|
* `content repository [expression]`
|
||||||
|
|
||||||
When run with an expression, configures the content that is preferred
|
When run with an expression, configures the content that is preferred
|
||||||
to be held in the archive. See PREFERRED CONTENT below.
|
to be held in the archive. See PREFERRED CONTENT below.
|
||||||
|
|
@ -411,13 +411,13 @@ subdirectories).
|
||||||
Without an expression, displays the current preferred content setting
|
Without an expression, displays the current preferred content setting
|
||||||
of the repository.
|
of the repository.
|
||||||
|
|
||||||
* vicfg
|
* `vicfg`
|
||||||
|
|
||||||
Opens EDITOR on a temp file containing most of the above configuration
|
Opens EDITOR on a temp file containing most of the above configuration
|
||||||
settings, and when it exits, stores any changes made back to the git-annex
|
settings, and when it exits, stores any changes made back to the git-annex
|
||||||
branch.
|
branch.
|
||||||
|
|
||||||
* direct
|
* `direct`
|
||||||
|
|
||||||
Switches a repository to use direct mode, where rather than symlinks to
|
Switches a repository to use direct mode, where rather than symlinks to
|
||||||
files, the files are directly present in the repository.
|
files, the files are directly present in the repository.
|
||||||
|
|
@ -428,7 +428,7 @@ subdirectories).
|
||||||
use in direct mode repositories, and can result in data loss or other
|
use in direct mode repositories, and can result in data loss or other
|
||||||
bad behavior.
|
bad behavior.
|
||||||
|
|
||||||
* indirect
|
* `indirect`
|
||||||
|
|
||||||
Switches a repository back from direct mode to the default, indirect mode.
|
Switches a repository back from direct mode to the default, indirect mode.
|
||||||
|
|
||||||
|
|
@ -436,7 +436,7 @@ subdirectories).
|
||||||
|
|
||||||
# REPOSITORY MAINTENANCE COMMANDS
|
# REPOSITORY MAINTENANCE COMMANDS
|
||||||
|
|
||||||
* fsck [path ...]
|
* `fsck [path ...]`
|
||||||
|
|
||||||
With no parameters, this command checks the whole annex for consistency,
|
With no parameters, this command checks the whole annex for consistency,
|
||||||
and warns about or fixes any problems found.
|
and warns about or fixes any problems found.
|
||||||
|
|
@ -467,7 +467,7 @@ subdirectories).
|
||||||
To verify data integrity only while disregarding required number of copies,
|
To verify data integrity only while disregarding required number of copies,
|
||||||
use `--numcopies=1`.
|
use `--numcopies=1`.
|
||||||
|
|
||||||
* unused
|
* `unused`
|
||||||
|
|
||||||
Checks the annex for data that does not correspond to any files present
|
Checks the annex for data that does not correspond to any files present
|
||||||
in any tag or branch, and prints a numbered list of the data.
|
in any tag or branch, and prints a numbered list of the data.
|
||||||
|
|
@ -482,7 +482,7 @@ subdirectories).
|
||||||
|
|
||||||
git annex unused; git annex move --unused --to origin
|
git annex unused; git annex move --unused --to origin
|
||||||
|
|
||||||
* dropunused [number|range ...]
|
* `dropunused [number|range ...]`
|
||||||
|
|
||||||
Drops the data corresponding to the numbers, as listed by the last
|
Drops the data corresponding to the numbers, as listed by the last
|
||||||
`git annex unused`
|
`git annex unused`
|
||||||
|
|
@ -491,23 +491,23 @@ subdirectories).
|
||||||
|
|
||||||
To drop the data from a remote, specify `--from.`
|
To drop the data from a remote, specify `--from.`
|
||||||
|
|
||||||
* addunused [number|range ...]
|
* `addunused [number|range ...]`
|
||||||
|
|
||||||
Adds back files for the content corresponding to the numbers or ranges,
|
Adds back files for the content corresponding to the numbers or ranges,
|
||||||
as listed by the last `git annex unused`. The files will have names
|
as listed by the last `git annex unused`. The files will have names
|
||||||
starting with "unused."
|
starting with "unused."
|
||||||
|
|
||||||
* fix [path ...]
|
* `fix [path ...]`
|
||||||
|
|
||||||
Fixes up symlinks that have become broken to again point to annexed content.
|
Fixes up symlinks that have become broken to again point to annexed content.
|
||||||
This is useful to run if you have been moving the symlinks around,
|
This is useful to run if you have been moving the symlinks around,
|
||||||
but is done automatically when committing a change with git too.
|
but is done automatically when committing a change with git too.
|
||||||
|
|
||||||
* upgrade
|
* `upgrade`
|
||||||
|
|
||||||
Upgrades the repository to current layout.
|
Upgrades the repository to current layout.
|
||||||
|
|
||||||
* forget
|
* `forget`
|
||||||
|
|
||||||
Causes the git-annex branch to be rewritten, throwing away historical
|
Causes the git-annex branch to be rewritten, throwing away historical
|
||||||
data about past locations of files. The resulting branch will use less
|
data about past locations of files. The resulting branch will use less
|
||||||
|
|
@ -526,11 +526,11 @@ subdirectories).
|
||||||
|
|
||||||
# QUERY COMMANDS
|
# QUERY COMMANDS
|
||||||
|
|
||||||
* version
|
* `version`
|
||||||
|
|
||||||
Shows the version of git-annex, as well as repository version information.
|
Shows the version of git-annex, as well as repository version information.
|
||||||
|
|
||||||
* find [path ...]
|
* `find [path ...]`
|
||||||
|
|
||||||
Outputs a list of annexed files in the specified path. With no path,
|
Outputs a list of annexed files in the specified path. With no path,
|
||||||
finds files in the current directory and its subdirectories.
|
finds files in the current directory and its subdirectories.
|
||||||
|
|
@ -547,12 +547,12 @@ subdirectories).
|
||||||
These variables are available for use in formats: file, key, backend,
|
These variables are available for use in formats: file, key, backend,
|
||||||
bytesize, humansize
|
bytesize, humansize
|
||||||
|
|
||||||
* whereis [path ...]
|
* `whereis [path ...]`
|
||||||
|
|
||||||
Displays a list of repositories known to contain the content of the
|
Displays a list of repositories known to contain the content of the
|
||||||
specified file or files.
|
specified file or files.
|
||||||
|
|
||||||
* log [path ...]
|
* `log [path ...]`
|
||||||
|
|
||||||
Displays the location log for the specified file or files,
|
Displays the location log for the specified file or files,
|
||||||
showing each repository they were added to ("+") and removed from ("-").
|
showing each repository they were added to ("+") and removed from ("-").
|
||||||
|
|
@ -564,7 +564,7 @@ subdirectories).
|
||||||
To generate output suitable for the gource visualisation program,
|
To generate output suitable for the gource visualisation program,
|
||||||
specify `--gource`.
|
specify `--gource`.
|
||||||
|
|
||||||
* status [directory ...]
|
* `status [directory ...]`
|
||||||
|
|
||||||
Displays some statistics and other information, including how much data
|
Displays some statistics and other information, including how much data
|
||||||
is in the annex and a list of all known repositories.
|
is in the annex and a list of all known repositories.
|
||||||
|
|
@ -582,7 +582,7 @@ subdirectories).
|
||||||
|
|
||||||
git annex status . --not --in here
|
git annex status . --not --in here
|
||||||
|
|
||||||
* map
|
* `map`
|
||||||
|
|
||||||
Helps you keep track of your repositories, and the connections between them,
|
Helps you keep track of your repositories, and the connections between them,
|
||||||
by going out and looking at all the ones it can get to, and generating a
|
by going out and looking at all the ones it can get to, and generating a
|
||||||
|
|
@ -602,7 +602,7 @@ subdirectories).
|
||||||
|
|
||||||
# UTILITY COMMANDS
|
# UTILITY COMMANDS
|
||||||
|
|
||||||
* migrate [path ...]
|
* `migrate [path ...]`
|
||||||
|
|
||||||
Changes the specified annexed files to use the default key-value backend
|
Changes the specified annexed files to use the default key-value backend
|
||||||
(or the one specified with `--backend`). Only files whose content
|
(or the one specified with `--backend`). Only files whose content
|
||||||
|
|
@ -615,7 +615,7 @@ subdirectories).
|
||||||
However, if a backend changes the information it uses to construct a key,
|
However, if a backend changes the information it uses to construct a key,
|
||||||
this can also be used to migrate files to use the new key format.
|
this can also be used to migrate files to use the new key format.
|
||||||
|
|
||||||
* reinject src dest
|
* `reinject src dest`
|
||||||
|
|
||||||
Moves the src file into the annex as the content of the dest file.
|
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
|
This can be useful if you have obtained the content of a file from
|
||||||
|
|
@ -628,7 +628,7 @@ subdirectories).
|
||||||
|
|
||||||
git annex reinject /tmp/foo.iso foo.iso
|
git annex reinject /tmp/foo.iso foo.iso
|
||||||
|
|
||||||
* unannex [path ...]
|
* `unannex [path ...]`
|
||||||
|
|
||||||
Use this to undo an accidental `git annex add` command. You can use
|
Use this to undo an accidental `git annex add` command. You can use
|
||||||
`git annex unannex` to move content out of the annex at any point,
|
`git annex unannex` to move content out of the annex at any point,
|
||||||
|
|
@ -641,7 +641,7 @@ subdirectories).
|
||||||
In `--fast` mode, this command leaves content in the annex, simply making
|
In `--fast` mode, this command leaves content in the annex, simply making
|
||||||
a hard link to it.
|
a hard link to it.
|
||||||
|
|
||||||
* uninit
|
* `uninit`
|
||||||
|
|
||||||
Use this to stop using git annex. It will unannex every file in the
|
Use this to stop using git annex. It will unannex every file in the
|
||||||
repository, and remove all of git-annex's other data, leaving you with a
|
repository, and remove all of git-annex's other data, leaving you with a
|
||||||
|
|
@ -649,7 +649,7 @@ subdirectories).
|
||||||
|
|
||||||
# PLUMBING COMMANDS
|
# PLUMBING COMMANDS
|
||||||
|
|
||||||
* pre-commit [path ...]
|
* `pre-commit [path ...]`
|
||||||
|
|
||||||
Fixes up symlinks that are staged as part of a commit, to ensure they
|
Fixes up symlinks that are staged as part of a commit, to ensure they
|
||||||
point to annexed content. Also handles injecting changes to unlocked
|
point to annexed content. Also handles injecting changes to unlocked
|
||||||
|
|
@ -658,12 +658,12 @@ subdirectories).
|
||||||
This is meant to be called from git's pre-commit hook. `git annex init`
|
This is meant to be called from git's pre-commit hook. `git annex init`
|
||||||
automatically creates a pre-commit hook using this.
|
automatically creates a pre-commit hook using this.
|
||||||
|
|
||||||
* fromkey key file
|
* `fromkey key file`
|
||||||
|
|
||||||
This plumbing-level command can be used to manually set up a file
|
This plumbing-level command can be used to manually set up a file
|
||||||
in the git repository to link to a specified key.
|
in the git repository to link to a specified key.
|
||||||
|
|
||||||
* dropkey [key ...]
|
* `dropkey [key ...]`
|
||||||
|
|
||||||
This plumbing-level command drops the annexed data for the specified
|
This plumbing-level command drops the annexed data for the specified
|
||||||
keys from this repository.
|
keys from this repository.
|
||||||
|
|
@ -675,11 +675,11 @@ subdirectories).
|
||||||
|
|
||||||
git annex dropkey SHA1-s10-7da006579dd64330eb2456001fd01948430572f2
|
git annex dropkey SHA1-s10-7da006579dd64330eb2456001fd01948430572f2
|
||||||
|
|
||||||
* transferkeys
|
* `transferkeys`
|
||||||
|
|
||||||
This plumbing-level command is used by the assistant to transfer data.
|
This plumbing-level command is used by the assistant to transfer data.
|
||||||
|
|
||||||
* rekey [file key ...]
|
* `rekey [file key ...]`
|
||||||
|
|
||||||
This plumbing-level command is similar to migrate, but you specify
|
This plumbing-level command is similar to migrate, but you specify
|
||||||
both the file, and the new key to use for it.
|
both the file, and the new key to use for it.
|
||||||
|
|
@ -687,34 +687,34 @@ subdirectories).
|
||||||
With `--force`, even files whose content is not currently available will
|
With `--force`, even files whose content is not currently available will
|
||||||
be rekeyed. Use with caution.
|
be rekeyed. Use with caution.
|
||||||
|
|
||||||
* test
|
* `test`
|
||||||
|
|
||||||
This runs git-annex's built-in test suite.
|
This runs git-annex's built-in test suite.
|
||||||
|
|
||||||
* xmppgit
|
* `xmppgit`
|
||||||
|
|
||||||
This command is used internally to perform git pulls over XMPP.
|
This command is used internally to perform git pulls over XMPP.
|
||||||
|
|
||||||
# OPTIONS
|
# OPTIONS
|
||||||
|
|
||||||
* --force
|
* `--force`
|
||||||
|
|
||||||
Force unsafe actions, such as dropping a file's content when no other
|
Force unsafe actions, such as dropping a file's content when no other
|
||||||
source of it can be verified to still exist, or adding ignored files.
|
source of it can be verified to still exist, or adding ignored files.
|
||||||
Use with care.
|
Use with care.
|
||||||
|
|
||||||
* --fast
|
* `--fast`
|
||||||
|
|
||||||
Enables less expensive, but also less thorough versions of some commands.
|
Enables less expensive, but also less thorough versions of some commands.
|
||||||
What is avoided depends on the command.
|
What is avoided depends on the command.
|
||||||
|
|
||||||
* --auto
|
* `--auto`
|
||||||
|
|
||||||
Enables automatic mode. Commands that get, drop, or move file contents
|
Enables automatic mode. Commands that get, drop, or move file contents
|
||||||
will only do so when needed to help satisfy the setting of annex.numcopies,
|
will only do so when needed to help satisfy the setting of annex.numcopies,
|
||||||
and preferred content configuration.
|
and preferred content configuration.
|
||||||
|
|
||||||
* --all
|
* `--all`
|
||||||
|
|
||||||
Operate on all data that has been stored in the git annex,
|
Operate on all data that has been stored in the git annex,
|
||||||
including old versions of files. This is the default behavior when
|
including old versions of files. This is the default behavior when
|
||||||
|
|
@ -722,56 +722,56 @@ subdirectories).
|
||||||
normal behavior is to only operate on specified files in the working
|
normal behavior is to only operate on specified files in the working
|
||||||
tree.
|
tree.
|
||||||
|
|
||||||
* --unused
|
* `--unused`
|
||||||
|
|
||||||
Operate on all data that has been determined to be unused by
|
Operate on all data that has been determined to be unused by
|
||||||
a previous run of `git-annex unused`.
|
a previous run of `git-annex unused`.
|
||||||
|
|
||||||
* --quiet
|
* `--quiet`
|
||||||
|
|
||||||
Avoid the default verbose display of what is done; only show errors
|
Avoid the default verbose display of what is done; only show errors
|
||||||
and progress displays.
|
and progress displays.
|
||||||
|
|
||||||
* --verbose
|
* `--verbose`
|
||||||
|
|
||||||
Enable verbose display.
|
Enable verbose display.
|
||||||
|
|
||||||
* --json
|
* `--json`
|
||||||
|
|
||||||
Rather than the normal output, generate JSON. This is intended to be
|
Rather than the normal output, generate JSON. This is intended to be
|
||||||
parsed by programs that use git-annex. Each line of output is a JSON
|
parsed by programs that use git-annex. Each line of output is a JSON
|
||||||
object. Note that json output is only usable with some git-annex commands,
|
object. Note that json output is only usable with some git-annex commands,
|
||||||
like status and find.
|
like status and find.
|
||||||
|
|
||||||
* --debug
|
* `--debug`
|
||||||
|
|
||||||
Show debug messages.
|
Show debug messages.
|
||||||
|
|
||||||
* --no-debug
|
* `--no-debug`
|
||||||
|
|
||||||
Disable debug messages.
|
Disable debug messages.
|
||||||
|
|
||||||
* --from=repository
|
* `--from=repository`
|
||||||
|
|
||||||
Specifies a repository that content will be retrieved from, or that
|
Specifies a repository that content will be retrieved from, or that
|
||||||
should otherwise be acted on.
|
should otherwise be acted on.
|
||||||
|
|
||||||
It should be specified using the name of a configured remote.
|
It should be specified using the name of a configured remote.
|
||||||
|
|
||||||
* --to=repository
|
* `--to=repository`
|
||||||
|
|
||||||
Specifies a repository that content will be sent to.
|
Specifies a repository that content will be sent to.
|
||||||
|
|
||||||
It should be specified using the name of a configured remote.
|
It should be specified using the name of a configured remote.
|
||||||
|
|
||||||
* --numcopies=n
|
* `--numcopies=n`
|
||||||
|
|
||||||
Overrides the `annex.numcopies` setting, forcing git-annex to ensure the
|
Overrides the `annex.numcopies` setting, forcing git-annex to ensure the
|
||||||
specified number of copies exist.
|
specified number of copies exist.
|
||||||
|
|
||||||
Note that setting numcopies to 0 is very unsafe.
|
Note that setting numcopies to 0 is very unsafe.
|
||||||
|
|
||||||
* --time-limit=time
|
* `--time-limit=time`
|
||||||
|
|
||||||
Limits how long a git-annex command runs. The time can be something
|
Limits how long a git-annex command runs. The time can be something
|
||||||
like "5h", or "30m" or even "45s" or "10d".
|
like "5h", or "30m" or even "45s" or "10d".
|
||||||
|
|
@ -782,16 +782,16 @@ subdirectories).
|
||||||
Also, note that if the time limit prevents git-annex from doing all it
|
Also, note that if the time limit prevents git-annex from doing all it
|
||||||
was asked to, it will exit with a special code, 101.
|
was asked to, it will exit with a special code, 101.
|
||||||
|
|
||||||
* --trust=repository
|
* `--trust=repository`
|
||||||
* --semitrust=repository
|
* `--semitrust=repository`
|
||||||
* --untrust=repository
|
* `--untrust=repository`
|
||||||
|
|
||||||
Overrides trust settings for a repository. May be specified more than once.
|
Overrides trust settings for a repository. May be specified more than once.
|
||||||
|
|
||||||
The repository should be specified using the name of a configured remote,
|
The repository should be specified using the name of a configured remote,
|
||||||
or the UUID or description of a repository.
|
or the UUID or description of a repository.
|
||||||
|
|
||||||
* --trust-glacier-inventory
|
* `--trust-glacier-inventory`
|
||||||
|
|
||||||
Amazon Glacier inventories take hours to retrieve, and may not represent
|
Amazon Glacier inventories take hours to retrieve, and may not represent
|
||||||
the current state of a repository. So git-annex does not trust that
|
the current state of a repository. So git-annex does not trust that
|
||||||
|
|
@ -802,14 +802,14 @@ subdirectories).
|
||||||
removed a file from Glacier. If you try to drop the only other copy of the
|
removed a file from Glacier. If you try to drop the only other copy of the
|
||||||
file, and this switch is enabled, you could lose data!
|
file, and this switch is enabled, you could lose data!
|
||||||
|
|
||||||
* --backend=name
|
* `--backend=name`
|
||||||
|
|
||||||
Specifies which key-value backend to use. This can be used when
|
Specifies which key-value backend to use. This can be used when
|
||||||
adding a file to the annex, or migrating a file. Once files
|
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
|
are in the annex, their backend is known and this option is not
|
||||||
necessary.
|
necessary.
|
||||||
|
|
||||||
* --format=value
|
* `--format=value`
|
||||||
|
|
||||||
Specifies a custom output format. The value is a format string,
|
Specifies a custom output format. The value is a format string,
|
||||||
in which '${var}' is expanded to the value of a variable. To right-justify
|
in which '${var}' is expanded to the value of a variable. To right-justify
|
||||||
|
|
@ -819,7 +819,7 @@ subdirectories).
|
||||||
|
|
||||||
Also, '\\n' is a newline, '\\000' is a NULL, etc.
|
Also, '\\n' is a newline, '\\000' is a NULL, etc.
|
||||||
|
|
||||||
* -c name=value
|
* `-c name=value`
|
||||||
|
|
||||||
Used to override git configuration settings. May be specified multiple times.
|
Used to override git configuration settings. May be specified multiple times.
|
||||||
|
|
||||||
|
|
@ -836,21 +836,21 @@ For example:
|
||||||
The above example prevents git-annex from working on mp3 files whose
|
The above example prevents git-annex from working on mp3 files whose
|
||||||
file contents are present at either of two repositories.
|
file contents are present at either of two repositories.
|
||||||
|
|
||||||
* --exclude=glob
|
* `--exclude=glob`
|
||||||
|
|
||||||
Skips files matching the glob pattern. The glob is matched relative to
|
Skips files matching the glob pattern. The glob is matched relative to
|
||||||
the current directory. For example:
|
the current directory. For example:
|
||||||
|
|
||||||
--exclude='*.mp3' --exclude='subdir/*'
|
--exclude='*.mp3' --exclude='subdir/*'
|
||||||
|
|
||||||
* --include=glob
|
* `--include=glob`
|
||||||
|
|
||||||
Skips files not matching the glob pattern. (Same as `--not --exclude`.)
|
Skips files not matching the glob pattern. (Same as `--not --exclude`.)
|
||||||
For example, to include only mp3 and ogg files:
|
For example, to include only mp3 and ogg files:
|
||||||
|
|
||||||
--include='*.mp3' --or --include='*.ogg'
|
--include='*.mp3' --or --include='*.ogg'
|
||||||
|
|
||||||
* --in=repository
|
* `--in=repository`
|
||||||
|
|
||||||
Matches only files that git-annex believes have their contents present
|
Matches only files that git-annex believes have their contents present
|
||||||
in a repository. Note that it does not check the repository to verify
|
in a repository. Note that it does not check the repository to verify
|
||||||
|
|
@ -860,13 +860,13 @@ file contents are present at either of two repositories.
|
||||||
or the UUID or description of a repository. For the current repository,
|
or the UUID or description of a repository. For the current repository,
|
||||||
use `--in=here`
|
use `--in=here`
|
||||||
|
|
||||||
* --copies=number
|
* `--copies=number`
|
||||||
|
|
||||||
Matches only files that git-annex believes to have the specified number
|
Matches only files that git-annex believes to have the specified number
|
||||||
of copies, or more. Note that it does not check remotes to verify that
|
of copies, or more. Note that it does not check remotes to verify that
|
||||||
the copies still exist.
|
the copies still exist.
|
||||||
|
|
||||||
* --copies=trustlevel:number
|
* `--copies=trustlevel:number`
|
||||||
|
|
||||||
Matches only files that git-annex believes have the specified number of
|
Matches only files that git-annex believes have the specified number of
|
||||||
copies, on remotes with the specified trust level. For example,
|
copies, on remotes with the specified trust level. For example,
|
||||||
|
|
@ -875,24 +875,24 @@ file contents are present at either of two repositories.
|
||||||
To match any trust level at or higher than a given level,
|
To match any trust level at or higher than a given level,
|
||||||
use 'trustlevel+'. For example, "--copies=semitrusted+:2"
|
use 'trustlevel+'. For example, "--copies=semitrusted+:2"
|
||||||
|
|
||||||
* --copies=groupname:number
|
* `--copies=groupname:number`
|
||||||
|
|
||||||
Matches only files that git-annex believes have the specified number of
|
Matches only files that git-annex believes have the specified number of
|
||||||
copies, on remotes in the specified group. For example,
|
copies, on remotes in the specified group. For example,
|
||||||
"--copies=archive:2"
|
"--copies=archive:2"
|
||||||
|
|
||||||
* --inbackend=name
|
* `--inbackend=name`
|
||||||
|
|
||||||
Matches only files whose content is stored using the specified key-value
|
Matches only files whose content is stored using the specified key-value
|
||||||
backend.
|
backend.
|
||||||
|
|
||||||
* --inallgroup=groupname
|
* `--inallgroup=groupname`
|
||||||
|
|
||||||
Matches only files that git-annex believes are present in all repositories
|
Matches only files that git-annex believes are present in all repositories
|
||||||
in the specified group.
|
in the specified group.
|
||||||
|
|
||||||
* --smallerthan=size
|
* `--smallerthan=size`
|
||||||
* --largerthan=size
|
* `--largerthan=size`
|
||||||
|
|
||||||
Matches only files whose content is smaller than, or larger than the
|
Matches only files whose content is smaller than, or larger than the
|
||||||
specified size.
|
specified size.
|
||||||
|
|
@ -900,25 +900,25 @@ file contents are present at either of two repositories.
|
||||||
The size can be specified with any commonly used units, for example,
|
The size can be specified with any commonly used units, for example,
|
||||||
"0.5 gb" or "100 KiloBytes"
|
"0.5 gb" or "100 KiloBytes"
|
||||||
|
|
||||||
* --not
|
* `--not`
|
||||||
|
|
||||||
Inverts the next file matching option. For example, to only act on
|
Inverts the next file matching option. For example, to only act on
|
||||||
files with less than 3 copies, use `--not --copies=3`
|
files with less than 3 copies, use `--not --copies=3`
|
||||||
|
|
||||||
* --and
|
* `--and`
|
||||||
|
|
||||||
Requires that both the previous and the next file matching option matches.
|
Requires that both the previous and the next file matching option matches.
|
||||||
The default.
|
The default.
|
||||||
|
|
||||||
* --or
|
* `--or`
|
||||||
|
|
||||||
Requires that either the previous, or the next file matching option matches.
|
Requires that either the previous, or the next file matching option matches.
|
||||||
|
|
||||||
* -(
|
* `-(`
|
||||||
|
|
||||||
Opens a group of file matching options.
|
Opens a group of file matching options.
|
||||||
|
|
||||||
* -)
|
* `-)`
|
||||||
|
|
||||||
Closes a group of file matching options.
|
Closes a group of file matching options.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue