diff options
| author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2023-10-28 12:01:19 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-28 12:01:19 +0000 |
| commit | 519b7ea0c3a8e612eaf7e64128e967549615b6a7 (patch) | |
| tree | 8052537e4fd51b1575e0a8b9bfb26a7c5487e7b5 /doc | |
| parent | cb64b504a0a80c4df9e96426d830f94080760628 (diff) | |
| parent | b30e97ace2945f9ddcf1b233e04d45ef3c511d9b (diff) | |
| download | nixlib-519b7ea0c3a8e612eaf7e64128e967549615b6a7.tar nixlib-519b7ea0c3a8e612eaf7e64128e967549615b6a7.tar.gz nixlib-519b7ea0c3a8e612eaf7e64128e967549615b6a7.tar.bz2 nixlib-519b7ea0c3a8e612eaf7e64128e967549615b6a7.tar.lz nixlib-519b7ea0c3a8e612eaf7e64128e967549615b6a7.tar.xz nixlib-519b7ea0c3a8e612eaf7e64128e967549615b6a7.tar.zst nixlib-519b7ea0c3a8e612eaf7e64128e967549615b6a7.zip | |
Merge master into staging-next
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/builders/fetchers.chapter.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/builders/fetchers.chapter.md b/doc/builders/fetchers.chapter.md index ba7b1b190128..c99b46097e9f 100644 --- a/doc/builders/fetchers.chapter.md +++ b/doc/builders/fetchers.chapter.md @@ -243,21 +243,21 @@ or *** ``` -## `fetchFromBittorrent` {#fetchfrombittorrent} +## `fetchtorrent` {#fetchtorrent} -`fetchFromBittorrent` expects two arguments. `url` which can either be a Magnet URI (Magnet Link) such as `magnet:?xt=urn:btih:dd8255ecdc7ca55fb0bbf81323d87062db1f6d1c` or an HTTP URL pointing to a `.torrent` file. It can also take a `config` argument which will craft a `settings.json` configuration file and give it to `transmission`, the underlying program that is performing the fetch. The available config options for `transmission` can be found [here](https://github.com/transmission/transmission/blob/main/docs/Editing-Configuration-Files.md#options) +`fetchtorrent` expects two arguments. `url` which can either be a Magnet URI (Magnet Link) such as `magnet:?xt=urn:btih:dd8255ecdc7ca55fb0bbf81323d87062db1f6d1c` or an HTTP URL pointing to a `.torrent` file. It can also take a `config` argument which will craft a `settings.json` configuration file and give it to `transmission`, the underlying program that is performing the fetch. The available config options for `transmission` can be found [here](https://github.com/transmission/transmission/blob/main/docs/Editing-Configuration-Files.md#options) ``` -{ fetchFromBittorrent }: +{ fetchtorrent }: -fetchFromBittorrent { +fetchtorrent { config = { peer-limit-global = 100; }; url = "magnet:?xt=urn:btih:dd8255ecdc7ca55fb0bbf81323d87062db1f6d1c"; sha256 = ""; } ``` -### Parameters {#fetchfrombittorrent-parameters} +### Parameters {#fetchtorrent-parameters} - `url`: Magnet URI (Magnet Link) such as `magnet:?xt=urn:btih:dd8255ecdc7ca55fb0bbf81323d87062db1f6d1c` or an HTTP URL pointing to a `.torrent` file. |