NetBSD/lib/libutil/getlabelsector.3

.\"	$NetBSD: getlabelsector.3,v 1.8 2011/09/14 11:43:29 njoly Exp $
.\"
.\"
.\" Copyright 2002 Wasabi Systems, Inc.
.\" All rights reserved.
.\"
.\" Written by Steve C. Woodford for Wasabi Systems, Inc.
.\"
.\" 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 for the NetBSD Project by
.\"      Wasabi Systems, Inc.
.\" 4. The name of Wasabi Systems, Inc. may not be used to endorse
.\"    or promote products derived from this software without specific prior
.\"    written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``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 WASABI SYSTEMS, INC
.\" 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 August 25, 2011
.Dt GETLABELSECTOR 3
.Os
.Sh NAME
.Nm getlabelsector ,
.Nm getlabeloffset ,
.Nm getlabelusesmbr
.Nd get disklabel location informations
.Sh LIBRARY
.Lb libutil
.Sh SYNOPSIS
.In util.h
.Ft daddr_t
.Fn getlabelsector void
.Ft off_t
.Fn getlabeloffset void
.Ft int
.Fn getlabelusesmbr void
.Sh DESCRIPTION
The
.Fn getlabelsector
and
.Fn getlabeloffset
functions return values which describe the exact on-disk location of the
.Xr disklabel 5
on the current system, or \-1 on error.
These functions supersede the hardcoded
.Dv LABELSECTOR
and
.Dv LABELOFFSET
definitions previously used to derive the location of the
.Xr disklabel 5 .
.Pp
The
.Fn getlabelusesmbr
returns 1 if the disklabel is located inside a MBR partition, 0 if it's stored
relative to the start of the disk, or \-1 on error.
.Sh SEE ALSO
.Xr sysctl 3 ,
.Xr disklabel 5
.Sh HISTORY
The
.Fn getlabelsector
and
.Fn getlabeloffset
functions appeared in
.Nx 2.0 .
Kill empty Dv macro. 2011-09-14 15:43:29 +04:00			`.\" $NetBSD: getlabelsector.3,v 1.8 2011/09/14 11:43:29 njoly Exp $`
Add getlabelsector() and getlabeloffset() as wrappers around the KERN_LABELSECTOR and KERN_LABELOFFSET sysctls. 2002-12-12 12:45:32 +03:00			`.\"`
			`.\"`
			`.\" Copyright 2002 Wasabi Systems, Inc.`
			`.\" All rights reserved.`
			`.\"`
			`.\" Written by Steve C. Woodford for Wasabi Systems, Inc.`
			`.\"`
			`.\" 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 for the NetBSD Project by`
			`.\" Wasabi Systems, Inc.`
			`.\" 4. The name of Wasabi Systems, Inc. may not be used to endorse`
			`.\" or promote products derived from this software without specific prior`
			`.\" written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``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 WASABI SYSTEMS, INC`
			`.\" 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.`
			`.\"`
Fix typo. 2011-09-05 22:25:57 +04:00			`.Dd August 25, 2011`
Add getlabelsector() and getlabeloffset() as wrappers around the KERN_LABELSECTOR and KERN_LABELOFFSET sysctls. 2002-12-12 12:45:32 +03:00			`.Dt GETLABELSECTOR 3`
			`.Os`
			`.Sh NAME`
Misc fixes. 2002-12-18 23:21:11 +03:00			`.Nm getlabelsector ,`
Add getlabelusesmbr(), as proposed in http://mail-index.netbsd.org/tech-userlevel/2011/08/25/msg005404.html This is used by disk tools such as disklabel(8) to dynamically decide is the undelyling platform uses a disklabel-in-mbr-partition or not (instead of using a compile-time list of ports). getlabelusesmbr() reads the sysctl kern.labelusesmbr, takes its value from the machdep #define LABELUSESMBR. For evbmips, make LABELUSESMBR 1 if the platform uses pmon as bootloader, and 0 (the previous value) otherwise. 2011-08-30 16:39:49 +04:00			`.Nm getlabeloffset ,`
			`.Nm getlabelusesmbr`
			`.Nd get disklabel location informations`
Add getlabelsector() and getlabeloffset() as wrappers around the KERN_LABELSECTOR and KERN_LABELOFFSET sysctls. 2002-12-12 12:45:32 +03:00			`.Sh LIBRARY`
			`.Lb libutil`
			`.Sh SYNOPSIS`
Use .In header.h instead of .Fd #include \[Lt]header.h\[Gt] Much easier to read and write, and supported by groff for ages. Okayed by ross. 2003-04-16 17:34:34 +04:00			`.In util.h`
Add getlabelsector() and getlabeloffset() as wrappers around the KERN_LABELSECTOR and KERN_LABELOFFSET sysctls. 2002-12-12 12:45:32 +03:00			`.Ft daddr_t`
			`.Fn getlabelsector void`
			`.Ft off_t`
			`.Fn getlabeloffset void`
Add getlabelusesmbr(), as proposed in http://mail-index.netbsd.org/tech-userlevel/2011/08/25/msg005404.html This is used by disk tools such as disklabel(8) to dynamically decide is the undelyling platform uses a disklabel-in-mbr-partition or not (instead of using a compile-time list of ports). getlabelusesmbr() reads the sysctl kern.labelusesmbr, takes its value from the machdep #define LABELUSESMBR. For evbmips, make LABELUSESMBR 1 if the platform uses pmon as bootloader, and 0 (the previous value) otherwise. 2011-08-30 16:39:49 +04:00			`.Ft int`
			`.Fn getlabelusesmbr void`
Add getlabelsector() and getlabeloffset() as wrappers around the KERN_LABELSECTOR and KERN_LABELOFFSET sysctls. 2002-12-12 12:45:32 +03:00			`.Sh DESCRIPTION`
			`The`
			`.Fn getlabelsector`
			`and`
			`.Fn getlabeloffset`
			`functions return values which describe the exact on-disk location of the`
			`.Xr disklabel 5`
Misc fixes. 2002-12-18 23:21:11 +03:00			`on the current system, or \-1 on error.`
correct spelling error. 2009-06-25 02:31:58 +04:00			`These functions supersede the hardcoded`
Misc fixes. 2002-12-18 23:21:11 +03:00			`.Dv LABELSECTOR`
			`and`
			`.Dv LABELOFFSET`
Add getlabelsector() and getlabeloffset() as wrappers around the KERN_LABELSECTOR and KERN_LABELOFFSET sysctls. 2002-12-12 12:45:32 +03:00			`definitions previously used to derive the location of the`
			`.Xr disklabel 5 .`
Add getlabelusesmbr(), as proposed in http://mail-index.netbsd.org/tech-userlevel/2011/08/25/msg005404.html This is used by disk tools such as disklabel(8) to dynamically decide is the undelyling platform uses a disklabel-in-mbr-partition or not (instead of using a compile-time list of ports). getlabelusesmbr() reads the sysctl kern.labelusesmbr, takes its value from the machdep #define LABELUSESMBR. For evbmips, make LABELUSESMBR 1 if the platform uses pmon as bootloader, and 0 (the previous value) otherwise. 2011-08-30 16:39:49 +04:00			`.Pp`
			`The`
			`.Fn getlabelusesmbr`
			`returns 1 if the disklabel is located inside a MBR partition, 0 if it's stored`
			`relative to the start of the disk, or \-1 on error.`
Add getlabelsector() and getlabeloffset() as wrappers around the KERN_LABELSECTOR and KERN_LABELOFFSET sysctls. 2002-12-12 12:45:32 +03:00			`.Sh SEE ALSO`
Misc fixes. 2002-12-18 23:21:11 +03:00			`.Xr sysctl 3 ,`
			`.Xr disklabel 5`
Add getlabelsector() and getlabeloffset() as wrappers around the KERN_LABELSECTOR and KERN_LABELOFFSET sysctls. 2002-12-12 12:45:32 +03:00			`.Sh HISTORY`
			`The`
			`.Fn getlabelsector`
			`and`
			`.Fn getlabeloffset`
Misc fixes. 2002-12-18 23:21:11 +03:00			`functions appeared in`
The next release will be 2.0, not 1.7. 2003-01-20 00:25:36 +03:00			`.Nx 2.0 .`