source: project/release/2/magic/eggdoc-magic.scm @ 8742

Last change on this file since 8742 was 8742, checked in by felix winkelmann, 12 years ago

moved eggs partially to rrb2

File size: 2.8 KB
Line 
1(use eggdoc)
2
3(define license `(pre #<<EOF
4Copyright (c) 2005, Peter Busser
5All rights reserved.
6
7Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
8conditions are met:
9
10  Redistributions of source code must retain the above copyright notice, this list of conditions and the following
11    disclaimer. 
12  Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
13    disclaimer in the documentation and/or other materials provided with the distribution. 
14  Neither the name of the author nor the names of its contributors may be used to endorse or promote
15    products derived from this software without specific prior written permission. 
16
17THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
18OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
19AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
20CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25POSSIBILITY OF SUCH DAMAGE.
26EOF
27) )
28
29(define examples `(pre #<<EOF
30(display "load extension") (newline)
31(require-extension magic)
32
33(display "create cookie") (newline)
34(define cookie (magic-open (+ MAGIC_MIME MAGIC_SYMLINK)))
35
36(display "open the file") (newline)
37(magic-load cookie #f)
38
39(display "test file") (newline)
40(display (magic-file cookie "/bin/ls")) (newline)
41
42(display "close") (newline)
43(magic-close cookie)
44EOF
45))
46
47(define doc
48  `((eggdoc:begin
49     (name "magic")
50     (description "Identifies file types")
51     (author "Peter Busser")
52     (history (version "1.0" "Initial release") )
53     (usage)
54     (download "magic.egg")
55
56     (documentation
57      (p "These functions operate on the magic database file which is described in magic(5).
58For more information, consult the libmagic(3) manual page.")
59      (subsection "Procedures"
60                  (pre #<<EOF
61(magic-open FLAGS) -> MAGIC-T
62(magic-load MAGIC-T FILENAME)
63(magic-error MAGIC-T) -> STRING
64(magic-file MAGIC-T FILENAME) -> STRING
65(magic-close MAGIC-T)
66(magic-setflags MAGIC-T FLAGS)
67(magic-errno MAGIC-T) -> INT
68EOF
69      ))
70      (subsection "Flags"
71                  (pre #<<EOF
72MAGIC_NONE
73MAGIC_DEBUG
74MAGIC_SYMLINK   
75MAGIC_COMPRESS
76MAGIC_DEVICES
77MAGIC_MIME
78MAGIC_CONTINUE
79MAGIC_CHECK
80MAGIC_PRESERVE_ATIME
81MAGIC_RAW
82MAGIC_ERROR
83EOF
84     )))
85     (examples ,examples)
86     (license ,license))))
87
88(eggdoc->html doc)
89
Note: See TracBrowser for help on using the repository browser.