/[fisg]/fisg/FAQ
ViewVC logotype

Contents of /fisg/FAQ

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.14 - (show annotations) (download)
Thu Sep 16 02:13:54 2004 UTC (8 years, 8 months ago) by ccr-guest
Branch: MAIN
CVS Tags: dev-0_3_12, dev-0_3_13, HEAD
Changes since 1.13: +12 -0 lines
Added section about character sets (and lack of support in FISG)
1 Frequently Asked Questions
2 ==========================
3
4 >--
5
6 Q: Is it possible to specify the character set?
7 Q: My logs contain Unicode (UTF-8, UTF-16, etc.) and FISG chokes on them!
8 A: Unfortunately there is no solution to this, FISG currently does
9 not handle character sets in any way. It also relies on some
10 codes to be like in ISO8859-* charsets.
11
12 While it is possible that I'll rework FISG to support unicode
13 (UTF-8 input and output, internally using UTF-32 for processing)
14 in future, it is not high on my priority list.
15
16 >--
17
18 Q: Is there any easy way to create a userfile?
19 A: Well.. yes and no. It's always best to do this by hand, but
20 since FISG v0.3.11, you can use commandline option "-d"
21 (dump userfile) in conjunction with few configuration settings
22 to ease the making of initial userfile:
23
24 1) Set following options TEMPORARILY in config file:
25 gen_auto_follow_nicks = yes
26 gen_auto_follow_heuristics = yes
27
28 2) Run fisg with your normal options, but add "-d newuser.cfg"
29 to dump the automagically gathered user information in file
30 "newuser.cfg".
31
32 3) Edit "newuser.cfg" to remove any mistakes made by FISG's
33 automatic user heuristics.
34
35 4) Set AT LEAST "gen_auto_follow_heuristics = no" in config,
36 this option is not meant for casual usage! You may leave
37 "gen_auto_follow_nicks = yes" if you want, but be aware
38 of the consequences.
39
40 5) It might be a good idea to leave the userfile dumping option
41 in place for debugging purposes (in case it seems somebody's
42 stats go to wrong person due to automatic combining of nicks).
43
44 >--
45
46 Q: How do I create my own input format?
47
48 A: This is not a simple question. You should be familiar with some
49 basic pattern matching (for example regular expressions, aka regexps)
50 and be patient enough to read "PARSER" and "logformat.cfg".
51
52 Tokens used in patterns for FISG's parser engine are explained in
53 "PARSER". A simple example format is specified in "logformat.cfg".
54
55 >--
56
57 Q: I'm using mIRC/Irssi/whatever, but FISG does not seem to work
58 correctly for these logs (I get missing stats, zero stats, etc.)
59 What gives?
60
61 A: In some programs (including especially mIRC and Irssi), the
62 log output can be altered. FISG only supports the default
63 formats, thus if you are using any scripts or have changed
64 the settings yourself, you can't expect FISG to magically adapt.
65
66 If you want to use FISG anyway, create your own logformat and
67 specify it to FISG. See "logformat.cfg" for more information.
68
69 >--
70
71 Q: Would you add support for 'Most used words' and/or
72 'Most referenced nick'?
73 A: No.
74
75 >--
76
77 Q: I'd like to have FISG supporting my own language /
78 I want internationalization support, can you add it?
79
80 A: It's on my TO-DO-list, but scheduled for v0.5.x-development series
81 (and subsequently will be on 0.6.x-stable)
82
83 >--
84
85 Q: What do those silly faces (smileys) mean?
86 A: They describe the relative happiness-level of given user.
87 The algorithm for calculating the happiness isn't too robust
88 currently, so most faces are too sad, but it will be improved.
89
90 >--
91
92 Q: I use FISG to generate many statistics and would like a global
93 template configuration file for general settings!
94 A: It is possible. Just give several -c options to FISG, as follows:
95
96 fisg -c global.cfg -c somechannel.cfg [...]
97
98 Configs specified later in commandline will override the settings
99 in previous files.
100
101 >--
102
103 Q: I have lots of separate logfiles, how do I give them to FISG?
104 A: If you are using Windows, you can only use "*" asterisk and "?" like:
105
106 fisg.exe -f mirc *.log
107
108 Under UNIX you can ALSO use the standard find(1) utility, for example
109 if you have logs in different subdirectories under "/path/to/logs"
110
111 fisg -f irssi `find /path/to/logs -type f -name "*.log"`
112
113 Please see the find(1) man-page for more information.
114
115 >--
116
117 Q: I have logfiles from Irssi and Eggdrop and I want to have them all in same stats!
118 A: It is possible to specify format for every given logfile, example:
119
120 fisg -c mychan.conf -f eggdrop eggdrop.log* -f irssi irssi.log other-irssi.log
121
122 The eggdrop.log* will then be parsed as eggdrop-format, etc.
123
124 >--
125
126 Q: I want to create stats for many channels, what should I do?
127 A: If you know shell-scripting under UNIX, it's quite simple.
128
129 See example scripts "*-multichan.sh" under unix/-subdir. Under Windows,
130 you can create a batch-file (.BAT). I'll add more example scripts soon.
131
132 >--
133
134 Q: There are duplicate nicks (users) in the top-list! Did I just find a bug?
135 A: Most probably you have forgot to specify the user's nick in the NICKLIST
136 in userfile. (Hey, the reminder in example users.cfg is there for a reason ;)
137
138 For example somebody in your channel is called "TheKing" and has also used
139 nicks "TheKing_", "TheKing__" and "daKing". A common mistake is to following
140 line in the userlist:
141
142 TheKing:TheKing_ TheKing__ daKing:
143
144 So, what's the problem? Above line specifies "TheKing" as USERNAME, not NICK.
145 It is important to remember that they are completely distinct concepts in FISG!
146 The correct definition line would be:
147
148 TheKing:TheKing TheKing_ TheKing__ daKing:
149
150 or a shorter version, using pattern matching:
151
152 TheKing:TheKing* daKing:
153
154 >--

  ViewVC Help
Powered by ViewVC 1.1.5