From 620f044278707c8573d2a8f62c6935cc15d99e43 Mon Sep 17 00:00:00 2001
From: fhdk <fh@uex.dk>
Date: Fri, 31 Mar 2017 12:53:55 +0200
Subject: [PATCH] Updated docs
---
docs/index.md | 30 ++++++++++++++++++++++++++++++
site/index.html | 33 +++++++++++++++++++++++++++++++--
site/mkdocs/search_index.json | 7 ++++++-
site/sitemap.xml | 6 +++---
4 files changed, 70 insertions(+), 6 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index e2d75fb7..44038dd9 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -64,3 +64,33 @@ Show the version of pacman-mirrors.
`--quiet`
Make pacman-mirrors silent.
+
+## pacman-mirrors.conf
+```
+## Branch Pacman should use (stable, testing, unstable)
+# Branch = stable
+
+## Generation method
+## 1) rank - rank mirrors depending on their access time
+## 2) random - randomly generate the output mirrorlist
+# Method = rank
+
+## Specify to use only mirrors from specific a country.
+## Can add multiple countries separated by a comma (ex: Germany,France)
+## Empty means all
+# OnlyCountry =
+
+## Mirrors directory
+# MirrorlistsDir = /var/lib/pacman-mirrors
+
+## Output file
+# OutputMirrorlist = /etc/pacman.d/mirrorlist
+
+## When set to True prevents the regeneration of the mirrorlist if
+## pacman-mirrors is invoked with the --no-update argument.
+## Useful if you don't want the mirrorlist regenerated after a
+## pacman-mirrors package upgrade.
+# NoUpdate = False
+
+# SSL = False
+```
diff --git a/site/index.html b/site/index.html
index a80208a4..9ca854ef 100644
--- a/site/index.html
+++ b/site/index.html
@@ -87,6 +87,7 @@
<ul class="nav bs-sidenav">
<li class="main active"><a href="#documentation-of-pacman-mirrors">Documentation of pacman-mirrors</a></li>
<li><a href="#commands">Commands</a></li>
+ <li><a href="#pacman-mirrorsconf">pacman-mirrors.conf</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
@@ -141,7 +142,35 @@ after the selection of mirrors.</p>
<p><code>-v</code>, <code>--version</code>
Show the version of pacman-mirrors.</p>
<p><code>--quiet</code>
-Make pacman-mirrors silent.</p></div>
+Make pacman-mirrors silent.</p>
+<h2 id="pacman-mirrorsconf">pacman-mirrors.conf</h2>
+<pre><code>## Branch Pacman should use (stable, testing, unstable)
+# Branch = stable
+
+## Generation method
+## 1) rank - rank mirrors depending on their access time
+## 2) random - randomly generate the output mirrorlist
+# Method = rank
+
+## Specify to use only mirrors from specific a country.
+## Can add multiple countries separated by a comma (ex: Germany,France)
+## Empty means all
+# OnlyCountry =
+
+## Mirrors directory
+# MirrorlistsDir = /var/lib/pacman-mirrors
+
+## Output file
+# OutputMirrorlist = /etc/pacman.d/mirrorlist
+
+## When set to True prevents the regeneration of the mirrorlist if
+## pacman-mirrors is invoked with the --no-update argument.
+## Useful if you don't want the mirrorlist regenerated after a
+## pacman-mirrors package upgrade.
+# NoUpdate = False
+
+# SSL = False
+</code></pre></div>
</div>
<footer class="col-md-12">
@@ -180,5 +209,5 @@ Make pacman-mirrors silent.</p></div>
<!--
MkDocs version : 0.16.1
-Build Date UTC : 2017-03-25 12:34:57
+Build Date UTC : 2017-03-31 10:53:18
-->
diff --git a/site/mkdocs/search_index.json b/site/mkdocs/search_index.json
index ed54d7ae..8b0713d3 100644
--- a/site/mkdocs/search_index.json
+++ b/site/mkdocs/search_index.json
@@ -2,7 +2,7 @@
"docs": [
{
"location": "/",
- "text": "Documentation of pacman-mirrors\n\n\nEnhanced pacman-mirrors for Manjaro Linux\n\n\nCommands\n\n\n-h\n, \n--help\n\nShow the help message.\n\n\n-g\n, \n--generate\n\nGenerate a new mirrorlist.\n\n\n-m [method]\n, \n--method [method]\n\nChoose the generation method:\n\n\n\n\nrank\n\n\nrandom.\n\n\n\n\n-b [branch]\n, \n--branch [branch]\n\nChoose the branch to use:\n\n\n\n\nstable\n\n\ntesting\n\n\nunstable\n\n\n\n\n-c [country]\n, \n--country [country]\n\nChoose the country to use:\n\n\n\n\nall\n\n\nFrance\n\n\nFrance, German, Spain\n\n\n\n\n--geoip\n\nDetect country by using geolocation.\n\n\n-d\n, \n--mirror_dir\n\nChange directory of mirrors to use.\n\n\n-f [n]\n, \n--fasttrack [n]\n\nGenerates an updated and responsive mirrorlist of [n] mirrors.\n\n\n-l\n, \n--list\n\nLists available mirror countries\n\n\n-o\n, \n--output\n\nChange path of the output file.\n\n\n-t\n, \n--timeout\n\nChange the server maximum waiting time.\n\n\n--no-update\n\nDon't generate mirrorlist.\n\n\n-i\n, \n--interactive\n\nLaunch a graphical tool to select mirrors to generate a custom mirrorlist.\n\n\n--default\n\nUsed in conjunction with \n-i/--interactive\n ignores custom mirrorfile,\n\nloading the default mirrorfile and executes the ranking/randomizing process\n\nafter the selection of mirrors.\n\n\n-v\n, \n--version\n\nShow the version of pacman-mirrors.\n\n\n--quiet\n\nMake pacman-mirrors silent.",
+ "text": "Documentation of pacman-mirrors\n\n\nEnhanced pacman-mirrors for Manjaro Linux\n\n\nCommands\n\n\n-h\n, \n--help\n\nShow the help message.\n\n\n-g\n, \n--generate\n\nGenerate a new mirrorlist.\n\n\n-m [method]\n, \n--method [method]\n\nChoose the generation method:\n\n\n\n\nrank\n\n\nrandom.\n\n\n\n\n-b [branch]\n, \n--branch [branch]\n\nChoose the branch to use:\n\n\n\n\nstable\n\n\ntesting\n\n\nunstable\n\n\n\n\n-c [country]\n, \n--country [country]\n\nChoose the country to use:\n\n\n\n\nall\n\n\nFrance\n\n\nFrance, German, Spain\n\n\n\n\n--geoip\n\nDetect country by using geolocation.\n\n\n-d\n, \n--mirror_dir\n\nChange directory of mirrors to use.\n\n\n-f [n]\n, \n--fasttrack [n]\n\nGenerates an updated and responsive mirrorlist of [n] mirrors.\n\n\n-l\n, \n--list\n\nLists available mirror countries\n\n\n-o\n, \n--output\n\nChange path of the output file.\n\n\n-t\n, \n--timeout\n\nChange the server maximum waiting time.\n\n\n--no-update\n\nDon't generate mirrorlist.\n\n\n-i\n, \n--interactive\n\nLaunch a graphical tool to select mirrors to generate a custom mirrorlist.\n\n\n--default\n\nUsed in conjunction with \n-i/--interactive\n ignores custom mirrorfile,\n\nloading the default mirrorfile and executes the ranking/randomizing process\n\nafter the selection of mirrors.\n\n\n-v\n, \n--version\n\nShow the version of pacman-mirrors.\n\n\n--quiet\n\nMake pacman-mirrors silent.\n\n\npacman-mirrors.conf\n\n\n## Branch Pacman should use (stable, testing, unstable)\n# Branch = stable\n\n## Generation method\n## 1) rank - rank mirrors depending on their access time\n## 2) random - randomly generate the output mirrorlist\n# Method = rank\n\n## Specify to use only mirrors from specific a country.\n## Can add multiple countries separated by a comma (ex: Germany,France)\n## Empty means all\n# OnlyCountry =\n\n## Mirrors directory\n# MirrorlistsDir = /var/lib/pacman-mirrors\n\n## Output file\n# OutputMirrorlist = /etc/pacman.d/mirrorlist\n\n## When set to True prevents the regeneration of the mirrorlist if\n## pacman-mirrors is invoked with the --no-update argument.\n## Useful if you don't want the mirrorlist regenerated after a\n## pacman-mirrors package upgrade.\n# NoUpdate = False\n\n# SSL = False",
"title": "Home"
},
{
@@ -15,6 +15,11 @@
"text": "-h , --help \nShow the help message. -g , --generate \nGenerate a new mirrorlist. -m [method] , --method [method] \nChoose the generation method: rank random. -b [branch] , --branch [branch] \nChoose the branch to use: stable testing unstable -c [country] , --country [country] \nChoose the country to use: all France France, German, Spain --geoip \nDetect country by using geolocation. -d , --mirror_dir \nChange directory of mirrors to use. -f [n] , --fasttrack [n] \nGenerates an updated and responsive mirrorlist of [n] mirrors. -l , --list \nLists available mirror countries -o , --output \nChange path of the output file. -t , --timeout \nChange the server maximum waiting time. --no-update \nDon't generate mirrorlist. -i , --interactive \nLaunch a graphical tool to select mirrors to generate a custom mirrorlist. --default \nUsed in conjunction with -i/--interactive ignores custom mirrorfile, \nloading the default mirrorfile and executes the ranking/randomizing process \nafter the selection of mirrors. -v , --version \nShow the version of pacman-mirrors. --quiet \nMake pacman-mirrors silent.",
"title": "Commands"
},
+ {
+ "location": "/#pacman-mirrorsconf",
+ "text": "## Branch Pacman should use (stable, testing, unstable)\n# Branch = stable\n\n## Generation method\n## 1) rank - rank mirrors depending on their access time\n## 2) random - randomly generate the output mirrorlist\n# Method = rank\n\n## Specify to use only mirrors from specific a country.\n## Can add multiple countries separated by a comma (ex: Germany,France)\n## Empty means all\n# OnlyCountry =\n\n## Mirrors directory\n# MirrorlistsDir = /var/lib/pacman-mirrors\n\n## Output file\n# OutputMirrorlist = /etc/pacman.d/mirrorlist\n\n## When set to True prevents the regeneration of the mirrorlist if\n## pacman-mirrors is invoked with the --no-update argument.\n## Useful if you don't want the mirrorlist regenerated after a\n## pacman-mirrors package upgrade.\n# NoUpdate = False\n\n# SSL = False",
+ "title": "pacman-mirrors.conf"
+ },
{
"location": "/installation/",
"text": "Installation\n\n\nAt the command line:\n\n\n$ easy_install pacman-mirrors\n\n\n\nOr, if you have virtualenvwrapper installed::\n\n\n$ mkvirtualenv pacman-mirrors\n$ pip install pacman-mirrors",
diff --git a/site/sitemap.xml b/site/sitemap.xml
index 71e7e84a..67f39640 100644
--- a/site/sitemap.xml
+++ b/site/sitemap.xml
@@ -4,7 +4,7 @@
<url>
<loc>/</loc>
- <lastmod>2017-03-25</lastmod>
+ <lastmod>2017-03-31</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -12,7 +12,7 @@
<url>
<loc>/installation/</loc>
- <lastmod>2017-03-25</lastmod>
+ <lastmod>2017-03-31</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -20,7 +20,7 @@
<url>
<loc>/usage/</loc>
- <lastmod>2017-03-25</lastmod>
+ <lastmod>2017-03-31</lastmod>
<changefreq>daily</changefreq>
</url>
--
GitLab