~apt-fast/apt-fast/apt-fast-ro

« back to all changes in this revision

Viewing changes to man/apt-fast.conf.5

  • Committer: Matt Parnell
  • Date: 2012-07-02 16:44:36 UTC
  • mfrom: (37.1.1)
  • Revision ID: git-v1:03372d58ad683364f7a40d3b68e5dbe4014bb0ae
Merge pull request #29 from Lasall/manpages

Add man pages. Update README.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\"
 
2
.\" Man page for apt-fast.conf
 
3
.\"
 
4
.\" Copyright: 2012, Dominique Lasserre <lasserre.d@gmail.com>
 
5
.\"
 
6
.\" You may distribute this file under the terms of the GNU General
 
7
.\" Public License as published by the Free Software Foundation; either
 
8
.\" version 3 of the License, or (at your option) any later version.
 
9
.\"
 
10
.TH "APT\-FAST.CONF" "5" "2012-06-01" "apt\-fast 1.6.5" "apt\-fast Manual"
 
11
.SH "NAME"
 
12
.LP
 
13
apt\-fast.conf \- configuration file for \fBapt\-fast\fR(5)
 
14
.SH "SYNOPSIS"
 
15
Configuration file is sourced by \fBbash\fR(1) to load configuration items, so
 
16
use '#' character to start comments. Each configuration item must directly
 
17
followed by '=' character, e.g.: _APTMGR=apt-get
 
18
.br
 
19
It is not recommended to load or execute custom functions.
 
20
.SH "DESCRIPTION"
 
21
.LP
 
22
/etc/apt-fast.conf is the configuration file for \fBapt\-fast\fR(5).
 
23
.TP
 
24
\fB_APTMGR\fR
 
25
Package manager to perform actions with. You may set absolute path to manager.
 
26
.br
 
27
Default: \fIapt\-get\fR
 
28
.TP
 
29
\fBDOWNLOADBEFORE\fR
 
30
Enable item to suppress \fBapt\-fast\fR(5) confirmation dialog and download
 
31
packages directly. 'Enable' means you can set any value to this configuration
 
32
item, e.g.: DOWNLOADBEFORE=true
 
33
.br
 
34
Default: disabled
 
35
.TP
 
36
\fB_MAXNUM\fR
 
37
This item is optional but is used in proposed download helper command
 
38
(configuration item \fB_DOWNLOADER\fR). You can use it as count of maximum
 
39
number of parallel connections to retrieve packages.
 
40
.br
 
41
Default: 5
 
42
.TP
 
43
\fBDLLIST\fR
 
44
Set location of temporary download list file where APT exports URIs of
 
45
downloadable packages.
 
46
.br
 
47
Default: '/tmp/apt-fast.list'
 
48
.TP
 
49
\fB_DOWNLOADER\fR
 
50
Download helper command how to download package URIs stored in \fBDLLIST\fR
 
51
file.
 
52
.br
 
53
aria2: 'aria2c \-c \-j ${_MAXNUM} \-i ${DLLIST} \-\-connect\-timeout=600 \-\-timeout=600 \-m0'
 
54
.br
 
55
axel:  'cat ${DLLIST} | xargs \-l1 axel \-n ${_MAXNUM} \-a'
 
56
.TP
 
57
\fBDLDIR\fR
 
58
Directory where to download packages with download helper to.
 
59
.br
 
60
Default: '/var/cache/apt/archives/apt-fast'
 
61
.TP
 
62
\fBAPTCACHE\fR
 
63
APT package cache directory. Set it to APT configuration items Dir::Cache and
 
64
Dir::Cache::archives, see also \fBapt.conf\fR(5).
 
65
.br
 
66
Default: '/var/cache/apt/archives'
 
67
.TP
 
68
\fBcGreen\fR
 
69
Set specific terminal color. Automatically disabled when \fBapt\-fast\fR(5) is
 
70
not executed in terminal.
 
71
.br
 
72
Default: '\\e[0;32m]'
 
73
.TP
 
74
\fBcRed\fR
 
75
See \fBcGreen\fR item.
 
76
.br
 
77
Default: '\\e[0;31m]'
 
78
.TP
 
79
\fBcBlue\fR
 
80
See \fBcGreen\fR item.
 
81
.br
 
82
Default: '\\e[0;34m]'
 
83
.TP
 
84
\fBendColor\fR
 
85
See \fBcGreen\fR item. This color resets color to default one.
 
86
.br
 
87
Default: '\\e[0m'
 
88
.SH "FILES"
 
89
.TP
 
90
/etc/apt\-fast.conf
 
91
Configuration file.
 
92
.TP
 
93
/tmp/apt-fast.list
 
94
Temporary download list file. Configuration item: \fBDLLIST\fR
 
95
.TP
 
96
/var/cache/apt/archives/apt-file/
 
97
Temporary download location where download accelerator retrieves packages
 
98
before \fBapt\-fast\fR(8) moves them to package cache. Configuration item:
 
99
\fBDLDIR\fR
 
100
.SH "SEE ALSO"
 
101
.LP
 
102
\fBapt-fast\fR(8)
 
103
.br
 
104
\fBapt\-get\fR(8),
 
105
\fBaptitude\fR(8),
 
106
\fBaria2c\fR(1),
 
107
\fBaxel\fR(1)