1fstrm_dump(1)               General Commands Manual              fstrm_dump(1)
2
3
4

NAME

6       fstrm_dump - Display metadata and contents of Frame Streams file.
7
8

SYNOPSIS

10       fstrm_dump input-file [output-file]
11
12

DESCRIPTION

14       fstrm_dump  opens  input-file and prints its framing metadata to stderr
15       and frame data to stdout.  The input-file may  be  "-"  to  read  Frame
16       Streams data from standard input.
17
18       Frame data is printed as a single line quoted string with non-printable
19       characters replaced by backslash-prefixed  hex  escape  sequences.  For
20       example,  a  frame  containing  "Hello,  world\n"  would  have its data
21       printed as:
22
23             "Hello, world\x0a"
24
25       The only framing metadata expected in a  Frame  Streams  file  are  the
26       start  frame with a content type field, the data frame lengths, and the
27       stop frame. These are printed, respectively, as:
28
29            FSTRM_CONTROL_START
30
31            FSTRM_CONTROL_FIELD_CONTENT_TYPE (N bytes)
32             "content-type"
33
34            Data frame (N) bytes
35
36            FSTRM_CONTROL_STOP
37
38       If fstrm_dump is given the second output-file parameter,  input  frames
39       are  additionally  written  to  output-file.  This is mainly useful for
40       regression testing of the fstrm_file_writer code.
41
42

SEE ALSO

44       fstrm_capture(1), fstrm_replay(1),
45       Frame Streams C Library https://farsightsec.github.io/fstrm
46
47
48
49                                                                 fstrm_dump(1)