documentation/3749: suggestion for addition to pf.conf.5

[jrrs@gateway.nodeless.net]

>Number:         3749
>Category:       documentation
>Synopsis:       slight clairification of the 'quick' behaviour of 'pass' on translation rules
>Confidential:   yes
>Severity:       non-critical
>Priority:       low
>Responsible:    bugs
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sat Apr 17 07:30:02 GMT 2004
>Closed-Date:
>Last-Modified:
>Originator:     jrrs@gateway.nodeless.net
>Release:        1.294
>Organization:
>Environment:
	
	System      : OpenBSD 3.5
	Architecture: OpenBSD.i386
	Machine     : i386
>Description:

	translation rules with 'pass' will always go to the default
    queue on a specific interface, if altq is used.

	this *can* be inferred from the current documentation, however
	an outright mention of it may be useful/effective/warranted.
 
>How-To-Repeat:
	
>Fix:

  an example clarification of this, is the addition of the following 
  sentence to the end of the 'Since translation occurs before filtering'
  paragraph in the TRANSLATION section of pf.conf.5 ( line 936 of 
  /usr/src/share/man/man5/pf.conf.5 ) :

If altq is used on the interface, packets matching a translation rule
which uses the pass modifier will be queued into that interface's default queue.

  i tried to make my english seem to make sense.  in the following patch,
  i also tried to ensure that the highlighting/underlining '.Ar' things
  are done where appropriate, but i am unsure about whether 'default' and
  'queue' should be '.Ar'd at the end?

  please pardon me if you find this an irrelevant or useless addition.

Index: pf.conf.5
===================================================================
RCS file: /cvs/src/share/man/man5/pf.conf.5,v
retrieving revision 1.294
diff -u -u -r1.294 pf.conf.5
--- pf.conf.5   4 Apr 2004 19:40:43 -0000       1.294
+++ pf.conf.5   17 Apr 2004 07:19:13 -0000
@@ -946,7 +946,12 @@
 .Ar block
 and
 .Ar pass
-rules.
+rules.  If
+.Ar altq
+is used on the interface, packets matching a translation rule which uses the
+.Ar pass
+modifier will be queued into that interface's
+.Ar default queue .
 .Pp
 The state entry created permits
 .Xr pf 4


>Release-Note:
>Audit-Trail:
>Unformatted: