| blob | 59b91be18554c874ae927ddf49e1e5b9682f89ba |
1 .\" Copyright (c) 2004\-2007 Yura Pakhuchiy.
2 .\" Copyright (c) 2005 Richard Russon.
3 .\" This file may be copied under the terms of the GNU Public License.
4 .\"
5 .TH NTFSCP 8 "September 2007" "ntfs-3g @VERSION@"
6 .SH NAME
7 ntfscp \- copy file to an NTFS volume.
8 .SH SYNOPSIS
9 \fBntfscp\fR [\fIoptions\fR] \fIdevice source_file destination\fR
10 .SH DESCRIPTION
11 \fBntfscp\fR will copy file to an NTFS volume. \fIdestination\fR can be either
12 file or directory. In case if \fIdestination\fR is directory specified by name
13 then \fIsource_file\fR is copied into this directory, in case if
14 \fIdestination\fR is directory and specified by inode number then unnamed data
15 attribute is created for this inode and \fIsource_file\fR is copied into it
16 (WARNING: it's unusual to have unnamed data streams in the directories, think
17 twice before specifying directory by inode number).
18 .SH OPTIONS
19 Below is a summary of all the options that
20 .B ntfscp
21 accepts. Nearly all options have two equivalent names. The short name is
22 preceded by
23 .B \-
24 and the long name is preceded by
25 .BR \-\- .
26 Any single letter options, that don't take an argument, can be combined into a
27 single command, e.g.
28 .B \-fv
29 is equivalent to
30 .BR "\-f \-v" .
31 Long named options can be abbreviated to any unique prefix of their name.
32 .TP
33 \fB\-a\fR, \fB\-\-attribute\fR NUM
34 Write to this attribute.
35 .TP
36 \fB\-i\fR, \fB\-\-inode\fR
37 Treat
38 .I destination
39 as inode number.
40 .TP
41 \fB\-N\fR, \fB\-\-attr\-name\fR NAME
42 Write to attribute with this name.
43 .TP
44 \fB\-n\fR, \fB\-\-no\-action\fR
45 Use this option to make a test run before doing the real copy operation.
46 Volume will be opened read\-only and no write will be done.
47 .TP
48 \fB\-f\fR, \fB\-\-force\fR
49 This will override some sensible defaults, such as not working with a mounted
50 volume. Use this option with caution.
51 .TP
52 \fB\-h\fR, \fB\-\-help\fR
53 Show a list of options with a brief description of each one.
54 .TP
55 \fB\-q\fR, \fB\-\-quiet\fR
56 Suppress some debug/warning/error messages.
57 .TP
58 \fB\-V\fR, \fB\-\-version\fR
59 Show the version number, copyright and license
60 .BR ntfscp .
61 .TP
62 \fB\-v\fR, \fB\-\-verbose\fR
63 Display more debug/warning/error messages.
64 .SH DATA STREAMS
65 All data on NTFS is stored in streams, which can have names. A file can have
66 more than one data streams, but exactly one must have no name. The size of a
67 file is the size of its unnamed data stream. Usually when you don't specify
68 stream name you are access to unnamed data stream. If you want access to named
69 data stream you need to add ":stream_name" to the filename. For example: by
70 opening "some.mp3:artist" you will open stream "artist" in "some.mp3". But
71 windows usually prevent you from accessing to named data streams, so you need
72 to use some program like FAR or utils from cygwin to access named data streams.
73 .SH EXAMPLES
74 Copy new_boot.ini from /home/user as boot.ini to the root of an /dev/hda1 NTFS
75 volume:
76 .RS
77 .sp
78 .B ntfscp /dev/hda1 /home/user/new_boot.ini boot.ini
79 .sp
80 .RE
81 Copy myfile to C:\\some\\path\\myfile:stream (assume that /dev/hda1 letter in
82 windows is C):
83 .RS
84 .sp
85 .B ntfscp \-N stream /dev/hda1 myfile /some/path
86 .sp
87 .RE
88 .SH BUGS
89 There are no known problems with \fBntfscp\fR. If you find a bug please send an
90 email describing the problem to the development team:
91 .br
92 .nh
93 ntfs\-3g\-devel@lists.sf.net
94 .hy
95 .SH AUTHORS
96 \fBntfscp\fR was written by Yura Pakhuchiy, with contributions from Anton
97 Altaparmakov and Hil Liao.
98 It was ported to ntfs-3g by Erik Larsson.
99 .SH DEDICATION
100 With love to Marina Sapego.
101 .SH AVAILABILITY
102 .B ntfscp
103 is part of the
104 .B ntfs-3g
105 package and is available from:
106 .br
107 .nh
108 http://www.tuxera.com/community/
109 .hy
110 .SH SEE ALSO
111 .BR ntfsprogs (8)