ryuslash/update-mirrors
1
0
Fork 0
Code Releases Activity

Mention defaults in configuration section

Browse source
This commit is contained in:
Tom Willemse 2022-11-26 16:54:56 -08:00
parent 27930ff66e
commit 12e6e5bf82
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.org
View file

@ -35,9 +35,9 @@ Note that my repository currently isn't signed, plus I'm just a random guy on th
There are a few configuration options. The configuration file is just a regular shell script sourced by the =update-mirrors= script.
- =url= :: A string. The base URL for archlinux's mirrorlist generator. You probably don't have to change this.
- =countries= :: An array of strings. Which countries you want to include mirrors from. You will probably want to change this.
- =protocols= :: An array of strings. Which protocols to include. Available protocols are =http= and =https=.
- =ip_versions= :: An array of numbers. Which IP versions to include in the mirrorlist. Available versions are =4= and =6=.
- =use_mirror_status= :: The string “on” or empty. Turning this on will make the generator filter the list of mirrors by the mirror score from the [[https://archlinux.org/mirrors/status/][Mirror Status]] page.
- =dest= :: A string, a file path. Where to write the result to. You probably don't have to change this.
- =url= :: A string. The base URL for archlinux's mirrorlist generator. You probably don't have to change this. *Default*: https://www.archlinux.org/mirrorslist.
- =countries= :: An array of strings. Which countries you want to include mirrors from. You will probably want to change this. *Default*: BE, NL.
- =protocols= :: An array of strings. Which protocols to include. Available protocols are =http= and =https=. *Default*: http, https.
- =ip_versions= :: An array of numbers. Which IP versions to include in the mirrorlist. Available versions are =4= and =6=. *Default*: 4.
- =use_mirror_status= :: The string “on” or empty. Turning this on will make the generator filter the list of mirrors by the mirror score from the [[https://archlinux.org/mirrors/status/][Mirror Status]] page. *Default*: on
- =dest= :: A string, a file path. Where to write the result to. You probably don't have to change this. *Default*: /etc/pacman.d/mirrorlist.