-
Notifications
You must be signed in to change notification settings - Fork 2
/
README
266 lines (198 loc) · 11.4 KB
/
README
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
MysticBBS Multi Tool
Ver 2.0.0.0
Black Panther(RCS)
aka Dan Richter
Sysop - Castle Rock BBS
telnet://bbs.castlerockbbs.com
http://www.castlerockbbs.com
The sparrows are flying again...
-=-= What's New =-=-
The MysticBBS Multi Tool, usually called mystmult, is what I like to call
a swiss-army knife for the MysticBBS sysop. There are many functions this
program does, which is beneficial to the sysop.
If you are running MTAFile file announcement, you will already have the
rcs.ini file. This program uses the same rcs.ini file to obtain information
about your system, and how you would like the reports to be shown.
-=-= Description =-=-
mystmult can perform many different functions for the MysticBBS sysop. The
first function it was capable of, is performing a backup of all the log files
within the /mystic/logs directory. The format of the backup logs are in the
format of:
/mystic/logs/2019/04/28/
mystmult, when this function is called, will create, if needed, the year,
month, and day folder for the previous days log files, and copy all of the
logs into that folder. These logs are not compressed or renamed, just copied.
This is important, as other functions and other programs will use these log
files to obtain information.
The reports that can be generated by mystmult include the following:
Detailed Echo Report
Can be sorted by incoming message count, outbound message count, duplicate
message count, message network, or echo name.
Detailed Node Report (incoming and outgoing message count, size, connections)
List of other networks, based on aka's shown by other systems.
List of mailers used, based on connecting systems.
-=-= Warranties and Guarantees =-=-
While every effort is made to make sure this program does what it is designed
to, and not harm your computer, the only warranty you have, is this program
will take up space on your hard drive. Other than that, I assume no
reponsibility for what happens to your computer due to the use of this
software.
If you do notice a bug in the program, or have a suggestion on how it could
be improved, please feel free to let me know.
-=-= Files =-=-
mystmult.exe - The main program
mystmult.txt - The file your reading right now :)
mystmult.log - File created by the program in logs directory
rcs.ini - Configuration file read by the program
echorpt.rpt - Generated by mystmult - Echomail Report
noderpt.rpt - Generated by mystmult - Node Report
onetrpt.rpt - Generated by mystmult - Othernet Report
mailrpt.rpt - Generated by mystmult - Mailer Report
-=-= Installation =-=-
mystmult uses the same config file as many of the other RCS programs. While
this file does look a bit overwhelming at first, it is actually quite simple
to use.
The file is documented, so you shouldn't have any problems with it. Each line
that starts with the ";" is ignored, and considered a comment. Keep in mind,
that not all of the information in this config is used for mystmult.
mystmult should be placed in my /mystic directory, along with the rcs.ini
file. The log file will be created in your /mystic/logs directory, or
wherever you indicate you would like them in the rcs.ini file. The reports,
at least at this time, will be created in the /mystic directory. These
reports will be overwritten each time the program is run in that particular
mode, so make sure you do something with them! :)
If you run mystmult with no parameters, you will see a help screen. It looks
like this at the moment:
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
RCS MysticBBS Multi Tool 2.0.0.0
Command Line Parameters:
L - Perform Log Backup
E# - Create Detailed Echo Report
Sort Echo Report by:
1 - Incoming Message count
2 - Message Network
3 - Duplicate Message count
4 - Outbound Message count
5 - Echo Name
N - Create Detailed Node Report
T - Generate a list of other networks
M - Generate a list of mailers used to connect
D - Number of day of information on reports
H - This help file :)
Example... Linux/64:
./mystmult D7 N E1 L T M
This will run all five modes while sorting the echo report
by the number of incoming messages, and report will contain
7 days of information.
DRPanther(RCS)
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
The example shown on this screen will show the OS that it was compiled
for. For example, the Windows compile shows:
Example... Windows/32:
mystmult.exe D7 N E1 L T M
Log Backup:
To perform the log backup function of mystmult, just run with the parameter
of 'L'. For example: mystmult L
This will copy all of the log files into the directory structure as shown
above. This funtion is extremely helpful if your system is running as a
hub for a network. MysticBBS has a tendancy to create some HUGE logfiles.
On the fsxNet hub 4 system, I have had days where the mis.log files, which
are set to 1 Mb each, can be up to mis.5.log, and the fidopoll can easily
be as large as 7 or 8 Mb, in one day. You can see how these log files can
easily get out of control.
Detailed Echo Report
To generate the detailed echo report, which will show how many incoming,
outgoing and dupe messages there are in each message echo, you just need
to run with the 'E#' command. The # is how you would like the report to be
sorted.
Running with this parameter will generate a report file called echorpt.rpt
which will look something like:
RCS Echomail Report
Castle Rock BBS
***********************
Apr 21
***********************
Sorted by Incoming Messages
Echo Name Inbound Outbound Dupes
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FSX_BOT 37 1646 94
FSX_DAT 27 1055 63
FSX_GEN 26 1178 58
FSX_MYS 6 270 17
FSX_BBS 4 182 14
FSX_ENG 1 15 1
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
System Totals: 101 4346 247
Report Generated by:
RCS MysticBBS Multi Tool v2.0.0.0 Linux/64
RCS - CRBBS(2017-2019)
One thing to keep in mind, if you would like to have this report sorted in
multiple ways, say by incoming and one by outgoing, you will need to run one
way, then process the file, then run again for the other sort method. The
program, at this time, will overwrite the file each time it's run. Perhaps
some type of rename within a script could be used.
With this function, you have the ability to exclude echos from being displayed.
For example, I have my netmail excluded, along with a few of the admin echos
that I'm connected to. This way, they are not displayed for the public to see.
There is also the ability to exclude a network from being displayed in the
reports. I have a network setup on my systems, that is primarily used for
testing functionality between systems. As I don't want these connections used
for reporting, they are excluded from the reports. Handy, isn't it? ;)
Detailed Node Connection Report
In order to generate the detailed node report, you would need to use the
parameter of 'N', when running mystmult. This report contains incoming/
outgoing message count, incoming/outgoing file size, number of connections,
and which network the node is connecting with.
Here is a shortened version of what this report contains:
RCS Node Connection Summary
Castle Rock BBS
***********************
Apr 21
***********************
In Out In Out
Node Network Connect Message Message Size Size
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
21:1/100 fsxnet 390 69 32 101,167 51,520
21:2/100 fsxnet 404 22 79 78,122 100,158
21:3/100 fsxnet 427 0 101 101,546 121,905
21:4/10 fsxnet 105 0 101 0 328,481
...etc...etc
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Totals: 4394 101 4346 376,445 19,033,209
Report Generated by:
RCS MysticBBS Multi Tool v2.0.0.0 Linux/64
RCS - CRBBS(2017-2019)
List of other Networks
The next function that mystmult will be able to do, is compile a list of
other networks, from information sent by connecting systems. This is still
a work in progress and may cause errors when trying to run...
List of Mailers
This function is also a work in progress. It will display a list of mailers
that have connected to the system. It also may cause errors when trying
to run...
Number of days for reports
This is not fully implemented yet. It will allow you to chose how many days
you would like included in the generated reports.
-=-= Credits =-=-
I would like to give sincere thanks to the following people
(in no particular order):
g00r00 - for making, and maintaning an awesome BBS package
Avon - for having an great network which provides great support
and for testing this program during pre-release
GaryCrunk - for answering some rookie pascal questions
Apam - for showing us all that BBS programming is still alive
fsxNet - for putting up with my stupid questions and test posts
Cmech - for making great looking programs look easy to do :)
Gryphon - for porting some awesome games into MPL which got me
interested in learning Pascal again
xqtr - for making some great MPLs - even if most of them won't work
on Windows :) (I ran Windows at the time)
fabian - for helping me figure out better functions to use
tiny - for giving me his string compare functions to use
I know I'm forgetting people here. It is not intentional. :)
-=-= Known bugs: =-=-
- None at this time - If you find something, please let me know
-=-= ToDo List: =-=-
- Experiment with adding ANSI capability to output file
- Complete the othernet and mailer functions
- Completely implement the number of days functionality