aboutsummaryrefslogtreecommitdiff
path: root/rpcapd/rpcapd.manadmin.in
diff options
context:
space:
mode:
Diffstat (limited to 'rpcapd/rpcapd.manadmin.in')
-rw-r--r--rpcapd/rpcapd.manadmin.in91
1 files changed, 70 insertions, 21 deletions
diff --git a/rpcapd/rpcapd.manadmin.in b/rpcapd/rpcapd.manadmin.in
index 0a9d4e031a3c..791b4ad1735e 100644
--- a/rpcapd/rpcapd.manadmin.in
+++ b/rpcapd/rpcapd.manadmin.in
@@ -30,7 +30,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.TH RPCAPD @MAN_ADMIN_COMMANDS@ "April 20, 2018"
+.TH RPCAPD @MAN_ADMIN_COMMANDS@ "13 January 2019"
.SH NAME
rpcapd \- capture daemon to be controlled by a remote libpcap application
.SH SYNOPSIS
@@ -48,7 +48,6 @@ rpcapd
.B \-l
.I host_list
]
-.br
.ti +8
[
.B \-a
@@ -62,17 +61,30 @@ rpcapd
] [
.B \-i
]
-.br
.ti +8
[
.B \-D
] [
.B \-s
.I config_file
-] [
+]
+[
.B \-f
.I config_file
]
+[
+.B \-S
+]
+.ti +8
+[
+.B \-K
+.I ssl_keyfile
+] [
+.B \-X
+.I ssl_certfile
+] [
+.B \-C
+]
.br
.ad
.SH DESCRIPTION
@@ -84,7 +96,9 @@ Rpcapd can run in two modes: passive mode (default) and active mode.
.LP
In passive mode, the client (e.g., a network sniffer) connects to
.BR rpcapd .
-It then sends hem the appropriate commands to start the capture.
+The client then sends the appropriate commands to
+.B rpcapd
+to start the capture.
.LP
In active mode,
.B rpcapd
@@ -103,26 +117,34 @@ establishing the connection, the protocol continues its job in almost
the same way in both active and passive mode.
.SH Configuration file
.LP
-The user can create a configuration file in the same folder of the
+The user can create a configuration file in the same directory as the
executable, and put the configuration commands in there. In order for
-rpcapd to execute the commands, you have to restart it on Win32, i.e.
-the initialization file is parsed only at the beginning). The UNIX
-version of rpcapd will reread the configuration file when receiving a
-HUP signel. In that case, all the existing connections remain in place,
+.B rpcapd
+to execute the commands, it needs to be restarted on Win32, i.e.
+the configuration file is parsed only at the beginning. The UNIX
+version of
+.B rpcapd
+will reread the configuration file upon receiving a
+HUP signal. In that case, all the existing connections remain in place,
while the new connections will be created according to the new parameters.
.LP
In case a user does not want to create the configuration file manually,
-they can launch rpcapd with the requested parameters plus "-s filename".
+they can launch
+.B rpcapd
+with the desired flags plus
+.BR "-s filename" .
Rpcapd will parse all the parameters and save them into the specified
configuration file.
.SH Installing rpcapd on Win32
.LP
The remote daemon is installed automatically when installing WinPcap.
-The installation process places the rpcapd file into the WinPcap folder.
+The installation process places the
+.B rpcapd
+executable file into the WinPcap folder.
This file can be executed either from the command line, or as a service.
For instance, the installation process updates the list of available
services list and it creates a new item (Remote Packet Capture Protocol
-v.0 (experimental) ). To avoid security problems, the service is
+v.0 (experimental)). To avoid security problems, the service is
inactive and it has to be started manually (control panel -
administrative tools - services - start).
.LP
@@ -134,7 +156,9 @@ flag (in order to make it run as a service) and the
flag.
.SH Starting rpcapd on Win32
.LP
-The rpcapd executable can be launched directly, i.e. it can run in the
+The
+.B rpcapd
+executable can be launched directly, i.e. it can run in the
foreground as well (not as a daemon/service). The procedure is quite
simple: you have to invoke the executable from the command line with all
the requested parameters except for the
@@ -172,13 +196,13 @@ By default,
.B rpcapd
listens on both IPv4 and IPv6 addresses.
.TP
-.BI -l " host_list"
+.BI \-l " host_list"
Only allow hosts specified in the
.I host_list
argument to connect to this server.
.I host_list
is a list of host names or IP addresses, separated by commas.
-We suggest that you use use host names rather than literal IP addresses
+We suggest that you use host names rather than literal IP addresses
in order to avoid problems with different address families.
.TP
.B \-n
@@ -202,8 +226,8 @@ is specified,
it accepts passive connections as well.
.TP
.B \-d
-Run in daemon mode (UNIX only) or as a service (Win32 only)
-Warning (Win32): this switch is provided automatically when
+Run in daemon mode (UNIX only) or as a service (Win32 only).
+Warning (Win32): this flag is specified automatically when
the service is started from the control panel.
.TP
.B \-i
@@ -222,12 +246,37 @@ in the format specified by
Load the current configuration from
.I config_file
in the format specified by
-.BR rpcapd-config (@MAN_FILE_FORMATS@);
-all switches specified from the command line are ignored.
+.BR rpcapd-config (@MAN_FILE_FORMATS@)
+and ignore all flags specified on the command line.
.TP
.B \-h
Print this help screen.
+.LP
+If
+.B rpcapd
+was compiled with SSL support, the following options are also
+available:
+.TP
+.B \-S
+Require that SSL be used on connections.
+.TP
+.B \-C
+With SSL enabled, XXX - I'm not sure how *fetching* the list of
+compression mechanisms does anything to compression.
+.TP
+.B \-S
+.I ssl_keyfile
+With SSL enabled, use
+.I ssl_keyfile
+as the SSL key file.
+.TP
+.B \-X
+.I ssl_certfile
+With SSL enabled, use
+.I ssl_certfile
+as the SSL certificate file.
.br
.ad
.SH "SEE ALSO"
-pcap(3PCAP), rpcapd-config(@MAN_FILE_FORMATS@)
+.BR pcap (3PCAP),
+.BR rpcapd-config (@MAN_FILE_FORMATS@)