Commit graph

4430 commits

Author SHA1 Message Date
Tom Rhodes 0d21302ea1 deischen had a good idea on how to make my previous commit a little better,
update accordingly.

Suggested by:	deischen
2004-01-31 22:02:03 +00:00
Tom Rhodes 448ed982f2 Update this manual page for the libkse -> libpthread changes.
Discussed with:	deischen
2004-01-31 17:56:45 +00:00
Maksim Yevmenkin 6223d1612e Document NO_BLUETOOTH knob
Reviewed by:	imp (mentor), ru
2004-01-28 22:46:39 +00:00
Robert Watson 2c21af5654 Add debug.mutex.prof.reset. 2004-01-28 22:21:04 +00:00
John Baldwin f1087f6869 - Catch up to new boot floppies targets.
- Update description of release.4 to mention KERNELS variable.
- Update field width for make release targets.
2004-01-28 21:07:36 +00:00
Maxime Henrion 5251cfab8d Fix another typo. 2004-01-28 13:29:40 +00:00
Maxime Henrion b4a993e9aa Fix typo. 2004-01-28 13:28:45 +00:00
Greg Lehey a1db2f59ae Remove trailing white space.
Sort SEE ALSO by section number first, not alphabetically.
Remove period at end SEE ALSO to make it look less like a sentence.

