source: project/wiki/eggref/5/salmonella-feeds @ 39934

Last change on this file since 39934 was 39934, checked in by Mario Domenech Goulart, 5 months ago

eggref/5/salmonella-feeds: break symlink to ../4/salmonella-feeds

File size: 3.2 KB
Line 
1[[tags: egg salmonella-feeds]]
2
3== salmonella-feeds
4
5[[toc:]]
6
7=== Introduction
8
9salmonella-feeds is a command line tool to generate atom feeds out of [[/egg/salmonella|salmonella]] log files.
10
11
12=== Author
13
14[[/users/mario-domenech-goulart|Mario Domenech Goulart]]
15
16=== Repository
17
18The salmonella-feeds egg is maintained in a
19[[https://github.com/mario-goulart/salmonella-feeds|Github repository]].
20
21
22=== Usage
23
24  salmonella-feeds [ -h | --help ]
25  salmonella-feeds <options>
26 
27  <options>:
28 
29  --log-file=<file>
30    The salmonella log file.
31 
32  --feeds-dir=<dir>
33    Directory where to write feed files.
34 
35  --custom-feeds-dir=<dir>
36    Directory where custom feeds can be read from (optional).
37 
38  --custom-feeds-out-dir=<dir>
39    Directory where custom feeds will be written to.
40 
41  --feeds-web-dir=<dir>
42    The web directory (i.e., the directory which HTTP clients request) where
43    feeds are located.
44 
45  --custom-feeds-web-dir=<dir>
46    The web directory (i.e., the directory which HTTP clients request) where
47    custom feeds are located.
48 
49  --feeds-server=<server address>
50    Feeds server address (e.g., "http://tests.call-cc.org")
51 
52  --salmonella-report-uri=<URI>
53    The URI where salmonella reports can be located.
54
55
56=== Custom feeds
57
58Custom feeds are special feeds that can be customized by users.
59
60The input file has a simple sexpr-based syntax.  Here's an example
61that:
62
63
64<enscript highlight=scheme>
65(title "Eggs that Mario is tracking")
66
67(egg awful)
68(egg salmonella)
69(egg salmonella-feeds)
70
71;; Ignore failures in tests (this example needs a server process
72;; which is not installed on the Salmonella-server)
73(egg postgresql ignore-tests)
74
75;; ignore warnings
76(egg salmonella-diff ignore-warnings)
77</enscript>
78
79
80=== License
81
82  Copyright (c) 2011-2020, Mario Domenech Goulart
83  All rights reserved.
84 
85  Redistribution and use in source and binary forms, with or without
86  modification, are permitted provided that the following conditions
87  are met:
88  1. Redistributions of source code must retain the above copyright
89     notice, this list of conditions and the following disclaimer.
90  2. Redistributions in binary form must reproduce the above copyright
91     notice, this list of conditions and the following disclaimer in the
92     documentation and/or other materials provided with the distribution.
93  3. The name of the authors may not be used to endorse or promote products
94     derived from this software without specific prior written permission.
95 
96  THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
97  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
98  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
99  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
100  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
101  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
102  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
103  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
104  IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
105  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
106  IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
107
108
109=== Version history
110
111==== Version 0.1.0 (2020-11-07)
112
113* CHICKEN 5 support
114
115
116==== Version 0
117
118* Initial release
119
Note: See TracBrowser for help on using the repository browser.