NAME

pacman-mirrors - generate pacman mirrorlist for Manjaro Linux

SYNOPSIS

pacman-mirrors [-f NUMBER | [[-i [-d]] [-c COUNTRY, [COUNTRY] ... | --geoip]]] [-m METHOD] [-a [-p PREFIX] [-R] [-G | -S BRANCH] [-P PROTO [PROTO] ...][-U URL]] [-b BRANCH] [-t SECONDS] [-q] [-v] [-n | -y]

DESCRIPTION

Generate mirrorlist for Manjaro Linux. Default is to rank all mirrors by reponse time. If no arguments are given pacman-mirrors lists available options. Pacman-mirrors requires access to files which are read-only so it must be run with su or sudo. To create a mirrorlist using all default use,

pacman-mirrors --generate

The mirrorlist generation process can be refined through arguments and arguments with options, for example,

pacman-mirrors --country Denmark --timeout 5

OPTIONS

Some options are mutual exclusive and will throw an arguments error:

• --no-mirrorlist and --sync
• --branch, --get-branch and --set-branch
• --sync and --no-mirrorlist
• --country and --geoip

Others can be used together but they have precedence. If the fasttrack arg is used with interactive, country or geoip the fasttrack arg will have precendence and the others are ignored. Some arguments requires other argument to have effect for example, this command will ignore --default argument

WRONG pacman-mirrors -b unstable --default

as it should have been in conjunction with --interactive, like

CORRECT pacman-mirrors -b unstable --interactive --default

The same goes for the API specific arguments. For those to have effect the --api argument must be present also.

pacman-mirrors -aS unstable

The arguments can appear in any order except for arguments which takes additional options in which case the options must follow immediately after the argument, for example

pacman-mirrors -ayidS unstable

METHODS

-g, --generate

Generate a new default mirrorlist using defaults

-f, --fasttrack NUMBER

Generates a mirrorlist with a number mirrors ranked by responsiveness, the mirrors are selected from http://repo.manjaro.org/status.json

-i, --interactive [--default]

Launches a tool for selectively picking mirrors and protocols, --default forces pacman-mirrors to load the default mirror file and ignore any preset custom-mirrors file, thus allowing for reselecting mirrors for a new custom mirror file

-m, --method METHOD

Default method is rank but random can be selected

BRANCH

-b, --branch BRANCH

Temporarily use another branch, use stable, testing or unstable, the branch is reset with next run of pacman-mirrors

COUNTRY

-c, --country COUNTRY [COUNTRY] ...

Specifiy a country or a list of countries

--geoip

Use geolocation if possible, if not uses all mirrors

-l, --list, --country-list

Lists available mirror countries

API

-a, --api [-p PREFIX] [-R] [-G|-S BRANCH] [-P PROTO [PROTO] ...][-U URL]

Instructs pacman-mirrors to activate processing of API arguments

-p, --prefix PREFIX

Add a path prefix to pacman-mirrors file-handling eg. /mnt/install or $mnt

-G, --get-branch

Return branch from configuration.

-R, --re-branch

Replace the branch in mirrorlist

-S, --set-branch BRANCH

Replace the branch in configuration, use stable, testing or unstable

-P, --proto, --protocols PROTO [PROTO] ...

Write the protocols to configuration, use all or http, https, ftp and ftps

-U, --url URL

Replace mirrorlist with supplied url

MISC

-h, --help

Show the help message

-n, --no-mirrorlist

Use to skip generation of mirrorlist

-q, --quiet

Make pacman-mirrors silent

-t, --timeout SECONDS

Change the number of seconds waiting for a server response, SSL enabled mirrors has this value doubled to compensate for the time spent on exchanging encryption keys

-v, --version

Show the version of pacman-mirrors

-y, --sync

Instruct pacman-mirrors to syncronize the pacman database

Exit status:

0 : OK
1 : Problem with argument
2 : Problem accessing systemfiles
3 : Missing mirror file
BRANCH: Value from config

Configuration flow of pacman-mirrors

At launch an internal default configuration is setup, file configuration is applied and the commandline is parsed and applied.

API arguments

These arguments modifies key elements of pacman-mirrors configuration according to the packagers needs.

The actions performed by the API are in strict order and performed before any other actions.

1. If --prefix

• prefix internal file configuration with $PREFIX
• continue

2. If --set-branch

• apply internal branch configuration with $BRANCH
• continue

3. If --url

• apply internal configuration to a mirrorlist with $URL
• continue

4. If --re-branch

• replace branch in mirrorlist with $BRANCH
• continue

5. If --get-branch

• sys.exit(config.branch)

When done pacman-mirrors checks the internet connection and if possible download the latest datafiles for creating the mirrorlist. At this point it is possible to interupt further processing.

If the -n / no-mirrorlist argument is present pacman-mirrors will now exit.

EXAMPLES

Most optional arguments are self explaining others require explanation. The API functions is mainly designed to help packagers and iso-builders. However it can be of use for everyone because it takes the hazzle out of editing your pacman-mirrors configuration.

• Which countries has mirrors?

  sudo pacman-mirrors -l

• I want to temporary change branch to unstable, use geolocation and syncronize pacman,

  sudo pacman-mirrors -yb unstable --geoip

• I want to permanently change branch to unstable, use mirrors from Germany and France, use only https and http protocol in that order and syncronize pacman

  sudo pacman-mirrors -yac Germany,France -S unstable -P https http

• Create a mirrorlist with German mirrors and syncronize pacman

  sudo pacman-mirrors -yc Germany

• If you want more countries in your mirrorlist add them

  sudo pacman-mirrors -yc Germany France Denmark

• Create a mirrorlist with 5 mirrors with current packages and syncronize pacman

  sudo pacman-mirrors -yf 5

• I want to choose my mirrors

  sudo pacman-mirrors -i

• I have a custom mirror list and I want to create a new custom mirror list?

  sudo pacman-mirrors -i --default

• I have a custom mirror list - can I reset it?

  sudo pacman-mirrors -c all

• What branch am I on

  sudo pacman-mirrors -a -G

• Change system branch and dont change the mirrorlist

  sudo pacman-mirrors -naS unstable

• Change system branch and replace branch in mirrorlist and quit

  sudo pacman-mirrors -naRS unstable

• Change protocols you will accept but dont touch the mirrorlist

  sudo pacman-mirrors -naP https http

• A packager can write directly to a mounted systems datafiles using either a path or an environment variable replacing the branch in both configuration and mirrorlist leaving the mirrors as is

  sudo pacman-mirrors -anR -p $mnt -S $branch -P https

REPORTING BUGS

https://github.com/manjaro/pacman-mirrors/issues

SEE ALSO

The pacman-mirrors source code and all documentation may be downloaded from https://github.com/manjaro/pacman-mirrors/archive/master.zip

AUTHORS

Esclapion esclapion@manjaro.org
philm philm@manjaro.org
Ramon Buldó rbuldo@gmail.com
Hugo Posnic huluti@manjaro.org
Frede Hundewadt frede@hundewadt.dk