man page draft

docs/pacman-mirrors.1.md

+# NAME
+pacman-mirrors - generate pacman mirrorlist for Manjaro Linux
+
+# SYNOPSIS
+pacman-mirrors [OPTION] ...
+
+# DESCRIPTION
+Generate mirrorlist for Manjaro Linux. Default is to rank all mirrors by reponse time. Mandatory arguments to long options are mandatory for short options too
+
+## METHODS
+
+_-f, --fasttrack NUMBER_
+    
+generates a mirrorlist with a number mirrors ranked by responsiveness, the mirrors are selected from <http://repo.manjaro.org/status.json>
+
+_-g, --generate_
+
+generate a new default mirrorlist using defaults
+
+_-m, --method METHOD_
+
+default is **rank** but **random** can be selected 
+
+_-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
+
+## MISC
+
+_-b, --branch BRANCH_
+
+temporarily use another branch, use **stable**, **testing** or **unstable**, the branch is reset with next run of pacman-mirrors
+
+_-c, --country COUNTRY [COUNTRY ...]_, cannot be used with _--geoip_
+
+specifiy a country or a list of countries  for example **-c Germany** will produce a mirrorlist including only German mirrors
+
+_--geoip_, cannot be used with _-c/--country_
+    
+use geolocation if possible else use all
+
+_-l, --country-list_
+
+lists available mirror countries
+
+_-d, --mirror_dir NEW_DIR_ **(DEPRECATED)**
+    
+choose a temporary directory where mirrors file is located
+
+_-o, --output NEW_FILE_ **(DEPRECATED)**
+
+choose a temporary file for your 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
+
+## SYNC and MIRRORLIST
+_-n, --no-mirrorlist_, cannot be used with _-y/--sync_
+
+skip mirrorlist generation
+
+_-y, --sync_, cannot be used with _-n/--no-mirrorlist_
+
+instruct pacman-mirrors to syncronize the pacman database
+
+## API
+
+_-a, --api_
+
+instructs pacman-mirrors to activate the following arguments
+
+-a [_-p, --prefix PREFIX_]
+
+add a path prefix to pacman-mirrors file-handling eg. /mnt/install or $mnt
+
+-a [_-G, --get-branch_]
+
+returns branch from configuration optionally with a prefix.
+
+-a [_-S, --set-branch BRANCH_]
+
+writes the branch to configuration optionally with a prefix use **stable**, **testing** or **unstable**
+
+-a [_-P, --proto, --protocols PROTO [PROTO ...]_]
+
+write the protocols to configuration optionally with a prefix use **all** or **http**, **https**, **ftp** and **ftps**.
+
+## GENERIC
+
+_-h, --help_
+
+show the help message
+
+_-v, --version_
+
+show the version of pacman-mirrors
+
+## Exit status:  
+
+0 if OK  
+1 if problem with argument  
+BRANCH from config  
+
+# AUTHOR
+
+Esclapion <esclapion@manjaro.org>  
+philm <philm@manjaro.org>  
+Ramon Buldó <rbuldo@gmail.com>  
+Hugo Posnic <huluti@manjaro.org>  
+Frede Hundewadt <frede@hundewadt.dk>  
+
+# REPORTING BUGS
+   <https://github.com/manjaro/pacman-mirrors/issues>

man/pacman-mirrors.1

