diff options
Diffstat (limited to 'usr/src/man/man7fs')
| -rw-r--r-- | usr/src/man/man7fs/Makefile | 38 | ||||
| -rw-r--r-- | usr/src/man/man7fs/ctfs.7fs | 30 | ||||
| -rw-r--r-- | usr/src/man/man7fs/dcfs.7fs | 47 | ||||
| -rw-r--r-- | usr/src/man/man7fs/dev.7fs | 45 | ||||
| -rw-r--r-- | usr/src/man/man7fs/devfs.7fs | 72 | ||||
| -rw-r--r-- | usr/src/man/man7fs/hsfs.7fs | 304 | ||||
| -rw-r--r-- | usr/src/man/man7fs/lofs.7fs | 91 | ||||
| -rw-r--r-- | usr/src/man/man7fs/objfs.7fs | 65 | ||||
| -rw-r--r-- | usr/src/man/man7fs/pcfs.7fs | 519 | ||||
| -rw-r--r-- | usr/src/man/man7fs/sharefs.7fs | 43 | ||||
| -rw-r--r-- | usr/src/man/man7fs/smbfs.7fs | 124 | ||||
| -rw-r--r-- | usr/src/man/man7fs/tmpfs.7fs | 147 | ||||
| -rw-r--r-- | usr/src/man/man7fs/udfs.7fs | 83 | ||||
| -rw-r--r-- | usr/src/man/man7fs/ufs.7fs | 276 |
14 files changed, 1884 insertions, 0 deletions
diff --git a/usr/src/man/man7fs/Makefile b/usr/src/man/man7fs/Makefile new file mode 100644 index 0000000000..e17aca0d0a --- /dev/null +++ b/usr/src/man/man7fs/Makefile @@ -0,0 +1,38 @@ +# +# This file and its contents are supplied under the terms of the +# Common Development and Distribution License ("CDDL"), version 1.0. +# You may only use this file in accordance with the terms of version +# 1.0 of the CDDL. +# +# A full copy of the text of the CDDL should have accompanied this +# source. A copy of the CDDL is also available via the Internet +# at http://www.illumos.org/license/CDDL. +# + +# Copyright 2011, Richard Lowe + +include ../../Makefile.master + +MANSECT = 7fs + +MANFILES = ctfs.7fs \ + dcfs.7fs \ + dev.7fs \ + devfs.7fs \ + hsfs.7fs \ + lofs.7fs \ + objfs.7fs \ + pcfs.7fs \ + sharefs.7fs \ + smbfs.7fs \ + tmpfs.7fs \ + udfs.7fs \ + ufs.7fs + +.KEEP_STATE: + +include ../Makefile.man + +install: $(ROOTMANFILES) + + diff --git a/usr/src/man/man7fs/ctfs.7fs b/usr/src/man/man7fs/ctfs.7fs new file mode 100644 index 0000000000..d7a99c78ab --- /dev/null +++ b/usr/src/man/man7fs/ctfs.7fs @@ -0,0 +1,30 @@ +'\" te +.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH ctfs 7FS "18 Nov 2004" "SunOS 5.11" "File Systems" +.SH NAME +ctfs \- contract file system +.SH DESCRIPTION +.sp +.LP +The \fBctfs\fR filesystem is the interface to the contract sub-system. +\fBctfs\fR is mounted during boot at \fB/system/contract\fR. For information on +contracts and the contents of this filesystem, see \fBcontract\fR(4). +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/system/contract\fR\fR +.ad +.RS 20n +.rt +Mount point for the \fBctfs\fR file system +.RE + +.SH SEE ALSO +.sp +.LP +\fBcontract\fR(4), \fBvfstab\fR(4), \fBattributes\fR(5), \fBsmf\fR(5) diff --git a/usr/src/man/man7fs/dcfs.7fs b/usr/src/man/man7fs/dcfs.7fs new file mode 100644 index 0000000000..b8b524769c --- /dev/null +++ b/usr/src/man/man7fs/dcfs.7fs @@ -0,0 +1,47 @@ +'\" te +.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH dcfs 7FS "28 Nov 2007" "SunOS 5.11" "File Systems" +.SH NAME +dcfs \- Compression file system +.SH SYNOPSIS +.LP +.nf +#include <sys/filio.h> +#include <sys/fs/decomp.h> +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBdcfs\fR filesystem is a layered filesystem that you use to compress data +when writing to a file and decompress upon read. The primary function of the +\fBdcfs\fR filesystem is to compress individual files when constructing a boot +archive and when reading or booting from the archive. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +lw(2.75i) lw(2.75i) +lw(2.75i) lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +Interface StabilityUncommitted +.TE + +.SH SEE ALSO +.sp +.LP +\fBboot\fR(1M), \fBbootadm\fR(1M), \fBfiocompress\fR(1M), \fBattributes\fR(5), +\fBufs\fR(7FS) +.SH NOTES +.sp +.LP +The \fBdcfs\fR compression/decompression file system works only with UFS. diff --git a/usr/src/man/man7fs/dev.7fs b/usr/src/man/man7fs/dev.7fs new file mode 100644 index 0000000000..87c8bbc659 --- /dev/null +++ b/usr/src/man/man7fs/dev.7fs @@ -0,0 +1,45 @@ +'\" te +.\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH dev 7FS "9 June 2006" "SunOS 5.11" "File Systems" +.SH NAME +dev \- Device name file system +.SH DESCRIPTION +.sp +.LP +The \fBdev\fR filesystem manages the name spaces of devices under the Solaris +operating environment. The global zone's instance of the \fBdev\fR filesystem +is mounted during boot on \fB/dev\fR. +.sp +.LP +A subdirectory under \fB/dev\fR may have unique operational semantics. Most of +the common device names under \fB/dev\fR are created automatically by +\fBdevfsadm\fR(1M). Others, such as \fB/dev/pts\fR, are dynamic and reflect +the operational state of the system. You can manually generate device names for +newly attached hardware by invoking \fBdevfsadm\fR(1M) or implicitly, by +indirectly causing a lookup or readdir operation in the filesystem to occur. +For example, you can discover a disk that was attached when the system was +powered down (and generate a name for that device) by invoking +\fBformat\fR(1M)). +.SH FILES +.sp +.ne 2 +.mk +.na +\fB/dev\fR +.ad +.RS 8n +.rt +Mount point for the \fB/dev\fR filesystem in the global zone. +.RE + +.SH SEE ALSO +.sp +.LP +\fBdevfsadm\fR(1M), \fBformat\fR(1M), \fBdevfs\fR(7FS) +.SH NOTES +.sp +.LP +The global \fB/dev\fR instance cannot be unmounted. diff --git a/usr/src/man/man7fs/devfs.7fs b/usr/src/man/man7fs/devfs.7fs new file mode 100644 index 0000000000..5693d9e32c --- /dev/null +++ b/usr/src/man/man7fs/devfs.7fs @@ -0,0 +1,72 @@ +'\" te +.\" Copyright (c) 2004 Sun Microsystems, Inc. All Rights Reserved. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH devfs 7FS "26 Oct 2004" "SunOS 5.11" "File Systems" +.SH NAME +devfs \- Devices file system +.SH DESCRIPTION +.sp +.LP +The \fBdevfs\fR filesystem manages a name space of all devices under the +Solaris operating environment and is mounted during boot on the \fB/devices\fR +name space. +.sp +.LP +The \fB/devices\fR name space is dynamic and reflects the current state of +accessible devices under the Solaris operating environment. The names of all +attached device instances are present under \fB/devices\fR. +.sp +.LP +The content under \fB/devices\fR is under the exclusive control of the +\fBdevfs\fR filesystem and cannot be changed. +.sp +.LP +The system may be configured to include a device in one of two ways: +.br +.in +2 +By means of dynamic reconfiguration (DR), using, for example, \fBcfgadm\fR(1M). +.in -2 +.br +.in +2 +For devices driven by \fBdriver.conf\fR(4) enumeration, edit the +\fBdriver.conf\fR file to add a new entry, then use \fBupdate_drv\fR(1M) to +cause the system to re-read the \fBdriver.conf\fR file and thereby enumerate +the instance. +.in -2 +.sp +.LP +The device may be attached through a number of system calls and programs, +including \fBopen\fR(2), \fBstat\fR(2) and \fBls\fR(1). During device attach, +the device driver typically creates minor nodes corresponding to the device via +\fBddi_create_minor_node\fR(9F). If the attach is successful, one or more minor +nodes referring to the device are created under \fB/devices\fR. +.sp +.LP +Operations like \fBmknod\fR(2), \fBmkdir\fR(2) and \fBcreat\fR(2) are not +supported in \fB/devices\fR. +.SH FILES +.sp +.ne 2 +.mk +.na +\fB/devices\fR +.ad +.RS 12n +.rt +Mount point for \fBdevfs\fR file system +.RE + +.SH SEE ALSO +.sp +.LP +\fBdevfsadm\fR(1M), \fBvfstab\fR(4), \fBattach\fR(9E) +.SH NOTES +.sp +.LP +The \fB/devices\fR name space cannot be unmounted. +.sp +.LP +All content at or below the \fB/devices\fR name space is an implementation +artifact and subject to incompatible change or removal without notification. diff --git a/usr/src/man/man7fs/hsfs.7fs b/usr/src/man/man7fs/hsfs.7fs new file mode 100644 index 0000000000..b498d545dc --- /dev/null +++ b/usr/src/man/man7fs/hsfs.7fs @@ -0,0 +1,304 @@ +'\" te +.\" Copyright (c) 2006, Sun Microsystems, Inc. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH hsfs 7FS "1 Nov 2006" "SunOS 5.11" "File Systems" +.SH NAME +hsfs \- High Sierra & ISO 9660 CD-ROM file system +.SH DESCRIPTION +.sp +.LP +\fBHSFS\fR is a file system type that allows users to access files on High +Sierra or \fBISO\fR 9660 format \fBCD-ROM\fR disks from within the SunOS +operating system. Once mounted, a \fBHSFS\fR file system provides standard +SunOS read-only file system operations and semantics, meaning that you can read +and list files in a directory on a High Sierra or \fBISO\fR 9660 \fBCD-ROM\fR +and applications can use standard UNIX system calls on these files and +directories. +.sp +.LP +This file system contains support for Rock Ridge, ISO 9660 Version 2 and Joliet +extensions. These extensions provide support for file names with a length of +at least 207 bytes, but only Rock Ridge extensions (with the exception of +writability and hard links) can provide file system semantics and file types as +they are found in UFS. The presence of Rock Ridge, ISO 9660 Version 2 and +Joliet is autodetected and the best-suitable available extension is used by +the HSFS driver for file name and attribute lookup. +.sp +.LP +If your \fB/etc/vfstab\fR file contains a line similar to the following: +.sp +.in +2 +.nf +/dev/dsk/c0t6d0s0 \(mi/hsfs hsfs \fB-no\fR ro +.fi +.in -2 + +.sp +.LP +and \fB/hsfs\fR exists, you can mount an \fBHSFS\fR file system with either of +the following commands: +.sp +.in +2 +.nf +mount \fB-F\fR hsfs \fB-o\fR ro \fIdevice-special\fR \fIdirectory-name\fR +.fi +.in -2 + +.sp +.LP +or +.sp +.in +2 +.nf +mount /hsfs +.fi +.in -2 + +.sp +.LP +By default, Rock Ridge extensions are used if available, otherwise ISO 9660 +Version 2, then Joliet are used. If neither extension is present HSFS defaults +to the standard capabilities of ISO 9660. Since so-called hybrid CD-ROMs that +contain multiple extensions are possible, you can use the following mount +options to deliberately disable the search for a specific extension or to +force the use of a specific extension even if a preferable type is present: +.sp +.in +2 +.nf +mount \fB-F\fR hsfs \fB-o\fR ro,nrr \fIdevice-special\fR \fIdirectory-name\fR +.fi +.in -2 + +.sp +.LP +Mount options are: +.sp +.LP +rr\(emrequest HSFS to use Rock Ridge extensions, if present. This is the +default behavior and does not need to be explicitly specified. +.sp +.LP +nrr\(emdisable detection and use of Rock Ridge extensions, even if present. +.sp +.LP +vers2\(emrequest HSFS to use \fIISO 9660\fR Version 2 extensions, even if Rock +Ridge is available. +.sp +.LP +novers2\(emdisable detection and use of \fIISO 9660\fR Version 2 extensions. +.sp +.LP +joliet\(emrequest HSFS to use Joliet extensions, even if Rock Ridge or \fIISO +9660\fR Version 2 extensions are available. +.sp +.LP +nojoliet\(emdisable detection and use of Joliet extensions. +.sp +.LP +Files on a High Sierra or \fBISO\fR 9660 \fBCD-ROM\fR disk have names of the +form \fIfilename.ext;version\fR, where \fIfilename\fR and the optional +\fIext\fR consist of a sequence of uppercase alphanumeric characters (including +``_''), while the \fIversion\fR consists of a sequence of digits, representing +the version number of the file. \fBHSFS\fR converts all the uppercase +characters in a file name to lowercase, and truncates the ``;'' and version +information. If more than one version of a file is present on the +\fBCD-ROM\fR, only the file with the highest version number is accessible. +.sp +.LP +Conversion of uppercase to lowercase characters may be disabled by using the +\fB-o\fR \fBnomaplcase\fR option to \fBmount\fR(1M). (See +\fBmount_hsfs\fR(1M)). +.sp +.LP +If the \fBCD-ROM\fR contains Rock Ridge, ISO 9660 version 2 or Joliet +extensions, the file names and directory names may contain any character +supported under \fBUFS.\fR The names may also be upper and/or lower case and +are case sensitive. File name lengths can be as long as those of \fBUFS\fR. +.sp +.LP +Files accessed through \fBHSFS\fR have mode 555 (owner, group and world +readable and executable), uid 0 and gid 3. If a directory on the \fBCD-ROM\fR +has read permission, \fBHSFS\fR grants execute permission to the directory, +allowing it to be searched. +.sp +.LP +With Rock Ridge extensions, files and directories can have any permissions that +are supported on a \fBUFS\fR file system. However, under all write +permissions, the file system is read-only, with \fBEROFS\fR returned to any +write operations. +.sp +.LP +Like High Sierra and \fBISO\fR 9660 \fBCD-ROMs\fR, HSFS supports only regular +files and directories. A Rock Ridge \fBCD-ROM\fR can support regular files, +directories, and symbolic links, as well as device nodes, such as block, +character, and FIFO. +.SH EXAMPLES +.LP +\fBExample 1 \fRSample Display of File System Files +.sp +.LP +If there is a file \fBBIG.BAR\fR on a High Sierra or \fBISO\fR 9660 format +\fBCD-ROM\fR it will show up as \fBbig.bar\fR when listed on a \fBHSFS\fR file +system. + +.sp +.LP +If there are three files + +.sp +.in +2 +.nf +\fBBAR.BAZ;1\fR +.fi +.in -2 + +.sp +.in +2 +.nf +\fBBAR.BAZ;2\fR +.fi +.in -2 + +.sp +.LP +and + +.sp +.in +2 +.nf +\fBBAR.BAZ;3\fR +.fi +.in -2 + +.sp +.LP +on a High Sierra or \fBISO\fR 9660 format \fBCD-ROM,\fR only the file +\fBBAR.BAZ;3\fR will be accessible. It will be listed as \fBbar.baz\fR. + +.SH SEE ALSO +.sp +.LP +\fBmount\fR(1M), \fBmount_hsfs\fR(1M), \fBvfstab\fR(4) +.sp +.LP +N. V. Phillips and Sony Corporation, \fISystem Description Compact Disc Digital +Audio\fR, ("Red Book"). +.sp +.LP +N. V. Phillips and Sony Corporation, \fISystem Description of Compact Disc Read +Only Memory\fR, ("Yellow Book"). +.sp +.LP +IR "Volume and File Structure of CD-ROM for Information Interchange", ISO +9660:1988(E). +.SH DIAGNOSTICS +.sp +.ne 2 +.mk +.na +\fBhsfs: Warning: the file system... \fR +.ad +.br +.na +\fBdoes not conform to the ISO-9660 spec\fR +.ad +.sp .6 +.RS 4n +The specific reason appears on the following line. You might be attempting to +mount a \fBCD-ROM\fR containing a different file system, such as \fBUFS\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fBhsfs: Warning: the file system... \fR +.ad +.br +.na +\fBcontains a file [with an] unsupported type\fR +.ad +.sp .6 +.RS 4n +The \fBhsfs\fR file system does not support the format of some file or +directory on the \fBCD-ROM,\fR for example a record structured file. +.RE + +.sp +.ne 2 +.mk +.na +\fBhsfs: hsnode table full, %d nodes allocated\fR +.ad +.sp .6 +.RS 4n +There are not enough \fBHSFS\fR internal data structure elements to handle all +the files currently open. This problem may be overcome by adding a line of the +form \fBset hsfs:nhsnode=\fR\fInumber\fR to the \fB/etc/system\fR system +configuration file and rebooting. See \fBsystem\fR(4). +.RE + +.SH WARNINGS +.sp +.LP +Do not physically eject a \fBCD-ROM\fR while the device is still mounted as a +\fBHSFS\fR file system. +.sp +.LP +Under \fBMS-DOS\fR (for which \fBCD-ROMs\fR are frequently targeted), files +with no extension may be represented either as: +.sp +.in +2 +.nf +\fIfilename.\fR +.fi +.in -2 + +.sp +.LP +or +.sp +.in +2 +.nf +\fIfilename\fR +.fi +.in -2 + +.sp +.LP +that is, with or without a trailing period. These names are not equivalent +under UNIX systems. For example, the names: +.sp +.in +2 +.nf +\fBBAR.\fR +.fi +.in -2 + +.sp +.LP +and +.sp +.in +2 +.nf +\fBBAR\fR +.fi +.in -2 + +.sp +.LP +are not names for the same file under the UNIX system. This may cause confusion +if you are consulting documentation for \fBCD-ROMs\fR originally intended for +\fBMS-DOS\fR systems. +.sp +.LP +Use of the \fB-o\fR \fBnotraildot\fR option to \fBmount\fR(1M) makes it +optional to specify the trailing dot. (See \fBmount_hsfs\fR(1M)). +.SH NOTES +.sp +.LP +No translation of any sort is done on the contents of High Sierra or \fBISO\fR +9660 format \fBCD-ROMs\fR; only directory and file names are subject to +interpretation by \fBHSFS.\fR diff --git a/usr/src/man/man7fs/lofs.7fs b/usr/src/man/man7fs/lofs.7fs new file mode 100644 index 0000000000..04ff8620ba --- /dev/null +++ b/usr/src/man/man7fs/lofs.7fs @@ -0,0 +1,91 @@ +'\" te +.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. +.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with +.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH lofs 7FS "31 Aug 2009" "SunOS 5.11" "File Systems" +.SH NAME +lofs \- loopback virtual file system +.SH SYNOPSIS +.LP +.nf +#include <sys/param.h> +#include <sys/mount.h> + +\fBint\fR \fBmount\fR (\fBconst char*\fR \fIdir\fR, \fBconst char*\fR \fIvirtual\fR, \fBint\fR \fImflag\fR, \fB\fR\fIlofs\fR, \fB\fR\fINULL\fR, \fB\fR\fI0\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The loopback file system device allows new, virtual file systems to be created, +which provide access to existing files using alternate pathnames. Once the +virtual file system is created, other file systems can be mounted within it, +without affecting the original file system. However, file systems which are +subsequently mounted onto the original file system \fIare\fR visible to the +virtual file system, unless or until the corresponding mount point in the +virtual file system is covered by a file system mounted there. +.sp +.LP +\fIvirtual\fR is the mount point for the virtual file system. \fIdir\fR is the +pathname of the existing file system. \fImflag\fR specifies the mount options; +the \fBMS_DATA\fR bit in \fImflag\fR must be set. If the \fBMS_RDONLY\fR bit +in \fImflag\fR is not set, accesses to the loop back file system are the same +as for the underlying file system. Otherwise, all accesses in the loopback file +system will be read-only. All other \fBmount\fR(2) options are inherited from +the underlying file systems. +.sp +.LP +A loopback mount of '\fB/\fR' onto \fB/tmp/newroot\fR allows the entire file +system hierarchy to appear as if it were duplicated under \fB/tmp/newroot\fR, +including any file systems mounted from remote \fBNFS\fR servers. All files +would then be accessible either from a pathname relative to '\fB/\fR' or from a +pathname relative to \fB/tmp/newroot\fR until such time as a file system is +mounted in \fB/tmp/newroot\fR, or any of its subdirectories. +.sp +.LP +Loopback mounts of '\fB/\fR' can be performed in conjunction with the +\fBchroot\fR(2) system call, to provide a complete virtual file system to a +process or family of processes. +.sp +.LP +Recursive traversal of loopback mount points is not allowed. After the loopback +mount of \fB/tmp/newroot\fR, the file \fB/tmp/newroot/tmp/newroot\fR does not +contain yet another file system hierarchy; rather, it appears just as +\fB/tmp/newroot\fR did before the loopback mount was performed (for example, as +an empty directory). +.SS "Examples" +.sp +.LP +\fBlofs\fR file systems are mounted using: +.sp +.in +2 +.nf +\fBmount\fR \fB-F\fR lofs /tmp /mnt +.fi +.in -2 +.sp + +.SH SEE ALSO +.sp +.LP +\fBlofiadm\fR(1M), \fBmount\fR(1M), \fBchroot\fR(2), \fBmount\fR(2), +\fBsysfs\fR(2), \fBvfstab\fR(4), \fBlofi\fR(7D) +.SH NOTES +.sp +.LP +All access to entries in \fBlofs\fR mounted file systems map to their +underlying file system. If a mount point is made available in multiple +locations via \fBlofs\fR and is busy in any of those locations, an attempt to +mount a file system at that mount point fails unless the overlay flag is +specified. See \fBmount\fR(1M). Examples of a mount point being busy within a +\fBlofs\fR mount include having a file system mounted on it or it being a +processes' current working directory. +.SH WARNINGS +.sp +.LP +Because of the potential for confusing users and applications, you should use +loopback mounts with care. A loopback mount entry in \fB/etc/vfstab\fR must be +placed after the mount points of both directories it depends on. This is most +easily accomplished by making the loopback mount entry the last in +\fB/etc/vfstab\fR. diff --git a/usr/src/man/man7fs/objfs.7fs b/usr/src/man/man7fs/objfs.7fs new file mode 100644 index 0000000000..d41d9e33e3 --- /dev/null +++ b/usr/src/man/man7fs/objfs.7fs @@ -0,0 +1,65 @@ +'\" te +.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH objfs 7FS "30 August 2004" "SunOS 5.11" "File Systems" +.SH NAME +objfs \- Kernel object filesystem +.SH DESCRIPTION +.sp +.LP +The \fBobjfs\fR filesystem describes the state of all modules currently loaded +by the kernel. It is mounted during boot at \fB/system/object\fR. +.sp +.LP +The contents of the filesystem are dynamic and reflect the current state of the +system. Each module is represented by a directory containing a single +file, 'object.' The object file is a read only ELF file which contains information +about the object loaded in the kernel. +.sp +.LP +The kernel may load and unload modules dynamically as the system runs. As a +result, applications may observe different directory contents in +\fB/system/object\fR if they repeatedly rescan the directory. If a module is +unloaded, its associated \fB/system/object\fR files disappear from the +hierarchy and subsequent attempts to open them, or to read files opened before +the module unloaded, elicits an error. +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/system/object\fR\fR +.ad +.RS 18n +.rt +Mount point for objfs file system +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityPrivate +.TE + +.SH SEE ALSO +.sp +.LP +\fBvfstab\fR(4) +.SH NOTES +.sp +.LP +The content of the ELF files is private to the implementation and subject to +change without notice. diff --git a/usr/src/man/man7fs/pcfs.7fs b/usr/src/man/man7fs/pcfs.7fs new file mode 100644 index 0000000000..cfea4d8dff --- /dev/null +++ b/usr/src/man/man7fs/pcfs.7fs @@ -0,0 +1,519 @@ +'\" te +.\" Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH pcfs 7FS "6 Nov 2007" "SunOS 5.11" "File Systems" +.SH NAME +pcfs \- FAT formatted file system +.SH SYNOPSIS +.LP +.nf +#include <sys/param.h> +#include <sys/mount.h> +#include <sys/fs/pc_fs.h> + +\fBint\fR \fBmount\fR(\fBconst char *\fR\fIspec\fR, + \fBconst char *\fR \fIdir\fR, \fBint\fR \fImflag\fR, + \fB"pcfs", NULL, 0,\fR \fBchar *\fR\fIoptptr\fR, + \fBint\fR \fIoptlen\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +\fBpcfs\fR is a file system type that enables direct access to files on +\fBFAT\fR formatted disks from within the SunOS operating system. +.sp +.LP +Once mounted, \fBpcfs\fR provides standard SunOS file operations and semantics. +Using \fBpcfs\fR, you can create, delete, read, and write files on a \fBFAT\fR +formatted disk. You can also create and delete directories and list files in a +directory. +.sp +.LP +\fBpcfs\fR supports FAT12 (floppies) and FAT16 and FAT32 file systems. +.sp +.LP +\fBpcfs\fR file systems can be force umounted using the \fB-f\fR argument to +\fBumount\fR(1M). +.sp +.LP +The \fBpcfs\fR file system contained on the block special file identified by +\fIspec\fR is mounted on the directory identified by \fIdir\fR. \fIspec\fR and +\fIdir\fR are pointers to pathnames. \fImflag\fR specifies the \fBmount\fR +options. The \fBMS_DATA\fR bit in \fImflag\fR must be set. Mount options can be +passed to \fBpcfs\fR using the optptr and optlen arguments. See +\fBmount_pcfs\fR(1M) for a list of mount options supported by \fBpcfs\fR. +.sp +.LP +Because FAT formatted media can record file timestamps between January 1st 1980 +and December 31st 2127, it's not possible to fully represent UNIX \fBtime_t\fR +in \fBpcfs\fR for 32 bit or 64 bit programs. In particular, if post-2038 +timestamps are present on a FAT formatted medium and \fBpcfs\fR returns these, +32bit applications may unexpectedly fail with \fBEOVERFLOW\fR errors. To +prevent this, the default behaviour of \fBpcfs\fR has been modified to clamp +post-2038 timestamps to the latest possible value for a 32bit \fBtime_t\fR, +which is January 19th 2038, 03:14:06 UTC when setting and retrieving file +timestamps. You can override this behavior using the \fBnoclamptime\fR mount +option, as described in \fBmount_pcfs\fR(1M). +.sp +.LP +Timestamps on FAT formatted media are recorded in local time. If the recording +and receiving systems use different timezones, the representation of +timestamps shown on the two systems for the same medium might vary. To correct +this, \fBpcfs\fR provides a timezone mount option to force interpretation +of timestamps as read from a FAT formatted medium in a given timezone (that of +the recorder). By default, the local timezone of the receiver is used. See +\fBmount_pcfs\fR(1M) for details. +.sp +.LP +The root directory of a FAT formatted medium has no timestamps and \fBpcfs\fR +returns the time when the mount was done as timestamp for the root of the +filesystem. +.sp +.LP +The FAT filesystem doesn't support multiple links. As a result, the link count +for all files and directories in \fBpcfs\fR is hard-coded as "1." +.SS "Mounting File Systems" +.sp +.LP +Use the following command to mount \fBpcfs\fR from diskette: +.sp +.in +2 +.nf +mount \fB-F\fR pcfs \fIdevice-special\fR \fIdirectory-name\fR +.fi +.in -2 +.sp + +.sp +.LP +You can use: +.sp +.in +2 +.nf +mount \fIdirectory-name\fR +.fi +.in -2 +.sp + +.sp +.LP +if the following line is in your \fB/etc/vfstab\fR file: +.sp +.in +2 +.nf +\fIdevice-special\fR - \fIdirectory-name\fRpcfs \(mi no rw +.fi +.in -2 + +.sp +.LP +Use the following command to mount \fBpcfs\fR from non-diskette media: +.sp +.in +2 +.nf +mount \fB-F\fR pcfs \fIdevice-special\fR:\fIlogical-drive\fR \fBdirectory-name\fR +.fi +.in -2 +.sp + +.sp +.LP +You can use: +.sp +.in +2 +.nf +mount \fIdirectory-name\fR +.fi +.in -2 +.sp + +.sp +.LP +if the following line is in your \fB/etc/vfstab\fR file: +.sp +.in +2 +.nf +\fIdevice-special\fR:\fIlogical_drive\fR \fB\(mi\fR \fIdirectory-name\fR \fBpcfs \(mi no rw\fR +.fi +.in -2 + +.sp +.LP +\fIdevice-special\fR specifies the special block device file for the diskette +(\fB/dev/diskette\fIN\fR\fR) or the entire hard disk +(\fB/dev/dsk/c\fIN\fRt\fIN\fRd\fIN\fRp0\fR for a SCSI disk, and +\fB/dev/dsk/c\fIN\fRd\fIN\fRp0\fR for \fBIDE\fR disks) or the \fBPCMCIA\fR +pseudo-floppy memory card (\fB/dev/dsk/c\fIN\fRt\fIN\fRd\fIN\fRs\fIN\fR\fR). +.sp +.LP +\fIlogical-drive\fR specifies either the \fBDOS\fR logical drive letter +(\fBc\fR through \fBz\fR) or a drive number (\fB1\fR through \fB24\fR). Drive +letter \fBc\fR is equivalent to drive number \fB1\fR and represents the Primary +\fBDOS\fR partition on the disk; drive letters \fBd\fR through \fBz\fR are +equivalent to drive numbers \fB2\fR through \fB24\fR, and represent \fBDOS\fR +drives within the Extended \fBFAT\fR partition. Note that \fIdevice-special\fR +and \fIlogical-drive\fR must be separated by a colon. +.sp +.LP +\fIdirectory-name\fR specifies the location where the file system is mounted. +.sp +.LP +For example, to mount the Primary \fBDOS\fR partition from a SCSI hard disk, +use: +.sp +.in +2 +.nf +mount \fB-F\fR pcfs /dev/dsk/c\fIN\fRt\fIN\fRd\fIN\fRp0:c /pcfs/c +.fi +.in -2 +.sp + +.sp +.LP +To mount the first logical drive in the Extended \fBDOS\fR partition from an +\fBIDE\fR hard disk, use: +.sp +.in +2 +.nf +mount \fB-F\fR pcfs /dev/dsk/c\fIN\fRd\fIN\fRp0:d /pcfs/d +.fi +.in -2 +.sp + +.sp +.LP +To mount a \fBDOS\fR diskette in the first floppy drive when volume management +is not running use: +.sp +.in +2 +.nf +mount \fB-F\fR pcfs /dev/diskette /pcfs/a +.fi +.in -2 +.sp + +.sp +.LP +If Volume Management is running, run \fBvolcheck\fR(1) to automatically mount +the floppy and some removable disks. +.sp +.LP +To mount a \fBPCMCIA\fR pseudo-floppy memory card, with Volume Management not +running (or not managing the \fBPCMCIA\fR media), use: +.sp +.in +2 +.nf +mount \fB-F\fR pcfs /dev/dsk/c\fIN\fRt\fIN\fRd\fIN\fRs\fIN\fR /pcfs +.fi +.in -2 +.sp + +.SS "Conventions" +.sp +.LP +Files and directories created through \fBpcfs\fR must comply with either the +\fBFAT\fR short file name convention or the long file name convention +introduced with Windows 95. The \fBFAT\fR short file name convention is of the +form \fIfilename\fR[.\fIext\fR], where \fIfilename\fR generally consists of +from one to eight upper-case characters, while the optional \fIext\fR consists +of from one to three upper-case characters. +.sp +.LP +The long file name convention is much closer to Solaris file names. A long file +name can consist of any characters valid in a short file name, lowercase +letters, non-leading spaces, the characters \fB+,;=[]\fR, any number of +periods, and can be up to 255 characters long. Long file names have an +associated short file name for systems that do not support long file names +(including earlier releases of Solaris). The short file name is not visible if +the system recognizes long file names. \fBpcfs\fR generates a unique short name +automatically when creating a long file name. +.sp +.LP +Given a long file name such as \fBThis is a really long filename.TXT\fR, the +short file name will generally be of the form \fBTHISIS~\fR\fIN\fR\fB\&.TXT\fR, +where \fIN\fR is a number. The long file name will probably get the short name +\fBTHISIS~1.TXT\fR, or \fBTHISIS~2.TXT\fR if \fBTHISIS~1.TXT\fR already exits +(or \fBTHISIS~3.TXT\fR if both exist, and so forth). If you use \fBpcfs\fR file +systems on systems that do not support long file names, you may want to +continue following the short file name conventions. See \fBEXAMPLES\fR. +.sp +.LP +When creating a file name, \fBpcfs\fR creates a short file name if it fits the +\fBFAT\fR short file name format, otherwise it creates a long file name. This +is because long file names take more directory space. Because the root +directory of a \fBpcfs\fR file system is fixed size, long file names in the +root directory should be avoided if possible. +.sp +.LP +When displaying file names, \fBpcfs\fR shows them exactly as they are on the +media. This means that short names are displayed as uppercase and long file +names retain their case. Earlier versions of \fBpcfs\fR folded all names to +lowercase, which can be forced with the \fBPCFS_MNT_FOLDCASE\fR mount option. +All file name searches within \fBpcfs\fR, however, are treated as if they were +uppercase, so \fBreadme.txt\fR and \fBReAdMe.TxT\fR refer to the same file. +.sp +.LP +To format a diskette or a \fBPCMCIA\fR pseudo-floppy memory card in \fBFAT\fR +format in the SunOS system, use either the \fBfdformat\fR \fB-d\fR or the +\fBDOS\fR \fBFORMAT\fR command. +.SS "Boot Partitions" +.sp +.LP +On x86 systems, hard drives may contain an \fBfdisk\fR partition reserved for +the Solaris boot utilities. These partitions are special instances of +\fBpcfs\fR. You can mount an x86 boot partition with the command: +.sp +.in +2 +.nf +mount \fB-F\fR pcfs \fIdevice-special\fR:boot \fIdirectory-name\fR +.fi +.in -2 +.sp + +.sp +.LP +or you can use: +.sp +.in +2 +.nf +\fBmount \fIdirectory-name\fR\fR +.fi +.in -2 +.sp + +.sp +.LP +if the following line is in your \fB/etc/vfstab\fR file: +.sp +.in +2 +.nf +\fIdevice-special\fR:boot \(mi \fIdirectory-name\fR pcfs \(mi no rw +.fi +.in -2 +.sp + +.sp +.LP +\fIdevice-special\fR specifies the special block device file for the entire +hard disk (\fB/dev/dsk/c\fIN\fRt\fIN\fRd\fIN\fRp0\fR) +.sp +.LP +\fIdirectory-name\fR specifies the location where the file system is mounted. +.sp +.LP +All files on a boot partition are owned by super-user. Only the super-user may +create, delete, or modify files on a boot partition. +.SH EXAMPLES +.LP +\fBExample 1 \fRSample Displays of File Names +.sp +.LP +If you copy a file \fBfinancial.data\fR from a UNIX file system to \fBpcfs\fR, +it displays as \fBfinancial.data\fR in \fBpcfs\fR, but may show up as +\fBFINANC~1.DAT\fR in systems that do not support long file names. + +.sp +.LP +The following are legal long file names. They are also \fBillegal\fR short file +names: + +.br +.in +2 +\fBtest.sh.orig\fR +.in -2 +.br +.in +2 +\fBdata+\fR +.in -2 +.br +.in +2 +\fB\&.login\fR +.in -2 +.sp +.LP +Other systems that do not support long file names may see: + +.br +.in +2 +\fBTESTSH~1.ORI\fR +.in -2 +.br +.in +2 +\fBDATA~1\fR +.in -2 +.br +.in +2 +\fBLOGIN~1\fR +.in -2 +.sp +.LP +The short file name is generated from the initial characters of the long file +name, so differentiate names in the first few characters. For example, these +names: + +.br +.in +2 +\fBWorkReport.January.Data\fR +.in -2 +.br +.in +2 +\fBWorkReport.February.Data\fR +.in -2 +.br +.in +2 +\fBWorkReport.March.Data\fR +.in -2 +.sp +.LP +result in these short names, which are not distinguishable: + +.br +.in +2 +\fBWORKRE~1.DAT\fR +.in -2 +.br +.in +2 +\fBWORKRE~2.DAT\fR +.in -2 +.br +.in +2 +\fBWORKRE~13.DAT\fR +.in -2 +.sp +.LP +These names, however: + +.br +.in +2 +\fBJanuary.WorkReport.Data\fR +.in -2 +.br +.in +2 +\fBFebruary.WorkReport.Data\fR +.in -2 +.br +.in +2 +\fBMarch.WorkReport.Data\fR +.in -2 +.sp +.LP +result in the more descriptive short names: + +.br +.in +2 +\fBJANUAR~1.DAT\fR +.in -2 +.br +.in +2 +\fBFEBRUA~1.DAT\fR +.in -2 +.br +.in +2 +\fBMARCHW~1.DAT\fR +.in -2 +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/usr/lib/fs/pcfs/mount\fR\fR +.ad +.RS 26n +.rt +\fBpcfs\fR \fBmount\fR command +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/usr/kernel/fs/pcfs\fR\fR +.ad +.RS 26n +.rt +32-bit kernel module +.RE + +.SH ENVIRONMENT VARIABLES +.sp +.LP +See \fBenviron\fR(5) for descriptions of the following environment variables +for the current locale setting: LANG, LC_ALL, LC_CTYPE, and LC_COLLATE. +.SH SEE ALSO +.sp +.LP +\fBchgrp\fR(1), \fBchown\fR(1), \fBdos2unix\fR(1), \fBeject\fR(1), +\fBfdformat\fR(1), \fBunix2dos\fR(1), \fBvolcheck\fR(1), \fBmount\fR(1M), +\fBmount_pcfs\fR(1M), \fBumount\fR(1M), \fBctime\fR(3C), \fBvfstab\fR(4), +\fBenviron\fR(5), \fBpcmem\fR(7D) +.SH WARNINGS +.sp +.LP +Do not physically eject a \fBFAT\fR floppy while the device is mounted as +\fBpcfs\fR. If Volume Management is managing a device, use the \fBeject\fR(1) +command before physically removing media. +.sp +.LP +When mounting \fBpcfs\fR on a hard disk, make sure the first block on that +device contains a valid \fBfdisk\fR partition table. +.sp +.LP +Because \fBpcfs\fR has no provision for handling owner-IDs or group-IDs on +files, \fBchown\fR(1) or \fBchgrp\fR(1) may generate various errors. This is a +limitation of \fBpcfs\fR, but it should not cause problems other than error +messages. +.SH NOTES +.sp +.LP +Only the following characters are allowed in \fBpcfs\fR short file names and +extensions: +.br +.in +2 +\fB0-9\fR +.in -2 +.br +.in +2 +\fBA-Z\fR +.in -2 +.br +.in +2 +\fB$#&@!%()-{}<>`_^~|'\fR +.in -2 +.sp +.LP +SunOS and \fBFAT\fR use different character sets and have different +requirements for the text file format. Use the \fBdos2unix\fR(1) and +\fBunix2dos\fR(1) commands to convert files between them. +.sp +.LP +\fBpcfs\fR offers a convenient transportation vehicle for files between Sun +workstations and \fBPCs.\fR Because the \fBFAT\fR disk format was designed for +use under \fBDOS,\fR it does not operate efficiently under the SunOS system and +should not be used as the format for a regular local storage. Instead, use +\fBufs\fR for local storage within the SunOS system. +.sp +.LP +Although long file names can contain spaces (just as in UNIX file names), some +utilities may be confused by them. +.sp +.LP +This implementation of \fBpcfs\fR conforms to the behavior exhibited by Windows +95 version 4.00.950. +.sp +.LP +When \fBpcfs\fR encounters long file names with non-ASCII characters, it +converts such long file names in Unicode scalar values into UTF-8 encoded +filenames so that they are legible and usable with any of Solaris UTF-8 +locales. In the same context, when new file names with non-ASCII characters are +created, \fBpcfs\fR expects that such file names are in UTF-8. This feature +increases the interoperability of \fBpcfs\fR on Solaris with other operating +systems. +.SH BUGS +.sp +.LP +\fBpcfs\fR should handle the disk change condition in the same way that +\fBDOS\fR does, so you do not need to unmount the file system to change +floppies. diff --git a/usr/src/man/man7fs/sharefs.7fs b/usr/src/man/man7fs/sharefs.7fs new file mode 100644 index 0000000000..a4ee88bedb --- /dev/null +++ b/usr/src/man/man7fs/sharefs.7fs @@ -0,0 +1,43 @@ +'\" te +.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH sharefs 7FS "31 Oct 2007" "SunOS 5.11" "File Systems" +.SH NAME +sharefs \- Kernel sharetab filesystem +.SH DESCRIPTION +.sp +.LP +The \fBsharefs\fR filesystem describes the state of all shares currently loaded +by the kernel. It is mounted during boot time as a read-only file at +\fB/etc/dfs/sharetab\fR. +.sp +.LP +Filesystem contents are dynamic and reflect the current set of shares in the +system. File contents are described in \fBsharetab\fR(4). +.sp +.LP +File contents can be modified as a result of \fBshare\fR(1M), +\fBsharectl\fR(1M), \fBsharemgr\fR(1M) and changing properties of a +\fBzfs\fR(1M) data set. +.sp +.LP +The module may not be unloaded dynamically by the kernel. +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/etc/dfs/sharetab\fR\fR +.ad +.RS 21n +.rt +System record of shared file systems. +.RE + +.SH SEE ALSO +.sp +.LP +\fBshare\fR(1M), \fBsharectl\fR(1M), \fBsharemgr\fR(1M), \fBzfs\fR(1M), +\fBsharetab\fR(4) diff --git a/usr/src/man/man7fs/smbfs.7fs b/usr/src/man/man7fs/smbfs.7fs new file mode 100644 index 0000000000..095f8a818d --- /dev/null +++ b/usr/src/man/man7fs/smbfs.7fs @@ -0,0 +1,124 @@ +'\" te +.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. +.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with +.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH smbfs 7FS "9 Sep 2009" "SunOS 5.11" "File Systems" +.SH NAME +smbfs \- CIFS/SMB file system +.SH DESCRIPTION +.sp +.LP +The \fBsmbfs\fR file system allows you to mount CIFS shares that are exported +from Windows or compatible systems. SMB is the historical name for the CIFS +protocol, which stands for Server Message Block and is more commonly used in +technical contexts. +.sp +.LP +The \fBsmbfs\fR file system permits ordinary UNIX applications to change +directory into an \fBsmbfs\fR mount and perform simple file and directory +operations. Supported operations include \fBopen\fR, \fBclose\fR, \fBread\fR, +\fBwrite\fR, \fBrename\fR, \fBdelete\fR, \fBmkdir\fR, \fBrmdir\fR and \fBls\fR. +.SS "Limitations" +.sp +.LP +Some local UNIX file systems (for example UFS) have features that are not +supported by \fBsmbfs\fR. These include: +.RS +4 +.TP +.ie t \(bu +.el o +No mapped-file access because \fBmmap\fR(2) returns \fBENOSYS\fR. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Locking is \fBlocal only\fR and is not sent to the server. +.RE +.sp +.LP +The following are limitations in the CIFS protocol: +.RS +4 +.TP +.ie t \(bu +.el o +\fBunlink()\fR or \fBrename()\fR of open files returns \fBEBUSY\fR. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +\fBrename()\fR of extended attribute files returns \fBEINVAL\fR. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Creation of files with any of the following illegal characters returns +\fBEINVAL\fR: colon (\fB:\fR), backslash (\fB\\\fR), slash (\fB/\fR), asterisk +(\fB*\fR), question mark (\fB?\fR), double quote (\fB"\fR), less than +(\fB<\fR), greater than (\fB>\fR), and vertical bar (\fB|\fR). +.RE +.RS +4 +.TP +.ie t \(bu +.el o +\fBchmod\fR and \fBchown\fR settings are silently discarded. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Links are not supported. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Symbolic links are not supported. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +\fBmknod\fR is not supported. (Only file and directory objects are supported.) +.RE +.sp +.LP +The current \fBsmbfs\fR implementation does not support multi-user mounts. +Instead, each Unix user needs to make their own private mount points. +.sp +.LP +Currently, all access through an \fBsmbfs\fR mount point uses the Windows +credentials established by the user that ran the \fBmount\fR command. Normally, +permissions on \fBsmbfs\fR mount points should be \fB0700\fR to prevent Unix +users from using each others' Windows credentials. See the \fBdirperms\fR +option to \fBmount_smbfs\fR(1M) for details regarding how to control +\fBsmbfs\fR mount point permissions. +.sp +.LP +An important implication of this limitation is that system-wide mounts, such as +those made using \fB/etc/vfstab\fR or automount maps are only useful in cases +where access control is not a concern, such as for public read-only resources. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.39i) |cw(3.11i) +lw(2.39i) |lw(3.11i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityUncommitted +.TE + +.SH SEE ALSO +.sp +.LP +\fBsmbutil\fR(1), \fBmount_smbfs\fR(1M), \fBnsmbrc\fR(4), \fBattributes\fR(5) diff --git a/usr/src/man/man7fs/tmpfs.7fs b/usr/src/man/man7fs/tmpfs.7fs new file mode 100644 index 0000000000..fdd1e90a98 --- /dev/null +++ b/usr/src/man/man7fs/tmpfs.7fs @@ -0,0 +1,147 @@ +'\" te +.\" Copyright (c) 1990, Sun Microsystems, Inc. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH tmpfs 7FS "9 Oct 1990" "SunOS 5.11" "File Systems" +.SH NAME +tmpfs \- memory based file system +.SH SYNOPSIS +.LP +.nf +#include <sys/mount.h> + +\fB\fR\fBmount\fR (\fB\fR\fIspecial\fR, \fB\fR\fIdirectory\fR, \fB\fR\fIMS_DATA\fR, \fB\fR\fI"tmpfs"\fR, \fB\fR\fINULL\fR, \fB\fR\fI0\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +\fBtmpfs\fR is a memory based file system which uses kernel resources relating +to the \fBVM\fR system and page cache as a file system. Once mounted, a +\fBtmpfs\fR file system provides standard file operations and semantics. +\fBtmpfs\fR is so named because files and directories are not preserved across +reboot or unmounts, all files residing on a \fBtmpfs\fR file system that is +unmounted will be lost. +.sp +.LP +\fBtmpfs\fR file systems can be mounted with the command: +.sp +.in +2 +.nf +\fBmount \fR\fB-F\fR\fB tmpfs swap \fR\fIdirectory\fR +.fi +.in -2 + +.sp +.LP +Alternatively, to mount a \fBtmpfs\fR file system on \fB/tmp\fR at multi-user +startup time (maximizing possible performance improvements), add the following +line to \fB/etc/vfstab\fR: +.sp +.in +2 +.nf +\fBswap \(mi/tmp tmpfs \(mi yes \(mi\fR +.fi +.in -2 + +.sp +.LP +\fBtmpfs\fR is designed as a performance enhancement which is achieved by +caching the writes to files residing on a \fBtmpfs\fR file system. Performance +improvements are most noticeable when a large number of short lived files are +written and accessed on a \fBtmpfs\fR file system. Large compilations with +\fBtmpfs\fR mounted on \fB/tmp\fR are a good example of this. +.sp +.LP +Users of \fBtmpfs\fR should be aware of some constraints involved in mounting a +\fBtmpfs\fR file system. The resources used by \fBtmpfs\fR are the same as +those used when commands are executed (for example, swap space allocation). +This means that large sized \fBtmpfs\fR files can affect the amount of space +left over for programs to execute. Likewise, programs requiring large amounts +of memory use up the space available to \fBtmpfs\fR. Users running into this +constraint (for example, running out of space on \fBtmpfs\fR) can allocate more +swap space by using the \fBswap\fR(1M) command. +.sp +.LP +Another constraint is that the number of files available in a \fBtmpfs\fR file +system is calculated based on the physical memory of the machine and not the +size of the swap device/partition. If you have too many files, \fBtmpfs\fR will +print a warning message and you will be unable to create new files. You cannot +increase this limit by adding swap space. +.sp +.LP +Normal file system writes are scheduled to be written to a permanent storage +medium along with all control information associated with the file (for +example, modification time, file permissions). \fBtmpfs\fR control information +resides only in memory and never needs to be written to permanent storage. File +data remains in core until memory demands are sufficient to cause pages +associated with \fBtmpfs\fR to be reused at which time they are copied out to +swap. +.sp +.LP +An additional mount option can be specified to control the size of an +individual \fBtmpfs\fR file system. +.SH SEE ALSO +.sp +.LP +\fBdf\fR(1M), \fBmount\fR(1M), \fBmount_tmpfs\fR(1M), \fBswap\fR(1M), +\fBmmap\fR(2), \fBmount\fR(2), \fBumount\fR(2), \fBvfstab\fR(4) +.sp +.LP +\fISystem Administration Guide: Basic Administration\fR +.SH DIAGNOSTICS +.sp +.LP +If \fBtmpfs\fR runs out of space, one of the following messages will display in +the console. +.sp +.ne 2 +.mk +.na +\fB\fB\fIdirectory\fR: File system full, swap space limit exceeded\fR\fR +.ad +.sp .6 +.RS 4n +This message appears because a page could not be allocated while writing to a +file. This can occur if \fBtmpfs\fR is attempting to write more than it is +allowed, or if currently executing programs are using a lot of memory. To make +more space available, remove unnecessary files, exit from some programs, or +allocate more swap space using \fBswap\fR(1M). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB\fIdirectory\fR: File system full, memory allocation failed\fR\fR +.ad +.sp .6 +.RS 4n +\fBtmpfs\fR ran out of physical memory while attempting to create a new file or +directory. Remove unnecessary files or directories or install more physical +memory. +.RE + +.SH WARNINGS +.sp +.LP +Files and directories on a \fBtmpfs\fR file system are not preserved across +reboots or unmounts. Command scripts or programs which count on this will not +work as expected. +.SH NOTES +.sp +.LP +Compilers do not necessarily use \fB/tmp\fR to write intermediate files +therefore missing some significant performance benefits. This can be remedied +by setting the environment variable \fBTMPDIR\fR to \fB/tmp\fR. Compilers use +the value in this environment variable as the name of the directory to store +intermediate files. +.sp +.LP +\fBswap\fR to a \fBtmpfs\fR file is not supported. +.sp +.LP +\fBdf\fR(1M) output is of limited accuracy since a \fBtmpfs\fR file system size +is not static and the space available to \fBtmpfs\fR is dependent on the swap +space demands of the entire system. diff --git a/usr/src/man/man7fs/udfs.7fs b/usr/src/man/man7fs/udfs.7fs new file mode 100644 index 0000000000..a173778a4a --- /dev/null +++ b/usr/src/man/man7fs/udfs.7fs @@ -0,0 +1,83 @@ +'\" te +.\" Copyright (c) 1999 Sun Microsystems, Inc. +.\" All Rights Reserved. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH udfs 7FS "29 Mar 1999" "SunOS 5.11" "File Systems" +.SH NAME +udfs \- universal disk format file system +.SH DESCRIPTION +.sp +.LP +The \fBudfs\fR file system is a file system type that allows user access to +files on Universal Disk Format (UDF) disks from within the Solaris operating +environment. Once mounted, a \fBudfs\fR file system provides standard Solaris +file system operations and semantics. That is, users can read files, write +files, and list files in a directory on a UDF device and applications can use +standard UNIX system calls on these files and directories. +.sp +.LP +Because \fBudfs\fR is a platform-independent file system, the same media can be +written to and read from by any operating system or vendor. +.SS "Mounting File Systems" +.sp +.LP +\fBudfs\fR file systems are mounted using: +.sp +.in +2 +.nf +mount\fB-F\fR udfs -o rw/ro device-special +.fi +.in -2 +.sp + +.sp +.LP +Use: +.sp +.in +2 +.nf +mount /udfs +.fi +.in -2 +.sp + +.sp +.LP +if the \fB/udfs\fR and device special file \fB/dev/dsk/c0t6d0s0\fR are valid +and the following line (or similar line) appears in your \fB/etc/vfstab\fR +file: +.sp +.in +2 +.nf +/dev/dsk/c0t6d0s0 - /udfs udfs - no ro +.fi +.in -2 +.sp + +.sp +.LP +The \fBudfs\fR file system provides read-only support for ROM, RAM, and +sequentially-recordable media and read-write support on RAM media. +.sp +.LP +The \fBudfs\fR file system also supports regular files, directories, and +symbolic links, as well as device nodes such as block, character, FIFO, and +Socket. +.SH SEE ALSO +.sp +.LP +\fBmount\fR(1M), \fBmount_udfs\fR(1M), \fBvfstab\fR(4) +.SH NOTES +.sp +.LP +Invalid characters such as "\fINULL\fR" and "\fB/\fR" and invalid file names +such as "\fB\&.\fR" and "\fB\&..\fR" will be translated according to the +following rule: +.sp +.LP +Replace the invalid character with an "\fB_\fR," then append the file name with +\fB#\fR followed by a 4 digit hex representation of the 16-bit CRC of the +original \fBFileIdentifier\fR. For example, the file name ".." will become +"__#4C05" diff --git a/usr/src/man/man7fs/ufs.7fs b/usr/src/man/man7fs/ufs.7fs new file mode 100644 index 0000000000..e3c7f5208f --- /dev/null +++ b/usr/src/man/man7fs/ufs.7fs @@ -0,0 +1,276 @@ +'\" te +.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright 1989 AT&T +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. +.\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with +.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH ufs 7FS "18 Jun 2009" "SunOS 5.11" "File Systems" +.SH NAME +ufs \- UFS file system +.SH SYNOPSIS +.LP +.nf +\fB#include <sys/param.h>\fR +.fi + +.LP +.nf +\fB#include <sys/types.h>\fR +.fi + +.LP +.nf +\fB#include <sys/fs/ufs_fs.h>\fR +.fi + +.LP +.nf +\fB#include <sys/fs/ufs_inode.h>\fR +.fi + +.SH DESCRIPTION +.sp +.LP +\fBUFS\fR is the default disk-based file system for the Solaris environment. +The UFS file system is hierarchical, starting with its root directory (\fB/\fR) +and continuing downward through a number of directories. The root of a UFS file +system is \fBinode 2\fR. A UFS file system's root contents replace the contents +of the directory upon which it is mounted. +.sp +.LP +Subsequent sections of this manpage provide details of the UFS file systems. +.SS "State Flags (\fBfs_state\fR and \fBfs_clean\fR)" +.sp +.LP +UFS uses state flags to identify the state of the file system. \fBfs_state\fR +is \fBFSOKAY\fR - \fBfs_time\fR. \fBfs_time\fR is the timestamp that indicates +when the last system write occurred. \fBfs_state\fR is updated whenever +\fBfs_clean\fR changes. Some \fBfs_clean\fR values are: +.sp +.ne 2 +.mk +.na +\fB\fBFSCLEAN\fR\fR +.ad +.RS 12n +.rt +Indicates an undamaged, cleanly unmounted file system. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFSACTIVE\fR\fR +.ad +.RS 12n +.rt +Indicates a mounted file system that has modified data in memory. A mounted +file system with this state flag indicates that user data or metadata would be +lost if power to the system is interrupted. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFSSTABLE\fR\fR +.ad +.RS 12n +.rt +Indicates an idle mounted file system. A mounted file system with this state +flag indicates that neither user data nor metadata would be lost if power to +the system is interrupted. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBFSBAD\fR\fR +.ad +.RS 12n +.rt +Indicates that this file system contains inconsistent file system data. +.RE + +.sp +.ne 2 +.mk +.na +\fBFSLOG\fR +.ad +.RS 12n +.rt +Indicates that the file system has logging enabled. A file system with this +flag set is either mounted or unmounted. If a file system has logging enabled, +the only flags that it can have are \fBFSLOG\fR or \fBFSBAD\fR. A non-logging +file system can have \fBFSACTIVE\fR, \fBFSSTABLE\fR, or \fBFSCLEAN\fR. +.RE + +.sp +.LP +It is not necessary to run the \fBfsck\fR command on unmounted file systems +with a state of \fBFSCLEAN\fR, \fBFSSTABLE\fR, or \fBFSLOG\fR. \fBmount\fR(2) +returns \fBENOSPC\fR if an attempt is made to mount a \fBUFS\fR file system +with a state of \fBFSACTIVE\fR for read/write access. +.sp +.LP +As an additional safeguard, \fBfs_clean\fR should be trusted only if +\fBfs_state\fR contains a value equal to \fBFSOKAY\fR - \fBfs_time\fR, where +\fBFSOKAY\fR is a constant integer defined in the +\fB/usr/include/sys/fs/ufs_fs.h\fR file. Otherwise, \fBfs_clean\fR is treated +as though it contains the value of \fBFSACTIVE\fR. +.SS "Extended Fundamental Types (\fBEFT\fR)" +.sp +.LP +Extended Fundamental Types (EFT) provide 32-bit user ID (UID), group ID (GID), +and device numbers. +.sp +.LP +If a UID or GID contains an extended value, the short variable (\fBic_suid\fR, +\fBic_sgid\fR) contains the value 65535 and the corresponding UID or GID is in +\fBic_uid\fR or \fBic_gid\fR. Because numbers for block and character devices +are stored in the first direct block pointer of the inode (\fBic_db[0]\fR) and +the disk block addresses are already 32 bit values, no special encoding exists +for device numbers (unlike UID or GID fields). +.SS "Multiterabyte File System" +.sp +.LP +A multiterabyte file system enables creation of a UFS file system up to +approximately 16 terabytes of usable space, minus approximately one percent +overhead. A sparse file can have a logical size of one terabyte. However, the +actual amount of data that can be stored in a file is approximately one percent +less than one terabyte because of file system overhead. +.sp +.LP +On-disk format changes for a multiterabyte UFS file system include: +.RS +4 +.TP +.ie t \(bu +.el o +The magic number in the superblock changes from \fBFS_MAGIC\fR to +\fBMTB_UFS_MAGIC\fR. For more information, see the +\fB/usr/include/sys/fs/ufs_fs\fR file. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +The \fBfs_logbno\fR unit is a sector for UFS that is less than 1 terabyte in +size and fragments for a multiterabyte UFS file system. +.RE +.SS "UFS Logging" +.sp +.LP +UFS logging bundles the multiple metadata changes that comprise a complete UFS +operation into a transaction. Sets of transactions are recorded in an on-disk +log and are applied to the actual UFS file system's metadata. +.sp +.LP +UFS logging provides two advantages: +.RS +4 +.TP +1. +A file system that is consistent with the transaction log eliminates the +need to run \fBfsck\fR after a system crash or an unclean shutdown. +.RE +.RS +4 +.TP +2. +UFS logging often provides a significant performance improvement. This is +because a file system with logging enabled converts multiple updates to the +same data into single updates, thereby reducing the number of overhead disk +operations. +.RE +.sp +.LP +The UFS log is allocated from free blocks on the file system and is sized at +approximately 1 Mbyte per 1 Gbyte of file system, up to 256 Mbytes. The log +size may be larger (up to a maximum of 512 Mbytes), depending upon the number +of cylinder groups present in the file system. The log is continually flushed +as it fills up. The log is also flushed when the file system is unmounted or as +a result of a \fBlockfs\fR(1M) command. +.SS "Mounting UFS File Systems" +.sp +.LP +You can mount a UFS file system in various ways using syntax similar to the +following: +.RS +4 +.TP +1. +Use \fBmount\fR from the command line: +.sp +.in +2 +.nf +# mount -F ufs /dev/dsk/c0t0d0s7 /export/home +.fi +.in -2 +.sp + +.RE +.RS +4 +.TP +2. +Include an entry in the \fB/etc/vfstab\fR file to mount the file system at +boot time: +.sp +.in +2 +.nf +/dev/dsk/c0t0d0s7 /dev/rdsk/c0t0d0s7 /export/home ufs 2 yes - +.fi +.in -2 +.sp + +.RE +.sp +.LP +For more information on mounting UFS file systems, see \fBmount_ufs\fR(1M). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for a description of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityUncommitted +.TE + +.SH SEE ALSO +.sp +.LP +\fBdf\fR(1M), \fBfsck\fR(1M), \fBfsck_ufs\fR(1M), \fBfstyp\fR(1M), +\fBlockfs\fR(1M), \fBmkfs_ufs\fR(1M), \fBnewfs\fR(1M), \fBufsdump\fR(1M), +\fBufsrestore\fR(1M), \fBtunefs\fR(1M), \fBmount\fR(2), \fBattributes\fR(5) +.sp +.LP +\fIWriting Device Drivers\fR +.SH NOTES +.sp +.LP +For information about internal UFS structures, see \fBnewfs\fR(1M) and +\fBmkfs_ufs\fR(1M). For information about the \fBufsdump\fR and +\fBufsrestore\fR commands, see \fBufsdump\fR(1M), \fBufsrestore\fR(1M), and +\fB/usr/include/protocols/dumprestore.h\fR. +.sp +.LP +If you experience difficulty in allocating space on the ufs filesystem, it may +be due to framentation. Fragmentation can occur when you do not have sufficient +free blocks to satisfy an allocation request even though \fBdf\fR(1M) indicates +that enough free space is available. (This may occur because df only uses the +available fragment count to calculate available space, but the file system +requires contiguous sets of fragments for most allocations). If you suspect +that you have exhausted contiguous fragments on your file system, you can use +the \fBfstyp\fR(1M) utility with the -v option. In the \fBfstyp\fR output, +look at the \fInbfree\fR (number of blocks free) and \fInffree\fR (number +of fragments free) fields. On unmounted filesystems, you can use \fBfsck\fR(1M) +and observe the last line of output, which reports, among other items, the +number of fragments and the degree of fragmentation. To correct a fragmentation +problem, run \fBufsdump\fR(1M) and \fBufsrestore\fR(1M) on the ufs filesystem. |