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

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

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

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

76 lines
2.1 KiB
Markdown

# NAME
git-annex unused - look for unused file content
# SYNOPSIS
git annex unused
# DESCRIPTION
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.
After running this command, you can use the `--unused` option with many
other git-annex commands to operate on all the unused data that was found.
For example, to move all unused data to origin:
git annex unused; git annex move --unused --to origin
# OPTIONS
* `--fast`
Only show unused temp and bad files.
* `--from=remote`
Check for unused data that is located on a remote.
* `--used-refspec=+ref:-ref`
By default, any data that the work tree uses, or that any refs in the git
repository point to is considered to be used. If you only want to use
some refs, you can use this option to specify the ones to use. Data that
is not in the specified refs (and not used by the work tree) will then be
considered unused.
The git configuration annex.used-refspec can be used to configure
this in a more permanent fashion.
# REFSPEC FORMAT
The refspec format for --used-refspec is a colon-separated list of
additions and removals of refs. For example:
+refs/heads/*:+HEAD^:+refs/tags/*:-refs/tags/old-tag
This adds all refs/heads/ refs, as well as the previous version
of HEAD. It also adds all tags, except for old-tag.
This refspec is processed by starting with an empty set of refs,
and walking the list in order from left to right.
* Each + using a glob is matched against all relevant refs
(a subset of `git show-ref`) and all matching refs are added
to the set.
For example, "+refs/remotes/*" adds all remote refs.
* Each + without a glob adds the literal value to the set.
For example, "+HEAD^" adds "HEAD^".
* Each - is matched against the set of refs accumulated so far.
Any matching refs are removed from the set.
# SEE ALSO
[[git-annex]](1)
[[git-annex-dropunused]](1)
[[git-annex-addunused]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.