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

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

details:   https://anonhg.NetBSD.org/src/rev/7e5f48be3841
branches:  trunk
changeset: 770769:7e5f48be3841
user:      yamt <yamt%NetBSD.org@localhost>
date:      Tue Nov 01 13:36:15 2011 +0000

description:
document skpc

diffstat:

 share/man/man9/Makefile |   4 +-
 share/man/man9/skpc.9   |  62 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 64 insertions(+), 2 deletions(-)

diffs (84 lines):

diff -r 16207ed78e01 -r 7e5f48be3841 share/man/man9/Makefile
--- a/share/man/man9/Makefile   Tue Nov 01 13:35:38 2011 +0000
+++ b/share/man/man9/Makefile   Tue Nov 01 13:36:15 2011 +0000
@@ -1,4 +1,4 @@
-#       $NetBSD: Makefile,v 1.356 2011/11/01 13:33:05 yamt Exp $
+#       $NetBSD: Makefile,v 1.357 2011/11/01 13:36:15 yamt Exp $
 
 #      Makefile for section 9 (kernel function and variable) manual pages.
 
@@ -47,7 +47,7 @@
        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 \
-       signal.9 sockopt.9 softintr.9 spl.9 splraiseipl.9 \
+       signal.9 skpc.9 sockopt.9 softintr.9 spl.9 splraiseipl.9 \
        store.9 suspendsched.9 \
        sysctl.9 sysmon_envsys.9 sysmon_pswitch.9 sysmon_taskq.9 tc.9 \
        tcp_congctl.9 timecounter.9 time_second.9 todr.9 tvtohz.9 \
diff -r 16207ed78e01 -r 7e5f48be3841 share/man/man9/skpc.9
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man9/skpc.9     Tue Nov 01 13:36:15 2011 +0000
@@ -0,0 +1,62 @@
+.\"    $NetBSD: skpc.9,v 1.1 2011/11/01 13:36:15 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 SKPC 9
+.Os
+.\" ------------------------------------------------------------
+.Sh NAME
+.Nm skpc
+.Nd Skip a character in a byte string
+.\" ------------------------------------------------------------
+.Sh SYNOPSIS
+.In lib/libkern/libkern.h
+.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+.Ft int
+.Fn skpc \
+"u_char mask" "size_t size" "u_char *cp"
+.\" ------------------------------------------------------------
+.Sh DESCRIPTION
+The
+.Fn skpc
+function scans the byte string
+.Fa cp ,
+whose length is
+.Fa size ,
+until it finds the first character which isn't equal to
+.Fa mask
+or the string is exhausted.
+.\" ------------------------------------------------------------
+.Sh RETURN VALUES
+The
+.Fn skpc
+function returns the number of characters skipped.
+.\" ------------------------------------------------------------
+.Sh HISTORY
+The
+.Fn skpc
+function emulates a VAX instruction with the same name.