NetBSD/lib/libahdi/ahdi_checklabel.3

97 lines
3.3 KiB
Groff

.\" $NetBSD: ahdi_checklabel.3,v 1.1 2000/02/05 20:40:37 jdc Exp $
.\"
.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Julian Coleman.
.\"
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the NetBSD
.\" Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\" contributors may be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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 January 5, 2000
.Dt ahdi_checklabel 3
.Sh NAME
.Nm ahdi_checklabel
.Nd check AHDI partition label
.Sh LIBRARY
.Lb libahdi
.Sh SYNOPSIS
.Fd #include <libahdi.h>
.Vt extern int errp1;
.Vt extern int errp2;
.Ft int
.Fn ahdi_checklabel "struct ahdi_ptable *ptable"
.Sh DESCRIPTION
The
.Nm
function checks an AHDI partition label for consistency.
.Sh DIAGNOSTICS
The
.Nm
function returns the following codes:
.Bl -column "Code" "Meaning" -offset indent
.It Em Code Ta Em Meaning
.It Li 1 Ta
Partition label is OK
.It Li -2 Ta
Number of partitions is greater than MAXPARTITIONS or less than 1
.It Li -3 Ta
GEM partition should be BGM or BGM partition should be GEM
.It Li -4 Ta
Partition overlaps root sector or bad sector list (starts before sector 2)
.It Li -5 Ta
Partition extends beyond end of disk
.It Li -6 Ta
Partitions overlap
.It Li -7 Ta
Partition overlaps auxilliary root
.It Li -8 Ta
More than 4 partitions in root sector
.It Li -9 Ta
More than 1 partition in an auxiliary root
.El
.Pp
The partitions which have errors are returned in the variables
.Em errp1
and
.Em errp2 .
.Sh SEE ALSO
.Xr ahdi_buildlabel 3 ,
.Xr ahdi_readlabel 3 ,
.Xr ahdi_writedisktab 3 ,
.Xr ahdi_writelabel 3 ,
.Xr ahdi 4
.Sh HISTORY
The
.Nm libahdi
package appeared in
.Nx 1.5 .
.Sh AUTHORS
.An Julian Coleman, Waldi Ravens, Leo Weppelman