Annotation of coherent/g/usr/lib/uucp/tay104/contrib/uurate.man, revision 1.1

1.1     ! root        1: .TH uurate 1
        !             2: .SH NAME
        !             3: uurate \- Report Taylor UUCP statistics
        !             4: .SH SYNOPSIS
        !             5: .BR uurate " [ " "\-cfexai" " ] [ " "\-h "
        !             6: .I host
        !             7: .RI " ] [ " "logfile..." " ] "
        !             8: .PP
        !             9: or simply,
        !            10: .PP
        !            11: .B uurate
        !            12: .PP
        !            13: for a traffic summary report.
        !            14: .SH DESCRIPTION
        !            15: The 
        !            16: .I uurate
        !            17: command provides tabular summary reports on the operation of the 
        !            18: Taylor UUCP system. Data is taken from the currently active log
        !            19: files, standard input, or from a list of log files given on the 
        !            20: command line. Output is in the form of tabular reports summarizing 
        !            21: call, file transfer, and command execution
        !            22: .RI "("  "uuxqt" ")"
        !            23: activity.
        !            24: .PP
        !            25: The log files given to
        !            26: .I uurate
        !            27: must be in the ``Taylor'' format. Also, note that call and file
        !            28: transfer activities are logged in separate files, nominally called 
        !            29: .I Log
        !            30: and
        !            31: .I Stats,
        !            32: respectively. For reports to be meaningful, the
        !            33: .I Log
        !            34: and
        !            35: .I Stats
        !            36: files should be given to 
        !            37: .I uurate
        !            38: together, and cover the same time period.
        !            39: .PP
        !            40: If neither the
        !            41: .B \-i
        !            42: option nor any 
        !            43: .I logfile
        !            44: options are given, 
        !            45: .I uurate
        !            46: defaults to taking its input from the current Taylor
        !            47: .I Log
        !            48: and
        !            49: .I Stats
        !            50: files, as defined at compilation time.
        !            51: This is the normal mode of operation.
        !            52: .PP
        !            53: The reporting options described below can be used to select
        !            54: the set of reports desired. If no options are given, the
        !            55: .B call
        !            56: and
        !            57: .B file
        !            58: reports are displayed. If there is no relevant data for a particular
        !            59: report or host, that report or host will be supressed.
        !            60: .SH OPTIONS
        !            61: The following options may be given to 
        !            62: .I uurate:
        !            63: .TP 5
        !            64: .B \-c
        !            65: Report on call statistics. Requires data from a
        !            66: .I Log
        !            67: file.
        !            68: .TP 5
        !            69: .B \-f
        !            70: Report on file transfer statistics. Requires data from a
        !            71: .I Stats
        !            72: file.
        !            73: .TP 5
        !            74: .B \-e
        !            75: Report on efficiency (total connect time versus time spent transferring
        !            76: files). Requires data from both a
        !            77: .I Log
        !            78: and a
        !            79: .I Stats
        !            80: file, and they must span the same time period.
        !            81: .TP 5
        !            82: .B \-x
        !            83: Report on remote execution requests (e.g.,
        !            84: .IR rmail ")."
        !            85: Requires data from a
        !            86: .I Log
        !            87: file.
        !            88: .TP 5
        !            89: .B \-a
        !            90: All reports. Identical to
        !            91: .B \-cfex.
        !            92: .TP 5
        !            93: .BI "\-h " "host"
        !            94: Restrict report output to
        !            95: .I host.
        !            96: .SH "DESCRIPTION OF REPORTS"
        !            97: There are four reports available: the call, file transfer, efficiency,
        !            98: and remote execution reports. Each may be selected by a command line
        !            99: option. All reports may be selected via the option
        !           100: .B \-a.
        !           101: If no report selection options are given, 
        !           102: .I uurate
        !           103: displays a compact traffic summary report (see below).
        !           104: .SS "Summary report"
        !           105: If no report options are given,
        !           106: .I uurate
        !           107: displays a traffic summary report. This is particularly useful in daily
        !           108: .I cron
        !           109: jobs which report on errors and the like. Traffic statistics for each
        !           110: active system is reported on a single line. If more than one system was
        !           111: active, a 'totals' line is included at the end of the report.
        !           112: .SS "Call report"
        !           113: The call report gives statistics on inbound and outbound calls for 
        !           114: each active host system. The fields are described below:
        !           115: .br
        !           116: .nf
        !           117: .in +.5i
        !           118: .ta 1.0i
        !           119: .BR "sysname   " "UUCP node name of neighbor host system"
        !           120: .BR "callto    " "Outbound calls attempted to that system"
        !           121: .BR "failto    " "Failed outbound calls to that system"
        !           122: .BR "totime    " "Connect time (sec.) on outbound calls"
        !           123: .BR "callfm    " "Inbound calls attempted by that system"
        !           124: .BR "failfm    " "Failed inbound calls from that system"
        !           125: .BR "fmtime    " "Connect time (sec.) on inbound calls"
        !           126: .in -.5
        !           127: .SS "File transfer reports"
        !           128: The file transfer reports give statistics on inbound and 
        !           129: outbound file transfers (regardless of which end initiated the transfer)
        !           130: for each active host system. There are two reports, one for files
        !           131: sent to the remote system and one for files received from the remote
        !           132: system. The fields in each report are described below:
        !           133: .br
        !           134: .nf
        !           135: .in +.5i
        !           136: .ta 1.0i
        !           137: .BR "sysname   " "UUCP node name of neighbor host system"
        !           138: .BR "files     " "Number of files transferred"
        !           139: .BR "bytes     " "Total size (bytes) of files transferred"
        !           140: .BR "seconds   " "Total time (sec.) to transfer files"
        !           141: .BR "byte/sec  " "Average transfer rate (bytes/sec)"
        !           142: .in -.5
        !           143: .SS "Efficiency report"
        !           144: The efficiency report describes the utilization of the links
        !           145: to each active remote system, giving the ratio of total connect time
        !           146: to the time spent actually transferring files. 
        !           147: The fields are described below:
        !           148: .br
        !           149: .nf
        !           150: .in +.5i
        !           151: .ta 1.0i
        !           152: .BR "sysname   " "UUCP node name of neighbor host system"
        !           153: .BR "conntime  " "Total connect time for that system"
        !           154: .BR "flowtime  " "Total file transfer time for that system"
        !           155: .BR "ovhdtime  " "Connect time not used to transfer files"
        !           156: .BR "effcy (%) " "Ratio of connect time to transfer time"
        !           157: .in -.5
        !           158: .SS "Remote execution report"
        !           159: The remote execution report describes remotely
        !           160: requested command executions from each active host system.
        !           161: Executions of
        !           162: .I rmail
        !           163: and
        !           164: .I rnews
        !           165: are the most common, and are detailed separately. The fields
        !           166: are described below:
        !           167: .br
        !           168: .nf
        !           169: .in +.5i
        !           170: .ta 1.0i
        !           171: .BR "sysname   " "UUCP node name of neighbor host system"
        !           172: .BR "rmail     " "Number of rmail requests from that system"
        !           173: .BR "rnews     " "Number of rnews requests from that system"
        !           174: .BR "other     " "Number of other requests from that system"
        !           175: .in -.5i
        !           176: .SS FILES
        !           177: The file names below may be changed at compilation time or by the
        !           178: configuration file, so these are only approximations.
        !           179: .br
        !           180: .nf
        !           181: .in +.5in
        !           182: .ta 2.0i
        !           183: .IR "/usr/spool/uucp/Log       " "Taylor format call/execution log"
        !           184: .IR "/usr/spool/uucp/Stats     " "Taylor format file transfer log"
        !           185: .SS "SEE ALSO"
        !           186: .IR uucico "(8)"
        !           187: .SS BUGS
        !           188: Does not understand older (V2, BNU) logging formats. Anyone care to
        !           189: volunteer to add this? I don't use the stuff myself.
        !           190: .PP
        !           191: The entries that Taylor UUCP makes in the log file for incoming calls
        !           192: don't have a host name. This confuses 
        !           193: .I uurate 
        !           194: into thinking that the calls came in for system "-". This may require 
        !           195: a change to Taylor logging.
        !           196: .PP
        !           197: Should check the configuration file to locate the currently active 
        !           198: .I Log
        !           199: and
        !           200: .I Stats
        !           201: files when using them for default inputs. Instead, it uses the
        !           202: compile-time settings only.
        !           203: .PP
        !           204: Should report packet protocol error statistics by host and
        !           205: protocol type.
        !           206: .SS AUTHOR
        !           207: Robert B. Denny ([email protected])
        !           208: .br
        !           209: Loosely based on the DECUS UUCP program
        !           210: .I uurate
        !           211: by Mark Pizzolato.
        !           212: 
        !           213: 
        !           214: 
        !           215: 
        !           216: 
        !           217: 

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.