proofreading docs

docs/index.md

@@ -166,7 +166,7 @@ pacman-mirrors when branch and mirrorlist has been written.
 1. If *-G*
    * *sys.exit(config.branch)*
 2. If *p*  *PREFIX*
-   * prefix internal file configuration with *PREFIX*
+   *  add *PREFIX* to internal file configuration 
 3. If *-S* *BRANCH*
    * apply *BRANCH* to internal configuration
    * replace branch in pacman-mirrors.conf with *BRANCH*

man/pacman-mirrors.8.html

@@ -138,7 +138,7 @@ BRANCH: Value from config</p>
 <li>If <em>p</em> <em>PREFIX</em></li>
 </ol>
 <ul>
-<li>prefix internal file configuration with <em>PREFIX</em></li>
+<li>add <em>PREFIX</em> to internal file configuration</li>
 </ul>
 <ol start="3" style="list-style-type: decimal">
 <li>If <em>-S</em> <em>BRANCH</em></li>

site/index.html

@@ -229,7 +229,7 @@ pacman-mirrors when branch and mirrorlist has been written.</p>
 <li>If <em>-G</em></li>
 <li><em>sys.exit(config.branch)</em></li>
 <li>If <em>p</em>  <em>PREFIX</em></li>
-<li>prefix internal file configuration with <em>PREFIX</em></li>
+<li>add <em>PREFIX</em> to internal file configuration </li>
 <li>If <em>-S</em> <em>BRANCH</em></li>
 <li>apply <em>BRANCH</em> to internal configuration</li>
 <li>replace branch in pacman-mirrors.conf with <em>BRANCH</em></li>
@@ -368,5 +368,5 @@ Frede Hundewadt <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;&#102;&#114;&#1
 
 <!--
 MkDocs version : 0.16.3
-Build Date UTC : 2017-06-07 07:39:56
+Build Date UTC : 2017-06-07 07:43:16
 -->

site/mkdocs/search_index.json

