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.
This commit is contained in:
Antoine Beaupré
parent
1393797373
commit
21ec5872f4
54 changed files with 208 additions and 7 deletions
|
|
@ -44,6 +44,18 @@ non-large file directly to the git repository, instead of to the annex.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-unlock]](1)
|
||||
|
||||
[[git-annex-lock]](1)
|
||||
|
||||
[[git-annex-undo]](1)
|
||||
|
||||
[[git-annex-import]](1)
|
||||
|
||||
[[git-annex-unannex]](1)
|
||||
|
||||
[[git-annex-reinject]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -17,6 +17,10 @@ The files will have names starting with "unused."
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-add]](1)
|
||||
|
||||
[[git-annex-unused]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -59,6 +59,12 @@ be used to get better filenames.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-rmurl]](1)
|
||||
|
||||
[[git-annex-registerurl]](1)
|
||||
|
||||
[[git-annex-importfeed]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -11,9 +11,6 @@ git annex assistant
|
|||
Watches for changes to files in the current directory and its subdirectories,
|
||||
and automatically syncs them to other remotes.
|
||||
|
||||
For more details about the git-annex assistant, see
|
||||
<https://git-annex.branchable.com/assistant/>
|
||||
|
||||
# OPTIONS
|
||||
|
||||
* `--autostart`
|
||||
|
|
@ -45,6 +42,13 @@ For more details about the git-annex assistant, see
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-watch]](1)
|
||||
|
||||
[[git-annex-schedule]](1)
|
||||
|
||||
For more details about the git-annex assistant, see
|
||||
<https://git-annex.branchable.com/assistant/>
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -68,6 +68,12 @@ Copies the content of files from or to another remote.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-get]](1)
|
||||
|
||||
[[git-annex-move]](1)
|
||||
|
||||
[[git-annex-drop]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -18,6 +18,14 @@ description, or their UUID.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-trust]](1)
|
||||
|
||||
[[git-annex-semitrust]](1)
|
||||
|
||||
[[git-annex-untrust]](1)
|
||||
|
||||
[[git-annex-expire]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -22,6 +22,8 @@ no git remote corresponding to it.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-init]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -21,6 +21,8 @@ commands.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-indirect]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -59,6 +59,12 @@ safe to do so.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-get]](1)
|
||||
|
||||
[[git-annex-move]](1)
|
||||
|
||||
[[git-annex-copy]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -32,6 +32,8 @@ Or, specify "all" to drop all unused data.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-unused]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -49,6 +49,8 @@ make little sense except in cases like the revoked key example above.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-initremote]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -58,6 +58,10 @@ finds files in the current directory and its subdirectories.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-whereis]](1)
|
||||
|
||||
[[git-annex-list]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -25,6 +25,8 @@ but is done automatically when committing a change with git too.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-fsck]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -84,7 +84,11 @@ With parameters, only the specified files are checked.
|
|||
|
||||
# SEE ALSO
|
||||
|
||||
[[git-annex]](1), [[git-annex-repair]](1)
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-repair]](1)
|
||||
|
||||
[[git-annex-expire]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
|
|
|
|||
|
|
@ -58,6 +58,10 @@ or transferring them from some kind of key-value store.
|
|||
|
||||
[[git-annex-drop]](1)
|
||||
|
||||
[[git-annex-copy]](1)
|
||||
|
||||
[[git-annex-move]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -22,6 +22,12 @@ A repository can be in multiple groups at the same time.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-ungroup]](1)
|
||||
|
||||
[[git-annex-preferred-content]](1)
|
||||
|
||||
[[git-annex-wanted]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -25,6 +25,12 @@ make repositories in the group want to contain 3 copies of every file:
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-group]](1)
|
||||
|
||||
[[git-annex-wanted]](1)
|
||||
|
||||
[[git-annex-preferred-content]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -75,6 +75,8 @@ backend does not look at file content, but filename and mtime.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-add]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -42,6 +42,8 @@ To make the import process add metadata to the imported files from the feed,
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-addurl]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -19,6 +19,8 @@ default to using direct mode.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-direct]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -20,6 +20,12 @@ one will be generated using the username, hostname and the path.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-describe]](1)
|
||||
|
||||
[[git-annex-reinit]](1)
|
||||
|
||||
git-init(1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -50,6 +50,8 @@ access.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-enableremote]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -27,6 +27,10 @@ files. This is similar to `git annex whereis` but a more compact display.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-find]](1)
|
||||
|
||||
[[git-annex-whereis]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -22,6 +22,10 @@ the files, or have made modifications you want to discard.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-add]](1)
|
||||
|
||||
[[git-annex-unlock]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -20,6 +20,8 @@ working copy automatically.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-sync]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -89,6 +89,8 @@ To set some tags on a file and also its author:
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-view]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ it's best to run migrate in all of them.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-upgrade]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ the source repository, it will be dropped from the destination repository
|
|||
when the numcopies setting allows.
|
||||
|
||||
Note that mirror does not sync the git repository, but only the file
|
||||
contents.
|
||||
contents. Use [[git-annex-sync]](1) for that.
|
||||
|
||||
# OPTIONS
|
||||
|
||||
|
|
@ -55,6 +55,8 @@ contents.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-sync]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -51,6 +51,12 @@ Moves the content of files from or to another remote.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-get]](1)
|
||||
|
||||
[[git-annex-copy]](1)
|
||||
|
||||
[[git-annex-drop]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -25,6 +25,8 @@ valid url, an URL key is constructed from the url.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-addurl]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -21,6 +21,8 @@ a fsck.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-init]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -25,6 +25,10 @@ Example:
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-add]](1)
|
||||
|
||||
[[git-annex-fsck]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -46,7 +46,9 @@ to make sure that the git-annex branch reflects reality.
|
|||
|
||||
# SEE ALSO
|
||||
|
||||
[[git-annex]](1), [[gi-annex-fsck]](1)
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-fsck]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
|
|
|
|||
|
|
@ -14,6 +14,8 @@ Record that the file is no longer available at the url.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-addurl]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -40,6 +40,10 @@ To schedule multiple jobs, separate them with "; ".
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-assistant]](1)
|
||||
|
||||
[[git-annex-expire]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -17,6 +17,14 @@ description, or their UUID. For the current repository, use "here".
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-trust]](1)
|
||||
|
||||
[[git-annex-untrust]](1)
|
||||
|
||||
[[git-annex-dead]](1)
|
||||
|
||||
[[git-annex-expire]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -25,6 +25,8 @@ Particularly useful in direct mode.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
git-status(1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -47,7 +47,10 @@ by running "git annex sync" on the remote.
|
|||
By default, this tries to get each annexed file that the local repository
|
||||
does not yet have, and then copies each file to every remote that it is
|
||||
syncing with. This behavior can be overridden by configuring the preferred
|
||||
content of a repository. See [git-annex-preferred-content](1)
|
||||
content of a repository. See [[git-annex-preferred-content]](1).
|
||||
|
||||
To make two repositories have the same set of fies, you should use
|
||||
[[git-annex-mirror]](1) instead of this flag.
|
||||
|
||||
* `--message=msg`
|
||||
|
||||
|
|
@ -57,6 +60,10 @@ by running "git annex sync" on the remote.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-preferred-content]](1)
|
||||
|
||||
[[git-annex-mirror]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -18,6 +18,12 @@ description, or their UUID. To trust the current repository, use "here".
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-semitrust]](1)
|
||||
|
||||
[[git-annex-untrust]](1)
|
||||
|
||||
[[git-annex-dead]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -26,6 +26,8 @@ operates on the file tree committed to git.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-add]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -14,6 +14,8 @@ Removes a repository from a group.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-group]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -18,6 +18,8 @@ git repository plus the previously annexed files.
|
|||
|
||||
[[git-annex-unannex]](1)
|
||||
|
||||
[[git-annex-init]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -25,6 +25,12 @@ it back into the annex.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-edit]](1)
|
||||
|
||||
[[git-annex-add]](1)
|
||||
|
||||
[[git-annex-lock]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -18,6 +18,12 @@ description, or their UUID. To untrust the current repository, use "here".
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-trust]](1)
|
||||
|
||||
[[git-annex-semitrust]](1)
|
||||
|
||||
[[git-annex-dead]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -65,6 +65,10 @@ and walking the list in order from left to right.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-dropunused]](1)
|
||||
|
||||
[[git-annex-addunused]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -25,6 +25,8 @@ allow archives to be taken offline for years and later used.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-migrate]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -21,6 +21,8 @@ to only those two.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-metadata]](1)
|
||||
|
||||
[[git-annex-view]](1)
|
||||
|
||||
[[git-annex-vpop]](1)
|
||||
|
|
|
|||
|
|
@ -17,6 +17,8 @@ it to author/tag/year.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-metadata]](1)
|
||||
|
||||
[[git-annex-view]](1)
|
||||
|
||||
[[git-annex-vpop]](1)
|
||||
|
|
|
|||
|
|
@ -15,6 +15,8 @@ specified field values and tags.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-metadata]](1)
|
||||
|
||||
[[git-annex-view]](1)
|
||||
|
||||
[[git-annex-vpop]](1)
|
||||
|
|
|
|||
|
|
@ -17,6 +17,8 @@ The optional number tells how many views to pop.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-metadata]](1)
|
||||
|
||||
[[git-annex-view]](1)
|
||||
|
||||
[[git-annex-vfilter]](1)
|
||||
|
|
|
|||
|
|
@ -22,6 +22,12 @@ of the repository.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-required]](1)
|
||||
|
||||
[[git-annex-preferred-content]](1)
|
||||
|
||||
[[git-annex-groupwanted]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -36,6 +36,8 @@ files that it does not match will instead be added with `git add`.
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-assistant]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -42,6 +42,8 @@ one way to generate those files, using a self-signed certificate:
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-assistant]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
|
|
@ -49,6 +49,10 @@ For example:
|
|||
|
||||
[[git-annex]](1)
|
||||
|
||||
[[git-annex-find]](1)
|
||||
|
||||
[[git-annex-list]](1)
|
||||
|
||||
# AUTHOR
|
||||
|
||||
Joey Hess <id@joeyh.name>
|
||||
|
|
|
|||
Loading…
Reference in a new issue