← Back to branch summary

~ubuntu-branches/ubuntu/saucy/apt-cacher-ng/saucy

« back to all changes in this revision

Viewing changes to doc/src/acngfs.but

  • Committer: Bazaar Package Importer
  • Author(s): Eduard Bloch
  • Date: 2011-08-07 17:53:21 UTC
  • mfrom: (24.2.14 sid)
  • Revision ID: james.westby@ubuntu.com-20110807175321-k80jrotzovldgu3c
* New upstream version
  + fixes various regressions
* removed dependency on libfuse2 (now used via dlopen, moved to Suggests)
* support new build-* targets in rules

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/acngfs.but
13
13
 
14
14
\H{manpage-synopsis} SYNOPSIS
15
15
 
16
 
\c acngfs BaseURL ProxyHost MountPoint [ -o FUSE Mount Options ]
 
16
\c acngfs BaseURL ProxyHost [CachePath] MountPoint [-o FUSE Mount Options]
17
17
 
18
18
\H{manpage-description} DESCRIPTION
19
19
 
29
29
 
30
30
\b When reading, certain files might need to be fetched in background (or updated) and this process needs to be triggered somehow
31
31
 
32
 
\b Network latency and speed are not relevant, e.g. accessing apt-cacher-ng via localhost connection (with the current implementation, this is very important
33
 
since all data is transfered twice internally, for technical reasons).
 
32
\b Network latency and speed are not relevant, e.g. accessing apt-cacher-ng via localhost connection
34
33
 
35
34
\b The proxy service can work efficiently with many requests for small data ranges (apt-cacher-ng, for example)
36
35
 
37
36
\b Pattern matching on paths is sufficient to distinguish file and directory names
38
37
 
 
38
If the apt-cacher-ng instance happens to run on the same system as acngfs or
 
39
its cache repository is mounted via fast remote file system, this cache
 
40
repository can be optionally specified as alternative source path. In this
 
41
cache, acngfs will attempt to read files directly from this filesystem where
 
42
possible, reducing network latency and avoiding additional load of apt-cacher-ng server.
 
43
The directory levels of BaseURL and CachePath should match.
 
44
 
 
45
\H{manpage-examples} EXAMPLES
 
46
 
39
47
Typical use may be to let apt/dpkg use package file like they are present on the local filesystem so there is no need to download them.
40
48
In sources.list, the source appears as a file:/ type URL, like: 
41
49
 
43
51
 
44
52
and the filesystem backend is prepared with a command like:
45
53
 
46
 
\c{/usr/lib/apt-cacher-ng/acngfs http://ftp.uni-kl.de/debian localhost:3142 /var/local/acngfs_debian -o allow_root}
 
54
\c{/usr/lib/apt-cacher-ng/acngfs http://ftp.uni-kl.de/debian cacheBox:3142 /var/local/acngfs_debian -o allow_root}
 
55
 
 
56
or for a locally installed apt-cacher-ng with common Debian cache repository stored in /var/cache/apt-cacher-ng/debrep:
 
57
 
 
58
\c{/usr/lib/apt-cacher-ng/acngfs http://ftp.uni-kl.de/debian localhost:3142 /var/cache/apt-cacher-ng/debrep /var/local/acngfs_debian -o allow_root}
47
59
 
48
60
\H{manpage-options} OPTIONS
49
61
 
60
72
 
61
73
\dd Complete or simplified host and port specification of the proxy server, \cw{http://localhost:3142}.
62
74
 
 
75
\dt \cw{CachePath}
 
76
 
 
77
\dd Optional hint, a directory path pointing to the internal cache subdirectory of apt-cacher-ng where it stores data downloaded from \cw{BaseURL}. For more details see \cw{apt-cacher-ng} manual, chapter "Advanced configuration".
 
78
 
63
79
\dt \cw{mountpoint}
64
80
 
65
81
\dd Directory representing the URL in the local filesytem.
92
108
 
93
109
Software is still experimental, use at your own risk!
94
110
 
95
 
There are natural limitations on capabilities of the FS: no directory reading
96
 
is allowed (only descending), permissions of files are inherited from the mount
97
 
point as well as other properties of the filesystem.
 
111
There are natural limitations on capabilities of the FS: no directory browsing
 
112
is allowed (only blind descending), permissions of files are inherited from the
 
113
mount point as well as other properties of the filesystem.
98
114
 
99
 
Should be used with apt-cacher-ng version 0.2pre2 or newer; otherwise it will
100
 
flood log files with many requests of small file chunks.
 
115
Should be used with apt-cacher-ng version 0.2pre2 or newer; otherwise it could
 
116
flood log files with many requests from small file chunks.
101
117
 
102
118
\H{manpage-more-information} SEE ALSO
103
119
 
107
123
either in the doc/pdf directory of the software source package or installed in
108
124
the documentation directory of apt-cacher-ng by your distribution.
109
125
 
110
 
\versionid Eduard Bloch, Tue, 24 Jun 2008 00:21:33 +0200
 
126
\versionid Eduard Bloch, Sun, 07 Aug 2011 00:38:54 +0200