1
0
Fork 0

Highlight default values in README

This commit is contained in:
Tom Willemse 2022-11-26 17:11:10 -08:00
parent b380afd9ea
commit 962a489840

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 =etc/xdg/update-mirrors/config.sh= 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. *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.
- =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=.