Submitted by: ru
2004-01-28 00:02:10 +00:00
Warner Losh ab27179eb9 Fix the example back the way it was. Fix the commentary to say it
allocates a 32 byte range of ioports.
2004-01-27 16:16:31 +00:00
Nate Lawson ba4594dccd Document my adventures in newbus land. Clarify some examples, especially
that count is in bytes, not bits.  There are some drivers that I think make
this mistake.  (I've seen counts of 16 in the tree).
2004-01-27 06:04:15 +00:00
Yaroslav Tykhiy 5eb4925c66 Document the interface method if_input(). 2004-01-26 12:51:00 +00:00
Dag-Erling Smørgrav b14fa90f01 mdoc cleanup.
Submitted by:	ru
2004-01-26 12:50:30 +00:00
Maxim Sobolev 7735aeb9bb Add support for WCCPv2. It should be enablem manually using link2
ifconfig(8) flag since header for version 2 is the same but IP payload
is prepended with additional 4-bytes field.

Inspired by:	Roman Synyuk <roman@univ.kiev.ua>
MFC after:	2 weeks
2004-01-26 12:33:56 +00:00
Yaroslav Tykhiy dede2093e5 Clearly state that upon SIOCSIFFLAGS, ifp->if_flags is updated
at the common ifioctl() level.
2004-01-26 12:08:23 +00:00
Yaroslav Tykhiy ac1ac9d76b Extend the description of SIOCSIFCAP. 2004-01-26 11:48:26 +00:00
Christian Brueffer d8f934da72 Fix sorting in the device list 2004-01-26 07:21:28 +00:00
Christian Brueffer 189da1aa79 Add SIS964 to the list of supported chipsets
Submitted by:	bmah
2004-01-25 16:13:49 +00:00
Christian Brueffer 3734601248 Back out rev. 1.40
The hardware notes were wrong WRT supported chipsets (northbridges are not
ata related)

Submitted by:	bmah
2004-01-25 16:12:09 +00:00
Ruslan Ermilov 1a35abc4ee Correct the name of a loader(8) tunable. 2004-01-25 14:03:55 +00:00
Dag-Erling Smørgrav 72ea4f788b Add more implentation notes based on the comments in sys/conf/NOTES. 2004-01-25 12:30:35 +00:00
Dag-Erling Smørgrav f11986fab2 Add a cross-reference to MUTEX_PROFILING(9). 2004-01-25 12:24:23 +00:00
Dag-Erling Smørgrav 77c36c1710 Add a manual page for the mutex profiling code. 2004-01-25 12:23:53 +00:00
Dag-Erling Smørgrav 09e0653941 I don't normally use my middle name, so remove it from attributions in
man pages (though not from copyright notices).  While I'm here, add email
addresses where appropriate.
2004-01-25 11:39:42 +00:00
Simon L. B. Nielsen a8e167f065 Add Sandberg USB to Serial Link (model number 133-08) to the list of
supported devices.

MFC after:	1 week
2004-01-24 22:12:06 +00:00
Christian Brueffer 7ec9c1e23e Sync the list of supported SiS chips with the hardware notes 2004-01-24 02:02:31 +00:00
Greg Lehey 3f333d6b1b Make references to using dmesg and ps directly on dumps rather than
running gdb just for these purposes.

Submitted by:	simokawa

Add references to dmesg(8) and ps(1).
Sort references.
2004-01-24 00:55:15 +00:00
Christian Brueffer c4f594ac72 Add SiI3114 to the list of supported chipsets 2004-01-23 23:55:22 +00:00
Wes Peters 351cb04192 PR: docs/58586
Submitted by:	Chris S.J. Peron <maneo@bsdpro.com>
2004-01-23 05:24:06 +00:00
Mike Makonnen dec04f43d9 o Implement the pthread_spin_* functions in libthr.
o Man pages
2004-01-22 15:31:56 +00:00
Yaroslav Tykhiy d4030ed6c5 Extend the description of the framework of interface capabilities. 2004-01-22 00:10:21 +00:00
Yaroslav Tykhiy 76f80df62e As I've been pointed out by Andrew Gallatin, there are some
network interface cards smart (or twisted?) enough to be able
to calculate a TCP/UDP checksum for a packet fragmented by the
host CPU.  Therefore the paragraph on the case has been revised.
2004-01-21 23:32:50 +00:00
Jens Schweikhardt 406b7fa3e0 DTRT, quote parens in an extended regular expression.
PR:	61668
Submitted by:	Oliver Eikemeier <eikemeier@fillmore-labs.com>
MFC after:	1 week
2004-01-21 18:57:45 +00:00
Yaroslav Tykhiy fbde705ac4 A couple of minor clarifications. 2004-01-21 13:17:24 +00:00
Yaroslav Tykhiy 0193eb5ee9 Add a description for the hardware-assisted checksumming
facilities based on http://people.freebsd.org/~jlemon/csum.txt
and my own observations.
2004-01-21 12:45:37 +00:00
Jens Schweikhardt 87dce4d26b Slightly rearrange wording to deconfuse our man.cgi.
PR:	60743
Submitted by:	Lucas <aspiesrule@mcleodusa.net>
MFC after:	2 weeks
2004-01-20 21:33:45 +00:00
Ruslan Ermilov 568fb8796f Grammar. 2004-01-20 12:57:28 +00:00
Ruslan Ermilov c1e15bb5cb mdoc(7): Fix title. 2004-01-20 10:31:52 +00:00
Ruslan Ermilov b760de9691 Use a single style for share/man/ makefiles:
- Sort MAN and MLINKS in "dictionary" order ignoring case.

- For multi-value MAN and multi-pair MLINKS, put each value/pair
  on its own line, for easier sorting and so that further diffs
  are easier to see.
2004-01-20 10:27:23 +00:00
Yaroslav Tykhiy 238d9c5975 Reformat the list of essential mbuf fields according
to the nice style used in ifnet(9).
This includes specifying field types, starting descriptions
with a capital letter, and ending them with a full stop.
Improve the language a bit, as well.
2004-01-18 23:42:28 +00:00
Yaroslav Tykhiy d2b7305939 Update the list of mbuf types from <sys/mbuf.h>. 2004-01-18 21:29:46 +00:00
Yaroslav Tykhiy f434362a8a Update the list of possible mbuf flags from <sys/mbuf.h>. 2004-01-18 21:23:30 +00:00
Simon L. B. Nielsen fe9a522092 Add Canon N676U and Canon N1220U to the list of supported devices.
MFC after:	1 week
2004-01-17 11:51:23 +00:00
Poul-Henning Kamp 1d9c86b948 Drop a hint about '+' being a potential wildcard. 2004-01-17 10:41:14 +00:00
Nate Lawson 09c84ba407 _OS and _OS_ are the same object (due to _ padding for spaces).
Pointed out by:	Ducrot Bruno (Linux)
2004-01-16 18:10:42 +00:00
Sam Leffler 4acf93a2f3 Splice in cryptodev (this man page originated on openbsd where there is
no cryptodev module.)  Should probably create a separate cryptodev man
page (or a link to this one) but for now add enough so folks understand
the relationship between the two.

Prodded by:	phk
2004-01-16 17:21:02 +00:00
Mike Makonnen 104ff764e5 Add an implementation of pthread_rwlock_timed{rd,wr}lock() to libthr with
attendant documentation.
2004-01-16 10:52:10 +00:00
Christian Brueffer c5ea6e19c6 Connect tx.4 to the build and MLINK it to if_tx.4 2004-01-15 23:05:22 +00:00
Christian Brueffer 1eeac4a4dc Don't claim this file is i386 specific 2004-01-15 23:03:17 +00:00
Christian Brueffer 8cb5043a87 tx.4 has been repocopied to src/share/man/man4
Repo-surgery by:	joe
2004-01-15 23:01:12 +00:00
Ruslan Ermilov c133f2ab6f Removed outdated text about libc_r replacing libc (it now provides
just libc functions wrappers), and updated text to match reality:
there are three threading libraries in FreeBSD these days.

Removed instructions of how not to build libc_r, it's documented in
the make.conf(5) manpage already.

Removed description of the FreeBSD-specific gcc(1) option, -pthread.
While it's still provided (for backwards compatibility reasons),
its usefulness is questionable.
2004-01-15 17:58:26 +00:00
Christian Brueffer f1fc09471b awi(4) needs 'device wlan' now 2004-01-15 17:21:06 +00:00
Ruslan Ermilov 95e055a2cf Removed the IMPLEMENTATION NOTES section made redundant by not
putting libc_r into the LIBRARY section.
2004-01-15 16:13:49 +00:00
Ruslan Ermilov 69a16e1e28 pthread_multi_np() is implemented in all threading libraries.
pthread_single_np() is not implemented in libthr.
2004-01-15 16:12:11 +00:00
Ruslan Ermilov bc5cc7732e Revert previous delta -- these interfaces aren't supported by libthr. 2004-01-15 16:07:52 +00:00
Ruslan Ermilov f9f9d2e804 Document interfaces that are supported by libthr. 2004-01-15 15:59:00 +00:00
Atsushi Onoe f36568f97c Cleanup obsolete text:
- hostap and ibss creation now works.
- delete messages for common net80211 layer from DIAGNOSTICS.
2004-01-15 14:06:51 +00:00
Ruslan Ermilov 8e750fa2e6 Assorted markup fixes. 2004-01-15 11:15:27 +00:00
Ruslan Ermilov 5360187e7a Spell POSIX threads library as "libpthread", mdoc(7) is smart
enough to render it as "-lkse" these days.
2004-01-14 21:53:19 +00:00
Ruslan Ermilov ec7452f103 Have a single set of POSIX threads man pages. The LIBRARY section
of each manpage lists libraries that have corresponding interfaces
implemented.

Prodded by:	threads
Reviewed by:	deischen
2004-01-14 21:44:26 +00:00
Ruslan Ermilov fac93adb3d This interface is not provided by libc_r. It is, on the other
hand, is also provided by libthr, but this will be addressed
later.
2004-01-14 21:12:39 +00:00
Christian Brueffer a16f34fd21 Add MLINK:
rue.4 -> if_rue.4
2004-01-14 13:35:15 +00:00
Brian Feldman 7586b25ce3 Add an "ethernet" hook to the rfc1490 netgraph module. It will send
and receive FCS-less RFC1490-"bridged" Ethernet packets that are
currently just ignored.
2004-01-14 00:39:28 +00:00
Alex Dupre fd4b744b5b Update list of device drivers that support polling.
Remove redundancy in NOTES.

PR:		docs/61195
Submitted by:	Xin LI <delphij@frontfree.net>
Approved by:	blackend (mentor)
MFC after:	1 week
2004-01-11 22:07:19 +00:00
Robert Watson 480a1cc8ef Minor typo: no line break after .Fn. 2004-01-11 19:57:42 +00:00
Robert Watson 9b1faf0afb Add a basic manpage for vn_fullpath().
Sponsored by:	DARPA, McAfee Research
2004-01-11 19:54:48 +00:00
Robert Watson 738d91ba76 Update the diskless(8) documentation to indicate that the use of the
kernel BOOTP options is *not* required if the boot loader can pass
network configuration information to the kernel using the kernel
environment.  As such, PXE doesn't require them.  However, the NFS
options are required in the kernel (previously not documented).

Tripped over by:	des
2004-01-10 22:38:54 +00:00
Dag-Erling Smørgrav 91c9d24e52 Move the description of sbuf_delete() closer to the description of
sbuf_new(), and try to make them both a little clearer.
2004-01-09 21:16:31 +00:00
Simon L. B. Nielsen d42944a1b8 Add missing manual page links for rman(9) and sysctl_add_oid(9).
Submitted by:	Lukas Ertl <l.ertl@univie.ac.at>
PR:		docs/60088
2004-01-09 20:15:51 +00:00
Nate Lawson d11a4e603f Update man page for \_OS* changes. 2004-01-09 20:06:04 +00:00
Christian Brueffer c8885b4b8f Add MLINK:
ndis.4 -> if_ndis.4
2004-01-09 17:55:48 +00:00
Christian Brueffer bd675dd3a9 Correct typo in MLINK 2004-01-09 17:49:03 +00:00
Christian Brueffer 130b84f512 Add reference to miibus.4
MFC after:	5 days
2004-01-09 17:43:37 +00:00
Christian Brueffer a376b5ff08 device uhci0 -> device uhci
Remove reference to miibus.4, the driver doesn't use it.

MFC after:	5 days
2004-01-09 17:39:08 +00:00
Christian Brueffer 484d662c34 kue(4) doesn't use miibus either
MFC after:	5 days
2004-01-09 17:31:33 +00:00
Christian Brueffer d2c7a11844 Remove drivers that don't need miibus(4):
o an
o awi

Add missing drivers:
o axe
o bfe
o gx
o lge
o nge
o re
o sk

MFC after:	5 days
2004-01-09 17:17:57 +00:00
Simon L. B. Nielsen a3d2cb0998 - Add the HP hn210e to the devices list.
- Make the device list compact.

MFC after:	1 week
2004-01-09 15:47:54 +00:00
Greg Lehey 8cfbf24f2e Correct capitalization.
Submitted by: ru
2004-01-07 23:00:01 +00:00
Bill Paul bf952fec70 Add 'device wlan' to synopsis. 2004-01-07 22:17:53 +00:00
Marc Fonvieille 704ee201ff Netgear WG511T card is a CardBus not a PCI card.
PR:		docs/61039
Submitted by:	Michael Lestinsky <michael@lestinsky.de>
2004-01-07 20:49:51 +00:00
David E. O'Brien 87294a9c5f Note that NO_FLOPPIES is i386-only. 2004-01-03 02:23:56 +00:00
Scott Long 24b4e9d17f Document taskqueue_enqueue_fast() 2004-01-02 07:23:40 +00:00
Greg Lehey 8da0249608 Remove extraneous text accidentally incorporated from ddb(4).
Rearrange the order of the initial description to correspond with the
detailed description below.
Reinstate reference to Topsy, at the risk of confusing people whose
understanding of English grammar is better than of American folklore.
2004-01-02 05:16:50 +00:00
Greg Lehey 35386a8afb Submit to police inspection. No content changes.
Submitted bu:	ru
2004-01-02 05:07:57 +00:00
Greg Lehey b0643f118c Hook up gdb.4 and vinumdebug.4 into build.
Reminded by: ru
2004-01-02 02:18:34 +00:00
Ruslan Ermilov a783a32a55 Some mdoc(7) polishing. 2004-01-01 21:04:44 +00:00
Joseph Koshy de77c1ba47 Add "options INVARIANTS" and "options INVARIANT_SUPPORT" to the
synopsis, with supporting text in the body of the manual page.

Add a cross-reference to panic(9) for completeness.

Reviewed by:	ru (synopsis changes)
2004-01-01 05:16:35 +00:00
Takanori Watanabe f50ad9a10c Correct _ACx description.
This is for a computer system, not for a furnace.
2004-01-01 04:28:13 +00:00
Greg Lehey a9215590a4 Add markup changes for more kosher mdoc(7).
Submitted by:	ru
2004-01-01 02:31:48 +00:00
Nate Lawson 9eaf31e548 Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00
Greg Lehey 279b7e129f Add a description of how to use a firewire connection to debug a
remote system without stopping it.
2003-12-31 01:25:07 +00:00
Greg Lehey 783a364bf8 Update firewire debugging description.
Reviewed by: simokawa.

Clarify terminology.

Update BUGS section.
2003-12-31 00:59:36 +00:00
Christian Brueffer 8a9ce5c0d2 o fix typos
o grammar fix
o concat two lines

MFC after:	5 days
2003-12-30 22:26:52 +00:00
Ruslan Ermilov e09cec395d Pull revision 1.13 from libpthread/man/pthread_mutex_init.3:
- Remove error code that can't be returned (and original description
  was not proper English)

