doc/man_pages/dpauxmon.adoc

   1 include::../attributes.adoc[]
   2 = dpauxmon(1)
   3 :doctype: manpage
   4 :stylesheet: ws.css
   5 :linkcss:
   6 :copycss: {css_dir}/{stylesheet}
   7
   8 == NAME
   9
  10 dpauxmon - Provide interfaces to capture DisplayPort AUX channel data.
  11
  12 == SYNOPSIS
  13
  14 [manarg]
  15 *dpauxmon*
  16 [ *--help* ]
  17 [ *--version* ]
  18 [ *--extcap-interfaces* ]
  19 [ *--extcap-dlts* ]
  20 [ *--extcap-interface*=<interface> ]
  21 [ *--extcap-config* ]
  22 [ *--extcap-capture-filter*=<capture filter> ]
  23 [ *--capture* ]
  24 [ *--fifo*=<path to file or pipe> ]
  25 [ *--interface_id*=<Interface ID to capture> ]
  26
  27 [manarg]
  28 *dpauxmon*
  29 *--extcap-interfaces*
  30
  31 [manarg]
  32 *dpauxmon*
  33 *--extcap-interface*=<interface>
  34 *--extcap-dlts*
  35
  36 [manarg]
  37 *dpauxmon*
  38 *--extcap-interface*=<interface>
  39 *--extcap-config*
  40
  41 [manarg]
  42 *dpauxmon*
  43 *--extcap-interface*=<interface>
  44 *--fifo*=<path to file or pipe>
  45 *--capture*
  46 *--interface_id=interface_id*
  47
  48 == DESCRIPTION
  49
  50 *dpauxmon* is an extcap tool that can capture DisplayPort AUX channel data
  51 from linux kernel drivers using the generic netlink interface.
  52
  53 Supported interfaces:
  54
  55 1. dpauxmon
  56
  57 == OPTIONS
  58
  59 --help::
  60 Print program arguments.
  61
  62 --version::
  63 Print program version.
  64
  65 --extcap-interfaces::
  66 List available interfaces.
  67
  68 --extcap-interface=<interface>::
  69 Use specified interfaces.
  70
  71 --extcap-dlts::
  72 List DLTs of specified interface.
  73
  74 --extcap-config::
  75 List configuration options of specified interface.
  76
  77 --capture::
  78 Start capturing from specified interface and save it in place specified by --fifo.
  79
  80 --fifo=<path to file or pipe>::
  81 Save captured packet to file or send it through pipe.
  82
  83 --interface_idt=<interface id>::
  84 The interface for capture.
  85
  86 == EXAMPLES
  87
  88 To see program arguments:
  89
  90     dpauxmon --help
  91
  92 To see program version:
  93
  94     dpauxmon --version
  95
  96 To see interfaces:
  97
  98     dpauxmon --extcap-interfaces
  99
 100 Only one interface (dpauxmon) is supported.
 101
 102 .Example output
 103     interface {value=dpauxmon}{display=DisplayPort AUX channel capture}
 104
 105 To see interface DLTs:
 106
 107     dpauxmon --extcap-interface=dpauxmon --extcap-dlts
 108
 109 .Example output
 110     dlt {number=275}{name=dpauxmon}{display=DisplayPort AUX channel monitor DLT}
 111
 112 To see interface configuration options:
 113
 114     dpauxmon --extcap-interface=dpauxmon --extcap-config
 115
 116 .Example output
 117     dpauxmon --extcap-interface=dpauxmon --extcap-config
 118     arg {number=0}{call=--interface_id}{display=Interface Id}
 119         {type=unsigned}{tooltip=The Interface Id}
 120         {required=true}
 121
 122 To capture:
 123
 124     dpauxmon --extcap-interface=dpauxmon --fifo=/tmp/dpauxmon.pcap --capture --interface_id 0
 125
 126 == SEE ALSO
 127
 128 xref:wireshark.html[wireshark](1), xref:tshark.html[tshark](1), xref:dumpcap.html[dumpcap](1), xref:extcap.html[extcap](4)
 129
 130 == NOTES
 131
 132 *dpauxmon* is part of the *Wireshark* distribution.  The latest version
 133 of *Wireshark* can be found at https://www.wireshark.org.
 134
 135 HTML versions of the Wireshark project man pages are available at
 136 https://www.wireshark.org/docs/man-pages.
 137
 138 == AUTHORS
 139
 140 .Original Author
 141 [%hardbreaks]
 142 Dirk Eibach <dirk.eibach[AT]gdsys.cc>