1 '\" te
   2 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
   3 .\" Copyright (c) 2002-2006 Szabolcs Szakacsits
   4 .\" Copyright (c) 2002-2005 Anton Altaparmakov
   5 .\" Copyright (c) 2002-2003 Richard Russon
   6 .\" Copyright (c) 2007 Yura Pakhuchiy
   7 .\" This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation ; either version 2 of the License, or (at your option) any later version.  This program is distributed
   8 .\" in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.  You should have received a copy of the GNU General Public License along with this program
   9 .\" (in the main directory of the Linux-NTFS distribution in the file COPYING);  if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 11-1307 USA
  10 .TH NTFSLABEL 1M "May 28, 2009"
  11 .SH NAME
  12 ntfslabel \- display or change the label on an NTFS file system
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBntfslabel\fR [\fIoptions\fR] \fIdevice\fR [\fInew_label\fR]
  17 .fi
  18 
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBntfslabel\fR utility displays or changes the file system label on the
  23 NTFS file system located on \fIdevice\fR (see Synopsis).
  24 .sp
  25 .LP
  26 If the optional argument \fInew_label\fR is not present, \fBntfslabel\fR
  27 displays the current file system label.
  28 .sp
  29 .LP
  30 If the optional argument \fInew_label\fR is present, \fBntfslabel\fR sets the
  31 file system label to be \fInew_label\fR. NTFS file system labels can be at most
  32 128 Unicode characters long; if \fInew_label\fR is longer than 128 Unicode
  33 characters, \fBntfslabel\fR truncates it and displays a warning message.
  34 .sp
  35 .LP
  36 It is also possible to set the file system label using the \fB-L\fR option of
  37 \fBmkntfs\fR(1M) during creation of the file system.
  38 .SH OPTIONS
  39 .sp
  40 .LP
  41 Supported options are listed below. Most options have both single-letter and
  42 full-name forms. Multiple single-letter options that do not take an argument
  43 can be combined. For example, \fB-fv\fR is the equivalent of \fB-f\fR \fB-v\fR.
  44 A full-name option can be abbreviated to a unique prefix of its name.
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fB-f\fR, \fB--force\fR\fR
  49 .ad
  50 .sp .6
  51 .RS 4n
  52 Overrides some sensible defaults, such as not working with a mounted volume.
  53 Use this option with caution.
  54 .RE
  55 
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fB-h\fR, \fB--help\fR\fR
  60 .ad
  61 .sp .6
  62 .RS 4n
  63 Show a list of options with a brief description of each.
  64 .RE
  65 
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB-n\fR, \fB--no-action\fR\fR
  70 .ad
  71 .sp .6
  72 .RS 4n
  73 Do not actually write a new label to disk.
  74 .RE
  75 
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fB-q\fR, \fB--quiet\fR\fR
  80 .ad
  81 .sp .6
  82 .RS 4n
  83 Suppress some debug, warning, and error messages.
  84 .RE
  85 
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB-V\fR, \fB--version\fR\fR
  90 .ad
  91 .sp .6
  92 .RS 4n
  93 Show the version number, copyright, and license information.
  94 .RE
  95 
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fB-v\fR, \fB--verbose\fR\fR
 100 .ad
 101 .sp .6
 102 .RS 4n
 103 Display more debug, warning, and error messages.
 104 .RE
 105 
 106 .SH ATTRIBUTES
 107 .sp
 108 .LP
 109 See \fBattributes\fR(5) for descriptions of the following attributes:
 110 .sp
 111 
 112 .sp
 113 .TS
 114 box;
 115 c | c
 116 l | l .
 117 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 118 _
 119 Interface Stability     Uncommitted
 120 .TE
 121 
 122 .SH SEE ALSO
 123 .sp
 124 .LP
 125 \fBmkntfs\fR(1M), \fBntfsprogs\fR(1M), \fBparted\fR(1M), \fBattributes\fR(5)
 126 .sp
 127 .LP
 128 http://wiki.linux-ntfs.org
 129 .SH AUTHORS
 130 .sp
 131 .LP
 132 \fBntfslabel\fR was written by Matthew J. Fanto, with  contributions from Anton
 133 Altaparmakov and Richard Russon.