PR:		docs/57434
2003-12-30 15:44:16 +00:00
Mike Makonnen ec2456e2c2 Aargh, cvs add pthread_mutex_timedlock 2003-12-30 08:50:04 +00:00
Mike Makonnen 2aa9de1f77 o Implement pthread_mutex_timedlock(), which does not block indefinitely on
a mutex locked by another thread.
o document it: pthread_mutex_timedlock(3)
2003-12-30 08:44:55 +00:00
Greg Lehey 6d8cac85f7 Clarify firewire setup, including minimal error recovery. 2003-12-30 02:04:25 +00:00
Greg Lehey 45c6a05ae1 Describe kernel debug macros for Vinum. This was originally intended
as part of gdb(4).

Suggested by: njl
2003-12-30 01:40:38 +00:00
Greg Lehey 1159af411b New man page for kernel debugging with gdb.
Reviewed by: jkoshy, des, gallatin, njl.
2003-12-30 01:39:08 +00:00
Alfred Perlstein 91b918cfff Explicitly state that mknod(8) can be used to undelete entries under devfs. 2003-12-29 00:40:44 +00:00
Takanori Watanabe ee0406f617 Hook up acpi_thermal.4 man page. 2003-12-28 23:23:16 +00:00
Ruslan Ermilov 3321b7cb8b mdoc(7): fixed document title. 2003-12-28 22:34:47 +00:00
Ruslan Ermilov 673fbcacfb Somebody called mdoc(7) janitor.
A bit of wordsmithing from a native speaker is still necessary.
2003-12-28 12:56:01 +00:00
Joseph Koshy 735adf63e4 Use of the MTX_SYSINIT macro requires the inclusion of <sys/kernel.h>. 2003-12-28 01:39:18 +00:00
Joseph Koshy 6c0f2b530e Make this manual page reflect the sources better.
- A #include of <sys/mutex.h> is no longer needed to use sx(9) (since
  2001/05/01).
