Skip to content
Snippets Groups Projects
Commit ec4b32da authored by Frede H's avatar Frede H :speech_balloon:
Browse files

update docs

parent d2a6d548
No related branches found
No related tags found
No related merge requests found
......@@ -16,6 +16,7 @@ To remove a custom mirror file
#### `--geoip`
Find current country by using geolocation.
### METHODS:
All methods can be combined with `-y/--sync` to fully complete the process.
#### `-g`, `--generate`
Generate a new default mirrorlist.
#### `-f {DIGIT}`, `--fasttrack {DIGIT}`
......
......@@ -110,6 +110,7 @@ To remove a custom mirror file
<h4 id="-geoip"><code>--geoip</code></h4>
<p>Find current country by using geolocation.</p>
<h3 id="methods">METHODS:</h3>
<p>All methods can be combined with <code>-y/--sync</code> to fully complete the process.</p>
<h4 id="-g-generate"><code>-g</code>, <code>--generate</code></h4>
<p>Generate a new default mirrorlist.</p>
<h4 id="-f-digit-fasttrack-digit"><code>-f {DIGIT}</code>, <code>--fasttrack {DIGIT}</code></h4>
......@@ -243,5 +244,5 @@ The branch is reset on next run of pacman-mirrors.</p>
<!--
MkDocs version : 0.16.3
Build Date UTC : 2017-05-14 10:48:22
Build Date UTC : 2017-05-14 10:52:03
-->
......@@ -2,7 +2,7 @@
"docs": [
{
"location": "/",
"text": "Documentation of pacman-mirrors\n\n\nEnhanced pacman-mirrors for Manjaro Linux\n\n\nUSAGE\n\n\nGENERIC:\n\n\n-h\n, \n--help\n\n\nShow the help message.\n\n\n-v\n, \n--version\n\n\nShow the version of pacman-mirrors.\n\n\nCOUNTRY:\n\n\n-c COUNTRY [COUNTRY ...]\n, \n--country COUNTRY [COUNTRY ...]\n\n\nSpecifiy country or list of countries separated by comma or space:\n\n --country France\n\n --country France Germany Austria\nTo remove a custom mirror file\n* --country all\n\n\n--geoip\n\n\nFind current country by using geolocation.\n\n\nMETHODS:\n\n\n-g\n, \n--generate\n\n\nGenerate a new default mirrorlist.\n\n\n-f {DIGIT}\n, \n--fasttrack {DIGIT}\n\n\nGenerates a mirrorlist of \nDIGIT\n mirrors ranked by responsiveness.\nThe mirrors are randomly selected from a selection of mirrors known to be up-to-date on all branches.\n\n\n-m {method}\n, \n--method {method}\n\n\nChoose the generation method:\n\nSelect \nrank\n or \nrandom\n\n\n-i\n, \n--interactive\n\n\nLaunch a tool for selectively picking mirrors and protocols for a custom mirrorlist.\n\n\nMISC:\n\n\n-b {branch}\n, \n--branch {branch}\n\n\nChoose a temporary branch:\n\nSelect \nstable\n, \ntesting\n or \nunstable\n.\nThe branch is reset on next run of pacman-mirrors.\n\n\n-d {new_dir}\n, \n--mirror_dir {new_dir}\n\n\nChoose a temporary directory where mirrors file is located.\n\n\n-l\n, \n--list\n\n\nLists available mirror countries\n\n\n-o {new_file}\n, \n--output {new_file}\n\n\nChoose a temporary file for your mirrorlist.\n\n\n-q\n, \n--quiet\n\n\nMake pacman-mirrors silent.\n\n\n-t {DIGIT}\n, \n--timeout {DIGIT}\n\n\nChange the server maximum waiting time. In case of SSL enabled mirrors the value is doubled to compensate for the time spent on exchanging encryption keys.\n\n\n--default\n\n\nThis argument \nonly\n have effect in conjunction with \n-i/--interactive\n. It 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. The argument executes the ranking/randomizing when the selection of mirrors is done. Can be combined with \n-y/--sync\n to fully complete the process.\n\n\n--no-update\n\n\nThis argument is tied to the \nNoUpdate = True\n setting in the config file. Pacman-mirrors will exit after parsing \npacman-mirrors.conf\n and is only useful if you don't want the mirrorlist regenerated after a pacman-mirrors package upgrade.\n\n\nSYNC:\n\n\n-y\n, \n--sync\n,\n-u\n, \nupdate\n\n\nInstruct pacman-mirrors to syncronise the pacman databases after mirrorlist generation. This is done by calling \npacman -Syy\n.\n\n\nAPI:\n\n\nMake permanent changes to pacman-mirrors configuration through an api. The tasks are executed before generating the mirrorlist.\n\n\n-a\n, \n--api\n [--prefix] [--get-branch | --set-branch {branch}] [--proto PROTO [PROTO ...]] [--no-mirrorlist]\n\n\nThe key to the following arguments is \n-a\n or \n--api\n. If it is missing none of the arguments will have any effect.\n\n\n--prefix\n\n\n\n\nAdd a path prefix to pacman-mirrors file-handling eg. \n/mnt/install\n or \n$mnt\n.\n\n\n\n\n--get-branch\n\n\n\n\nReturns branch from \n/etc/pacman-mirrors.conf\n optionally with a prefix.\n\n\n\n\n--set-branch {branch}\n\n\n\n\nWrites the branch to \n/etc/pacman-mirrors.conf\n optionally with a prefix.\n\n\nSelect \nstable\n, \ntesting\n or \nunstable\n.\n\n\n\n\n--proto PROTO [PROTO ...]\n\n\n\n\nWrite the specified protocols to \n/etc/pacman-mirrors.conf\n optionally with a prefix.\n\n\nSelect \nall\n or \nhttp\n, \nhttps\n, \nftp\n and \nftps\n.\n\n\n\n\n-n\n, \n--no-mirrorlist\n\n\n\n\nSkip mirrorlist and exit when tasks has been done.\n\n\n\n\npacman-mirrors.conf\n\n\nManjaro branch to use for your system\n\n\n# Branch = stable\n\n\n\n\nThe setting defaults to \nstable\n branch. \n\n\nSelect \nstable\n, \ntesting\n or \nunstable\n.\n\n\nThe setting can be changed by invoking \npacman-mirrors --api --set-branch <branch>\n.\n\n\n\n\nGeneration method\n\n\n# Method = rank\n\n\nInvoking \npacman-mirrors --method <method>\n will temporariy change the setting.\n\n The setting defaults to \nrank\n.\n\n Select \nrank\n or \nrandom\n. \n\n\nProtocols and priority\n\n\n# Protocols =\n\n\nThe setting defines which protocols offered by mirrors will be considered in a mirrorlist. At the moment mirrors offers: http, https, ftp. When the mirrorlist is created and a mirror has more than one protocol defined only the first protocol is written to the mirrorlist.\n\n The default is empty which means \nall\n protocols.\n\n Separate the protocols with \ncomma\n \nor\n \nspace\n.\n* The setting can be changed by invoking \npacman-mirrors --api --proto <proto> <proto>\n.\n\n\nSpecify to use only mirrors from a specific country.\n\n\n# Country =\n\n\nThe setting defines which countries will be considered in a mirrorlist. To get a list of available countries run \npacman-mirrors -l\n and collect names of the countries you will use. You can add countries by hand or you can use the interactive mode to select mirrors and protocols to use. \n\n\n The default setting is empty which means all countries.\n\n Separate your countries with \ncomma\n \nor\n \nspace\n\n\nMirrors directory\n\n\n# MirrorlistsDir = /var/lib/pacman-mirrors\n\n\nA temporary location from which to read the mirrors file.\n\n\nOutput file\n\n\n# OutputMirrorlist = /etc/pacman.d/mirrorlist\n\n\nA temporary location for the generated mirrorlist.\n\n\nNoUpdate\n\n\n# NoUpdate = False\n\n\nWhen this setting is \nTrue\n it prevents the regeneration of the mirrorlist if pacman-mirrors is invoked with the \n--no-update\n argument. Useful if you don't want the mirrorlist regenerated after a pacman-mirrors package upgrade.\n\n\nSSL Verification\n\n\n# SSLVerify = True\n\n\nThe setting controls whether to accept all certificates or not. Only change it if you \nfully trust\n all ssl-enabled mirrors.\n* \nall certificates\n are accepted when set to \nFalse",
"text": "Documentation of pacman-mirrors\n\n\nEnhanced pacman-mirrors for Manjaro Linux\n\n\nUSAGE\n\n\nGENERIC:\n\n\n-h\n, \n--help\n\n\nShow the help message.\n\n\n-v\n, \n--version\n\n\nShow the version of pacman-mirrors.\n\n\nCOUNTRY:\n\n\n-c COUNTRY [COUNTRY ...]\n, \n--country COUNTRY [COUNTRY ...]\n\n\nSpecifiy country or list of countries separated by comma or space:\n\n --country France\n\n --country France Germany Austria\nTo remove a custom mirror file\n* --country all\n\n\n--geoip\n\n\nFind current country by using geolocation.\n\n\nMETHODS:\n\n\nAll methods can be combined with \n-y/--sync\n to fully complete the process.\n\n\n-g\n, \n--generate\n\n\nGenerate a new default mirrorlist.\n\n\n-f {DIGIT}\n, \n--fasttrack {DIGIT}\n\n\nGenerates a mirrorlist of \nDIGIT\n mirrors ranked by responsiveness.\nThe mirrors are randomly selected from a selection of mirrors known to be up-to-date on all branches.\n\n\n-m {method}\n, \n--method {method}\n\n\nChoose the generation method:\n\nSelect \nrank\n or \nrandom\n\n\n-i\n, \n--interactive\n\n\nLaunch a tool for selectively picking mirrors and protocols for a custom mirrorlist.\n\n\nMISC:\n\n\n-b {branch}\n, \n--branch {branch}\n\n\nChoose a temporary branch:\n\nSelect \nstable\n, \ntesting\n or \nunstable\n.\nThe branch is reset on next run of pacman-mirrors.\n\n\n-d {new_dir}\n, \n--mirror_dir {new_dir}\n\n\nChoose a temporary directory where mirrors file is located.\n\n\n-l\n, \n--list\n\n\nLists available mirror countries\n\n\n-o {new_file}\n, \n--output {new_file}\n\n\nChoose a temporary file for your mirrorlist.\n\n\n-q\n, \n--quiet\n\n\nMake pacman-mirrors silent.\n\n\n-t {DIGIT}\n, \n--timeout {DIGIT}\n\n\nChange the server maximum waiting time. In case of SSL enabled mirrors the value is doubled to compensate for the time spent on exchanging encryption keys.\n\n\n--default\n\n\nThis argument \nonly\n have effect in conjunction with \n-i/--interactive\n. It 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. The argument executes the ranking/randomizing when the selection of mirrors is done. Can be combined with \n-y/--sync\n to fully complete the process.\n\n\n--no-update\n\n\nThis argument is tied to the \nNoUpdate = True\n setting in the config file. Pacman-mirrors will exit after parsing \npacman-mirrors.conf\n and is only useful if you don't want the mirrorlist regenerated after a pacman-mirrors package upgrade.\n\n\nSYNC:\n\n\n-y\n, \n--sync\n,\n-u\n, \nupdate\n\n\nInstruct pacman-mirrors to syncronise the pacman databases after mirrorlist generation. This is done by calling \npacman -Syy\n.\n\n\nAPI:\n\n\nMake permanent changes to pacman-mirrors configuration through an api. The tasks are executed before generating the mirrorlist.\n\n\n-a\n, \n--api\n [--prefix] [--get-branch | --set-branch {branch}] [--proto PROTO [PROTO ...]] [--no-mirrorlist]\n\n\nThe key to the following arguments is \n-a\n or \n--api\n. If it is missing none of the arguments will have any effect.\n\n\n--prefix\n\n\n\n\nAdd a path prefix to pacman-mirrors file-handling eg. \n/mnt/install\n or \n$mnt\n.\n\n\n\n\n--get-branch\n\n\n\n\nReturns branch from \n/etc/pacman-mirrors.conf\n optionally with a prefix.\n\n\n\n\n--set-branch {branch}\n\n\n\n\nWrites the branch to \n/etc/pacman-mirrors.conf\n optionally with a prefix.\n\n\nSelect \nstable\n, \ntesting\n or \nunstable\n.\n\n\n\n\n--proto PROTO [PROTO ...]\n\n\n\n\nWrite the specified protocols to \n/etc/pacman-mirrors.conf\n optionally with a prefix.\n\n\nSelect \nall\n or \nhttp\n, \nhttps\n, \nftp\n and \nftps\n.\n\n\n\n\n-n\n, \n--no-mirrorlist\n\n\n\n\nSkip mirrorlist and exit when tasks has been done.\n\n\n\n\npacman-mirrors.conf\n\n\nManjaro branch to use for your system\n\n\n# Branch = stable\n\n\n\n\nThe setting defaults to \nstable\n branch. \n\n\nSelect \nstable\n, \ntesting\n or \nunstable\n.\n\n\nThe setting can be changed by invoking \npacman-mirrors --api --set-branch <branch>\n.\n\n\n\n\nGeneration method\n\n\n# Method = rank\n\n\nInvoking \npacman-mirrors --method <method>\n will temporariy change the setting.\n\n The setting defaults to \nrank\n.\n\n Select \nrank\n or \nrandom\n. \n\n\nProtocols and priority\n\n\n# Protocols =\n\n\nThe setting defines which protocols offered by mirrors will be considered in a mirrorlist. At the moment mirrors offers: http, https, ftp. When the mirrorlist is created and a mirror has more than one protocol defined only the first protocol is written to the mirrorlist.\n\n The default is empty which means \nall\n protocols.\n\n Separate the protocols with \ncomma\n \nor\n \nspace\n.\n* The setting can be changed by invoking \npacman-mirrors --api --proto <proto> <proto>\n.\n\n\nSpecify to use only mirrors from a specific country.\n\n\n# Country =\n\n\nThe setting defines which countries will be considered in a mirrorlist. To get a list of available countries run \npacman-mirrors -l\n and collect names of the countries you will use. You can add countries by hand or you can use the interactive mode to select mirrors and protocols to use. \n\n\n The default setting is empty which means all countries.\n\n Separate your countries with \ncomma\n \nor\n \nspace\n\n\nMirrors directory\n\n\n# MirrorlistsDir = /var/lib/pacman-mirrors\n\n\nA temporary location from which to read the mirrors file.\n\n\nOutput file\n\n\n# OutputMirrorlist = /etc/pacman.d/mirrorlist\n\n\nA temporary location for the generated mirrorlist.\n\n\nNoUpdate\n\n\n# NoUpdate = False\n\n\nWhen this setting is \nTrue\n it prevents the regeneration of the mirrorlist if pacman-mirrors is invoked with the \n--no-update\n argument. Useful if you don't want the mirrorlist regenerated after a pacman-mirrors package upgrade.\n\n\nSSL Verification\n\n\n# SSLVerify = True\n\n\nThe setting controls whether to accept all certificates or not. Only change it if you \nfully trust\n all ssl-enabled mirrors.\n* \nall certificates\n are accepted when set to \nFalse",
"title": "Home"
},
{
......@@ -47,7 +47,7 @@
},
{
"location": "/#methods",
"text": "",
"text": "All methods can be combined with -y/--sync to fully complete the process.",
"title": "METHODS:"
},
{
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment