ntfsprogs/ntfslabel.8.in

   1 .\" -*- nroff -*-
   2 .\" Copyright (c) 2002 Anton Altaparmakov. All Rights Reserved.
   3 .\" This file may be copied under the terms of the GNU Public License.
   4 .\" Adapted from e2fsprogs-1.26/misc/e2label.8.in by Theodore Ts'o.
   5 .\"
   6 .TH NTFSLABEL 8 "April 2002" "Linux-NTFS version @VERSION@"
   7 .SH NAME
   8 ntfslabel \- display/change the label on an ntfs file system
   9 .SH SYNOPSIS
  10 .B ntfslabel
  11 .I device
  12 [
  13 .I new-label
  14 ]
  15 .SH DESCRIPTION
  16 .B ntfslabel
  17 will display or change the file system label on the ntfs file system located on
  18 .IR device .
  19 .PP
  20 If the optional argument
  21 .I new-label
  22 is not present,
  23 .B ntfslabel
  24 will simply display the current file system label.
  25 .PP
  26 If the optional argument
  27 .I new-label
  28 is present, then
  29 .B ntfslabel
  30 will set the file system label to be
  31 .IR new-label .
  32 NTFS file system labels can be at most 128 Unicode characters long; if
  33 .I new-label
  34 is longer than 128 Unicode characters,
  35 .B ntfslabel
  36 will truncate it and print a warning message.
  37 .PP
  38 It is also possible to set the file system label using the
  39 .B \-L
  40 option of
  41 .BR mkntfs (8)
  42 during creation of the file system.
  43 .PP
  44 .SH AUTHOR
  45 .B ntfslabel
  46 was written by Matthew J. Fanto (fanto1mj@cmich.edu). This man page was written
  47 by Anton Altaparmakov (aia21@cantab.net).
  48 .SH AVAILABILITY
  49 .B ntfslabel
  50 is part of the linux-ntfs package and is available from
  51 http://linux-ntfs.sourceforge.net/.
  52 .SH SEE ALSO
  53 .BR mkntfs (8),
  54 .BR ntfsprogs (8)
  55