usr/src/man/man1m/mkfs.1m

   1 '\" te
   2 .\"  Copyright (c) 2000, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH MKFS 1M "Nov 17, 2000"
   7 .SH NAME
   8 mkfs \- construct a file system
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBmkfs\fR [\fB-F\fR \fIFSType\fR] [\fIgeneric_options\fR]
  13      [\fB-o\fR \fIFSType-specific_options\fR] \fIraw_device_file\fR
  14      [\fIoperands\fR]
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBmkfs\fR utility constructs a file system on the \fIraw_device_file\fR by
  21 calling the specific \fBmkfs\fR module indicated by  \fB-F\fR\fI
  22 FSType\fR\fB\&.\fR
  23 .sp
  24 .LP
  25 \fBNote\fR: ufs file systems are normally created with the \fBnewfs\fR(1M)
  26 command.
  27 .sp
  28 .LP
  29 \fIgeneric_options\fR are independent of file system type.
  30 \fIFSType-specific_options\fR is a comma-separated  list of
  31 \fIkeyword\fR=\fIvalue\fR pairs (with no intervening spaces), which are
  32 \fIFSType\fR-specific. \fIraw_device_file\fR specifies the disk partition on
  33 which to write the file system. It is required and  must be the first argument
  34 following the  \fIspecific_options\fR (if any). \fIoperands\fR are
  35 \fIFSType\fR-specific. See the \fIFSType\fR-specific manual page of  \fBmkfs\fR
  36 (for example,  \fBmkfs_ufs \fR(1M)) for a detailed description.
  37 .SH OPTIONS
  38 .sp
  39 .LP
  40 The following are the generic options for \fBmkfs\fR:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB-F\fR\fR
  45 .ad
  46 .RS 6n
  47 Specify the  \fIFSType\fR to be constructed. If  \fB-F\fR is not specified, the
  48 \fIFSType\fR is determined from  \fB/etc/vfstab\fR by matching the
  49 \fIraw_device_file\fR with a  \fBvfstab\fR entry, or by consulting the
  50 \fB/etc/default/fs\fR file.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fB-V\fR\fR
  57 .ad
  58 .RS 6n
  59 Echo the complete command line, but do not execute the command. The command
  60 line is generated by using the options and arguments provided and adding to
  61 them information derived from  \fB/etc/vfstab\fR or  \fB/etc/default/fs\fR.
  62 This option may be used to verify and validate the command line.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fB-m\fR\fR
  69 .ad
  70 .RS 6n
  71 Return the command line which was used to create the file system. The file
  72 system must already exist. This option provides a means of determining the
  73 command used in constructing the file system.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fB-o\fR\fR
  80 .ad
  81 .RS 6n
  82 Specify  \fIFSType\fR-specific options. See the manual page for the  \fBmkfs\fR
  83 module specific to the file system type.
  84 .RE
  85
  86 .SH USAGE
  87 .sp
  88 .LP
  89 See \fBlargefile\fR(5) for the description of the behavior of \fBmkfs\fR when
  90 encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
  91 .SH FILES
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fB/etc/default/fs\fR\fR
  96 .ad
  97 .RS 19n
  98 Default file system type. Default values can be set for the following flags in
  99 \fB/etc/default/fs\fR. For example: \fBLOCAL=ufs\fR
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBLOCAL\fR\fR
 104 .ad
 105 .RS 9n
 106 The default partition for a command if no \fIFSType\fR is specified.
 107 .RE
 108
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fB/etc/vfstab\fR\fR
 115 .ad
 116 .RS 19n
 117 List of default parameters for each file system
 118 .RE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBmkfs_ufs\fR(1M), \fBnewfs\fR(1M), \fBvfstab\fR(4), \fBattributes\fR(5),
 124 \fBlargefile\fR(5)
 125 .sp
 126 .LP
 127 Manual pages for the  \fIFSType\fR-specific modules of  \fBmkfs\fR.
 128 .SH NOTES
 129 .sp
 130 .LP
 131 This command might not be supported for all \fIFSType\fRs.
 132 .sp
 133 .LP
 134 You can use \fBlofiadm\fR to create a file that appears to a \fBmkfs\fR command
 135 as a raw device. You can then use a \fBmkfs\fR command to create a file system
 136 on that device. See \fBlofiadm\fR(1M) for examples of creating a UFS and a PC
 137 (FAT) file system (using \fBmkfs_ufs\fR(1M) and \fBmkfs_pcfs\fR(1M)) on a
 138 device created by \fBlofiadm\fR.