File: pcapdump.docbook

package info (click to toggle)
pcaputils 0.8-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 372 kB
  • sloc: ansic: 2,945; sh: 44; makefile: 38
file content (114 lines) | stat: -rw-r--r-- 4,238 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "file:///usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" []>

<refentry>
  <refmeta>
    <refentrytitle>pcapdump</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>pcapdump</refname>
    <refpurpose>dedicated packet capture utility</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>pcapdump</command>
      <arg rep="repeat"><replaceable class="parameter">OPTIONS</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para><command>pcapdump</command> captures packets from a network interface and writes them to a dumpfile. The filename argument given to <option>-w</option> will be formatted by <function>strftime(3)</function>.</para>
  </refsect1>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="pcapnet.docbook"/>
 
  <refsect1>
    <title>PROGRAM OPTIONS</title>
    <variablelist>

      <varlistentry>
        <term><option>-u </option><replaceable>owner</replaceable></term>
        <listitem>
          <para>Set the output file's owning user to <replaceable>owner</replaceable>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-g </option><replaceable>group</replaceable></term>
        <listitem>
          <para>Set the output file's owning group to <replaceable>group</replaceable>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-m </option><replaceable>mode</replaceable></term>
        <listitem>
          <para>Set the output file's mode to <replaceable>mode</replaceable>, specified in octal.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-t </option><replaceable>secs</replaceable></term>
        <listitem>
          <para>Dump file rotation interval in seconds.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-c </option><replaceable>count</replaceable></term>
        <listitem>
          <para>Exit after capturing <replaceable>count</replaceable> packets.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-T </option><replaceable>secs</replaceable></term>
        <listitem>
          <para>Exit after capturing during this amount of seconds.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-H </option></term>
        <listitem>
          <para>Only capture link, network, and transport headers; do not capture application-layer data.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-S </option><replaceable>sample value</replaceable></term>
        <listitem>
          <para>Sample the packet stream by only dumping 1 in every <replaceable>sample value</replaceable> packets.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-R </option></term>
        <listitem>
          <para>Together with -S, sample the packets randomly, not systematically.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-P </option><replaceable>pidfile</replaceable></term>
        <listitem>
          <para>Daemonize the process and write its PID to <replaceable>pidfile</replaceable>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-C </option><replaceable>config file</replaceable></term>
        <listitem>
          <para>File to read configuration variables from. Instead of passing configuration through the command line, a file can be used to specify values for the <option>bpf</option>, <option>device</option>, <option>filefmt</option>, <option>group</option>, <option>interval</option>, <option>mode</option>, <option>owner</option>, <option>promisc</option>, and <option>snaplen</option> options (not all need to be specified; defaults will be used otherwise). See /usr/share/doc/pcaputils/examples/pcapdump/eth0 for an example.</para>
        </listitem>
      </varlistentry>

    </variablelist>

  </refsect1>
  
</refentry>