Debian Codegraph @

doc/FORMAT

raw
1 Here is the description of the virtual path format:
2
3 The canonical form
4 ==================
5
6 [basepath]#handler[options][:parameters][/internalpath]
7
8 'basepath', if given is an ordinary file path (can be a regular file,
9 or a directory, and can be a real or a virtual path).
10
11 '#' is the character that prefixes the handler name and is
12 defined by VDEV_SEP_CHAR.
13
14 'handler' is the name of the file handler (filter, remote file
15 access or other processing unit). Handler names consist of only
16 alphanumeric characters ([a-z0-9_]). Handler names are case
17 sensitive, and should always be lower case.
18
19 'options' is an optional field containing "mount options". These
20 options should not change the content of the virtual mount, only the
21 permissions or mode of access. For example:
22
23 '+' - read-write
24 '=' - don't cache
25
26 'parameters' are part of the path, but before the mount root.
27
28 'internalpath' is the optional path within the handlers file
29 structure. It is prefixed by '/'.
30
31 Notes:
32
33 The only special characters are '#' and '/'.
34
35 If an ordinary (non virtual) file name contains a '#', then this
36 file can be accessed normaly (i.e. existing files take
37 precedence over virtual ones). If a virtual path contains '#'
38 (even in the real path part) they must be represented by '##'.
39
40 (This way a situation can arrise, where you can't access a
41 virtual file, because a real file 'shadows' it. This is a case
42 of tough luck ;)
43
44 Examples (not all of these are implemented yet):
45
46 /home/user/archive.tar.gz#ugz#utar/path/file
47 /#ftp:host.dom.org/pub/README
48 /#http:www.dom.org|some|where|index.html
49 /#http:localhost:8000|~user|file
50 file#gz-9
51 /#floppy:a/xyz
52
53 The non-canonical virtual paths
54 ===============================
55
56 This is to make life easier for the user.
57
58 dir/file.ext#[/extrapath]
59
60 With this notation, the '#' is substituted with the handler(s)
61 determined from the file's extension. Any parameters after the # are
62 passed to the last expanded handler.
63
64 Examples:
65 file.gz# == file.gz#ugz
66 archive.tar.gz#/dir == archive.tar.gz#ugz#utar/dir
67 archive.tar.gz#+/dir == archive.tar.gz#ugz#utar+/dir