1git-annex-multicast(1)      General Commands Manual     git-annex-multicast(1)
2
3
4

NAME

6       git-annex-multicast - multicast file distribution
7

SYNOPSIS

9       git annex multicast [options]
10

DESCRIPTION

12       Multicast allows files to be broadcast to multiple receivers, typically
13       on a single local network.
14
15       The uftp program is used for multicast.  <http://uftp-multicast.source‐
16       forge.net/>
17

OPTIONS

19       --gen-address
20
21              Generates  a multicast encryption key and stores a corresponding
22              multicast address to the git-annex branch.
23
24       --send [file]
25              Sends the specified files to any receivers whose  multicast  ad‐
26              dresses are stored in the git-annex branch.
27
28              When  no  files  are specified, all annexed files in the current
29              directory and subdirectories are sent.
30
31              The git-annex-matching-options(1) can be used to  control  which
32              files to send. For example:
33
34               git annex multicast send . --not --copies 2
35
36       --receive
37              Receives files from senders whose multicast addresses are stored
38              in the git-annex brach.
39
40              As each file is received, its filename is displayed. This is the
41              filename  that the sender used; the local working tree may use a
42              different name for the file, or not contain a link to the file.
43
44              This command continues running, until it is interrupted  by  you
45              pressing ctrl-c.
46
47              Note  that  the  configured  annex.diskreserve is not honored by
48              this command, because uftpd receives the actual files,  and  can
49              receive any size file.
50
51       --uftp-opt=option -Uoption
52              Pass  an  option  on to the uftp/uftpd command. May be specified
53              multiple times.
54
55              For example, to broadcast at 50 Mbps:
56
57               git annex multicast send -U-R -U50000
58
59       Also the git-annex-common-options(1) can be used.
60

EXAMPLE

62       Suppose a teacher wants to multicast files to students in a classroom.
63
64       This assumes that the teacher and  students  have  cloned  a  git-annex
65       repository,  and both can push changes to its git-annex branch, or oth‐
66       erwise push changes to each-other.
67
68       First, the teacher runs git annex multicast  --gen-address;  git  annex
69       sync
70
71       Next,  students  each  run git annex multicast --gen-address; git annex
72       sync
73
74       Once all the students have generated addresses, the  teacher  runs  git
75       annex sync once more. (Now the students all have received the teacher's
76       address, and the teacher has received all the student's addresses.)
77
78       Next students each run git annex multicast --receive
79
80       Finally, once the students are all listening (ahem), teacher  runs  git
81       annex multicast --send
82

SEE ALSO

84       git-annex(1)
85
86       uftp(1)
87
88       uftpd(1)
89

AUTHOR

91       Joey Hess <id@joeyh.name>
92
93                                                        git-annex-multicast(1)