[src/trunk]: src/share/man/man9 document scanc

[yamt <yamt%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/16fabea75ce3
branches:  trunk
changeset: 770766:16fabea75ce3
user:      yamt <yamt%NetBSD.org@localhost>
date:      Tue Nov 01 13:33:05 2011 +0000

description:
document scanc

diffstat:

 share/man/man9/Makefile |   3 +-
 share/man/man9/scanc.9  |  64 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 66 insertions(+), 1 deletions(-)

diffs (85 lines):

diff -r beb1ddf93343 -r 16fabea75ce3 share/man/man9/Makefile
--- a/share/man/man9/Makefile   Tue Nov 01 13:19:53 2011 +0000
+++ b/share/man/man9/Makefile   Tue Nov 01 13:33:05 2011 +0000
@@ -1,4 +1,4 @@
-#       $NetBSD: Makefile,v 1.355 2011/10/24 07:31:31 yamt Exp $
+#       $NetBSD: Makefile,v 1.356 2011/11/01 13:33:05 yamt Exp $
 
 #      Makefile for section 9 (kernel function and variable) manual pages.
 
@@ -43,6 +43,7 @@
        preempt.9 proc_find.9 pserialize.9 putter.9 \
        radio.9 ras.9 rasops.9 ratecheck.9 resettodr.9 rnd.9 roundup.9 \
        rssadapt.9 rt_timer.9 rwlock.9 RUN_ONCE.9 STACK.9 \
+       scanc.9 \
        sched_4bsd.9 sched_m2.9 scsipi.9 \
        secmodel.9 secmodel_bsd44.9 secmodel_overlay.9 secmodel_securelevel.9 \
        secmodel_suser.9 SET.9 setbit.9 setjmp.9 shutdownhook_establish.9 \
diff -r beb1ddf93343 -r 16fabea75ce3 share/man/man9/scanc.9
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man9/scanc.9    Tue Nov 01 13:33:05 2011 +0000
@@ -0,0 +1,64 @@
+.\"    $NetBSD: scanc.9,v 1.1 2011/11/01 13:33:05 yamt Exp $
+.\"
+.\" Copyright (c)2011 YAMAMOTO Takashi,
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" ------------------------------------------------------------
+.Dd November 1, 2011
+.Dt SCANC 9
+.Os
+.\" ------------------------------------------------------------
+.Sh NAME
+.Nm scanc
+.Nd Scan characters
+.\" ------------------------------------------------------------
+.Sh SYNOPSIS
+.In lib/libkern/libkern.h
+.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+.Ft int
+.Fn scanc \
+"size_t size" "const u_char *cp" "const u_char table[]" "int mask"
+.\" ------------------------------------------------------------
+.Sh DESCRIPTION
+The
+.Fn scanc
+function scans the byte string
+.Fa cp ,
+whose length is
+.Fa size .
+A character in the string is used as an index in the 256-byte
+.Fa table .
+If a bitwise-AND of the byte from the table and
+.Fa mask
+isn't zero or the string is exausted, the scan stops.
+.\" ------------------------------------------------------------
+.Sh RETURN VALUES
+The
+.Fn scanc
+function returns the number of characters skipped.
+.\" ------------------------------------------------------------
+.Sh HISTORY
+The
+.Fn scanc
+function emulates a VAX instruction with the same name.