usr/src/man/man1/ncab2clf.1

   1 '\" te
   2 .\" Copyright (C) 2001, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH NCAB2CLF 1 "Sep 28, 2001"
   7 .SH NAME
   8 ncab2clf \- convert binary log file to Common Log File format
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/bin/ncab2clf\fR [\fB-Dhv\fR] [\fB-i\fR \fIinput-file\fR] [\fB-o\fR \fIoutput-file\fR]
  13      [\fB-b\fR \fIsize\fR] [\fB-n\fR \fInumber\fR] [\fB-s\fR \fIdatetime\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBncab2clf\fR command is used to convert the log file generated by the
  20 Solaris Network Cache and Accelerator ("\fBNCA\fR") from binary format, to
  21 Common Log File ("\fBCLF\fR") format. If no \fIinput-file\fR is specified,
  22 \fBncab2clf\fR uses \fBstdin\fR. If no \fIoutput-file\fR is specified, the
  23 output goes to \fBstdout\fR.
  24 .SH OPTIONS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fB-b\fR\fR
  29 .ad
  30 .RS 18n
  31 Specifies the binary-log-file blocking in kilobytes; the default is 64 Kbyte.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fB-D\fR\fR
  38 .ad
  39 .RS 18n
  40 Specifies that direct \fBI/O\fR be disabled.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fB-h\fR\fR
  47 .ad
  48 .RS 18n
  49 Prints usage message.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB-i\fR \fIinput-file\fR\fR
  56 .ad
  57 .RS 18n
  58 Specifies the input file.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB-n\fR \fInumber\fR\fR
  65 .ad
  66 .RS 18n
  67 Output \fInumber\fR CLF records.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fB-o\fR \fIoutput-file\fR\fR
  74 .ad
  75 .RS 18n
  76 Specifies the output file.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fB-s\fR \fIdatetime\fR\fR
  83 .ad
  84 .RS 18n
  85 Skip any records before the date and time specified in \fIdatetime\fR. You can
  86 specify the date and time in CLF format or in the format specified by the
  87 \fBtouch\fR(1) utility. CLF format is the dominant format, so \fBncab2clf\fR
  88 first analyzes \fIdatetime\fR assuming CLF.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-v\fR\fR
  95 .ad
  96 .RS 18n
  97 Provides verbose output.
  98 .RE
  99
 100 .SH EXAMPLES
 101 .LP
 102 \fBExample 1 \fRConverting a Binary File to a Common Log File Format
 103 .sp
 104 .LP
 105 The following example converts the binary file \fB/var/nca/logs/nca.blf\fR to a
 106 file \fB/var/nca/logs/nca.clf\fR, which is in Common Log File format.
 107
 108 .sp
 109 .in +2
 110 .nf
 111 example% \fBncab2clf -D -i /var/nca/logs/nca.blf -o /var/nca/logs/nca.clf\fR
 112 .fi
 113 .in -2
 114 .sp
 115
 116 .LP
 117 \fBExample 2 \fRConverting Multiple Log Files
 118 .sp
 119 .LP
 120 The following script may be used to convert multiple log files. The directory
 121 designated by "\fB*\fR" must only contain log files.
 122
 123 .sp
 124 .in +2
 125 .nf
 126 !/bin/ksh
 127 for filename in *
 128 do
 129     ncab2clf -D < $filename > $filename.clf
 130 done
 131 .fi
 132 .in -2
 133
 134 .LP
 135 \fBExample 3 \fRUsing \fB-s\fR and \fB-n\fR on a Raw Device
 136 .sp
 137 .LP
 138 The following example shows how \fBncab2clf\fR can be used on a raw device. If
 139 not using the \fB-n\fR option, the default is to convert all records from the
 140 starting location to the end of the file. The date and time specified with
 141 \fB-s\fR, below, is in CLF format.
 142
 143 .sp
 144 .in +2
 145 .nf
 146 example% ncab2clf -s '10/Apr/2001:09:23:13' -n 100 < /dev/dsk/c2t1d0s6
 147 .fi
 148 .in -2
 149 .sp
 150
 151 .SH EXIT STATUS
 152 .sp
 153 .LP
 154 The following exit values are returned:
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fB0\fR \fR
 159 .ad
 160 .RS 6n
 161 The file converted successfully
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fB>\fB0\fR\fR
 168 .ad
 169 .RS 6n
 170 An error occurred.
 171 .RE
 172
 173 .SH ATTRIBUTES
 174 .sp
 175 .LP
 176 See \fBattributes\fR(5) for descriptions of the following attributes:
 177 .sp
 178
 179 .sp
 180 .TS
 181 box;
 182 c | c
 183 l | l .
 184 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 185 _
 186 Interface Stability     Evolving
 187 .TE
 188
 189 .SH SEE ALSO
 190 .sp
 191 .LP
 192 \fBnca\fR(1), \fBncakmod\fR(1), \fBnca.if\fR(4), \fBncakmod.conf\fR(4),
 193 \fBncalogd.conf\fR(4), \fBattributes\fR(5)
 194 .sp
 195 .LP
 196 \fISystem Administration Guide: IP Services\fR
 197 .SH NOTES
 198 .sp
 199 .LP
 200 The binary log files generated by \fBNCA\fR can become very large. When
 201 converting these large binary files, use the \fB-b\fR option to the
 202 \fBncab2clf\fR command to help performance.
 203 .sp
 204 .LP
 205 Direct \fBI/O\fR is a benefit to the user if the data being written does not
 206 come in as large chunks. However, if the user wishes to convert the log file in
 207 large chunks using the \fB-b\fR option, then direct \fBI/O\fR should be
 208 disabled by using the \fB-D\fR option.