release/src/router/ntfs-3g/src/ntfs-3g.usermap.8.in

   1 .\" Copyright (c) 2007-2009 Jean-Pierre André.
   2 .\" This file may be copied under the terms of the GNU Public License.
   3 .\"
   4 .TH NTFS-3G.USERMAP 8 "February 2010" "ntfs-3g.usermap 1.1.2"
   5 .SH NAME
   6 ntfs-3g.usermap \- NTFS Building a User Mapping File
   7 .SH SYNOPSIS
   8 .B ntfs-3g.usermap
   9 \fIwindows-system-device\fP
  10 \fB[\fIother-ntfs-device\fP...\fB]\fR
  11 .PP
  12 Where \fIwindows-system-device\fP is the device containing the Windows system
  13 whose users are to be mapped to current Linux system.
  14 .PP
  15 And \fIother-ntfs-device\fP is another device containing files which are
  16 to be accessed both by the Windows mentioned above and current Linux system.
  17 .PP
  18 the ntfs-3g.usermap command must be started as root, and the designated devices
  19 must not be mounted.
  20 .PP
  21 Typing ntfs-3g.usermap with no args will display a summary of command
  22 arguments.
  23 .SH DESCRIPTION
  24 \fBntfs-3g.usermap\fR
  25 creates the file defining the mapping of Windows accounts to Linux logins for
  26 users who owns files which should be visible from both Windows and
  27 Linux.
  28 .PP
  29 It relies on existing files which were created on Windows, trying
  30 to locate significant files and asking which Linux user or group should
  31 own them. When a Linux owner or group is requested, the reply may be :
  32 .PP
  33 - the uid or gid (numeric or symbolic) of Linux owner or group of the file.
  34 .RS
  35 In that situation, no more file with the same Windows owner will be selected.
  36 .RE
  37 - or no answer, when not able to define the owner or group.
  38 .RS
  39 In that situation another file owned by the same Windows user or group
  40 may be selected later so that a mapping can be defined.
  41 .RE
  42 .PP
  43 The mappings for standard Windows users, such as "Administrator" or
  44 "All Users" are defined implicitly. As a consequence a user mapping should
  45 never be defined as Linux root.
  46 .PP
  47 When there are no more significant files, ntfs-3g.usermap create the
  48 mapping file into the file UserMapping in the current directory. This
  49 file has to be moved to the hidden directory .NTFS-3G in the root of
  50 all the NTFS file systems to be shared between Windows and Linux. This
  51 requires the file system to be mounted, but the created file will not
  52 be taken into account if not present at mount time, which means the
  53 file system has to be unmounted and mounted again for the new mapping
  54 file to be taken into account.
  55 .SH OPTIONS
  56 No option is defined for ntfs-3g.usermap.
  57 .SH EXAMPLES
  58 Map the users defined on the Windows system present on /dev/sda1 :
  59 .RS
  60 .sp
  61 .B ntfs-3g.usermap /dev/sda1
  62 .sp
  63 .RE
  64 .PP
  65 A detailed example, with screen displays is available on
  66 http://pagesperso-orange.fr/b.andre/usermap.html
  67 .SH EXIT CODES
  68 .B ntfs-3g.usermap
  69 exits with a value of 0 when no error was detected, and with a value
  70 of 1 when an error was detected.
  71 .SH KNOWN ISSUES
  72 Please see
  73 .RS
  74 .sp
  75 http://www.tuxera.com/community/ntfs-3g-faq/
  76 .sp
  77 .RE
  78 for common questions and known issues.
  79 If you would find a new one in the latest release of
  80 the software then please send an email describing it
  81 in detail. You can contact the
  82 development team on the ntfs\-3g\-devel@lists.sf.net
  83 address.
  84 .SH AUTHORS
  85 .B ntfs-3g.secaudit
  86 has been developed by Jean-Pierre André.
  87 .SH THANKS
  88 Several people made heroic efforts, often over five or more
  89 years which resulted the ntfs-3g driver. Most importantly they are
  90 Anton Altaparmakov, Richard Russon, Szabolcs Szakacsits, Yura Pakhuchiy,
  91 Yuval Fledel, and the author of the groundbreaking FUSE filesystem development
  92 framework, Miklos Szeredi.
  93 .SH SEE ALSO
  94 .BR ntfsprogs (8),
  95 .BR attr (5),
  96 .BR getfattr (1)