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

updated docs 

fixed typo
parent 975e320b
No related branches found
No related tags found
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
docs/index.md
+ 41
− 3
View file @ 5329b19b
......@@ -8,7 +8,7 @@ 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*] ...]] [-b *BRANCH*] [-t *SECONDS*] [-q] [-v] [-n | -y]
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
......@@ -94,7 +94,7 @@ immediately after the argument, for example
## API
-a, \--api [-p *PREFIX*] [-R] [-G|-S *BRANCH*] [-P *PROTO* [*PROTO*] ...]
-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*
......@@ -113,7 +113,10 @@ immediately after the argument, for example
-P, \--proto, \--protocols *PROTO* [*PROTO*] ...
: Write the protocols to configuration,
use *all* or *http*, *https*, *ftp* and *ftps*.
use *all* or *http*, *https*, *ftp* and *ftps*
-U, \--url *URL*
: Replace mirrorlist with supplied url
## MISC
......@@ -145,6 +148,41 @@ immediately after the argument, for example
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.
......
man/pacman-mirrors.8.gz
+ 0
− 0
View file @ 5329b19b
No preview for this file type
man/pacman-mirrors.8.html
+ 47
− 3
View file @ 5329b19b
......@@ -18,7 +18,7 @@
<h1 id="name">NAME</h1>
<p>pacman-mirrors - generate pacman mirrorlist for Manjaro Linux</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>pacman-mirrors [-f <em>NUMBER</em> | [[-i [-d]] [-c <em>COUNTRY</em>, [<em>COUNTRY</em>] ... | --geoip]]] [-m <em>METHOD</em>] [-a [-p <em>PREFIX</em>] [-R] [-G | -S <em>BRANCH</em>] [-P <em>PROTO</em> [<em>PROTO</em>] ...]] [-b <em>BRANCH</em>] [-t <em>SECONDS</em>] [-q] [-v] [-n | -y]</p>
<p>pacman-mirrors [-f <em>NUMBER</em> | [[-i [-d]] [-c <em>COUNTRY</em>, [<em>COUNTRY</em>] ... | --geoip]]] [-m <em>METHOD</em>] [-a [-p <em>PREFIX</em>] [-R] [-G | -S <em>BRANCH</em>] [-P <em>PROTO</em> [<em>PROTO</em>] ...][-U <em>URL</em>]] [-b <em>BRANCH</em>] [-t <em>SECONDS</em>] [-q] [-v] [-n | -y]</p>
<h1 id="description">DESCRIPTION</h1>
<p>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,</p>
<pre><code>pacman-mirrors --generate</code></pre>
......@@ -75,7 +75,7 @@
</dl>
<h2 id="api">API</h2>
<dl>
<dt>-a, --api [-p <em>PREFIX</em>] [-R] [-G|-S <em>BRANCH</em>] [-P <em>PROTO</em> [<em>PROTO</em>] ...]</dt>
<dt>-a, --api [-p <em>PREFIX</em>] [-R] [-G|-S <em>BRANCH</em>] [-P <em>PROTO</em> [<em>PROTO</em>] ...][-U <em>URL</em>]</dt>
<dd>Instructs pacman-mirrors to activate processing of API arguments
</dd>
<dt>-p, --prefix <em>PREFIX</em></dt>
......@@ -91,7 +91,10 @@
<dd>Replace the branch in configuration, use <em>stable</em>, <em>testing</em> or <em>unstable</em>
</dd>
<dt>-P, --proto, --protocols <em>PROTO</em> [<em>PROTO</em>] ...</dt>
<dd>Write the protocols to configuration, use <em>all</em> or <em>http</em>, <em>https</em>, <em>ftp</em> and <em>ftps</em>.
<dd>Write the protocols to configuration, use <em>all</em> or <em>http</em>, <em>https</em>, <em>ftp</em> and <em>ftps</em>
</dd>
<dt>-U, --url <em>URL</em></dt>
<dd>Replace mirrorlist with supplied url
</dd>
</dl>
<h2 id="misc">MISC</h2>
......@@ -121,6 +124,47 @@
2 : Problem accessing systemfiles<br />
3 : Missing mirror file<br />
BRANCH: Value from config</p>
<h2 id="configuration-flow-of-pacman-mirrors">Configuration flow of pacman-mirrors</h2>
<p>At launch an internal default configuration is setup, file configuration is applied and the commandline is parsed and applied.</p>
<h2 id="api-arguments">API arguments</h2>
<p>These arguments modifies key elements of pacman-mirrors configuration according to the packagers needs.</p>
<p>The actions performed by the API are in strict order and performed <strong>before any</strong> other actions.</p>
<ol style="list-style-type: decimal">
<li>If --prefix</li>
</ol>
<ul>
<li>prefix internal file configuration with $PREFIX</li>
<li>continue</li>
</ul>
<ol start="2" style="list-style-type: decimal">
<li>If --set-branch</li>
</ol>
<ul>
<li>apply internal branch configuration with $BRANCH</li>
<li>continue</li>
</ul>
<ol start="3" style="list-style-type: decimal">
<li>If --url</li>
</ol>
<ul>
<li>apply internal configuration to a mirrorlist with $URL</li>
<li>continue</li>
</ul>
<ol start="4" style="list-style-type: decimal">
<li>If --re-branch</li>
</ol>
<ul>
<li>replace branch in mirrorlist with $BRANCH</li>
<li>continue</li>
</ul>
<ol start="5" style="list-style-type: decimal">
<li>If --get-branch</li>
</ol>
<ul>
<li>sys.exit(config.branch)</li>
</ul>
<p>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.</p>
<p>If the <strong>-n</strong> / <strong>no-mirrorlist</strong> argument is present pacman-mirrors will now exit.</p>
<h1 id="examples">EXAMPLES</h1>
<p>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.</p>
<ul>
......
pacman_mirrors/pacman_mirrors.py
+ 1
− 1
View file @ 5329b19b
......@@ -143,7 +143,7 @@ class PacmanMirrors:
action="store_true",
help=txt.HLP_ARG_API_RE_BRANCH)
api.add_argument("-U", "--url",
type="string",
type=str,
help=txt.HLP_ARG_API_URL)
# Misc arguments
misc = parser.add_argument_group("MISC")
......
site/index.html
+ 40
− 4
View file @ 5329b19b
......@@ -95,6 +95,8 @@
<li><a href="#api">API</a></li>
<li><a href="#misc">MISC</a></li>
<li><a href="#exit-status">Exit status:</a></li>
<li><a href="#configuration-flow-of-pacman-mirrors">Configuration flow of pacman-mirrors</a></li>
<li><a href="#api-arguments">API arguments</a></li>
<li class="main "><a href="#examples">EXAMPLES</a></li>
<li class="main "><a href="#reporting-bugs">REPORTING BUGS</a></li>
<li class="main "><a href="#see-also">SEE ALSO</a></li>
......@@ -109,7 +111,7 @@
<h1 id="name">NAME</h1>
<p>pacman-mirrors - generate pacman mirrorlist for Manjaro Linux</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>pacman-mirrors [-f <em>NUMBER</em> | [[-i [-d]] [-c <em>COUNTRY</em>, [<em>COUNTRY</em>] ... | --geoip]]] [-m <em>METHOD</em>] [-a [-p <em>PREFIX</em>] [-R] [-G | -S <em>BRANCH</em>] [-P <em>PROTO</em> [<em>PROTO</em>] ...]] [-b <em>BRANCH</em>] [-t <em>SECONDS</em>] [-q] [-v] [-n | -y] </p>
<p>pacman-mirrors [-f <em>NUMBER</em> | [[-i [-d]] [-c <em>COUNTRY</em>, [<em>COUNTRY</em>] ... | --geoip]]] [-m <em>METHOD</em>] [-a [-p <em>PREFIX</em>] [-R] [-G | -S <em>BRANCH</em>] [-P <em>PROTO</em> [<em>PROTO</em>] ...][-U <em>URL</em>]] [-b <em>BRANCH</em>] [-t <em>SECONDS</em>] [-q] [-v] [-n | -y] </p>
<h1 id="description">DESCRIPTION</h1>
<p>Generate mirrorlist for Manjaro Linux.
Default is to rank all mirrors by reponse time.
......@@ -175,7 +177,7 @@ immediately after the argument, for example</p>
<p>-l, --list, --country-list
: Lists available mirror countries</p>
<h2 id="api">API</h2>
<p>-a, --api [-p <em>PREFIX</em>] [-R] [-G|-S <em>BRANCH</em>] [-P <em>PROTO</em> [<em>PROTO</em>] ...]
<p>-a, --api [-p <em>PREFIX</em>] [-R] [-G|-S <em>BRANCH</em>] [-P <em>PROTO</em> [<em>PROTO</em>] ...][-U <em>URL</em>]
: Instructs pacman-mirrors to activate processing of API arguments</p>
<p>-p, --prefix <em>PREFIX</em>
: Add a path prefix to pacman-mirrors file-handling
......@@ -189,7 +191,9 @@ immediately after the argument, for example</p>
use <em>stable</em>, <em>testing</em> or <em>unstable</em></p>
<p>-P, --proto, --protocols <em>PROTO</em> [<em>PROTO</em>] ...
: Write the protocols to configuration,
use <em>all</em> or <em>http</em>, <em>https</em>, <em>ftp</em> and <em>ftps</em>.</p>
use <em>all</em> or <em>http</em>, <em>https</em>, <em>ftp</em> and <em>ftps</em></p>
<p>-U, --url <em>URL</em>
: Replace mirrorlist with supplied url</p>
<h2 id="misc">MISC</h2>
<p>-h, --help
: Show the help message</p>
......@@ -211,6 +215,38 @@ immediately after the argument, for example</p>
2 : Problem accessing systemfiles<br />
3 : Missing mirror file<br />
BRANCH: Value from config </p>
<h2 id="configuration-flow-of-pacman-mirrors">Configuration flow of pacman-mirrors</h2>
<p>At launch an internal default configuration is setup,
file configuration is applied and the commandline is parsed and applied.</p>
<h2 id="api-arguments">API arguments</h2>
<p>These arguments modifies key elements of pacman-mirrors configuration
according to the packagers needs.</p>
<p>The actions performed by the API are in strict order and
performed <strong>before any</strong> other actions.</p>
<ol>
<li>If --prefix</li>
<li>prefix internal file configuration with $PREFIX</li>
<li>continue</li>
<li>If --set-branch</li>
<li>apply internal branch configuration with $BRANCH</li>
<li>continue</li>
<li>If --url</li>
<li>apply internal configuration to a mirrorlist with $URL</li>
<li>continue</li>
<li>If --re-branch</li>
<li>replace branch in mirrorlist with $BRANCH</li>
<li>
<p>continue</p>
</li>
<li>
<p>If --get-branch</p>
</li>
<li>sys.exit(config.branch)</li>
</ol>
<p>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.</p>
<p>If the <strong>-n</strong> / <strong>no-mirrorlist</strong> argument is present pacman-mirrors will now exit.</p>
<h1 id="examples">EXAMPLES</h1>
<p>Most optional arguments are self explaining others require explanation.
The API functions is mainly designed to help packagers and iso-builders.
......@@ -329,5 +365,5 @@ Frede Hundewadt <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;&#102;&#114;&#1
<!--
MkDocs version : 0.16.3
Build Date UTC : 2017-05-28 14:13:11
Build Date UTC : 2017-06-01 08:52:31
-->
site/mkdocs/search_index.json
+ 13
− 3
View file @ 5329b19b
This diff is collapsed.
site/sitemap.xml
+ 3
− 3
View file @ 5329b19b
......@@ -4,7 +4,7 @@
<url>
<loc>/</loc>
<lastmod>2017-05-28</lastmod>
<lastmod>2017-06-01</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -12,7 +12,7 @@
<url>
<loc>/installation/</loc>
<lastmod>2017-05-28</lastmod>
<lastmod>2017-06-01</lastmod>
<changefreq>daily</changefreq>
</url>
......@@ -20,7 +20,7 @@
<url>
<loc>/usage/</loc>
<lastmod>2017-05-28</lastmod>
<lastmod>2017-06-01</lastmod>
<changefreq>daily</changefreq>
</url>
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment