1git-annex-importfeed(1) General Commands Manual git-annex-importfeed(1)
2
6 git-annex-importfeed - import files from podcast feeds
7
9 git annex importfeed [url ...]
10
12 Imports the contents of podcasts and other feeds. Only downloads files
13 whose content has not already been added to the repository before, so
14 you can delete, rename, etc the resulting files and repeated runs won't
15 duplicate them.
16 When youtube-dl is installed, it can be used to download links in the
18 feed. This allows importing e.g., YouTube playlists. (However, this
19 is disabled by default as it can be a security risk. See the documen‐
20 tation of annex.security.allowed-ip-addresses in git-annex(1) for de‐
21 tails.)
22 To make the import process add metadata to the imported files from the
24 feed, git config annex.genmetadata true
25 By default, the downloaded files are put in a directory with the title
27 of the feed, and files are named based on the title of the item in the
28 feed. This can be changed using the --template option.
29 Existing files are not overwritten by this command. If "some
31 feed/foo.mp3" already exists, it will instead write to "some
32 feed/2_foo.mp3" (or 3, 4, etc). Sometimes a feed will change an item's
33 url, resulting in the new url being downloaded to such a filename.
34
36 --force
37 Force downloading items it's seen before.
39 --relaxed, --fast, --raw
41 These options behave the same as when using git-annex-addurl(1).
42 --fast Avoid immediately downloading urls. The url is still checked
44 (via HEAD) to verify that it exists, and to get its size if pos‐
45 sible.
46 --relaxed
48 Don't immediately download urls, and avoid storing the size of
49 the url's content. This makes git-annex accept whatever content
50 is there at a future point.
51 --raw Prevent special handling of urls by youtube-dl, bittorrent, and
53 other special remotes. This will for example, make importfeed
54 download a .torrent file and not the contents it points to.
55 --no-raw
57 Require content pointed to by the url to be downloaded using
58 youtube-dl or a special remote, rather than the raw content of
59 the url. if that cannot be done, the import will fail, and the
60 next import of the feed will retry.
61 --template
63 Controls where the files are stored.
64 The default template is '${feedtitle}/${itemtitle}${extension}'
66 The available variables in the template include these that are
68 information about the feed: feedtitle, feedauthor
69 And these that are information about individual items in the
71 feed: itemtitle, itemauthor, itemsummary, itemdescription, item‐
72 rights, itemid.
73 Also, title is itemtitle but falls back to feedtitle if the item
75 has no title, and author is itemauthor but falls back to feedau‐
76 thor.
77 (All of the above are also added as metadata when annex.genmeta‐
79 data is set.)
80 The extension variable is the extension of the file in the feed,
82 or sometimes ".m" if no extension can be determined.
83 The template also has some variables for when an item was pub‐
85 lished.
86 itempubyear (YYYY), itempubmonth (MM), itempubday (DD), itempub‐
88 hour (HH), itempubminute (MM), itempubsecond (SS), itempubdate
89 (YYYY-MM-DD or if the feed's date cannot be parsed, the raw
90 value from the feed).
91 (These use the UTC time zone, not the local time zone.)
93 --no-check-gitignore
95 By default, gitignores are honored and it will refuse to down‐
96 load an url to a file that would be ignored. This makes such
97 files be added despite any ignores.
98 Also the git-annex-common-options(1) can be used.
100
102 git-annex(1)
103 git-annex-addurl(1)
105
107 Joey Hess <id@joeyh.name>
108 git-annex-importfeed(1)