lib/libc/sys/lfs_segclean.2

   1 .\"     $NetBSD: lfs_segclean.2,v 1.8 2008/04/30 13:10:51 martin Exp $
   2 .\"
   3 .\" Copyright (c) 2000 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Konrad Schroder.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd May 23, 2000
  31 .Dt LFS_SEGCLEAN 2
  32 .Os
  33 .Sh NAME
  34 .Nm lfs_segclean
  35 .Nd mark a segment clean
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .Ft int
  41 .Fn lfs_segclean "fsid_t *fsidp" "u_long segment"
  42 .Sh DESCRIPTION
  43 .Fn lfs_segclean
  44 marks segment number
  45 .Fa segment
  46 in LFS filesystem
  47 .Fa *fsidp
  48 "clean" or available for writing.
  49 .Sh RETURN VALUES
  50 .Fn lfs_segclean
  51 returns 0 on success, or \-1 on error.
  52 .Sh ERRORS
  53 An error return from
  54 .Fn lfs_segclean
  55 indicates:
  56 .Bl -tag -width Er
  57 .It Bq Er EFAULT
  58 .Fa fsidp
  59 points outside the process's allocated address space.
  60 .It Bq Er EINVAL
  61 .Fa *fsidp
  62 does not specify a valid filesystem.
  63 .It Bq Er EBUSY
  64 .Fa segment
  65 is marked SU_ACTIVE, meaning that it does not yet belong to a valid checkpoint.
  66 .El
  67 .Sh SEE ALSO
  68 .Xr lfs_bmapv 2 ,
  69 .Xr lfs_markv 2 ,
  70 .Xr lfs_segwait 2 ,
  71 .Xr lfs_cleanerd 8
  72 .Sh HISTORY
  73 The
  74 .Fn lfs_segclean
  75 function call appeared in
  76 .Bx 4.4 .