- Use of the SX_SYSINIT() macro requires inclusion of '<sys/kernel.h>'
2003-12-28 01:37:48 +00:00
Christian Brueffer a5aea251fd unlinke -> unlike
Submitted by:	Pawel Jakub Dawidek <nick@garage.freebsd.pl>
2003-12-27 21:14:32 +00:00
Christian Brueffer 63dc0fa0a6 Correct reference to mac_none.4
Submitted by:	Pawel Jakub Dawidek <nick@garage.freebsd.pl>
2003-12-27 20:48:22 +00:00
Takanori Watanabe d827f9b59f Add acpi_thermal manual page,
because I asked about the unit of thermal
zone-related value too freqently.
Come on, mdoc police.
2003-12-27 16:25:11 +00:00
Christian Brueffer b194fa9395 o use .Nm
o fix language usage

MFC after:	5 days
2003-12-27 16:00:42 +00:00
Christian Brueffer 4206a5bbdc Add missing word 2003-12-27 15:46:30 +00:00
Christian Brueffer c9420ecc33 o add missing sysctl to synopsis
o remove some useless words
o fix spelling

MFC after:	5 days
2003-12-27 15:45:08 +00:00
Christian Brueffer 03cfc71663 o add reference to safe.4
o remove useless word

MFC after:	5 days
2003-12-27 15:40:47 +00:00
Christian Brueffer 692a9ed847 o Grammar fix
o Add missing punctuation
2003-12-27 15:38:08 +00:00
Christian Brueffer 4b94b0bde6 Grammar fixes 2003-12-27 15:35:09 +00:00
Christian Brueffer 927967a855 o grammar fixes
o FireWire.4 -> firewire.4
o wordsmithing

MFC after:	5 days
2003-12-27 15:30:49 +00:00
Christian Brueffer b7da444256 o grammar fixes
o wordsmithing
o sort references

