share/man/man5/xfs.5

   1 .\"
   2 .\" Copyright (c) 2007 Craig Rodrigues
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd January 16, 2011
  28 .Dt XFS 5
  29 .Os
  30 .Sh NAME
  31 .Nm xfs
  32 .Nd "XFS file system"
  33 .Sh SYNOPSIS
  34 To link into the kernel:
  35 .Bd -ragged -offset indent
  36 .Cd "options XFS"
  37 .Ed
  38 .Pp
  39 To load as a kernel loadable module:
  40 .Pp
  41 .Dl "kldload xfs"
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 driver will permit the
  46 .Fx
  47 kernel to access
  48 .Tn XFS
  49 file systems.
  50 .Sh EXAMPLES
  51 To mount a
  52 .Nm
  53 volume located on
  54 .Pa /dev/ad1s1 :
  55 .Pp
  56 .Dl "mount -t xfs -o ro /dev/ad1s1 /mnt"
  57 .Sh SEE ALSO
  58 .Xr nmount 2 ,
  59 .Xr unmount 2 ,
  60 .Xr fstab 5 ,
  61 .Xr mount 8
  62 .Sh NOTES
  63 The
  64 .Pa sysutils/xfsprogs
  65 port contains the
  66 .Cm mkfs.xfs
  67 utility for
  68 creating XFS file systems, and also other utilities for analyzing,
  69 and repairing XFS file systems.
  70 .Sh HISTORY
  71 XFS was originally written by SGI for the IRIX operating system.
  72 SGI ported XFS to Linux, and released the source code under the GNU
  73 Public License.  For more details, see:
  74 .Pa http://oss.sgi.com/projects/xfs
  75 .Pp
  76 The port to
  77 .Fx
  78 was based on the Linux port, and started by
  79 .An -nosplit
  80 .An Russell Cattelan Aq cattelan@xfs.org ,
  81 .An Alexander Kabaev Aq kan@FreeBSD.org ,
  82 and
  83 .An Craig Rodrigues Aq rodrigc@FreeBSD.org .
  84 .Pp
  85 The
  86 .Nm
  87 file system support
  88 first appeared in
  89 .Fx 7.0 .
  90 .Sh AUTHORS
  91 This manual page was written by
  92 .An Craig Rodrigues Aq rodrigc@FreeBSD.org .
  93 .Sh CAVEATS
  94 The port of XFS to
  95 .Fx
  96 is currently incomplete.
  97 Only read-only access is supported for XFS volumes.
  98 Writing to a volume is not supported.
  99 .Pp
 100 The
 101 .Fl p
 102 flag to
 103 .Cm mkfs.xfs
 104 can be used to create an XFS file system which is populated with files
 105 and other metadata.
 106 This can be used to quickly create a read-only file system which
 107 can be tested on
 108 .Fx .