diff options
| author |  Joey Hess <joeyh@joeyh.name> | 2016-11-29 17:31:10 -0400 |
|---|---|---|
| committer | Joey Hess <joeyh@joeyh.name> | 2016-11-29 17:31:10 -0400 |
| commit | c75ff07b143e1917fe65abeddd221fa3252fb02d (patch) | |
| tree | 373123140ddabce09faecc020b53cea29e5ffad8 /doc/git-annex-p2p.mdwn | |
| parent | 6fbf18025af8c697b515e83600f16de0c232a994 (diff) | |
update docs for git-annex p2p command
It is not yet implemented.
Diffstat (limited to 'doc/git-annex-p2p.mdwn')
| -rw-r--r-- | doc/git-annex-p2p.mdwn | 35 |
1 files changed, 10 insertions, 25 deletions
diff --git a/doc/git-annex-p2p.mdwn b/doc/git-annex-p2p.mdwn index 41e1967ee..8e06cc47c 100644 --- a/doc/git-annex-p2p.mdwn +++ b/doc/git-annex-p2p.mdwn @@ -1,6 +1,6 @@ # NAME -git-annex p2p - manage peer-to-peer connections +git-annex p2p - configure peer-2-peer links between repositories # SYNOPSIS @@ -8,36 +8,21 @@ git annex p2p [options] # DESCRIPTION -When using git-annex with peer-to-peer communication, this manages -connections between the peers. - -Currently, git-annex supports peer-to-peer communication over Tor. +This command can be used to link git-annex repositories over peer-2-peer +networks. # OPTIONS -* `--gen-address [name]` - - Generates one or more addresses, which allow whoever knows them to access - your repository. The addresses are output on standard output, one per - supported P2P network. - - You can re-run this command repeatedly to generate as many addresses - as you like. - - The name is an optional parameter, the name of the person or device you - intend to give this address to. Providig it makes it easier to use - `--remove-address` - -* `--link-remote name address` +* `--gen-address` - Link the local repository to a remote repository. This sets up a git remote - with the specified name. The address is one generated by `--gen-address` - run on the remote repository. + Generates addresses that can be used to access this git-annex repository + over a P2P network. The address or addresses is output to stdout. -* `--remove-address [address|name]` +* `--link-remote remotename address` - If you've given out an address to someone, and don't want to accept - connections from them anymore, this can be used to remove it. + Sets up a git remote with the specified remotename that is accessed over + a P2P network. The address is one generated in the remote repository using + `git annex p2p --gen-address` # SEE ALSO |