summaryrefslogtreecommitdiff
path: root/sbin
diff options
context:
space:
mode:
authorJason McIntyre <jmc@cvs.openbsd.org>2003-01-28 10:40:22 +0000
committerJason McIntyre <jmc@cvs.openbsd.org>2003-01-28 10:40:22 +0000
commit1f70103e12ca9890cfff98320f97e67a4f80f3de (patch)
treef67c0f4aa353bee5330290e9d9246803a204281d /sbin
parentf798cc62500b1f7ec32467a0805d64ebb1889735 (diff)
typos; added white boldface to examples
ok deraadt@
Diffstat (limited to 'sbin')
-rw-r--r--sbin/pfctl/pfctl.843
-rw-r--r--sbin/pflogd/pflogd.828
2 files changed, 44 insertions, 27 deletions
diff --git a/sbin/pfctl/pfctl.8 b/sbin/pfctl/pfctl.8
index cf96d01339c..689b7d377c0 100644
--- a/sbin/pfctl/pfctl.8
+++ b/sbin/pfctl/pfctl.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: pfctl.8,v 1.70 2003/01/25 01:01:04 henning Exp $
+.\" $OpenBSD: pfctl.8,v 1.71 2003/01/28 10:40:21 jmc Exp $
.\"
.\" Copyright (c) 2001 Kjell Wooding. All rights reserved.
.\"
@@ -32,6 +32,7 @@
.Nd control the packet filter (PF) and network address translation (NAT) device
.Sh SYNOPSIS
.Nm pfctl
+.Bk -words
.Op Fl AdehnNqrRvzO
.Op Fl a Ar anchor[:ruleset]
.Op Fl F Ar modifier
@@ -41,6 +42,7 @@
.Op Fl x Ar level
.Op Fl t Ar table
.Op Fl T Ar command
+.Ek
.Sh DESCRIPTION
The
.Nm
@@ -78,9 +80,9 @@ The packet filter does not itself forward packets between interfaces.
Forwarding can be enabled by setting the
.Xr sysctl 8
variables
-.Li net.inet.ip.forwarding
+.Em net.inet.ip.forwarding
and/or
-.Li net.inet6.ip6.forwarding ,
+.Em net.inet6.ip6.forwarding ,
to 1. Set them permanently in
.Xr sysctl.conf 5 .
.Pp
@@ -144,13 +146,13 @@ A second
.Fl k Ar host
option may be specified, which will kill all the state entries
from the first host to the second host.
-.Bd -literal
+.Bd -literal -offset indent
Example:
- Kill all of the state entries from host
- # pfctl -k host
-
- Kill all of the state entries from host1 to host2
- # pfctl -k host1 -k host2
+Kill all of the state entries from host
+.Ic # pfctl -k host
+.Pp
+Kill all of the state entries from host1 to host2
+.Ic # pfctl -k host1 -k host2
.Ed
.It Fl h
Help.
@@ -158,7 +160,7 @@ Help.
Do not actually load rules, just parse them.
.It Fl N
Load only the NAT rules present in the rule file. Filter rules and options are
-ignored
+ignored.
.It Fl q
Only print errors and warnings.
.It Fl r
@@ -177,8 +179,11 @@ Modifier names may be abbreviated:
Show the currently loaded NAT rules.
.It Fl s Ar queue
Show the currently loaded queue rules.
-When used together with -v, per-queue statistics are also shown.
-When used together with -v -v,
+When used together with
+.Fl v ,
+per-queue statistics are also shown.
+When used together with
+.Fl v v ,
.Nm
will loop and show updated queue statistics every five seconds, including
measured bandwidth and packets per second.
@@ -242,9 +247,10 @@ Clear all the statistics of a table.
Load only the table definitions from pf.conf.
Used in "pfctl -Tl -f pf.conf".
.El
+.Pp
For the
-.Ar add
-.Ar delete
+.Ar add ,
+.Ar delete ,
.Ar replace
and
.Ar test
@@ -253,11 +259,14 @@ line and/or in an unformatted text file, using the
.Fl f
flag.
#-starting comments are allowed in the text file.
-With theses commands, the
+With these commands, the
.Fl v
-flag can also be used once or twice, in which case pfctl will print the
+flag can also be used once or twice, in which case
+.Nm pfctl
+will print the
detailed result of the operation for each individual address, prefixed by
-one of the following letter:
+one of the following letters:
+.Pp
.Bl -tag -width XXX -compact
.It A
The address/network has been added.
diff --git a/sbin/pflogd/pflogd.8 b/sbin/pflogd/pflogd.8
index ad7568b8472..60c986ca685 100644
--- a/sbin/pflogd/pflogd.8
+++ b/sbin/pflogd/pflogd.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: pflogd.8,v 1.16 2002/11/09 00:57:20 fgsch Exp $
+.\" $OpenBSD: pflogd.8,v 1.17 2003/01/28 10:40:21 jmc Exp $
.\"
.\" Copyright (c) 2001 Can Erkin Acar. All rights reserved.
.\"
@@ -49,7 +49,7 @@ in
.Xr tcpdump 8
binary format.
These logs can be reviewed later using the
-.Ar -r
+.Fl r
option of
.Xr tcpdump 8 ,
hopefully offline in case there are bugs in the packet parsing code of
@@ -99,31 +99,36 @@ The default of 96 is adequate for IP, ICMP, TCP, and UDP headers but may
truncate protocol information for other protocols.
Other file parsers may desire a higher snaplen.
.It Ar expression
-selects which packets will be dumped, using the regular language of
+Selects which packets will be dumped, using the regular language of
.Xr tcpdump 8 .
.El
.Sh EXAMPLES
Log specific tcp packets to a different log file with a large snaplen
(useful with a log-all rule to dump complete sessions)
.Bd -literal -offset indent
-# pflogd -s 1600 -f suspicious.log port 80 and host evilhost
+.Xo Ic # pflogd -s 1600 -f suspicious.log port 80\
+.Ic and host evilhost
+.Xc
.Ed
.Pp
Display binary logs:
.Bd -literal -offset indent
-# tcpdump -n -e -ttt -r /var/log/pflog
+.Ic # tcpdump -n -e -ttt -r /var/log/pflog
.Ed
.Pp
Display the logs in real time (this does not interfere with the
operation of pflogd):
.Bd -literal -offset indent
-# tcpdump -n -e -ttt -i pflog0
+.Ic # tcpdump -n -e -ttt -i pflog0
.Ed
.Pp
Tcpdump has been extended to to be able to filter on the pfloghdr
-structure defined in net/if_pflog.h. Tcpdump can restrict the output
+structure defined in
+.Aq Ar net/if_pflog.h .
+Tcpdump can restrict the output
to packets logged on a specified interface, a rule number, a reason,
a direction, an ip family or an action.
+.Pp
.Bl -tag -width "reason match " -compact
.It ip
Address family equals IPv4.
@@ -149,14 +154,17 @@ The direction was outbound.
Display the logs in real time of inbound packets that were blocked on
the wi0 interface:
.Bd -literal -offset indent
-# tcpdump -n -e -ttt -i pflog0 inbound and action block and on wi0
+.Xo Ic # tcpdump -n -e -ttt -i pflog0 inbound\
+.Ic and action block and on wi0
+.Xc
.Ed
.Sh FILES
.Bl -tag -width /var/run/pflogd.pid -compact
.It Pa /var/run/pflogd.pid
-process ID of current
+Process ID of the currently running
+.Nm pflogd .
.It Pa /var/log/pflog
-Default log file
+Default log file.
.El
.Sh SEE ALSO
.Xr pcap 3 ,