MFC after:	5 days
2003-12-27 15:14:58 +00:00
Christian Brueffer ce2524aca4 Add reference to safe.4
MFC after:	5 days
2003-12-27 15:00:07 +00:00
Joseph Koshy 2d8d6274dc Improve continuity of text. 2003-12-27 14:01:08 +00:00
Tom Rhodes 9df81bbc89 It is not the job of this manual page to list 'supported chipsets'.
PR:		60575
Submitted by:	Andreas Möller
2003-12-26 16:05:45 +00:00
Sergey Babkin fb43f32be9 Documented the new parameter cron_dst. 2003-12-26 03:41:27 +00:00
Hidetoshi Shimokawa 69c6f5060b Fix reference to firewire(4).
Submitted by: Andre Guibert de Bruet <andy@siliconlandmark.com>
2003-12-24 12:58:35 +00:00
Tom Rhodes a78383f7b3 Add the MegaRAID 320-4X cards to the supported device list.
Submitted by:	Andre Guibert de Bruet <andy@siliconlandmark.com> (via -doc)
2003-12-23 16:22:34 +00:00
Tom Rhodes 124a5c5795 Remove the Minolta item, it already exists in the uscanner(4) manual page.
Noticed by:	simon
2003-12-22 23:20:58 +00:00
Tom Rhodes 106c6f4018 Update the supported device list.
Discussed with:	sanpei
2003-12-22 23:01:25 +00:00
Simon L. B. Nielsen 0db25406cc Add Epson Perfection 1250 and Minolta 5400 to the list of supported
devices.
2003-12-22 20:23:43 +00:00
Warner Losh 0dece262d4 Add more bridges, based on reading the pccbb.c file. 2003-12-22 06:08:14 +00:00
Hideyuki KURASHINA d562e82bec Fix a typo.
Submitted by:	Lukas Ertl <l.ertl@univie.ac.at>
PR:		docs/60469
2003-12-21 14:30:26 +00:00
Yaroslav Tykhiy db2db5fe18 Bring the description of the sysctl(8) variable
net.graph.nonstandard_pppoe into accord with the reality.

MFC after:	1 week
2003-12-19 16:42:35 +00:00
Yaroslav Tykhiy 417de5c6d2 mdoc(7) style: Start each sentence on a new line. 2003-12-18 17:31:44 +00:00
Yaroslav Tykhiy 9e76dcae12 Capitalize PPPoE, PPP, and Ethernet in a consistent way. 2003-12-18 17:27:49 +00:00
Yaroslav Tykhiy 8caa8dd355 The politically incorrect sysctl "stupid_isp" had its name
changed long ago.  It has been "nonstandard_pppoe" for quite
a while.
2003-12-18 16:55:09 +00:00
Nate Lawson 3526eac0d8 Document new sysctls for throttling. 2003-12-18 04:39:09 +00:00
Christian Brueffer 54cbe1b2db Add MLINKS:
axe.4 -> if_axe.4
bfe.4 -> if_bfe.4
my.4  -> if_my.4
re.4  -> if_re.4
xe.4  -> if_xe.4
2003-12-17 10:38:40 +00:00
Christian Brueffer dda19a81f8 o grammar fixes
o wordsmithing

MFC after:	5 days
2003-12-17 10:23:14 +00:00
Christian Brueffer 6734ea9d70 o correct a path
o wordsmithing

MFC after:	5 days
2003-12-17 09:56:46 +00:00
Christian Brueffer 59940bac74 o grammar fixes
o removed wrong 's usage

MFC after:	5 days
2003-12-17 09:51:25 +00:00
Christian Brueffer af7552658b Grammar fixes
MFC after:	5 days
2003-12-17 02:16:04 +00:00
Christian Brueffer 9e8f0d81d3 o use .Nm
o wordsmithing

MFC after:	5 days
2003-12-17 01:44:14 +00:00
Christian Brueffer 2883d48be5 Wordsmithing
MFC after:	5 days
2003-12-17 01:13:13 +00:00
Peter Pentchev a61f15043c Fix a couple of typos: hexidecimal -> hexadecimal.
Reviewied by:	scottl
2003-12-12 11:08:51 +00:00
Bill Paul c854fc1092 Commit the first cut of Project Evil, also known as the NDISulator.
Yes, it's what you think it is. Yes, you should run away now.

This is a special compatibility module for allowing Windows NDIS
miniport network drivers to be used with FreeBSD/x86. This provides
_binary_ NDIS compatibility (not source): you can run NDIS driver
code, but you can't build it. There are three main parts:

sys/compat/ndis: the NDIS compat API, which provides binary
compatibility functions for many routines in NDIS.SYS, HAL.dll
and ntoskrnl.exe in Windows (these are the three modules that
most NDIS miniport drivers use). The compat module also contains
a small PE relocator/dynalinker which relocates the Windows .SYS
image and then patches in our native routines.

sys/dev/if_ndis: the if_ndis driver wrapper. This module makes
use of the ndis compat API and can be compiled with a specially
prepared binary image file (ndis_driver_data.h) containing the
Windows .SYS image and registry key information parsed out of the
accompanying .INF file. Once if_ndis.ko is built, it can be loaded
and unloaded just like a native FreeBSD kenrel module.

