--- docs/flow-export.1.orig Wed Dec 4 08:28:58 2002 +++ docs/flow-export.1 Fri Aug 8 12:19:28 2003 @@ -1,83 +1,42 @@ -...\" $Header: /usr/src/docbook-to-man/cmd/RCS/docbook-to-man.sh,v 1.3 1996/06/17 03:36:49 fld Exp $ -...\" -...\" transcript compatibility for postscript use. -...\" -...\" synopsis: .P! -...\" -.de P! -\\&. -.fl \" force out current output buffer -\\!%PB -\\!/showpage{}def -...\" the following is from Ken Flowers -- it prevents dictionary overflows -\\!/tempdict 200 dict def tempdict begin -.fl \" prolog -.sy cat \\$1\" bring in postscript file -...\" the following line matches the tempdict above -\\!end % tempdict % -\\!PE -\\!. -.sp \\$2u \" move below the image -.. -.de pF -.ie \\*(f1 .ds f1 \\n(.f -.el .ie \\*(f2 .ds f2 \\n(.f -.el .ie \\*(f3 .ds f3 \\n(.f -.el .ie \\*(f4 .ds f4 \\n(.f -.el .tm ? font overflow -.ft \\$1 -.. -.de fP -.ie !\\*(f4 \{\ -. ft \\*(f4 -. ds f4\" -' br \} -.el .ie !\\*(f3 \{\ -. ft \\*(f3 -. ds f3\" -' br \} -.el .ie !\\*(f2 \{\ -. ft \\*(f2 -. ds f2\" -' br \} -.el .ie !\\*(f1 \{\ -. ft \\*(f1 -. ds f1\" -' br \} -.el .tm ? font underflow -.. -.ds f1\" -.ds f2\" -.ds f3\" -.ds f4\" -.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n -.TH "\fBflow-export\fP" "1" -.SH "NAME" -\fBflow-export\fP \(em Export flow-tools files into other NetFlow packages\&. -.SH "SYNOPSIS" -.PP -\fBflow-export\fP [-h] [-d\fI debug_level\fP] [-f\fI format\fP] [-m\fI mask_fields\fP] [-u\fI user:password:host:port:name:table\fP] +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" +.\" Please send anDone. +reports, improvements, comments, patches, +.\" etc. to Steve Cheng . +.TH "FLOW-EXPORT" "1" "08 August 2003" "" "" +.SH NAME +flow-export \- Export flow-tools files into other NetFlow packages. +.SH SYNOPSIS + +\fBflow-export\fR [ \fB-h\fR] [ \fB-d\fI debug_level\fB\fR] [ \fB-f\fI format\fB\fR] [ \fB-m\fI mask_fields\fB\fR] [ \fB-u\fI user:password:host:port:name:table\fB\fR] + .SH "DESCRIPTION" .PP -The \fBflow-export\fP utility will convert flow-tools -flow files to ASCII CSV, cflowd, or pcap format\&. +The \fBflow-export\fR utility will convert flow-tools +flow files to ASCII CSV, cflowd, or pcap format. .SH "OPTIONS" -.IP "-d\fI debug_level\fP" 10 -Enable debugging\&. -.IP "-f\fI format\fP" 10 -Export format\&. Supported formats are: - 0 cflowd - 1 pcap - 2 ASCII CSV - 3 MySQL - 4 wire -.IP "-h" 10 -Display help\&. -.IP "-m\fI mask_fields\fP" 10 -Select fields for cflowd and ASCII formats\&. The -\fImask_fields\fP is built from a bitwise OR of the following: -.IP "" 10 -.PP +.TP +\fB-d\fI debug_level\fB\fR +Enable debugging. +.TP +\fB-f\fI format\fB\fR +Export format. Supported formats are: +0 cflowd +1 pcap +2 ASCII CSV +3 MySQL +4 wire +.TP +\fB-h\fR +Display help. +.TP +\fB-m\fI mask_fields\fB\fR +Select fields for MySQL, PostgreSQL, cflowd and ASCII formats. The +\fImask_fields\fR +is built from a bitwise OR of the following: + + .nf UNIX_SECS 0x0000000000000001LL UNIX_NSECS 0x0000000000000002LL @@ -119,10 +78,11 @@ EXTRA_PKTS 0x0000000100000000LL MARKED_TOS 0x0000000200000000LL .fi -.IP "" 10 -When exporting to cflowd format the \fImask_fields\fP field is the cflowd mask which is defined as the following: -.IP "" 10 -.PP + +When exporting to cflowd format the \fImask_fields\fR +field is the cflowd mask which is defined as the following: + + .nf ROUTERMASK 0x00000001 SRCIPADDRMASK 0x00000002 @@ -159,31 +119,44 @@ INDEX_V8_4_MASK 0x00C28D95 INDEX_V8_5_MASK 0x00C3CD9F .fi - -.IP "" 10 + The default value is all fields applicable to the the flow file, or -the cflowd INDEX mask applicabable to the export format\&. -.IP "-u\fI user:password:host:port:name:table\fP" 10 -Configure MySQL Access\&. +the cflowd INDEX mask applicabable to the export format. +.TP +\fB-u\fI user:password:host:port:name:table\fB\fR +Configure MySQL or PostgreSQL Access. +.SH "EXAMPLES" +.PP +.PP +Convert the flow-tools file \fIflows\fR and export +flow data to an MySQL Database. Include only SRCADDR, DSTADDR +and DOCTETS. +.PP +\fBflow-export -f3 -m0x3040 -u "user:password:host:port:name:table" < flows \fR .SH "EXAMPLES" .PP -Convert the flow-tools file \fBflows\fP to the cflowd -file \fBflows\&.cflowd\fP\&. Include all fields\&. .PP - \fBflow-export -f0 < flows > flows\&.cflowd\fP +Convert the flow-tools file \fIflows\fR to the cflowd +file \fIflows.cflowd\fR. Include all fields. +.PP +\fBflow-export -f0 < flows > flows.cflowd\fR .SH "EXAMPLES" .PP -Convert the flow-tools file \fBflows\fP to the ASCII\&. Include -the SRCADDR and DSTADDR fields\&. .PP - \fBflow-export -f2 -m0x3000 < flows > flows\&.ascii\fP +Convert the flow-tools file \fIflows\fR to the ASCII. Include +the SRCADDR and DSTADDR fields. +.PP +\fBflow-export -f2 -m0x3000 < flows > flows.ascii\fR .SH "BUGS" .PP -The pcap format is a hack\&. +The pcap format is a hack. .SH "AUTHOR" .PP -Mark Fullmer maf@splintered\&.net +Mark Fullmer + +.PP +William Emmanuel Yu (For SQL issues) + .SH "SEE ALSO" .PP -\fBflow-tools\fP(1) -...\" created by instant / docbook-to-man, Tue 03 Dec 2002, 19:28 +\fBflow-tools\fR(1) --- docs/flow-export.sgml.orig Wed Dec 4 08:28:55 2002 +++ docs/flow-export.sgml Fri Aug 8 12:17:33 2003 @@ -77,7 +77,7 @@ -m mask_fields -Select fields for cflowd and ASCII formats. The +Select fields for MySQL, PostgreSQL, cflowd and ASCII formats. The mask_fields is built from a bitwise OR of the following: @@ -177,7 +177,7 @@ -u user:password:host:port:name:table -Configure MySQL Access. +Configure MySQL or PostgreSQL Access. @@ -189,6 +189,20 @@ EXAMPLES +Convert the flow-tools file flows and export +flow data to an MySQL Database. Include only SRCADDR, DSTADDR +and DOCTETS. + + + flow-export -f3 -m0x3040 -u "user:password:host:port:name:table" < flows + + + + + +EXAMPLES + + Convert the flow-tools file flows to the cflowd file flows.cflowd. Include all fields. @@ -222,11 +236,18 @@ AUTHOR -Mark +Mark Fullmer maf@splintered.net + + +William Emmanuel +Yu (For SQL issues) + +wyu@ateneo.edu +