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

NAME

6       git-annex-addurl - add urls to annex
7

SYNOPSIS

9       git annex addurl [url ...]
10

DESCRIPTION

12       Downloads each url to its own file, which is added to the annex.
13
14       When  youtube-dl  is  installed,  it  can  be used to check for a video
15       embedded in  a web page at the url, and that  is  added  to  the  annex
16       instead.  (However, this is disabled by default as it can be a security
17       risk.  See the documentation of annex.security.allowed-ip-addresses  in
18       git-annex(1) for details.)
19
20       Special  remotes can add other special handling of particular urls. For
21       example, the bittorrent special remotes makes  urls  to  torrent  files
22       (including  magnet  links)  download  the content of the torrent, using
23       aria2c.
24
25       Normally the filename is based on the  full  url,  so  will  look  like
26       "www.example.com_dir_subdir_bigfile".  In some cases, addurl is able to
27       come up with a better filename based on other information. Options  can
28       also be used to get better filenames.
29

OPTIONS

31       --fast
32
33              Avoid  immediately downloading the url. The url is still checked
34              (via HEAD) to verify that it exists, and to get its size if pos‐
35              sible.
36
37       --relaxed
38              Don't  immediately  download the url, and avoid storing the size
39              of the url's content. This makes git-annex accept whatever  con‐
40              tent is there at a future point.
41
42              This  is the fastest option, but it still has to access the net‐
43              work to check if the url contains embedded  media.  When  adding
44              large numbers of urls, using --relaxed --raw is much faster.
45
46       --raw  Prevent  special handling of urls by youtube-dl, bittorrent, and
47              other special remotes. This will for example, make addurl  down‐
48              load the .torrent file and not the contents it points to.
49
50       --file=name
51              Use  with  a  filename that does not yet exist to add a new file
52              with the specified name and the content downloaded from the url.
53
54              If the file already exists, addurl will record that  it  can  be
55              downloaded from the specified url(s).
56
57       --pathdepth=N
58              Rather  than basing the filename on the whole url, this causes a
59              path to be constructed, starting at the specified  depth  within
60              the path of the url.
61
62              For  example,  adding  the  url  http://www.example.com/dir/sub
63              dir/bigfile with --pathdepth=1  will  use  "dir/subdir/bigfile",
64              while --pathdepth=3 will use "bigfile".
65
66              It  can  also  be negative; --pathdepth=-2 will use the last two
67              parts of the url.
68
69       --prefix=foo --suffix=bar
70              Use to adjust the filenames that  are  created  by  addurl.  For
71              example,  --suffix=.mp3  can  be used to add an extension to the
72              file.
73
74       --jobs=N -JN
75              Enables parallel downloads when multiple urls are  being  added.
76              For example: -J4
77
78              Setting this to "cpus" will run one job per CPU core.
79
80       --batch
81              Enables  batch  mode,  in which lines containing urls to add are
82              read from stdin.
83
84       -z     Makes the --batch input be delimited by  nulls  instead  of  the
85              usual newlines.
86
87       --with-files
88              When  batch  mode  is enabled, makes it parse lines of the form:
89              "$url $file"
90
91              That adds the specified url to the specified  file,  downloading
92              its  content  if  the  file  does not yet exist; the same as git
93              annex addurl $url --file $file
94
95       --json Enable JSON output. This is intended to be  parsed  by  programs
96              that use git-annex. Each line of output is a JSON object.
97
98       --json-progress
99              Include progress objects in JSON output.
100
101       --json-error-messages
102              Messages  that  would  normally  be output to standard error are
103              included in the json instead.
104

CAVEATS

106       If annex.largefiles is configured, and does not match a file, git annex
107       addurl  will  add  the  non-large  file directly to the git repository,
108       instead of to the annex. However, this  is  not  done  when  --fast  or
109       --relaxed is used.
110

SEE ALSO

112       git-annex(1)
113
114       git-annex-rmurl(1)
115
116       git-annex-registerurl(1)
117
118       git-annex-importfeed(1)
119

AUTHOR

121       Joey Hess <id@joeyh.name>
122
123                                                           git-annex-addurl(1)
Impressum