CVS log for src/share/man/man4/bpf.4

Up to [cvs.NetBSD.org] / src / share / man / man4

Request diff between arbitrary revisions

Keyword substitution: kv
Default branch: MAIN

bpf(4): fix couple more nits

bpf(4): fix couple of overlooked markup nits

bpf(4): spaces around + in instruction tables

Makes them easier on the eyes.

bpf(4): use nicer glyphs for some operations in PS output

bpf(4): make all instruction tables align

Define string max-insn and use it in all tables for the width of the
first column (nroff has variables, shocking, I know).  Define only the
width of the first column, the last column gets all the remaining width.

bpf(4): use \[<-] instead of <-

bpf(4): assorted markup tweaks

This is mostly non-controversial changes to the cargo-culted markup.
While here - add missing .It to BIOCLOCK so that it's not buried in
the text for the previous item and comment out a paragraph about an
ancient SunOS bug.

bpf.4: fix a garbled item heading

Make the BIOCSDIRECTION & BIOCGDIRECTION entry like those around it.

man, bpf: support loopback interfaces for send

bpf.4: amend caveat about what types of links can be written to

Try to be clearer about what's supported. A peripheral issue noted in
PR pkg/55446.

Use more markup.

bpf(4): Add ioctls BIOCSETWF and BIOCLOCK

Once BIOCLOCK is executed, the device becomes locked which prevents the
execution of ioctl(2) commands which can change the underlying parameters
of the bpf(4) device. An example might be the setting of bpf(4) filter
programs or attaching to different network interfaces.

BIOCSETWF can be used to set write filters for outgoing packets.
Currently if a bpf(4) consumer is compromised, the bpf(4) descriptor can
essentially be used as a raw socket, regardless of consumer's UID.
Write filters give users the ability to constrain which packets can be sent
through the bpf(4) descriptor.

Taken from OpenBSD.

