git-annex/doc/git-annex-whereis.mdwn

# NAME

git-annex whereis - lists repositories that have file content

# SYNOPSIS

git annex whereis `[path ...]`

# DESCRIPTION

Displays information about where the contents of files are located.

For example:

	# git annex whereis
	whereis my_cool_big_file (1 copy)
		0c443de8-e644-11df-acbf-f7cd7ca6210d  -- laptop
	whereis other_file (3 copies)
		0c443de8-e644-11df-acbf-f7cd7ca6210d  -- laptop
		62b39bbe-4149-11e0-af01-bb89245a1e61  -- usb drive [here]
		7570b02e-15e9-11e0-adf0-9f3f94cb2eaa  -- backup drive

# OPTIONS

* file matching options
  
  The [[git-annex-matching-options]](1)
  can be used to specify files to act on.

* `--key=keyname`

  Show where a particular git-annex key is located.

* `--all`

  Show whereis information for all known keys.

* `--unused`

  Show whereis information for files found by last run of git-annex unused.

* `--json`

  Enable JSON output. This is intended to be parsed by programs that use
  git-annex. Each line of output is a JSON object.

* `--batch`

  Enables batch mode, in which a file is read in a line from stdin,
  its information displayed, and repeat.

  Note that if the file is not an annexed file, an empty line will be
  output instead.

# SEE ALSO

[[git-annex]](1)

[[git-annex-find]](1)

[[git-annex-list]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.
separated man pages for all the maintenance commands 2015-03-24 19:23:59 +00:00			`# NAME`

			`git-annex whereis - lists repositories that have file content`

			`# SYNOPSIS`

			git annex whereis `[path ...]`

			`# DESCRIPTION`

			`Displays information about where the contents of files are located.`

			`For example:`

			`# git annex whereis`
			`whereis my_cool_big_file (1 copy)`
			`0c443de8-e644-11df-acbf-f7cd7ca6210d -- laptop`
			`whereis other_file (3 copies)`
			`0c443de8-e644-11df-acbf-f7cd7ca6210d -- laptop`
			`62b39bbe-4149-11e0-af01-bb89245a1e61 -- usb drive [here]`
			`7570b02e-15e9-11e0-adf0-9f3f94cb2eaa -- backup drive`

			`# OPTIONS`

			`* file matching options`

			`The [[git-annex-matching-options]](1)`
			`can be used to specify files to act on.`

both whereis and metadata accept --key, --all, and --unused; document that 2015-04-21 20:31:00 +00:00			* `--key=keyname`

			`Show where a particular git-annex key is located.`

			* `--all`

			`Show whereis information for all known keys.`

			* `--unused`

			`Show whereis information for files found by last run of git-annex unused.`

whereis --batch 2016-01-20 16:46:00 +00:00			* `--json`

			`Enable JSON output. This is intended to be parsed by programs that use`
			`git-annex. Each line of output is a JSON object.`

			* `--batch`

			`Enables batch mode, in which a file is read in a line from stdin,`
			`its information displayed, and repeat.`

			`Note that if the file is not an annexed file, an empty line will be`
			`output instead.`
both whereis and metadata accept --key, --all, and --unused; document that 2015-04-21 20:31:00 +00:00
separated man pages for all the maintenance commands 2015-03-24 19:23:59 +00:00			`# SEE ALSO`

			`[[git-annex]](1)`

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 16:12:55 +00:00			`[[git-annex-find]](1)`

			`[[git-annex-list]](1)`

separated man pages for all the maintenance commands 2015-03-24 19:23:59 +00:00			`# AUTHOR`

			`Joey Hess <id@joeyh.name>`

			`Warning: Automatically converted into a man page by mdwn2man. Edit with care.`