Annotation of embedaddon/libpdel/sys/fs_mount.3, revision 1.1.1.1

1.1       misho       1: .\" Copyright (c) 2001-2002 Packet Design, LLC.
                      2: .\" All rights reserved.
                      3: .\" 
                      4: .\" Subject to the following obligations and disclaimer of warranty,
                      5: .\" use and redistribution of this software, in source or object code
                      6: .\" forms, with or without modifications are expressly permitted by
                      7: .\" Packet Design; provided, however, that:
                      8: .\" 
                      9: .\"    (i)  Any and all reproductions of the source or object code
                     10: .\"         must include the copyright notice above and the following
                     11: .\"         disclaimer of warranties; and
                     12: .\"    (ii) No rights are granted, in any manner or form, to use
                     13: .\"         Packet Design trademarks, including the mark "PACKET DESIGN"
                     14: .\"         on advertising, endorsements, or otherwise except as such
                     15: .\"         appears in the above copyright notice or in the software.
                     16: .\" 
                     17: .\" THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
                     18: .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
                     19: .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
                     20: .\" THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
                     21: .\" WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
                     22: .\" OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
                     23: .\" OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
                     24: .\" OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
                     25: .\" RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
                     26: .\" LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
                     27: .\" OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
                     28: .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
                     29: .\" DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
                     30: .\" USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
                     31: .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
                     32: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
                     33: .\" THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
                     34: .\" THE POSSIBILITY OF SUCH DAMAGE.
                     35: .\"
                     36: .\" Author: Archie Cobbs <archie@freebsd.org>
                     37: .\"
                     38: .\" $Id: fs_mount.3,v 1.4 2004/06/02 17:24:38 archie Exp $
                     39: .\"
                     40: .Dd April 22, 2002
                     41: .Dt FS_MOUNT 3
                     42: .Os
                     43: .Sh NAME
                     44: .Nm fs_mount ,
                     45: .Nm fs_unmount ,
                     46: .Nd simplified file system mounting
                     47: .Sh LIBRARY
                     48: PDEL Library (libpdel, \-lpdel)
                     49: .Sh SYNOPSIS
                     50: .In pdel/sys/fs_mount.h
                     51: .Ft int
                     52: .Fn fs_mount "const char *path" "int flags"
                     53: .Ft int
                     54: .Fn fs_unmount "const char *path" "int flags"
                     55: .Sh DESCRIPTION
                     56: These functions provide a simplified interface to
                     57: .Xr mount 2
                     58: and
                     59: .Xr unmount 2 .
                     60: .Pp
                     61: .Fn fs_mount
                     62: attempts to mount the filesystem on the directory
                     63: .Fa path .
                     64: The device to be mounted must be described in
                     65: .Pa /etc/fstab .
                     66: The
                     67: .Fa flags
                     68: are passed unchanged to
                     69: .Xr mount 2 .
                     70: .Pp
                     71: .Fn fs_ummount
                     72: attempts to unmount the filesystem mounted on the directory
                     73: .Fa path .
                     74: The
                     75: .Fa flags
                     76: are passed unchanged to
                     77: .Xr unmount 2 .
                     78: .Sh RETURN VALUES
                     79: .Fn fs_mount
                     80: and
                     81: .Fn fs_unmount
                     82: return 0 if successful, otherwise -1 is returned and
                     83: .Va errno
                     84: is set accordingly;
                     85: see
                     86: .Xr mount 2
                     87: for the possible values for
                     88: .Va errno .
                     89: .Sh SEE ALSO
                     90: .Xr mount 2 ,
                     91: .Xr libpdel 3
                     92: .Sh HISTORY
                     93: The PDEL library was developed at Packet Design, LLC.
                     94: .Dv "http://www.packetdesign.com/"
                     95: .Sh AUTHORS
                     96: .An Archie Cobbs Aq archie@freebsd.org

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>