Pull up following revision(s) (requested by sevan in ticket #1351):

	share/man/man4/man4.amiga/grf.4: revision 1.7
	share/man/man4/si.4: revision 1.11
	share/man/man8/man8.sparc/boot.8: revision 1.32
	share/man/man5/nsswitch.conf.5: revision 1.29
	share/man/man5/mixerctl.conf.5: revision 1.7
	share/man/man8/man8.vax/boot.8: revision 1.14
	share/man/man4/man4.vax/dn.4: revision 1.12
	share/man/man8/man8.vax/drtest.8: revision 1.16
	share/man/man8/sysinst.8: revision 1.6
	share/man/man4/ip.4: revision 1.37
	share/man/man5/boot.cfg.5: revision 1.28
	share/man/man1/cd.1: revision 1.10
	share/man/man4/usb.4: revision 1.106
	share/man/man4/man4.vax/ix.4: revision 1.17
	share/man/man7/security.7: revision 1.15
	share/man/man7/hier.7: revision 1.123
	share/man/man8/afterboot.8: revision 1.58
	share/man/man1/man1.x68k/bellctrl.1: revision 1.14
	share/man/man4/se.4: revision 1.6
	share/man/man4/utoppy.4: revision 1.7
	share/man/man4/midi.4: revision 1.32
	share/man/man4/cfb.4: revision 1.5
	share/man/man4/man4.sparc/magma.4: revision 1.12
	share/man/man4/audio.4: revision 1.80
	share/man/man4/isic.4: revision 1.18
	share/man/man1/cd.1: revision 1.7
	share/man/man4/envsys.4: revision 1.51
	share/man/man1/cd.1: revision 1.8
	share/man/man1/cd.1: revision 1.9
	share/man/man3/fast_divide32.3: revision 1.9
	share/man/man4/pci.4: revision 1.97
	share/man/man5/ranlib.5: revision 1.7
	share/man/man3/__arraycount.3: revision 1.7
	share/man/man4/isa.4: revision 1.46
	share/man/man8/man8.atari/ahdilabel.8: revision 1.14
	share/man/man4/chipsfb.4: revision 1.6
	share/man/man8/man8.macppc/boot.8: revision 1.8
	share/man/man5/passwd.5: revision 1.33
	share/man/man8/man8.macppc/ofwboot.8: revision 1.14
	share/man/man8/compat_linux.8: revision 1.38
	share/man/man4/iop.4: revision 1.22
	share/man/man4/ddb.4: revision 1.167
	share/man/man4/termios.4: revision 1.37
	share/man/man8/compat_freebsd.8: revision 1.18
	share/man/man5/ar.5: revision 1.9
	share/man/man7/release.7: revision 1.37
	share/man/man5/core.5: revision 1.31
	share/man/man4/ahd.4: revision 1.6
	share/man/man4/man4.vax/ad.4: revision 1.12
	share/man/man4/pppoe.4: revision 1.39
	share/man/man5/locale.alias.5: revision 1.3
	share/man/man8/man8.amiga/installboot.8: revision 1.23
	share/man/man4/etherip.4: revision 1.8
	share/man/man3/queue.3: revision 1.57
	share/man/man5/genassym.cf.5: revision 1.13
	share/man/man4/mpls.4: revision 1.10
	share/man/man1/wait.1: revision 1.5
	share/man/man5/capfile.5: revision 1.4
	share/man/man4/man4.alpha/ttwopci.4: revision 1.6
	share/man/man4/man4.atari/rtc.4: revision 1.8
	share/man/man4/gpiosim.4: revision 1.6
	share/man/man3/bitstring.3: revision 1.18
	share/man/man4/isdntel.4: revision 1.8
	share/man/man4/ai.4: revision 1.9
	share/man/man8/man8.hppa/boot.8: revision 1.2
	share/man/man4/uyurex.4: revision 1.6
	share/man/man8/man8.alpha/mkbootimage.8: revision 1.9
	share/man/man4/bpf.4: revision 1.56
	share/man/man4/man4.amiga/mfcs.4: revision 1.8
	share/man/man4/cmpci.4: revision 1.9
	share/man/man8/man8.vax/format.8: revision 1.14
	share/man/man8/compat_svr4.8: revision 1.27
	share/man/man4/crypto.4: revision 1.26
	share/man/man4/userconf.4: revision 1.13
	share/man/man4/agp.4: revision 1.17
	share/man/man9/man9.i386/bioscall.9: revision 1.10
	share/man/man4/uftdi.4: revision 1.20
	share/man/man4/radio.4: revision 1.13
	share/man/man4/mfb.4: revision 1.5
	share/man/man7/ascii.7: revision 1.8
	share/man/man4/man4.vax/dl.4: revision 1.13
	share/man/man4/ral.4: revision 1.12
	share/man/man4/unix.4: revision 1.26
	share/man/man4/edc.4: revision 1.12
	share/man/man4/pim.4: revision 1.5
	share/man/man8/compat_ultrix.8: revision 1.21
	share/man/man4/dge.4: revision 1.11
	share/man/man8/diskless.8: revision 1.32
	share/man/man5/passwd.conf.5: revision 1.11
	share/man/man8/man8.acorn26/boot26.8: revision 1.8
	share/man/man4/man4.vax/hy.4: revision 1.12
	share/man/man4/plip.4: revision 1.4
	share/man/man4/sc.4: revision 1.8
	share/man/man4/ec.4: revision 1.14
	share/man/man4/man4.sgimips/giopci.4: revision 1.9
	share/man/man7/sysctl.7: revision 1.114
	share/man/man3/bits.3: revision 1.18
	share/man/man4/we.4: revision 1.19
	share/man/man8/compat_sunos.8: revision 1.21
	share/man/man4/ip6.4: revision 1.31
	share/man/man4/acpilid.4: revision 1.8
	share/man/man4/man4.dreamcast/aica.4: revision 1.6
	share/man/man4/mfi.4: revision 1.12
	share/man/man4/ugen.4: revision 1.32
	share/man/man4/jme.4: revision 1.7
	share/man/man4/man4.sparc64/intro.4: revision 1.5
	share/man/man4/zyd.4: revision 1.5
	share/man/man4/gre.4: revision 1.45
	share/man/man3/bitmap.3: revision 1.10
	share/man/man4/man4.vax/cons.4: revision 1.12
	share/man/man3/gcq.3: revision 1.4
	share/man/man4/man4.hppa/pdc.4: revision 1.3
	share/man/man4/multicast.4: revision 1.8
	share/man/man4/man4.sparc/intro.4: revision 1.27
	share/man/man4/ath.4: revision 1.32
	share/man/man4/ym.4: revision 1.19
	share/man/man3/iso646.3: revision 1.6
	share/man/man4/btsco.4: revision 1.13
	share/man/man4/man4.i386/ndis.4: revision 1.6
	share/man/man4/pad.4: revision 1.6
	share/man/man4/strip.4: revision 1.16
	share/man/man8/man8.x86/boot.8: revision 1.12
	share/man/man4/amr.4: revision 1.15
	share/man/man4/ieee80211.4: revision 1.5
	share/man/man4/options.4: revision 1.467
	share/man/man5/link.5: revision 1.24
	share/man/man8/man8.cobalt/boot.8: revision 1.10
	share/man/man5/stab.5: revision 1.15
	share/man/man3/tree.3: revision 1.12
	share/man/man4/route.4: revision 1.31
	share/man/man4/man4.sun3/leds.4: revision 1.13
	share/man/man4/bluetooth.4: revision 1.20
	share/man/man4/man4.i386/pcibios.4: revision 1.19
	share/man/man5/veriexec.5: revision 1.8
	share/man/man7/operator.7: revision 1.12
	share/man/man4/man4.hp300/dcl.4: revision 1.13
	share/man/man4/man4.i386/intro.4: revision 1.31
	share/man/man5/ld.so.conf.5: revision 1.21
	share/man/man8/man8.alpha/boot.8: revision 1.16
	share/man/man4/bio.4: revision 1.13
	share/man/man4/man4.sun2/leds.4: revision 1.10
	share/man/man8/man8.x86/mbr.8: revision 1.4
	share/man/man8/man8.mvme68k/boot.8: revision 1.9
	share/man/man4/man4.alpha/ttwoga.4: revision 1.6
	share/man/man4/ahc.4: revision 1.34

Direct reader to shell documentation generally, rather than csh(1)
specifically.

Mention variables OLDPWD and PWD.

Move the text that explains that cd(1) is a shell built-in to the very
beginning of the description where it can be seen prominently.

Improve formatting.

 -

Remove workaround for ancient HTML generation code.
Use EXIT STATUS and .Ex.

Sync with HEAD

 Implement the BPF direction filter (BIOC[GS]DIRECTION). It provides backward
compatibility with BIOC[GS]SEESENT ioctl. The userland interface is the same
as FreeBSD.

 This change also fixes a bug that the direction is misunderstand on some
environment by passing the direction to bpf_mtap*() instead of checking
m->m_pkthdr.rcvif.

Remove Tn. Fix some mandoc lint warnings.

Fix another column width.

Use .Fn when describing C macros

Fix column width in postscript output.

Remove workaround for ancient HTML generation code.

Rebase to HEAD as of a few days ago.

Rebase.

Sort SEE ALSO. Use .An. Bump date.

Use .Sy for 'Just-In-Time', add a reference to bpfjit(4).

sync with head.

for a reference, the tree before this commit was tagged
as yamt-pagecache-tag8.

this commit was splitted into small chunks to avoid
a limitation of cvs.  ("Protocol error: too many arguments")

New sentence, new line. Bump date for previous.

Implement BPF_COP/BPF_COPX instructions in the misc category (BPF_MISC)
which add a capability to call external functions in a predetermined way.

It can be thought as a BPF "coprocessor" -- a generic mechanism to offload
more complex packet inspection operations.  There is no default coprocessor
and this functionality is not targeted to the /dev/bpf.  This is primarily
targeted to the kernel subsystems, therefore there is no way to set a custom
coprocessor at the userlevel.

Discussed on: tech-net@
OK: core@

Resync to 2012-11-19 00:00:00 UTC

sync with head

Document net.bpf.jit sysctl.

sync with head

Fix typos and style glitches.  Remove outdated info about only
Ethernet, SLIP, and PPP being supported, and no network types with
variable-length headers (such as 802.11).
Document BIOCSRSIG and BIOCGRSIG.

From Guy Harris in PR#40703.

Document that overflow in P[X+k:n] terminates a filter program.
Based on a discussion with Christos on source-changes-d.

Remove duplicate RCS Id. New sentence, new line.

PR/45750: Alexander Nasonov: Type of k in bpf_insn is bpf(9) is different
from sys/net/bpf.h

Sync with HEAD.

Remove SIOCGIFADDR. Noted by Ross Patterson in PR kern/21513.

file bpf.4 was added on branch uebayasi-xip on 2010-08-17 06:40:01 +0000

Use .In instead of .Aq Pa for header files.

FreeBSD -> .Fx, add RCS Id.

Document BIOC{G,S}FEEDBACK; I forgot who sent me the patch, so whoever created
it, thanks!

update type of bh_tstamp

grammar fix

Sync with HEAD.

Third (and last) commit. See http://mail-index.netbsd.org/source-changes/2009/05/13/msg221222.html

Pull up following revision(s) (requested by joerg in ticket #685):
	share/man/man4/ses.4: revision 1.7
	share/man/man4/bpf.4: revision 1.40
Fix markup.

Fix markup.

New sentence, new line. Use more markup.
Bump date for previous.

If user buffers do not match kernel buffers our kernel returns EINVAL,
not EIO.

There can be as many bpf clones as you want and the kernel doesn't
enforce any number.

u_intN_t -> uintN_t

Remove BIOC[GS]RSIG and fix BIOC[GS]HDRCMPLT typo.

Bump date for 1.32.
Use .Aq instead of \*[Lt]\*[Gt] and mark up paths with .Pa.

Change 'headers' to 'network layer headers' as suggested by Tetsuya Isaki.

PR misc/31139: bpf(4) does not describe some ioctls, by Tetsuya Isaki.
IOCTLs explained: BIO[GS]HDRCMPLT and IO[GS]SEESENT.

Remove trailing whitespace.

Added a new section called "SYSCTLS" explaining the purpose of
net.bpf.maxbufsize, net.bpf.stats and net.bpf.peers.
Bump the date.

Reviewed by: wiz@

Pull up revision 1.29 (requested by rpaulo in ticket #634):
Since bpf is now a clonable device, remove references to /dev/bpfX.
Update the structs so that they match bpf.h and bpfdesc.h.
Bump date.
ok christos@

Since bpf is now a clonable device, remove references to /dev/bpfX.
Update the structs so that they match bpf.h and bpfdesc.h.
Bump date.

ok christos@

Removed accidental repetitious words.

Add Ns.

Fix some macro abuses.

Uppercase ULTRIX. Igor Sobrado in PR 19678.

.Nm does not need a dummy argument ("") before punctuation or
for correct formatting of the SYNOPSIS any longer.

"Utilize" has exactly the same meaning as "use," but it is more
difficult to read and understand. Most manuals of English style
therefore say that you should use "use".

typo (be -> by)

Fix typo in last.

Mark up error values and NULL.

Add 2 APIs to get a list of available DLTs and use one for them.
	BIOCGDLTLIST (struct bpf_dltlist)
	BIOCSDLT (u_int)

Two major fixes for PS output; also cut down on Ns and No misuses.

Generate <>& symbolically. I'm avoiding .../dist/... directories for now.

Edit -mdoc usage.

* There is no -indent option to .Bd or .Bl, although you would
  never know that from its frequent use in this tree. There is a
  "-offset indent" combination that makes sense, and you can certainly
  say "-width indent".

* Also, you can't markup the -width option argument, tho you CAN
  use a callable macro. So "-width Ar filename" doesn't make sense,
  but either "-width Ar" or "-width filename" does, as might something
  like "-width xxfilename" for a little extra space.

* There are a lot of needlessly complex hanging tag macros in man4 used
  to create simple item lists. Those should be simplified one of these
  days before someone copies and edits yet another man4 page.

Whitespace, paragraph, punctuation, citation fixes. Sort sections.

Use EAGAIN instead of EWOULDBLOCK.  The actual numeric value is
same, but EAGAIN is the posixly correct name.
Addresses misc/12960.

insure -> ensure

Convert to use mdoc macros more.  The pervious commit, which partially
converted to mdoc, just results malformed output.

Pull up to last week's -current.

Misc small fixes to try to standardise the format to make it easier
to parse by an automated script (say one that just might want to
generate webpage summaries of available drivers :)

don't xref nonexistent filio(2)

PR misc/3375, submitted by der Mouse <mouse@Rodents.Montreal.QC.CA>.
The if_name fields are really called ifr_name.

misc. updates and fixes from LBL version (bpf-1.1).

Update from Stu Grossman <grossman@cygnus.com>, documenting his enhancements.

4.4BSD-Lite2

fix tcpdump cross reference

Merged with 4.4lite.
Changed to conform to NetBSD's new RCS Id convention.

cleared with mccanne: "the bug is in the bpf man page.  SIOCGIFADDR
should go away.  Link addresses should be looked up with SIOCGIFCONF."

Add RCS identifiers, remove some completely useless RCS logs and patchkit
headers, and a few other insignificant changes.

error found by hpeyerl, cleared by mccanne

fixed epsilon problem in tp man page, added bpf man page.