usr.sbin/ndiscvt: a special utility that converts foo.sys and foo.inf
into an ndis_driver_data.h file that can be compiled into if_ndis.o.
Contains an .inf file parser graciously provided by Matt Dodd (and
mercilessly hacked upon by me) that strips out device ID info and
registry key info from a .INF file and packages it up with a binary
image array. The ndiscvt(8) utility also does some manipulation of
the segments within the .sys file to make life easier for the kernel
loader. (Doing the manipulation here saves the kernel code from having
to move things around later, which would waste memory.)

ndiscvt is only built for the i386 arch. Only files.i386 has been
updated, and none of this is turned on in GENERIC. It should probably
work on pc98. I have no idea about amd64 or ia64 at this point.

This is still a work in progress. I estimate it's about %85 done, but
I want it under CVS control so I can track subsequent changes. It has
been tested with exactly three drivers: the LinkSys LNE100TX v4 driver
(Lne100v4.sys), the sample Intel 82559 driver from the Windows DDK
(e100bex.sys) and the Broadcom BCM43xx wireless driver (bcmwl5.sys). It
still needs to have a net80211 stuff added to it. To use it, you would
do something like this:

# cd /sys/modules/ndis
# make; make load
# cd /sys/modules/if_ndis
# ndiscvt -i /path/to/foo.inf -s /path/to/foo.sys -o ndis_driver_data.h
# make; make load
# sysctl -a | grep ndis

All registry keys are mapped to sysctl nodes. Sometimes drivers refer
to registry keys that aren't mentioned in foo.inf. If this happens,
the NDIS API module creates sysctl nodes for these keys on the fly so
you can tweak them.

An example usage of the Broadcom wireless driver would be:

# sysctl hw.ndis0.EnableAutoConnect=1
# sysctl hw.ndis0.SSID="MY_SSID"
# sysctl hw.ndis0.NetworkType=0 (0 for bss, 1 for adhoc)
# ifconfig ndis0 <my ipaddr> netmask 0xffffff00 up

Things to be done:

- get rid of debug messages
- add in ndis80211 support
- defer transmissions until after a status update with
  NDIS_STATUS_CONNECTED occurs
- Create smarter lookaside list support
- Split off if_ndis_pci.c and if_ndis_pccard.c attachments
- Make sure PCMCIA support works
- Fix ndiscvt to properly parse PCMCIA device IDs from INF files
- write ndisapi.9 man page
2003-12-11 22:34:37 +00:00
Maxim Konovalov 369bf356c9 Grammar.
PR:		docs/60158
Submitted by:	Lukas Ertl
MFC after:	1 week
2003-12-11 21:54:26 +00:00
Joseph Koshy 385032f901 Typo fix. 2003-12-11 13:30:26 +00:00
Joseph Koshy f096643b2d Document a few kernel functions and the sysctl tunables that
affect their behaviour.
2003-12-11 13:29:05 +00:00
Ruslan Ermilov fc063beedb Grammar. 2003-12-10 09:43:53 +00:00
Mike Makonnen 8c307294e6 Grammar 2003-12-09 09:04:45 +00:00
Warner Losh d642c42ed3 Add the meteor driver man page back. It has moved up a level from the
man4.i386.  It documents that meteor no longer works, but keeps the
extensive documentation on the meteor interface, which the bktr driver
implements also.  This should be merged into tha man page, but such a
merging seems to be planned by others.

# we really need something like video4bsd to define these sorts of
# things for all video capture drivers.

Requested by: rwatson and obrien
2003-12-08 02:59:34 +00:00
Warner Losh 946984d155 Copy the old dgb man page to digi.4, plus very minor hacking. Add a
note that says that this man page is sub-optimal.  Bruce Mah should be
happier about this, but someone that groks the cards supported by the
digi driver is encouraged to make this man page suck less.
2003-12-08 00:11:22 +00:00
Scott Long 4fb638c329 Add a manual page for the consolidated debugging commit. 2003-12-07 20:48:00 +00:00
Murray Stokely a298e0ba03 Add support for timeout: and attempts: resolver options.
Submitted by:	Paul Vixie <paul@vix.com> / ISC
MFC After:	1 week
2003-12-07 12:32:24 +00:00
Warner Losh af20af3e68 lmc.4 is now gone 2003-12-07 06:49:10 +00:00
Warner Losh 65b4a1b917 Remote meteor driver. It hasn't compiled in over 3 years. If someone
makes it compile again, and can test it, we can restore the driver to
the tree.
2003-12-07 04:41:11 +00:00
Warner Losh 6ee2f106aa The dgb driver is redundant with the digi driver in the tree. It uses
lots of old interfaces, and digi now supports all cards that dgb
supported.  The author of the driver says that this is no longer
necessary.

Approved by: babkin@
2003-12-07 04:18:52 +00:00
Warner Losh 29b4184577 Continue to remove drivers that don't compile and haven't compiled in
a long time: lmc The LAN Media Corp PCI WAN driver based on tulip.
This driver hasn't compiled for 3 years since the PCI compat shims
were removed, and Lan Media appears to have gone out of business.
These cards appear to be rare (a recent search of ebay had no hits).

