contrib/libpcap/rpcapd/rpcapd-config.manfile.in

   1 .\" Copyright (c) 1994, 1996, 1997
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that: (1) source code distributions
   6 .\" retain the above copyright notice and this paragraph in its entirety, (2)
   7 .\" distributions including binary code include the above copyright notice and
   8 .\" this paragraph in its entirety in the documentation or other materials
   9 .\" provided with the distribution, and (3) all advertising materials mentioning
  10 .\" features or use of this software display the following acknowledgement:
  11 .\" ``This product includes software developed by the University of California,
  12 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  13 .\" the University nor the names of its contributors may be used to endorse
  14 .\" or promote products derived from this software without specific prior
  15 .\" written permission.
  16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  17 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  18 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  19 .\"
  20 .TH RPCAPD-CONFIG @MAN_FILE_FORMATS@ "6 January 2019"
  21 .SH NAME
  22 rpcapd-config \- rpcapd configuration file format
  23 .SH DESCRIPTION
  24 An
  25 .B rpcapd
  26 configuration file allows parameters to be set for
  27 .BR rpcapd (@MAN_ADMIN_COMMANDS@).
  28 .LP
  29 A # introduces a comment that runs to the end of the line.  Blank lines,
  30 and lines with only a comment, are ignored.  Leading and trailing white
  31 space on a line are also ignored.
  32 .LP
  33 Lines that set a parameter are of the form
  34 .IP
  35 \fIparameter\fB=\fIvalue\fR
  36 .LP
  37 Whitespace preceding or following the = is ignored.
  38 .LP
  39 The
  40 .IR parameter s
  41 are:
  42 .TP
  43 .B ActiveClient
  44 .I value
  45 is a host name or IP addresse, followed by a comma,
  46 semicolon, or space, followed by a port name and address or
  47 .BR DEFAULT .
  48 .B DEFAULT
  49 specifies the default active mode port for rpcapd, port 2003.
  50 Each
  51 .B ActiveClient
  52 line adds the host and port to the list of clients to which the server
  53 should connect in active mode.
  54 .TP
  55 .B PassiveClient
  56 .I value
  57 is a host name or IP addresse, followed by a comma,
  58 semicolon, or space, followed by a port name and address or
  59 .BR DEFAULT .
  60 .B DEFAULT
  61 specifies the default passive mode port for rpcapd, port 2002.
  62 Each
  63 .B PassiveClient
  64 line adds the host and port to the list of clients addresses and ports
  65 that are allowed to connect to the server in passive mode.
  66 .TP
  67 .B NullAuthPermit
  68 .I value
  69 is either
  70 .B YES
  71 or
  72 .BR NO .
  73 .B YES
  74 means that null authentication is permitted;
  75 .B No
  76 means that it is not permitted.
  77 .SH SEE ALSO
  78 rpcapd(@MAN_ADMIN_COMMANDS@)