blob: 6715f38583db5b20527f289f3d907114a2755139 (
plain)
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
|
[comment {-*- tcl -*- doctools manpage}]
[manpage_begin fileutil::magic::cfront n 1.0]
[see_also file(1)]
[see_also fileutil]
[see_also magic(5)]
[keywords {file recognition}]
[keywords {file type}]
[keywords {file utilities}]
[keywords mime]
[keywords type]
[moddesc {file utilities}]
[titledesc {Generator core for compiler of magic(5) files}]
[category {Programming tools}]
[require Tcl 8.4]
[require fileutil::magic::cfront [opt 1.0]]
[require fileutil::magic::cgen [opt 1.0]]
[require fileutil::magic::rt [opt 1.0]]
[require struct::list]
[require fileutil]
[description]
[para]
This package provides the frontend of a compiler of magic(5) files
into recognizers based on the [package fileutil::magic::rt] recognizer
runtime package. For the generator backed used by this compiler see
the package [package fileutil::magic::cgen].
[section COMMANDS]
[list_begin definitions]
[call [cmd ::fileutil::magic::cfront::compile] [arg path]...]
This command takes the paths of one or more files and directories and
compiles all the files, and the files in all the directories into a
single recognizer for all the file types specified in these files.
[para]
All the files have to be in the format specified by magic(5).
[para]
The result of the command is a Tcl script containing the generated
recognizer.
[call [cmd ::fileutil::magic::cfront::procdef] [arg procname] [arg path]...]
This command behaves like [cmd ::fileutil::magic::cfront::compile]
with regard to the specified path arguments, then wraps the resulting
recognizer script into a procedure named [arg procname], puts code
setting up the namespace of [arg procname] in front, and returns the
resulting script.
[call [cmd ::fileutil::magic::cfront::install] [arg path]...]
This command uses [cmd ::fileutil::magic::cfront::procdef] to compile
each of the paths into a recognizer procedure and installs the result
in the current interpreter.
[para]
The name of each new procedure is derived from the name of the
file/directory used in its creation, with file/directory [file FOO]
causing the creation of procedure [const ::fileutil::magic::/FOO::run].
[list_end]
[vset CATEGORY {fileutil :: magic}]
[include ../doctools2base/include/feedback.inc]
[manpage_end]
|
