release/src/router/ntfs-3g/ntfsprogs/ntfslabel.8.in

   1 .\" Copyright (c) 2002\-2004 Anton Altaparmakov.
   2 .\" Copyright (c) 2005 Richard Russon.
   3 .\" This file may be copied under the terms of the GNU Public License.
   4 .\"
   5 .TH NTFSLABEL 8 "November 2005" "ntfs-3g @VERSION@"
   6 .SH NAME
   7 ntfslabel \- display/change the label on an ntfs file system
   8 .SH SYNOPSIS
   9 .B ntfslabel
  10 [\fIoptions\fR] \fIdevice \fR[\fInew\-label\fR]
  11 .SH DESCRIPTION
  12 .B ntfslabel
  13 will display or change the file system label on the ntfs file system located on
  14 .IR device .
  15 It can also change the serial number of the
  16 .IR device .
  17 .PP
  18 If the optional argument
  19 .I new\-label
  20 is not present, and no option is present,
  21 .B ntfslabel
  22 will simply display the current file system label.
  23 .PP
  24 If the optional argument
  25 .I new\-label
  26 is present, then
  27 .B ntfslabel
  28 will set the file system label to be
  29 .IR new\-label .
  30 NTFS file system labels can be at most 128 Unicode characters long; if
  31 .I new\-label
  32 is longer than 128 Unicode characters,
  33 .B ntfslabel
  34 will truncate it and print a warning message.
  35 .PP
  36 It is also possible to set the file system label using the
  37 .B \-L
  38 option of
  39 .BR mkntfs (8)
  40 during creation of the file system.
  41 .SH OPTIONS
  42 Below is a summary of all the options that
  43 .B ntfslabel
  44 accepts.  Nearly all options have two equivalent names.  The short name is
  45 preceded by
  46 .B \-
  47 and the long name is preceded by
  48 .BR \-\- .
  49 Any single letter options, that don't take an argument, can be combined into a
  50 single command, e.g.
  51 .B \-fv
  52 is equivalent to
  53 .BR "\-f \-v" .
  54 Long named options can be abbreviated to any unique prefix of their name.
  55 .TP
  56 \fB\-f\fR, \fB\-\-force\fR
  57 This will override some sensible defaults, such as not working with a mounted
  58 volume.  Use this option with caution.
  59 .TP
  60 \fB\-h\fR, \fB\-\-help\fR
  61 Show a list of options with a brief description of each one.
  62 .TP
  63 \fB\-\-new\-serial\fR[\fI=ssssssssssssssss\fR], or
  64 .TP
  65 \fB\-\-new\-half\-serial\fR[\fI=ssssssss\fR]
  66 Set a new serial number to the device, either the argument value, or a random
  67 one if no argument is given. The serial number is a 64 bit number,
  68 represented as a sixteen-digit hexadecimal number, used to identify the
  69 device during the mounting process. As a consequence, two devices with the
  70 same serial number cannot be mounted at the same time on the same computer.
  71 This is not the volume UUID used by Windows to locate files which have been
  72 moved to another volume.
  73
  74 The option \-\-new\-half\-serial only changes the upper part of the serial
  75 number, keeping the lower part which is used by Windows unchanged.
  76 In this case the optional argument is an eight-digit hexadecimal number.
  77
  78 .TP
  79 \fB\-n\fR, \fB\-\-no\-action\fR
  80 Don't actually write to disk.
  81 .TP
  82 \fB\-q\fR, \fB\-\-quiet\fR
  83 Reduce the amount of output to a minimum.
  84 .TP
  85 \fB\-v\fR, \fB\-\-verbose\fR
  86 Increase the amount of output that
  87 .B ntfslabel
  88 prints. The label and the serial number are displayed.
  89 .TP
  90 \fB\-V\fR, \fB\-\-version\fR
  91 Show the version number, copyright and license for
  92 .BR ntfslabel .
  93 .SH BUGS
  94 There are no known problems with
  95 .BR ntfslabel .
  96 If you find a bug please send an email describing the problem to the
  97 development team:
  98 .br
  99 .nh
 100 ntfs\-3g\-devel@lists.sf.net
 101 .hy
 102 .SH AUTHORS
 103 .B ntfslabel
 104 was written by Matthew J. Fanto, with contributions from Anton Altaparmakov and
 105 Richard Russon.
 106 It was ported to ntfs-3g by Erik Larsson.
 107 .SH AVAILABILITY
 108 .B ntfslabel
 109 is part of the
 110 .B ntfs-3g
 111 package and is available from:
 112 .br
 113 .nh
 114 http://www.tuxera.com/community/
 115 .hy
 116 .SH SEE ALSO
 117 .BR mkntfs (8),
 118 .BR ntfsprogs (8)