Debian Codegraph @

upstream/debian-unstable/man1/uurate.1

raw
1 .\" ''' $Id: uurate.man,v 1.4 1993/09/28 17:38:31 kdburg Rel $
2 .TH uurate 1
3 .SH NAME
4 uurate \- Report Taylor UUCP statistics
5 .SH SYNOPSIS
6 .BR uurate " [ " "\-acdefhipqtvx" " ] [ " "\-s "
7 .I host
8 .RI " ] [ " "\-I "
9 .I config
10 .RI " ][ " "logfile..." " ] "
11 .PP
12 or simply,
13 .PP
14 .B uurate
15 .PP
16 for a traffic summary report.
17 .SH DESCRIPTION
18 The
19 .I uurate
20 command provides tabular summary reports on the operation of the
21 Taylor UUCP system. Data is taken from the currently active log
22 files, standard input, or from a list of log files given on the
23 command line. Output is in the form of tabular reports summarizing
24 call, file transfer, and command execution
25 .RI "(" "uuxqt" ")"
26 activity.
27 .PP
28 The log and stats files given to
29 .I uurate
30 must be in the ``Taylor'' or ``V2'' format. Also, note that call and file
31 transfer activities are logged in separate files, nominally called
32 .I Log
33 and
34 .I Stats,
35 respectively. For reports to be meaningful, the
36 .I Log
37 and
38 .I Stats
39 files should be given to
40 .I uurate
41 together, and cover the same time period.
42 .PP
43 If neither the
44 .B \-i
45 or
46 .B \-I
47 option nor any
48 .I logfile
49 options are given,
50 .I uurate
51 defaults to taking its input from the current Taylor
52 .I Log
53 and
54 .I Stats
55 files. The names are either as defined at compilation time, in case
56 there is no config file, or taken from the arguments of the keywords
57 .I logfile
58 and
59 .I statfile
60 when encountered in the config file.
61 This is the normal mode of operation.
62 .PP
63 The reporting options described below can be used to select
64 the set of reports desired. If no options are given, a summary
65 report is displayed. If there is no relevant data for a particular
66 report or host, that report or host will be suppressed.
67 .SH OPTIONS
68 The following options may be given to
69 .I uurate:
70 .TP 5
71 .B \-a
72 All reports. Identical to
73 .B \-cfexp.
74 .TP 5
75 .B \-c
76 Report on call statistics. Requires data from a
77 .I Log
78 file.
79 .TP 5
80 .B \-d
81 will print the default config file to be used.
82 .TP 5
83 .B \-e
84 Report on efficiency (total connect time versus time spent transferring
85 files). Requires data from both a
86 .I Log
87 and a
88 .I Stats
89 file, and they must span the same time period.
90 .TP 5
91 .B \-f
92 Report on file transfer statistics. Requires data from a
93 .I Stats
94 file.
95 .TP 5
96 .B \-h
97 will print a short help information.
98 .TP 5
99 .B \-i
100 tells uurate to read any logfile information from standard input.
101 .TP 5
102 .B \-p
103 report on protocol errors and packets sent/received
104 .TP 5
105 .B \-q
106 do not print the Environment information,
107 .TP 5
108 .B \-t
109 All reports. Identical to
110 .B \-cfexp.
111 plus the
112 .B Compact summary.
113 .TP 5
114 .B \-v
115 will print the version id string
116 .TP 5
117 .B \-x
118 Report on remote execution requests (e.g.,
119 .IR rmail ")."
120 Requires data from a
121 .I Log
122 file.
123 .TP 5
124 .BI "\-s " "host"
125 Restrict report output to
126 .I host.
127 .TP 5
128 .BI "\-I " "config file"
129 an alternate config file may be passed by this option.
130 .SH "DESCRIPTION OF REPORTS"
131 There are four reports available: the call, file transfer, efficiency,
132 and remote execution reports. Each may be selected by a command line
133 option. All reports may be selected via the options
134 .B \-a
135 or
136 .B \-t.
137 If no report selection options are given,
138 .I uurate
139 displays a compact traffic summary report (see below).
140 .SS "Summary report"
141 If no report options are given,
142 .I uurate
143 displays a traffic summary report. This is particularly useful in daily
144 .I cron
145 jobs which report on errors and the like. Traffic statistics for each
146 active system is reported on a single line. If more than one system was
147 active, a 'totals' line is included at the end of the report.
148 .SS "Protocol packet report"
149 The protocol report gives statistics on min/max packet and window sizes
150 used during transmission. Further on data is collected for packets
151 transferred. The data is collected for each host/protocol type.
152 The fields are described below:
153 .PP
154 .br
155 .nf
156 .in +.3i
157 .ta 1.0i
158 .BR "site " "UUCP node name of neighbor host system,"
159 .BR "typ " "Type of protocol used"
160 .BR "Min " "minimum packet/window size"
161 .BR "Max " "maximum packet/window size"
162 .BR "sent " "packets sent"
163 .BR "resent " "packets resent"
164 .BR "received " "packets received"
165 .in -.3
166 .SS "Protocol error report"
167 The protocol report gives statistics on packet errors
168 during transmission. The data is collected for each host/protocol type.
169 The fields are described below:
170 .PP
171 .br
172 .nf
173 .in +.3i
174 .ta 1.5i
175 .BR "site " "UUCP node name of neighbor host system,"
176 .BR "typ " "Type of protocol used"
177 .BR "header " "number of errors in header"
178 .BR "checksum " "number of checksum errors"
179 .BR "order " "number of order errors"
180 .BR "resent " "number packets resent"
181 .BR "rem-reject " "packets that the remote site rejected"
182 .in -.3
183 .SS "Call report"
184 The call report gives statistics on inbound and outbound calls for
185 each active host system. The fields are described below:
186 .PP
187 .br
188 .nf
189 .in +.3i
190 .ta 1.0i
191 .BR "site " "UUCP node name of neighbor host system,"
192 .BR "succ. " "Successful calls attempted to/by that system,"
193 .BR "failed " "Failed calls to/by that system,"
194 .BR "total " "Total calls to/by that system,"
195 .BR "time " "Collected connect time (hh:mm:ss) for all calls,"
196 .in -.3
197 .SS "File transfer reports"
198 The file transfer reports give statistics on inbound and
199 outbound file transfers (regardless of which end initiated the transfer)
200 for each active host system. There are two reports, one for files
201 sent to the remote system and one for files received from the remote
202 system. The fields in each report are described below:
203 .PP
204 .br
205 .nf
206 .in +.3i
207 .ta 1.0i
208 .BR "site " "UUCP node name of neighbor host system"
209 .BR "files " "Number of files transferred"
210 .BR "Bytes/1000 " "Total size of files transferred given in thousands"
211 .BR "xfr time " "Total time (hh:mm:ss) spent on transfer the files,"
212 .BR "B/sec " "Average transfer rate (bytes/sec)."
213 .in -.3
214 .SS "Efficiency report"
215 The efficiency report describes the utilization of the links
216 to each active remote system, giving the ratio of total connect time
217 to the time spent actually transferring files.
218 The fields are described below:
219 .PP
220 .br
221 .nf
222 .in +.3i
223 .ta 1.0i
224 .BR "site " "UUCP node name of neighbor host system"
225 .BR "connected " "Total connect time for that system (turn-around)"
226 .BR "xfr time " "Total file transfer time for that system"
227 .BR "overhead " "Connect time not used to transfer files,"
228 .BR "eff. % " "Ratio of connect time to transfer time (xfer*100/conn)"
229 .in -.3
230 .SS "Command executions report"
231 The remote execution report describes remotely
232 requested command executions from each active host system, like
233 .I rmail
234 and
235 .IR rnews "."
236 Up to eight command names are displayed. If there are more, the
237 rest will be put together in an `Misc.' column.
238 The fields are described below:
239 .PP
240 .br
241 .nf
242 .in +.3i
243 .ta 1.0i
244 .BR "site " "UUCP node name of neighbor host system,"
245 .BR "(command) " "Number of requests of this command,"
246 .BR "Misc. " "Number of other requests, if more than eight."
247 .in -.3i
248 .SS FILES
249 The file names below may be changed at compilation time or by the
250 configuration file, so these are only approximations.
251 .br
252 .nf
253 .in +.3in
254 .ta 2.2i
255 .IR "/usr/spool/uucp/Log " "V2/Taylor format call/execution log,"
256 .IR "/usr/spool/uucp/Stats " "V2/Taylor format file transfer log."
257 .SS "SEE ALSO"
258 .IR uucico "(8)"
259 .SS BUGS
260 Does not understand other than V2/TAYLOR logging formats. Anyone care to
261 volunteer to add the not mentioned?
262 .PP
263 Scanning the arguments of logfile and statfile keywords
264 in config should handle lines continued with the backslash as well.
265 .PP
266 The
267 .B failfm
268 field in the call statistics table is always zero, unless
269 something really serious happens, e.g. uucico got SIGQUIT or
270 the whole system crashed.
271 .SS AUTHOR
272 Robert B. Denny ([email protected]).
273 .br
274 Loosely based on the DECUS UUCP program
275 .I uurate
276 by Mark Pizzolato.
277 .br
278 Modified by Stephan Niemz ([email protected]).
279 .br
280 Modified by Klaus Dahlenburg ([email protected]).