File: Approx.pod

package info (click to toggle)
libconfig-model-approx-perl 1.009-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 148 kB
  • ctags: 7
  • sloc: perl: 238; makefile: 2
file content (109 lines) | stat: -rw-r--r-- 3,155 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
=head1 NAME

Config::Model::models::Approx - Configuration class Approx

=head1 DESCRIPTION

Configuration classes used by L<Config::Model>

Configuration model for Approx

=head1 Elements

=head2 cache - approx cache directory

Specifies the location of the approx cache directory (default: /var/cache/approx). It and all its subdirectories must be owned by the approx server (see also the $user and $group parameters, below.)I<< Optional. Type uniline. upstream_default: '/var/cache/approx'.  >> 

=head2 interval - file cache expiration in minutes

Specifies the time in minutes after which a cached file will be considered too old to deliver without first checking with the remote repository for a newer version. I<< Optional. Type integer. upstream_default: '720'.  >> 

=head2 max_rate - maximum download rate from remote repositories

Specifies the maximum download rate from remote repositories, in bytes per second (default: unlimited). The value may be suffixed with "K", "M", or "G" to indicate kilobytes, megabytes, or gigabytes per second, respectively.I<< Optional. Type uniline.  >> 

=head2 max_redirects - maximum number of HTTP redirections

Specifies the maximum number of HTTP redirections that will be followed when downloading a remote file. I<< Optional. Type integer. upstream_default: '5'.  >> 

=head2 user - user that owns the files in the approx cache

I<< Optional. Type uniline. upstream_default: 'approx'.  >> 

=head2 group - group that owns the files in the approx cache

I<< Optional. Type uniline. upstream_default: 'approx'.  >> 

=head2 syslog - syslog(3) facility to use when logging

I<< Optional. Type uniline. upstream_default: 'daemon'.  >> 

=head2 pdiffs - support IndexFile diffs

I<< Optional. Type boolean. upstream_default: '1'.  >> 

=head2 offline - use cached files when offline

Specifies whether to deliver (possibly out-of-date) cached files when they cannot be downloaded from remote repositories. I<< Optional. Type boolean. upstream_default: '0'.  >> 

=head2 max_wait - max wait for concurrent file download

Specifies how many seconds an approx(8) process will wait for a concurrent download of a file to complete, before attempting to download the file itself. I<< Optional. Type integer. upstream_default: '10'.  >> 

=head2 verbose

Specifies whether informational messages should be printed in the log. I<< Optional. Type boolean. upstream_default: '0'.  >> 

=head2 debug

Specifies whether debug messages should be printed in the log. I<< Optional. Type boolean. upstream_default: '0'.  >> 

=head2 distributions - remote repositories

The other name/value pairs are used to map distribution names to remote repositories. For example,

  debian     =>   http://ftp.debian.org/debian
  security   =>   http://security.debian.org/debian-security

Use the distribution name as the key of the hash element and the URL as the value
. I<< Optional. Type hash of uniline.  >> 

=head1 SEE ALSO

=over

=item *

L<cme>

=back

=head1 AUTHOR

=over

=item Dominique Dumont


=back

=head1 COPYRIGHT

=over

=item 2011, Dominique Dumont


=back

=head1 LICENSE

=over

=item LGPL-2.1+


=back

=cut