git-annex/doc/git-annex-describe.mdwn

# NAME

git-annex describe - change description of a repository

# SYNOPSIS

git annex describe repository description

# DESCRIPTION

Changes the description of a repository.

The repository to describe can be specified by git remote name or
by uuid. To change the description of the current repository, use
"here".

Repository descriptions are displayed by git-annex in various places.
They are most useful when git-annex knows about a repository, but there is
no git remote corresponding to it.

# OPTIONS

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

# SEE ALSO

[[git-annex]](1)

[[git-annex-init]](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 setup commands while at the gate in ATL 2015-03-23 22:20:42 +00:00			`# NAME`

			`git-annex describe - change description of a repository`

			`# SYNOPSIS`

			`git annex describe repository description`

			`# DESCRIPTION`

			`Changes the description of a repository.`

			`The repository to describe can be specified by git remote name or`
			`by uuid. To change the description of the current repository, use`
			`"here".`

			`Repository descriptions are displayed by git-annex in various places.`
			`They are most useful when git-annex knows about a repository, but there is`
			`no git remote corresponding to it.`

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			`# OPTIONS`

			`* The [[git-annex-common-options]](1) can be used.`

separated man pages for all the setup commands while at the gate in ATL 2015-03-23 22:20:42 +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-init]](1)`

separated man pages for all the setup commands while at the gate in ATL 2015-03-23 22:20:42 +00:00			`# AUTHOR`

			`Joey Hess <id@joeyh.name>`

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