b184fc490a
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.
82 lines
2.2 KiB
Markdown
82 lines
2.2 KiB
Markdown
# NAME
|
|
|
|
git-annex p2p - configure peer-2-peer links between repositories
|
|
|
|
# SYNOPSIS
|
|
|
|
git annex p2p [options]
|
|
|
|
# DESCRIPTION
|
|
|
|
This command can be used to link git-annex repositories over peer-2-peer
|
|
networks.
|
|
|
|
Currently, the only P2P network supported by git-annex is Tor hidden
|
|
services.
|
|
|
|
# OPTIONS
|
|
|
|
* `--pair`
|
|
|
|
Run this in two repositories to pair them together over the P2P network.
|
|
|
|
This will print out a code phrase, like "3-mango-elephant", and
|
|
will prompt for you to enter the code phrase from the other repository.
|
|
|
|
Once code phrases have been exchanged, the two repositories will
|
|
be paired. A git remote will be created for the other repository,
|
|
with a name like "peer1".
|
|
|
|
This uses [Magic Wormhole](https://github.com/warner/magic-wormhole)
|
|
to verify the code phrases and securely communicate the P2P addresses of
|
|
the repositories, so you will need it installed on both computers that are
|
|
being paired.
|
|
|
|
This feature was present in a broken form in git-annex versions
|
|
before version 6.20180705. Make sure that a new enough git-annex
|
|
is installed on both computers that are being paired.
|
|
|
|
* `--gen-addresses`
|
|
|
|
Generates addresses that can be used to access this git-annex repository
|
|
over the available P2P networks. The address or addresses is output to
|
|
stdout.
|
|
|
|
Note that anyone who knows these addresses can access your
|
|
repository over the P2P networks.
|
|
|
|
This can be run repeatedly, in order to give different addresses
|
|
out to different people.
|
|
|
|
* `--link`
|
|
|
|
Sets up a git remote that is accessed over a P2P network.
|
|
|
|
This will prompt for an address to be entered; you should paste in the
|
|
address that was generated by --gen-addresses in the remote repository.
|
|
|
|
Defaults to making the git remote be named "peer1", "peer2",
|
|
etc. This can be overridden with the `--name` option.
|
|
|
|
* `--name`
|
|
|
|
Specify a name to use when setting up a git remote with `--link`
|
|
or `--pair`.
|
|
|
|
* Also the [[git-annex-common-options]](1) can be used.
|
|
|
|
# SEE ALSO
|
|
|
|
[[git-annex]](1)
|
|
|
|
[[git-annex-enable-tor]](1)
|
|
|
|
[[git-annex-remotedaemon]](1)
|
|
|
|
wormhole(1)
|
|
|
|
# AUTHOR
|
|
|
|
Joey Hess <id@joeyh.name>
|
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|