git-annex/doc/git-annex-list.mdwn

# NAME

git-annex list - show which remotes contain files

# SYNOPSIS

git annex list `[path ...]`

# DESCRIPTION

Displays a table of remotes that contain the contents of the specified
files. This is similar to `git annex whereis` but a more compact display.

# OPTIONS

* `--allrepos`

  Only configured remotes are shown by default; this option
  adds all known repositories to the list.

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

* Also the [[git-annex-common-options]](1) can be used.

# SEE ALSO

[[git-annex]](1)

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

[[git-annex-whereis]](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 list - show which remotes contain files`

			`# SYNOPSIS`

			git annex list `[path ...]`

			`# DESCRIPTION`

			`Displays a table of remotes that contain the contents of the specified`
			files. This is similar to `git annex whereis` but a more compact display.

			`# OPTIONS`

			* `--allrepos`

			`Only configured remotes are shown by default; this option`
			`adds all known repositories to the list.`

			`* file matching options`

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

split out common options to its own page and mention it on each subcommand page Sometimes users would get confused because an option they were looking for was not mentioned on a subcommand's man page, and they had not noticed that the main git-annex man page had a list of common options. This change lets each subcommand mention the common options, similarly to how the matching options are handled. This commit was sponsored by Svenne Krap on Patreon. 2021-05-10 19:00:13 +00:00			`* Also the [[git-annex-common-options]](1) can be used.`

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-whereis]](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.`