+.\" Automatically generated by Pandoc 1.19.2.1
+.\"
+.TH "" "" "" "" ""
+.hy
+.SH NAME
+.PP
+pacman\-mirrors \- generate pacman mirrorlist for Manjaro Linux
+.SH SYNOPSIS
+.PP
+pacman\-mirrors [OPTION] ...
+.SH DESCRIPTION
+.PP
+Generate mirrorlist for Manjaro Linux.
+Default is to rank all mirrors by reponse time.
+Mandatory arguments to long options are mandatory for short options too
+.SS METHODS
+.PP
+\f[I]\-f, \-\-fasttrack NUMBER\f[]
+.PP
+generates a mirrorlist with a number mirrors ranked by responsiveness,
+the mirrors are selected from <http://repo.manjaro.org/status.json>
+.PP
+\f[I]\-g, \-\-generate\f[]
+.PP
+generate a new default mirrorlist using defaults
+.PP
+\f[I]\-m, \-\-method METHOD\f[]
+.PP
+default is \f[B]rank\f[] but \f[B]random\f[] can be selected
+.PP
+\f[I]\-i, \-\-interactive [\-\-default]\f[]
+.PP
+launches a tool for selectively picking mirrors and protocols,
+\f[I]\-\-default\f[] 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
+.SS MISC
+.PP
+\f[I]\-b, \-\-branch BRANCH\f[]
+.PP
+temporarily use another branch, use \f[B]stable\f[], \f[B]testing\f[] or
+\f[B]unstable\f[], the branch is reset with next run of pacman\-mirrors
+.PP
+\f[I]\-c, \-\-country COUNTRY [COUNTRY ...]\f[], cannot be used with
+\f[I]\-\-geoip\f[]
+.PP
+specifiy a country or a list of countries for example \f[B]\-c
+Germany\f[] will produce a mirrorlist including only German mirrors
+.PP
+\f[I]\-\-geoip\f[], cannot be used with \f[I]\-c/\-\-country\f[]
+.PP
+use geolocation if possible else use all
+.PP
+\f[I]\-l, \-\-country\-list\f[]
+.PP
+lists available mirror countries
+.PP
+\f[I]\-d, \-\-mirror_dir NEW_DIR\f[] \f[B](DEPRECATED)\f[]
+.PP
+choose a temporary directory where mirrors file is located
+.PP
+\f[I]\-o, \-\-output NEW_FILE\f[] \f[B](DEPRECATED)\f[]
+.PP
+choose a temporary file for your mirrorlist
+.PP
+\f[I]\-q, \-\-quiet\f[]
+.PP
+make pacman\-mirrors silent
+.PP
+\f[I]\-t, \-\-timeout SECONDS\f[]
+.PP
+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
+.SS SYNC and MIRRORLIST
+.PP
+\f[I]\-n, \-\-no\-mirrorlist\f[], cannot be used with
+\f[I]\-y/\-\-sync\f[]
+.PP
+skip mirrorlist generation
+.PP
+\f[I]\-y, \-\-sync\f[], cannot be used with
+\f[I]\-n/\-\-no\-mirrorlist\f[]
+.PP
+instruct pacman\-mirrors to syncronize the pacman database
+.SS API
+.PP
+\f[I]\-a, \-\-api\f[]
+.PP
+instructs pacman\-mirrors to activate the following arguments
+.PP
+\-a [\f[I]\-p, \-\-prefix PREFIX\f[]]
+.PP
+add a path prefix to pacman\-mirrors file\-handling eg.
+/mnt/install or $mnt
+.PP
+\-a [\f[I]\-G, \-\-get\-branch\f[]]
+.PP
+returns branch from configuration optionally with a prefix.
+.PP
+\-a [\f[I]\-S, \-\-set\-branch BRANCH\f[]]
+.PP
+writes the branch to configuration optionally with a prefix use
+\f[B]stable\f[], \f[B]testing\f[] or \f[B]unstable\f[]
+.PP
+\-a [\f[I]\-P, \-\-proto, \-\-protocols PROTO [PROTO ...]\f[]]
+.PP
+write the protocols to configuration optionally with a prefix use
+\f[B]all\f[] or \f[B]http\f[], \f[B]https\f[], \f[B]ftp\f[] and
+\f[B]ftps\f[].
+.SS GENERIC
+.PP
+\f[I]\-h, \-\-help\f[]
+.PP
+show the help message
+.PP
+\f[I]\-v, \-\-version\f[]
+.PP
+show the version of pacman\-mirrors
+.SS Exit status:
+.PP
+0 if OK
+.PD 0
+.P
+.PD
+1 if problem with argument
+.PD 0
+.P
+.PD
+BRANCH from config
+.SH AUTHOR
+.PP
+Esclapion <esclapion@manjaro.org>
+.PD 0
+.P
+.PD
+philm <philm@manjaro.org>
+.PD 0
+.P
+.PD
+Ramon Buldó <rbuldo@gmail.com>
+.PD 0
+.P
+.PD
+Hugo Posnic <huluti@manjaro.org>
+.PD 0
+.P
+.PD
+Frede Hundewadt <frede@hundewadt.dk>
+.SH REPORTING BUGS
+.PP
+<https://github.com/manjaro/pacman-mirrors/issues>