add stubby version of puffs_framebuf manual page. proper one
forthcoming to an internet near you Real Soon Now(tm)
This commit is contained in:
pooka
parent
0e7bdfc146
commit
bb0de0a878
|
|
@ -1,4 +1,4 @@
|
|||
# $NetBSD: Makefile,v 1.16 2007/05/05 15:48:18 pooka Exp $
|
||||
# $NetBSD: Makefile,v 1.17 2007/05/05 16:09:16 pooka Exp $
|
||||
#
|
||||
|
||||
.include <bsd.own.mk>
|
||||
|
|
@ -9,8 +9,8 @@ LIB= puffs
|
|||
SRCS= puffs.c callcontext.c creds.c flush.c framebuf.c null.c \
|
||||
opdump.c paths.c pnode.c requests.c subr.c suspend.c
|
||||
MAN= puffs.3 puffs_cc.3 puffs_cred.3 puffs_flush.3 \
|
||||
puffs_node.3 puffs_ops.3 puffs_path.3 puffs_req.3 \
|
||||
puffs_suspend.3
|
||||
puffs_framebuf.3 puffs_node.3 puffs_ops.3 puffs_path.3 \
|
||||
puffs_req.3 puffs_suspend.3
|
||||
INCS= puffs.h puffsdump.h
|
||||
INCSDIR= /usr/include
|
||||
LINTFLAGS+=-S -w
|
||||
|
|
|
|||
|
|
@ -0,0 +1,108 @@
|
|||
.\" $NetBSD: puffs_framebuf.3,v 1.1 2007/05/05 16:09:17 pooka Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2007 Antti Kantee. 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 May 5, 2007
|
||||
.Dt PUFFS_FRAMEBUF 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm puffs_framebuf
|
||||
.Nd puffs buffering routines for networked file systems
|
||||
.Sh LIBRARY
|
||||
.Lb libpuffs
|
||||
.Sh SYNOPSIS
|
||||
.In puffs.h
|
||||
.Ft struct puffs_framebuf *
|
||||
.Fn puffs_framebuf_make
|
||||
.Ft void
|
||||
.Fn puffs_framebuf_destroy "struct puffs_framebuf *pufbuf"
|
||||
.Ft void
|
||||
.Fn puffs_framebuf_recycle "struct puffs_framebuf *pufbuf"
|
||||
.Ft int
|
||||
.Fn puffs_framebuf_reserve_space "struct puffs_framebuf *pufbuf" "size_t space"
|
||||
.Ft int
|
||||
.Fo puffs_framebuf_putdata
|
||||
.Fa "struct puffs_framebuf *pufbuf" "const void *data" "size_t dlen"
|
||||
.Fc
|
||||
.Ft int
|
||||
.Fo puffs_framebuf_putdata_atoff
|
||||
.Fa "struct puffs_framebuf *pufbuf" "size_t offset" "const void *data"
|
||||
.Fa "size_t dlen"
|
||||
.Fc
|
||||
.Ft int
|
||||
.Fo puffs_framebuf_getdata
|
||||
.Fa "struct puffs_framebuf *pufbuf" "void *data" "size_t dlen"
|
||||
.Fc
|
||||
.Ft int
|
||||
.Fo puffs_framebuf_getdata_atoff
|
||||
.Fa "struct puffs_framebuf *pufbuf" "size_t offset"
|
||||
.Fa "void * data" "size_t dlen"
|
||||
.Fc
|
||||
.Ft size_t
|
||||
.Fn puffs_framebuf_telloff "struct puffs_framebuf *pufbuf"
|
||||
.Ft size_t
|
||||
.Fn puffs_framebuf_tellsize "struct puffs_framebuf *pufbuf"
|
||||
.Ft size_t
|
||||
.Fn puffs_framebuf_remaining "struct puffs_framebuf *pufbuf"
|
||||
.Ft int
|
||||
.Fn puffs_framebuf_seekset "struct puffs_framebuf *pufbuf" "size_t offset"
|
||||
.Ft int
|
||||
.Fo puffs_framebuf_getwindow
|
||||
.Fa "struct puffs_framebuf *pufbuf" "size_t offset"
|
||||
.Fa "void **winp" "size_t *winlen"
|
||||
.Fc
|
||||
.Ft int
|
||||
.Fo puffs_framebuf_enqueue_cc
|
||||
.Fa "struct puffs_cc *pcc" "struct puffs_framebuf *pufbuf"
|
||||
.Fc
|
||||
.Ft void
|
||||
.Fo puffs_framebuf_enqueue_cb
|
||||
.Fa "struct puffs_usermount *pu" "struct puffs_framebuf *pufbuf"
|
||||
.Fa "puffs_framebuf_cb fcb" "void *fcb_arg"
|
||||
.Fc
|
||||
.Ft void
|
||||
.Fo puffs_framebuf_enqueue_justsend
|
||||
.Fa "struct puffs_usermount *pu" "struct puffs_framebuf *pufbuf" "int waitreply"
|
||||
.Fc
|
||||
.Ft int
|
||||
.Fo puffs_framebuf_eventloop
|
||||
.Fa "struct puffs_usermount *pu" "int fd"
|
||||
.Fa "puffs_framebuf_readframe_fn rfb" "puffs_framebuf_writeframe_fn wfb"
|
||||
.Fa "puffs_framebuf_respcmp_fn cmpfn"
|
||||
.Fa "puffs_framebuf_loop_fn lfn" "void *lfn_arg"
|
||||
.Fc
|
||||
.Sh DESCRIPTION
|
||||
.Em IMPORTANT NOTE!
|
||||
This document describes interfaces which are not yet guaranteed to be
|
||||
stable.
|
||||
In case you update your system sources, please recompile everything
|
||||
and fix complation errors.
|
||||
If your sources are out-of-sync, incorrect operation may result.
|
||||
The interfaces in this document will most likely be hugely simplified
|
||||
in later versions or made transparent to the implementation.
|
||||
.Pp
|
||||
Under construction.
|
||||
.Sh SEE ALSO
|
||||
.Xr puffs 3 ,
|
||||
.Xr puffs_cc 3
|
||||
Loading…
Reference in New Issue