Should someone wish to revive this driver, submitting patches to make
it compile plus a testing report will bring it back.
2003-12-07 04:05:19 +00:00
Bruce A. Mah 1d8f8416ad Hook the sab(4) manpage up to the build.
Reviewed by:	bms
Approved by:	re (implicitly)
2003-12-07 00:46:37 +00:00
MIHIRA Sanpei Yoshiro 773c505f3c Add support for ELECOM/Laneed CardBus FastEtherner Card(LD-CBL/TXA)
Submitted by:	Masahiro Yamagishi <night@pluto.dti.ne.jp>
Approved by:	re (scottl)
2003-12-06 02:29:31 +00:00
Warner Losh 335cd66dc2 Updated man page from cronyx.
Forgotten by: imp
Reminded by: Roman Kurakin
Approved by: re@ <scottl>
2003-12-05 07:03:58 +00:00
Bruce A. Mah 72a6e47193 Add a few wi-supported cards to get this manpage caught up with
the hardware notes.

Reviewed by:	imp
Approved by:	re (implicitly)
2003-12-02 07:07:45 +00:00
Simon L. B. Nielsen 1cd908be33 Mdoc(7) janitor cleanup.
Reviewed and improved by:	ru
OK'ed by:	phk
Approved by:	re (rwatson)
2003-11-30 12:42:01 +00:00
Ruslan Ermilov 320a3e0c19 Removed the i386 specific bit from title.
Reviewed by:	non
Approved by:	re (rwatson)
2003-11-30 08:50:17 +00:00
Ruslan Ermilov 16d8e9335a - Connect a few forgotten Netgraph manpages.
- Sort.

Approved by:	re (rwatson)
2003-11-29 18:14:04 +00:00
Poul-Henning Kamp ccc5f62f97 Add manual page for CPU_ELAN, CPU_SOEKRIS and related options for the
Elan 520 CPU chip.

Approved by:	re@
2003-11-27 20:28:25 +00:00
Poul-Henning Kamp 9491306ad3 Improve semantics of the 'sequence' command to led(4) devices:
use lowercase for off and upper case for on.

Approved by:	re@
2003-11-27 20:23:32 +00:00
Noriaki Mitsunaga 985b09e826 Add nsp(4) man page for nsp PC-Card SCSI host adapter device driver,
and attach it to the build.

Submitted by:	non, rushani
Approved by:	re (rwatson)
2003-11-24 23:57:59 +00:00
Noriaki Mitsunaga af3ebabea3 o Add HISTORY and AUTHORS section
o Add scsi.4 in the SEE ALSO section

Reviewed by:	rushani
Approved by:	re (rwatson)
2003-11-24 23:47:24 +00:00
Scott Long 90768c55d4 Install UDF header files to unbreak /sbin building when /sys is not present.
Submitted by:	imura@ryu16.org
2003-11-22 06:08:59 +00:00
Tom Rhodes 381fd5b439 Bring in a new manual page, ncv.4, and attach it to the build.
Based on an original version submitted by:	non

Approved by:	re (scottl)
2003-11-21 00:55:11 +00:00
Nate Lawson 39330d77d4 Clean up one more sentence that was wrapped unnecessarily.
Approved by:	re (implicitly)
2003-11-19 20:37:15 +00:00
Nate Lawson 1e14834ae3 Update the man page for hw.acpi.reset_video and a few mdoc(7) cleanups.
Submitted by:	Andreas Kohn <andreas.kohn@gmx.net>
Approved by:	re (implicitly)
2003-11-19 20:30:18 +00:00
Nate Lawson c25a3f8a7a Improve the section on Cx states, documenting the removal of -1 as a
valid value for cx_lowest.  To disable sleeping, use machdep.cpu_idle_hlt
instead.  Update the version of the ACPI spec we implement.

Approved by:	re (implicitly)
2003-11-19 20:28:56 +00:00
Gordon Tetlow eb5ed42cfe Update hier(7) to reflect the world with respect to /lib and /libexec. 2003-11-17 17:29:04 +00:00
Simon L. B. Nielsen 52108daca2 Document NO_DYNAMICROOT.
Reviewed by:	gordon
2003-11-16 22:15:09 +00:00
Simon L. B. Nielsen f72375e102 mdoc(7) janitor:
- Use .Aq macro instead of <foo>.
- Kill EOL whitespace.
2003-11-16 15:16:19 +00:00
Simon L. B. Nielsen a013513add Add the following devices to the list of supported devices, to sync
manual page with the source code:
- HAL Corporation Crossam2+USB IR commander
- RATOC REX-USB60
- SOURCENEXT KeikaiDenwa 8 (with and without charger)
2003-11-16 14:02:37 +00:00
Shunsuke Akiyama 6ee806e35e Add rue(4) into list of miibus-using drivers and reference.
MFC after:	1 week
2003-11-16 11:52:26 +00:00
Tom Rhodes 4008aa4cd2 Minor word tweaks.
Submitted by:	Mathew Kanner <mat@cnd.mcgill.ca>
2003-11-15 19:53:22 +00:00
Nate Lawson 6b74f9b7f5 Implement Cx CPU idle states and updated throttling support.
* Use the cpu_idle_hook() to do idling for C1-C3.
* Use both _CST and the FADT to detect Cx states.
* Use both _PTC and P_CNT for controlling throttling.
* Add a notify handler to detect changes in _CST and _PSS
* Call the _INI function for each processor if present.  This will be
  done by ACPI-CA in the future.
* Fix a bug on SMP systems where CPUs will attach multiple times if the
  bus is rescan.