@@ -2,7 +2,7 @@
     "docs": [
         {
             "location": "/",
-            "text": "% pacman-mirrors(8) Pacman-Mirrors 4.2 User Manual\n\n% \n\n% June, 2017  \n\n\nNAME\n\n\npacman-mirrors - generate pacman mirrorlist for Manjaro Linux\n\n\nSYNOPSIS\n\n\npacman-mirrors [-f \nNUMBER\n | [[-i [-d]] [-c \nCOUNTRY\n, [\nCOUNTRY\n] ... | --geoip]]] [-m \nMETHOD\n] [-a [-p \nPREFIX\n] [-R] [-G | -S \nBRANCH\n] [-P \nPROTO\n [\nPROTO\n] ...][-U \nURL\n]] [-b \nBRANCH\n] [-t \nSECONDS\n] [-q] [-v] [-n | -y]  \n\n\nDESCRIPTION\n\n\nGenerate mirrorlist for Manjaro Linux.\nDefault is to rank all mirrors by reponse time.\nIf no arguments are given pacman-mirrors lists available options.\nPacman-mirrors requires access to files which are read-only \nso it must be run with su or sudo.\nTo create a mirrorlist using all default use,\n\n\npacman-mirrors --generate\n\n\n\nThe mirrorlist generation process can be refined through arguments \nand arguments with options, for example,\n\n\npacman-mirrors --country Denmark --timeout 5\n\n\n\nOPTIONS\n\n\nSome options are mutual exclusive and will throw an arguments error:  \n\n\n\n\n--no-mirrorlist\n and \n--sync\n\n\n--branch\n, \n--get-branch\n and \n--set-branch\n\n\n--sync\n and \n--no-mirrorlist\n\n\n--country\n and \n--geoip\n\n\n\n\nOthers can be used together but they have precedence.\nIf the fasttrack arg is used with interactive, country or geoip\nthe fasttrack arg will have precendence and the others are ignored.\nSome arguments requires other argument to have effect for example,\nthis command will ignore --default argument\n\n\nWRONG pacman-mirrors -b unstable --default\n\n\n\nas it should have been in conjunction with --interactive, like\n\n\nCORRECT pacman-mirrors -b unstable --interactive --default\n\n\n\nThe same goes for the API specific arguments. \nFor those to have effect the --api argument must be present also.\n\n\npacman-mirrors -aS unstable\n\n\n\nThe arguments can appear in any order except for arguments which takes \nadditional options in which case the options must follow \nimmediately after the argument, for example\n\n\npacman-mirrors -ayidS unstable\n\n\n\nMETHODS\n\n\n-g, --generate\n:   Generate a new default mirrorlist using defaults\n\n\n-f, --fasttrack \nNUMBER\n\n:   Generates a mirrorlist with a number mirrors ranked by responsiveness,\n    the mirrors are selected from \nhttp://repo.manjaro.org/status.json\n\n\n-i, --interactive [--default]\n:   Launches a tool for selectively picking mirrors and protocols,\n    \n--default\n forces pacman-mirrors to load the default mirror\n    file and ignore any preset custom-mirrors file, thus allowing for \n    reselecting mirrors for a new custom mirror file\n\n\n-m, --method \nMETHOD\n\n:   Default method is \nrank\n but \nrandom\n can be selected \n\n\nBRANCH\n\n\n-b, --branch \nBRANCH\n\n:   Temporarily use another branch, \nstable\n, \ntesting\n or \nunstable\n, \n    the branch is reset with next run of pacman-mirrors\n\n\nCOUNTRY\n\n\n-c, --country \nCOUNTRY\n [\nCOUNTRY\n] ...\n:   Specifiy a country or a list of countries\n\n\n--geoip\n:   Use geolocation if possible, if not uses all mirrors\n\n\n-l, --list, --country-list\n:   Lists available mirror countries\n\n\nAPI\n\n\n-a, --api [-p \nPREFIX\n] [-R] [-G|-S \nBRANCH\n] [-P \nPROTO\n [\nPROTO\n] ...] [-U \nURL\n]\n:   Instructs pacman-mirrors to activate processing of API arguments\n\n\n-p, --prefix \nPREFIX\n\n:   Add a path prefix to pacman-mirrors file-handling\n    eg. \n/mnt/install\n or \n$mnt\n\n\n-G, --get-branch\n:   Return branch from configuration.\n\n\n-P, --proto, --protocols \nPROTO\n [\nPROTO\n] ...\n:   Write protocols to configuration,\n    use \nall\n or \nhttp\n, \nhttps\n, \nftp\n and \nftps\n\n\n-R, --re-branch\n:   Replace branch in mirrorlist\n\n\n-S, --set-branch \nBRANCH\n\n:   Replace branch in configuration,\n    use \nstable\n, \ntesting\n or \nunstable\n\n\n-U, --url \nURL\n\n:   Replace mirrorlist with supplied url\n\n\nMISC\n\n\n-h, --help\n:   Show the help message\n\n\n-n, --no-mirrorlist\n:   Use to skip generation of mirrorlist\n\n\n-q, --quiet\n:   Make pacman-mirrors silent\n\n\n-t, --timeout \nSECONDS\n\n:   Change the number of seconds waiting for a server response, \n    SSL enabled mirrors has this value doubled to compensate \n    for the time spent on exchanging encryption keys\n\n\n-v, --version\n:   Show the version of pacman-mirrors\n\n\n-y, --sync\n:   Instruct pacman-mirrors to syncronize the pacman database\n\n\nExit status:\n\n\n0     : OK\n\n1     : Problem with argument\n\n2     : Problem accessing systemfiles\n\n3     : Missing mirror file\n\nBRANCH: Value from config    \n\n\nConfiguration flow of pacman-mirrors\n\n\nAt launch an internal default configuration is setup, \nfile configuration is applied and the commandline is parsed and applied.\n\n\nAPI arguments\n\n\nThese arguments modifies key elements of pacman-mirrors configuration \naccording to the packagers needs.\n\n\nThe actions performed by the API are in strict order and \nperformed \nbefore any\n other actions. This also means that ordinary arguments \nsupplied in conjunction with app might be ignored. Eg. \n-U\n argument terminates\npacman-mirrors when branch and mirrorlist has been written.\n\n\n\n\nIf \n-G\n\n\nsys.exit(config.branch)\n\n\nIf \np\n  \nPREFIX\n\n\nprefix internal file configuration with \nPREFIX\n\n\nIf \n-S\n \nBRANCH\n\n\napply \nBRANCH\n to internal configuration\n\n\nreplace branch in pacman-mirrors.conf with \nBRANCH\n\n\nIf \n-U\n \nURL\n\n\napply internal configuration to a mirrorlist with \nURL\n\n\nsys.exit(0)\n\n\nIf \n-P\n \nPROTO\n [\nPROTO\n] ...\n\n\nreplace protocols in pacman-mirrors.conf with \nPROTO\n\n\nIf \n-R\n\n\nreplace branch in mirrorlist with \n-S\n \nBRANCH\n\n\n\n\nWhen done pacman-mirrors checks the internet connection and if possible \ndownload the latest datafiles for creating the mirrorlist. \nAt this point it is possible to interrupt further processing.\n\n\nIf the \n-n\n argument is present pacman-mirrors will now exit.\n\n\nEXAMPLES\n\n\nMost optional arguments are self explaining others require explanation. \nThe API functions is mainly designed to help packagers and iso-builders. \nHowever it can be of use for everyone because it takes the hazzle out \nof editing your pacman-mirrors configuration.\n\n\n\n\n\n\nWhich countries has mirrors?\n\n\nsudo pacman-mirrors -l\n\n\n\n\n\n\nI want to temporary change branch to unstable, \nuse geolocation and syncronize pacman,\n\n\nsudo pacman-mirrors -yb unstable --geoip\n\n\n\n\n\n\nI want to permanently change branch to unstable, \nuse mirrors from Germany and France, \nuse only https and http protocol in that order and syncronize pacman\n\n\nsudo pacman-mirrors -yac Germany,France -S unstable -P https http\n\n\n\n\n\n\nCreate a mirrorlist with German mirrors and syncronize pacman\n\n\nsudo pacman-mirrors -yc Germany\n\n\n\n\n\n\nIf you want more countries in your mirrorlist add them\n\n\nsudo pacman-mirrors -yc Germany France Denmark\n\n\n\n\n\n\nCreate a mirrorlist with 5 mirrors with current packages and syncronize pacman\n\n\nsudo pacman-mirrors -yf 5\n\n\n\n\n\n\nI want to choose my mirrors\n\n\nsudo pacman-mirrors -i\n\n\n\n\n\n\nI have a custom mirror list and I want to create a new custom mirror list?\n\n\nsudo pacman-mirrors -i --default\n\n\n\n\n\n\nI have a custom mirror list - can I reset it?\n\n\nsudo pacman-mirrors -c all\n\n\n\n\n\n\nWhat branch am I on\n\n\nsudo pacman-mirrors -aG\n\n\n\n\n\n\nChange system branch and dont change the mirrorlist\n\n\nsudo pacman-mirrors -naS unstable\n\n\n\n\n\n\nChange system branch and replace branch in mirrorlist and quit\n\n\nsudo pacman-mirrors -naRS unstable\n\n\n\n\n\n\nChange protocols you will accept but dont touch the mirrorlist\n\n\nsudo pacman-mirrors -naP https http\n\n\n\n\n\n\nA packager can write directly to a mounted systems \ndatafiles using either a path or an environment variable\nreplacing the branch in both configuration and mirrorlist \nleaving the mirrors as is\n\n\nsudo pacman-mirrors -anR -p $prefix -S $branch -P https\n\n\n\n\n\n\nIt is also possible to specify a mirror in which case the mirrorlist\nis created and pacman-mirrors terminate\n\n\nsudo pacman-mirrors -ap $prefix -S $branch -U $url\n\n\n\n\n\n\nREPORTING BUGS\n\n\nhttps://github.com/manjaro/pacman-mirrors/issues\n\n\nSEE ALSO\n\n\nThe pacman-mirrors source code and all documentation \nmay be downloaded from \nhttps://github.com/manjaro/pacman-mirrors/archive/master.zip\n\n\nAUTHORS\n\n\nEsclapion \nesclapion@manjaro.org\n\nphilm \nphilm@manjaro.org\n\nRamon Buld\u00f3 \nrbuldo@gmail.com\n\nHugo Posnic \nhuluti@manjaro.org\n\nFrede Hundewadt \nfrede@hundewadt.dk",
+            "text": "% pacman-mirrors(8) Pacman-Mirrors 4.2 User Manual\n\n% \n\n% June, 2017  \n\n\nNAME\n\n\npacman-mirrors - generate pacman mirrorlist for Manjaro Linux\n\n\nSYNOPSIS\n\n\npacman-mirrors [-f \nNUMBER\n | [[-i [-d]] [-c \nCOUNTRY\n, [\nCOUNTRY\n] ... | --geoip]]] [-m \nMETHOD\n] [-a [-p \nPREFIX\n] [-R] [-G | -S \nBRANCH\n] [-P \nPROTO\n [\nPROTO\n] ...][-U \nURL\n]] [-b \nBRANCH\n] [-t \nSECONDS\n] [-q] [-v] [-n | -y]  \n\n\nDESCRIPTION\n\n\nGenerate mirrorlist for Manjaro Linux.\nDefault is to rank all mirrors by reponse time.\nIf no arguments are given pacman-mirrors lists available options.\nPacman-mirrors requires access to files which are read-only \nso it must be run with su or sudo.\nTo create a mirrorlist using all default use,\n\n\npacman-mirrors --generate\n\n\n\nThe mirrorlist generation process can be refined through arguments \nand arguments with options, for example,\n\n\npacman-mirrors --country Denmark --timeout 5\n\n\n\nOPTIONS\n\n\nSome options are mutual exclusive and will throw an arguments error:  \n\n\n\n\n--no-mirrorlist\n and \n--sync\n\n\n--branch\n, \n--get-branch\n and \n--set-branch\n\n\n--sync\n and \n--no-mirrorlist\n\n\n--country\n and \n--geoip\n\n\n\n\nOthers can be used together but they have precedence.\nIf the fasttrack arg is used with interactive, country or geoip\nthe fasttrack arg will have precendence and the others are ignored.\nSome arguments requires other argument to have effect for example,\nthis command will ignore --default argument\n\n\nWRONG pacman-mirrors -b unstable --default\n\n\n\nas it should have been in conjunction with --interactive, like\n\n\nCORRECT pacman-mirrors -b unstable --interactive --default\n\n\n\nThe same goes for the API specific arguments. \nFor those to have effect the --api argument must be present also.\n\n\npacman-mirrors -aS unstable\n\n\n\nThe arguments can appear in any order except for arguments which takes \nadditional options in which case the options must follow \nimmediately after the argument, for example\n\n\npacman-mirrors -ayidS unstable\n\n\n\nMETHODS\n\n\n-g, --generate\n:   Generate a new default mirrorlist using defaults\n\n\n-f, --fasttrack \nNUMBER\n\n:   Generates a mirrorlist with a number mirrors ranked by responsiveness,\n    the mirrors are selected from \nhttp://repo.manjaro.org/status.json\n\n\n-i, --interactive [--default]\n:   Launches a tool for selectively picking mirrors and protocols,\n    \n--default\n forces pacman-mirrors to load the default mirror\n    file and ignore any preset custom-mirrors file, thus allowing for \n    reselecting mirrors for a new custom mirror file\n\n\n-m, --method \nMETHOD\n\n:   Default method is \nrank\n but \nrandom\n can be selected \n\n\nBRANCH\n\n\n-b, --branch \nBRANCH\n\n:   Temporarily use another branch, \nstable\n, \ntesting\n or \nunstable\n, \n    the branch is reset with next run of pacman-mirrors\n\n\nCOUNTRY\n\n\n-c, --country \nCOUNTRY\n [\nCOUNTRY\n] ...\n:   Specifiy a country or a list of countries\n\n\n--geoip\n:   Use geolocation if possible, if not uses all mirrors\n\n\n-l, --list, --country-list\n:   Lists available mirror countries\n\n\nAPI\n\n\n-a, --api [-p \nPREFIX\n] [-R] [-G|-S \nBRANCH\n] [-P \nPROTO\n [\nPROTO\n] ...] [-U \nURL\n]\n:   Instructs pacman-mirrors to activate processing of API arguments\n\n\n-p, --prefix \nPREFIX\n\n:   Add a path prefix to pacman-mirrors file-handling\n    eg. \n/mnt/install\n or \n$mnt\n\n\n-G, --get-branch\n:   Return branch from configuration.\n\n\n-P, --proto, --protocols \nPROTO\n [\nPROTO\n] ...\n:   Write protocols to configuration,\n    use \nall\n or \nhttp\n, \nhttps\n, \nftp\n and \nftps\n\n\n-R, --re-branch\n:   Replace branch in mirrorlist\n\n\n-S, --set-branch \nBRANCH\n\n:   Replace branch in configuration,\n    use \nstable\n, \ntesting\n or \nunstable\n\n\n-U, --url \nURL\n\n:   Replace mirrorlist with supplied url\n\n\nMISC\n\n\n-h, --help\n:   Show the help message\n\n\n-n, --no-mirrorlist\n:   Use to skip generation of mirrorlist\n\n\n-q, --quiet\n:   Make pacman-mirrors silent\n\n\n-t, --timeout \nSECONDS\n\n:   Change the number of seconds waiting for a server response, \n    SSL enabled mirrors has this value doubled to compensate \n    for the time spent on exchanging encryption keys\n\n\n-v, --version\n:   Show the version of pacman-mirrors\n\n\n-y, --sync\n:   Instruct pacman-mirrors to syncronize the pacman database\n\n\nExit status:\n\n\n0     : OK\n\n1     : Problem with argument\n\n2     : Problem accessing systemfiles\n\n3     : Missing mirror file\n\nBRANCH: Value from config    \n\n\nConfiguration flow of pacman-mirrors\n\n\nAt launch an internal default configuration is setup, \nfile configuration is applied and the commandline is parsed and applied.\n\n\nAPI arguments\n\n\nThese arguments modifies key elements of pacman-mirrors configuration \naccording to the packagers needs.\n\n\nThe actions performed by the API are in strict order and \nperformed \nbefore any\n other actions. This also means that ordinary arguments \nsupplied in conjunction with app might be ignored. Eg. \n-U\n argument terminates\npacman-mirrors when branch and mirrorlist has been written.\n\n\n\n\nIf \n-G\n\n\nsys.exit(config.branch)\n\n\nIf \np\n  \nPREFIX\n\n\nadd \nPREFIX\n to internal file configuration \n\n\nIf \n-S\n \nBRANCH\n\n\napply \nBRANCH\n to internal configuration\n\n\nreplace branch in pacman-mirrors.conf with \nBRANCH\n\n\nIf \n-U\n \nURL\n\n\napply internal configuration to a mirrorlist with \nURL\n\n\nsys.exit(0)\n\n\nIf \n-P\n \nPROTO\n [\nPROTO\n] ...\n\n\nreplace protocols in pacman-mirrors.conf with \nPROTO\n\n\nIf \n-R\n\n\nreplace branch in mirrorlist with \n-S\n \nBRANCH\n\n\n\n\nWhen done pacman-mirrors checks the internet connection and if possible \ndownload the latest datafiles for creating the mirrorlist. \nAt this point it is possible to interrupt further processing.\n\n\nIf the \n-n\n argument is present pacman-mirrors will now exit.\n\n\nEXAMPLES\n\n\nMost optional arguments are self explaining others require explanation. \nThe API functions is mainly designed to help packagers and iso-builders. \nHowever it can be of use for everyone because it takes the hazzle out \nof editing your pacman-mirrors configuration.\n\n\n\n\n\n\nWhich countries has mirrors?\n\n\nsudo pacman-mirrors -l\n\n\n\n\n\n\nI want to temporary change branch to unstable, \nuse geolocation and syncronize pacman,\n\n\nsudo pacman-mirrors -yb unstable --geoip\n\n\n\n\n\n\nI want to permanently change branch to unstable, \nuse mirrors from Germany and France, \nuse only https and http protocol in that order and syncronize pacman\n\n\nsudo pacman-mirrors -yac Germany,France -S unstable -P https http\n\n\n\n\n\n\nCreate a mirrorlist with German mirrors and syncronize pacman\n\n\nsudo pacman-mirrors -yc Germany\n\n\n\n\n\n\nIf you want more countries in your mirrorlist add them\n\n\nsudo pacman-mirrors -yc Germany France Denmark\n\n\n\n\n\n\nCreate a mirrorlist with 5 mirrors with current packages and syncronize pacman\n\n\nsudo pacman-mirrors -yf 5\n\n\n\n\n\n\nI want to choose my mirrors\n\n\nsudo pacman-mirrors -i\n\n\n\n\n\n\nI have a custom mirror list and I want to create a new custom mirror list?\n\n\nsudo pacman-mirrors -i --default\n\n\n\n\n\n\nI have a custom mirror list - can I reset it?\n\n\nsudo pacman-mirrors -c all\n\n\n\n\n\n\nWhat branch am I on\n\n\nsudo pacman-mirrors -aG\n\n\n\n\n\n\nChange system branch and dont change the mirrorlist\n\n\nsudo pacman-mirrors -naS unstable\n\n\n\n\n\n\nChange system branch and replace branch in mirrorlist and quit\n\n\nsudo pacman-mirrors -naRS unstable\n\n\n\n\n\n\nChange protocols you will accept but dont touch the mirrorlist\n\n\nsudo pacman-mirrors -naP https http\n\n\n\n\n\n\nA packager can write directly to a mounted systems \ndatafiles using either a path or an environment variable\nreplacing the branch in both configuration and mirrorlist \nleaving the mirrors as is\n\n\nsudo pacman-mirrors -anR -p $prefix -S $branch -P https\n\n\n\n\n\n\nIt is also possible to specify a mirror in which case the mirrorlist\nis created and pacman-mirrors terminate\n\n\nsudo pacman-mirrors -ap $prefix -S $branch -U $url\n\n\n\n\n\n\nREPORTING BUGS\n\n\nhttps://github.com/manjaro/pacman-mirrors/issues\n\n\nSEE ALSO\n\n\nThe pacman-mirrors source code and all documentation \nmay be downloaded from \nhttps://github.com/manjaro/pacman-mirrors/archive/master.zip\n\n\nAUTHORS\n\n\nEsclapion \nesclapion@manjaro.org\n\nphilm \nphilm@manjaro.org\n\nRamon Buld\u00f3 \nrbuldo@gmail.com\n\nHugo Posnic \nhuluti@manjaro.org\n\nFrede Hundewadt \nfrede@hundewadt.dk",
             "title": "Home"
         },
         {
@@ -62,7 +62,7 @@
         },
         {
             "location": "/#api-arguments",
-            "text": "These arguments modifies key elements of pacman-mirrors configuration \naccording to the packagers needs.  The actions performed by the API are in strict order and \nperformed  before any  other actions. This also means that ordinary arguments \nsupplied in conjunction with app might be ignored. Eg.  -U  argument terminates\npacman-mirrors when branch and mirrorlist has been written.   If  -G  sys.exit(config.branch)  If  p    PREFIX  prefix internal file configuration with  PREFIX  If  -S   BRANCH  apply  BRANCH  to internal configuration  replace branch in pacman-mirrors.conf with  BRANCH  If  -U   URL  apply internal configuration to a mirrorlist with  URL  sys.exit(0)  If  -P   PROTO  [ PROTO ] ...  replace protocols in pacman-mirrors.conf with  PROTO  If  -R  replace branch in mirrorlist with  -S   BRANCH   When done pacman-mirrors checks the internet connection and if possible \ndownload the latest datafiles for creating the mirrorlist. \nAt this point it is possible to interrupt further processing.  If the  -n  argument is present pacman-mirrors will now exit.",
+            "text": "These arguments modifies key elements of pacman-mirrors configuration \naccording to the packagers needs.  The actions performed by the API are in strict order and \nperformed  before any  other actions. This also means that ordinary arguments \nsupplied in conjunction with app might be ignored. Eg.  -U  argument terminates\npacman-mirrors when branch and mirrorlist has been written.   If  -G  sys.exit(config.branch)  If  p    PREFIX  add  PREFIX  to internal file configuration   If  -S   BRANCH  apply  BRANCH  to internal configuration  replace branch in pacman-mirrors.conf with  BRANCH  If  -U   URL  apply internal configuration to a mirrorlist with  URL  sys.exit(0)  If  -P   PROTO  [ PROTO ] ...  replace protocols in pacman-mirrors.conf with  PROTO  If  -R  replace branch in mirrorlist with  -S   BRANCH   When done pacman-mirrors checks the internet connection and if possible \ndownload the latest datafiles for creating the mirrorlist. \nAt this point it is possible to interrupt further processing.  If the  -n  argument is present pacman-mirrors will now exit.",
             "title": "API arguments"
         },
         {