Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src/share/man/man9 New sentence, new line.
details: https://anonhg.NetBSD.org/src/rev/4a8573b67a0c
branches: trunk
changeset: 538204:4a8573b67a0c
user: wiz <wiz%NetBSD.org@localhost>
date: Mon Oct 14 13:43:14 2002 +0000
description:
New sentence, new line.
diffstat:
share/man/man9/audio.9 | 118 ++--
share/man/man9/autoconf.9 | 6 +-
share/man/man9/bcopy.9 | 5 +-
share/man/man9/bufq.9 | 5 +-
share/man/man9/bus_dma.9 | 191 ++++---
share/man/man9/bus_space.9 | 585 +++++++++++++-----------
share/man/man9/callout.9 | 32 +-
share/man/man9/cardbus.9 | 65 +-
share/man/man9/cnmagic.9 | 40 +-
share/man/man9/config.9 | 137 +++--
share/man/man9/cons.9 | 25 +-
share/man/man9/copy.9 | 8 +-
share/man/man9/cpu_configure.9 | 9 +-
share/man/man9/cpu_coredump.9 | 9 +-
share/man/man9/cpu_dumpconf.9 | 5 +-
share/man/man9/cpu_exit.9 | 6 +-
share/man/man9/cpu_fork.9 | 11 +-
share/man/man9/cpu_initclocks.9 | 6 +-
share/man/man9/cpu_reboot.9 | 8 +-
share/man/man9/cpu_swapout.9 | 8 +-
share/man/man9/cpu_sysctl.9 | 6 +-
share/man/man9/disk.9 | 86 ++-
share/man/man9/dmover.9 | 160 +++---
share/man/man9/doshutdownhooks.9 | 5 +-
share/man/man9/driver.9 | 185 ++++---
share/man/man9/ethersubr.9 | 5 +-
share/man/man9/evcnt.9 | 66 +-
share/man/man9/extent.9 | 80 ++-
share/man/man9/fetch.9 | 8 +-
share/man/man9/fork1.9 | 22 +-
share/man/man9/inittodr.9 | 10 +-
share/man/man9/ioctl.9 | 33 +-
share/man/man9/ipkdb.9 | 32 +-
share/man/man9/isa.9 | 99 ++-
share/man/man9/isapnp.9 | 49 +-
share/man/man9/kprintf.9 | 26 +-
share/man/man9/kthread.9 | 21 +-
share/man/man9/linedisc.9 | 13 +-
share/man/man9/lock.9 | 174 ++++---
share/man/man9/ltsleep.9 | 13 +-
share/man/man9/malloc.9 | 6 +-
share/man/man9/mbuf.9 | 8 +-
share/man/man9/mca.9 | 69 +-
share/man/man9/memcpy.9 | 5 +-
share/man/man9/namei.9 | 89 ++-
share/man/man9/pci.9 | 140 +++--
share/man/man9/pci_configure_bus.9 | 59 +-
share/man/man9/pci_intr.9 | 16 +-
share/man/man9/pcmcia.9 | 92 ++-
share/man/man9/pfil.9 | 53 +-
share/man/man9/pmc.9 | 48 +-
share/man/man9/pool.9 | 5 +-
share/man/man9/powerhook_establish.9 | 18 +-
share/man/man9/properties.9 | 82 ++-
share/man/man9/ras.9 | 20 +-
share/man/man9/rasops.9 | 20 +-
share/man/man9/ratecheck.9 | 21 +-
share/man/man9/resettodr.9 | 5 +-
share/man/man9/rnd.9 | 42 +-
share/man/man9/rt_timer.9 | 36 +-
share/man/man9/scsipi.9 | 124 +++--
share/man/man9/setjmp.9 | 5 +-
share/man/man9/shutdownhook_establish.9 | 15 +-
share/man/man9/signal.9 | 106 ++--
share/man/man9/softintr.9 | 12 +-
share/man/man9/spl.9 | 102 ++-
share/man/man9/suser.9 | 8 +-
share/man/man9/tc.9 | 33 +-
share/man/man9/time.9 | 13 +-
share/man/man9/todr.9 | 20 +-
share/man/man9/ucom.9 | 19 +-
share/man/man9/usbdi.9 | 8 +-
share/man/man9/vattr.9 | 8 +-
share/man/man9/vfs.9 | 9 +-
share/man/man9/vfsops.9 | 127 ++--
share/man/man9/vme.9 | 73 +-
share/man/man9/vnfileops.9 | 71 +-
share/man/man9/vnode.9 | 254 ++++++----
share/man/man9/vnodeops.9 | 752 ++++++++++++++++++-------------
share/man/man9/vnsubr.9 | 70 +-
share/man/man9/wscons.9 | 21 +-
share/man/man9/wsdisplay.9 | 121 ++--
share/man/man9/wsfont.9 | 38 +-
share/man/man9/wskbd.9 | 63 +-
share/man/man9/wsmouse.9 | 42 +-
85 files changed, 3015 insertions(+), 2305 deletions(-)
diffs (truncated from 11406 to 300 lines):
diff -r 395217b862bf -r 4a8573b67a0c share/man/man9/audio.9
--- a/share/man/man9/audio.9 Mon Oct 14 13:37:57 2002 +0000
+++ b/share/man/man9/audio.9 Mon Oct 14 13:43:14 2002 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: audio.9,v 1.22 2002/06/04 14:09:34 isaki Exp $
+.\" $NetBSD: audio.9,v 1.23 2002/10/14 13:43:14 wiz Exp $
.\"
.\" Copyright (c) 1999, 2000 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -43,8 +43,8 @@
.Sh DESCRIPTION
The audio device driver is divided into a high level,
hardware independent layer, and a low level hardware
-dependent layer. The interface between these is
-the
+dependent layer.
+The interface between these is the
.Va audio_hw_if
structure.
.Bd -literal
@@ -133,7 +133,8 @@
.Pp
The
.Va audio_hw_if
-struct is as shown above. The
+struct is as shown above.
+The
.Va hdl
argument is a handle to some low level data structure.
It is sent as the first argument to all the functions
@@ -144,13 +145,13 @@
is the device struct for the hardware device.
.Pp
The upper layer of the audio driver allocates one buffer for playing
-and one for recording. It handles the buffering of data from the
-user processes in these. The data is presented to the lower level
-in smaller chunks, called blocks. If there, during playback, is
-no data available from the user process when the hardware request
-another block a block of silence will be used instead. Furthermore,
-if the user process does not read data quickly enough during recording
-data will be thrown away.
+and one for recording.
+It handles the buffering of data from the user processes in these.
+The data is presented to the lower level in smaller chunks, called blocks.
+If there, during playback, is no data available from the user process when
+the hardware request another block a block of silence will be used instead.
+Furthermore, if the user process does not read data quickly enough during
+recording data will be thrown away.
.Pp
The fields of
.Va audio_hw_if
@@ -158,8 +159,9 @@
Some fields are optional and can be set to 0 if not needed.
.Bl -tag -width indent
.It Dv int open(void *hdl, int flags)
-is called when the audio device is opened. It should initialize
-the hardware for I/O. Every successful call to
+is called when the audio device is opened.
+It should initialize the hardware for I/O.
+Every successful call to
.Va open
is matched by a call to
.Va close .
@@ -169,15 +171,17 @@
.It Dv int drain(void *hdl)
optional, is called before the device is closed or when
.Dv AUDIO_DRAIN
-is called. It should make sure that no samples remain
-in to be played that could be lost when
+is called.
+It should make sure that no samples remain in to be played that could
+be lost when
.Va close
is called.
Return 0 on success, otherwise an error code.
.It Dv int query_encoding(void *hdl, struct audio_encoding *ae)
is used when
.Dv AUDIO_GETENC
-is called. It should fill the
+is called.
+It should fill the
.Va audio_encoding
structure and return 0 or, if there is no encoding with the
given number, return EINVAL.
@@ -193,7 +197,7 @@
flags to indicate which mode(s) are to be set.
.Va usemode
is also a combination of these flags, but indicates the current
-mode of the device (i.e. the value of
+mode of the device (i.e., the value of
.Va mode
in the
.Va audio_info
@@ -224,16 +228,17 @@
1 to
.Va factor_denom ,
.Dv AUDIO_ENCODING_SLINEAR_LE
-to
+to
.Va hw_encoding
and 16 to
.Va hw_precision .
The values of the structures may also be modified if the hardware
-cannot be set to exactly the requested mode (e.g. if the requested
+cannot be set to exactly the requested mode (e.g., if the requested
sampling rate is not supported, but one close enough is).
.Pp
The hardware driver can also request sampling rate conversion
-and mono-stereo conversion. If
+and mono-stereo conversion.
+If
.Va set_params
sets to
.Va hw_sampling_rate
@@ -248,7 +253,8 @@
to
.Va hw_encoding ,
the hardware independent driver performs sampling rate and/or mono-stereo
-conversion. If such conversion is not needed,
+conversion.
+If such conversion is not needed,
.Va set_params
must keep
.Va sampling_rate
@@ -261,7 +267,7 @@
respectively.
.Pp
Note: The order of conversion is
-.Va sw_code
+.Va sw_code
followed by sampling rate and mono-stereo in playing,
and sampling rate and mono-stereo followed by
.Va sw_code
@@ -283,33 +289,34 @@
.It Dv int round_blocksize(void *hdl, int bs)
optional, is called with the block size,
.Va bs ,
-that has been computed by the upper layer. It should return
-a block size, possibly changed according to the needs of the
-hardware driver.
+that has been computed by the upper layer.
+It should return a block size, possibly changed according to the needs
+of the hardware driver.
.It Dv int commit_settings(void *hdl)
optional, is called after all calls to
.Va set_params ,
and
.Va set_port ,
-are done. A hardware driver that needs to get the hardware in
-and out of command mode for each change can save all the changes
-during previous calls and do them all here.
+are done.
+A hardware driver that needs to get the hardware in and out of command
+mode for each change can save all the changes during previous calls and
+do them all here.
Return 0 on success, otherwise an error code.
.It Dv int init_output(void *hdl, void *buffer, int size)
optional, is called before any output starts, but when the total
.Va size
of the output
.Va buffer
-has been determined. It can be used to initialize looping DMA
-for hardware that needs that.
+has been determined.
+It can be used to initialize looping DMA for hardware that needs that.
Return 0 on success, otherwise an error code.
.It Dv int init_input(void *hdl, void *buffer, int size)
optional, is called before any input starts, but when the total
.Va size
of the input
.Va buffer
-has been determined. It can be used to initialize looping DMA
-for hardware that needs that.
+has been determined.
+It can be used to initialize looping DMA for hardware that needs that.
Return 0 on success, otherwise an error code.
.It Dv int start_output(void *hdl, void *block, int blksize,
.Dv "void (*intr)(void*), void *intrarg)"
@@ -318,9 +325,10 @@
.Va blksize
bytes from
.Va block
-to the audio hardware. The call should return when the data
-transfer has been initiated (normally with DMA). When the
-hardware is ready to accept more samples the function
+to the audio hardware.
+The call should return when the data transfer has been initiated
+(normally with DMA).
+When the hardware is ready to accept more samples the function
.Va intr
should be called with the argument
.Va intrarg .
@@ -336,9 +344,10 @@
.Va blksize
bytes to
.Va block
-from the audio hardware. The call should return when the data
-transfer has been initiated (normally with DMA). When the
-hardware is ready to deliver more samples the function
+from the audio hardware.
+The call should return when the data transfer has been initiated
+(normally with DMA).
+When the hardware is ready to deliver more samples the function
.Va intr
should be called with the argument
.Va intrarg .
@@ -359,7 +368,8 @@
Return 0 on success, otherwise an error code.
.It Dv int speaker_ctl(void *hdl, int on)
optional, is called when a half duplex device changes between
-playing and recording. It can, e.g., be used to turn on
+playing and recording.
+It can, e.g., be used to turn on
and off the speaker.
Return 0 on success, otherwise an error code.
.It Dv int getdev(void *hdl, struct audio_device *ret)
@@ -375,27 +385,31 @@
.It Dv int set_port(void *hdl, mixer_ctl_t *mc)
is called in when
.Dv AUDIO_MIXER_WRITE
-is used. It should take data from the
+is used.
+It should take data from the
.Va mixer_ctl_t
struct at set the corresponding mixer values.
Return 0 on success, otherwise an error code.
.It Dv int get_port(void *hdl, mixer_ctl_t *mc)
is called in when
.Dv AUDIO_MIXER_READ
-is used. It should fill the
+is used.
+It should fill the
.Va mixer_ctl_t
struct.
Return 0 on success, otherwise an error code.
.It Dv int query_devinfo(void *hdl, mixer_devinfo_t *di)
is called in when
.Dv AUDIO_MIXER_DEVINFO
-is used. It should fill the
+is used.
+It should fill the
.Va mixer_devinfo_t
struct.
Return 0 on success, otherwise an error code.
.It Dv "void *allocm(void *hdl, int direction, size_t size, int type, int flags)"
.br
-optional, is called to allocate the device buffers. If not present
+optional, is called to allocate the device buffers.
+If not present
.Xr malloc 9
is used instead (with the same arguments but the first two).
The reason for using a device dependent routine instead of
@@ -410,8 +424,8 @@
is used.
.It Dv size_t round_buffersize(void *hdl, int direction, size_t bufsize)
optional, is called at startup to determine the audio
-buffer size. The upper layer supplies the suggested
-size in
+buffer size.
+The upper layer supplies the suggested size in
.Va bufsize ,
which the hardware driver can then change if needed.
E.g., DMA on the ISA bus cannot exceed 65536 bytes.
@@ -428,7 +442,7 @@
Returns -1 on failure, or a machine dependent opaque value
on success.
.It Dv int get_props(void *hdl)
-Should return the device properties; i.e. a combination of
+Should return the device properties; i.e., a combination of
AUDIO_PROP_xxx.
.It Dv int trigger_output(void *hdl, void *start, void *end,
.Dv "int blksize, void (*intr)(void*), void *intrarg,"
@@ -443,8 +457,8 @@
to the audio hardware, parameterized as in
.Va param .
The call should return when the data transfer has been initiated
-(normally with DMA). When the hardware is finished transferring
-each
+(normally with DMA).
+When the hardware is finished transferring each
.Va blksize
sized block, the function
.Va intr
@@ -467,8 +481,8 @@
and
.Va end .
The call should return when the data transfer has been initiated
-(normally with DMA). When the hardware is finished transferring
-each
+(normally with DMA).
+When the hardware is finished transferring each
.Va blksize
sized block, the function
.Va intr
@@ -510,7 +524,7 @@
class of type
.Dv AUDIO_MIXER_VALUE
if recording level of the source can be set.
-If the overall recording level can be changed (i.e. regardless
+If the overall recording level can be changed (i.e., regardless
Home |
Main Index |
Thread Index |
Old Index