* Document new sysctls for controlling idling.
2003-11-15 19:26:06 +00:00
Hartmut Brandt 89624a3490 Replace all uses of the old netgraph constants NG_*LEN by the new
constants NG_*SIZ that include the trailing NUL byte. This change
is mostly mechanical except for the replacement of a couple of snprintf()
and sprintf() calls with strlcpy.
2003-11-15 15:26:35 +00:00
Tom Rhodes 53b2520d01 Remove an extra 'for' in the HISTORY section. 2003-11-15 14:23:48 +00:00
Tom Rhodes b88ca5c03e Bring in a 90% rewrite of the pcm.4 manual page. This adds tunables, loader
options, information on VCHANs, and more.

Based on content submitted by:	Mathew Kanner <mat@cnd.mcgill.ca> && Cameron Grant
Update requested by:		ru, and I think hmp
2003-11-15 06:08:57 +00:00
Bruce M Simpson 69d9a82eb9 Add a manual page for the IDT NICStAR driver, and hook it up to the build. 2003-11-14 20:29:12 +00:00
Warner Losh b35ee63d8a Amplify the reboot requirement 2003-11-14 16:55:00 +00:00
Warner Losh 614e1f02e8 Add required reboot into single-user mode step.
# mdoc janitors should make sure I did the markup right

Inspired by: recent problems in this area
2003-11-14 06:24:20 +00:00
David E. O'Brien 9f067574ba Document this driver works for the Billionton 10/100 FastEthernet USBKR2
"thumb" adaptor.
2003-11-13 21:01:58 +00:00
Simon L. B. Nielsen 2e76d77fd0 Add cross reference to the em(4) driver, which also supports the NICs
supported by the gx(4) driver.
2003-11-13 20:35:13 +00:00
Simon L. B. Nielsen 9e151be8fd Add a few more devices from the hardware notes. 2003-11-13 17:01:08 +00:00
Simon L. B. Nielsen ad76688d59 - Add Linksys EG1032 and SMC 9452TX to the list of supported devices.
- Sort the device list.
2003-11-13 16:23:00 +00:00
Simon L. B. Nielsen 98277d1788 Sync the list of supported devices in the manual page with the hardware
notes and the driver source.
2003-11-12 14:13:36 +00:00
Hartmut Brandt 8c736ee23c Document that the length of a command string is now 32. Also change all
occurences of the old *LEN definitions to the new *SIZ definitions.

Correct the example how to compare a nodename.
strncmp(name, "fred", NG_NODELEN) may step behind "fred" if the node
name is really fred.

Reminded by: ru
2003-11-12 13:24:03 +00:00
Tony Finch f004a9739c Better English usage.
Submitted by: wollman
2003-11-12 10:53:52 +00:00
Christian Brueffer 7b93590403 Correct the on-disc path to the porters-handbook 2003-11-12 08:26:08 +00:00
Christian Brueffer 515ba752bd Document the 'fetch-recursive-list' and 'deinstall-all' targets.
No MFC reminder, I'll sync this page with the one in -stable in
a couple of days.

PR:			docs/46181
Patch submitted by:	Sergey Matveychuk <sem@ciam.ru>
2003-11-12 08:06:35 +00:00
Hiten Pandya 727119d5cd Mdoc Janitor:
* cleanup hard sentence breaks.

	* sprinle some .Dq macros.
2003-11-12 02:35:20 +00:00
Hiten Pandya 7106962038 Mdoc Janitor:
* Add missing `utility' word to sentence describing
	  ips(4) card configuration.

	* Remove extraneous use of .Pp, and describe the tunable
	  hw.ips.0.disable in a better way.

	* Replace wrongly used .Op mdoc macros with the .Bq macro.
	  The .Op macro should only be used when describing a
	  ``usage'' line of a utility/command.

	* Add .Er, for marking errno defines (ENOMEM etc etc)
2003-11-12 02:26:47 +00:00
Tom Rhodes 9e2d6c362a Attach ips.4 to the build. 2003-11-11 18:48:02 +00:00
Tom Rhodes 6856090898 Add a manual page for the ips(4) driver.
Requested by:	obrien
Reviewed by:	scottl (older version)
2003-11-11 18:47:01 +00:00
Simon L. B. Nielsen 8f7c50a225 Sort the device lists alphabetically to make it simpler to add new
devices to the lists in the appropriate places.  This also makes it
easier to find devices in the lists.

OK'ed by:	ceri, silby
2003-11-11 13:34:53 +00:00
Scott Long f27ec812b6 Note support for the Adaptec 2410SA in the aac.4 manpage. 2003-11-11 08:40:43 +00:00
Maksim Yevmenkin 3a08bb88ed Fix SYNOPSIS section in Bluetooth man pages
Reviewed by: imp, julian, ru
Approved by: ru
2003-11-11 03:27:08 +00:00
Hiten Pandya dab12c8eba Manual page for Asynchronous Logging Queues (ALQ) facility.
The manual page contains enough information to get someone started
with ALQ.

MLINKS have been added appropriately.

Approved by:	jeff, des
Reviewed by:	des, jeff, sam, brooks, rwatson, mtm
2003-11-10 22:45:09 +00:00
Tom Rhodes 2c85cbd9b5 Score one 'duh' point for me and replace all instances of scott@ with
rsm@.
2003-11-10 21:56:47 +00:00