Initial import package mtools: Programs for accessing MS-DOS disks without mounting...
[profile/ivi/mtools.git] / mkmanifest.1
1 .TH mkmanifest 1 "03Nov09" mtools-4.0.12
2 .SH Name
3 mkmanifest - makes list of file names and their DOS 8+3 equivalent
4 '\" t
5 .de TQ
6 .br
7 .ns
8 .TP \\$1
9 ..
10
11 .tr \(is'
12 .tr \(if`
13 .tr \(pd"
14
15 .SH Note\ of\ warning
16 This manpage has been automatically generated from mtools's texinfo
17 documentation, and may not be entirely accurate or complete.  See the
18 end of this man page for details.
19 .PP
20 .SH Description
21 .iX "p mkmanifest"
22 .iX "c packing list"
23 .PP
24 The \fR\&\f(CWmkmanifest\fR command is used to create a shell script (packing
25 list) to restore Unix filenames. Its syntax is:
26 .PP
27 \&\fR\&\f(CWmkmanifest\fR [ \fIfiles\fR ]
28 .PP
29 \&\fR\&\f(CWMkmanifest\fR creates a shell script that aids in the restoration of
30 Unix filenames that got clobbered by the MS-DOS filename restrictions.
31 MS-DOS filenames are restricted to 8 character names, 3 character
32 extensions, upper case only, no device names, and no illegal characters.
33 .PP
34 The mkmanifest program is compatible with the methods used in
35 \&\fR\&\f(CWpcomm, arc,\fR and \fR\&\f(CWmtools\fR to change perfectly good Unix
36 filenames to fit the MS-DOS restrictions. This command is only useful if
37 the target system which will read the diskette cannot handle vfat long
38 names.
39 .PP
40 .SH Example
41 You want to copy the following Unix files to a MS-DOS diskette (using the
42 \&\fR\&\f(CWmcopy\fR command).
43 .PP
44  
45 .nf
46 .ft 3
47 .in +0.3i
48   very_long_name
49   2.many.dots
50   illegal:
51   good.c
52   prn.dev
53   Capital
54 .fi
55 .in -0.3i
56 .ft R
57 .lp
58  
59 \&\fR
60 .PP
61 \&\fR\&\f(CWMcopy\fR
62 converts the names to:
63 .PP
64  
65 .nf
66 .ft 3
67 .in +0.3i
68   very_lon
69   2xmany.dot
70   illegalx
71   good.c
72   xprn.dev
73   capital
74 .fi
75 .in -0.3i
76 .ft R
77 .lp
78  
79 \&\fR
80 .PP
81 The command:
82  
83 .nf
84 .ft 3
85 .in +0.3i
86 mkmanifest very_long_name 2.many.dots illegal: good.c prn.dev Capital >manifest
87 .fi
88 .in -0.3i
89 .ft R
90 .lp
91  
92 \&\fRwould produce the following:
93  
94 .nf
95 .ft 3
96 .in +0.3i
97   mv very_lon very_long_name
98   mv 2xmany.dot 2.many.dots
99   mv illegalx illegal:
100   mv xprn.dev prn.dev
101   mv capital Capital
102 .fi
103 .in -0.3i
104 .ft R
105 .lp
106  
107 \&\fR
108 .PP
109 Notice that "good.c" did not require any conversion, so it did not
110 appear in the output.
111 .PP
112 Suppose I've copied these files from the diskette to another Unix
113 system, and I now want the files back to their original names.  If the
114 file "manifest" (the output captured above) was sent along with those
115 files, it could be used to convert the filenames.
116 .PP
117 .SH Bugs
118 .PP
119 The short names generated by \fR\&\f(CWmkmanifest\fR follow the old convention
120 (from mtools-2.0.7) and not the one from Windows 95 and mtools-3.0.
121 .PP
122 .SH See\ Also
123 Mtools' texinfo doc
124 .SH Viewing\ the\ texi\ doc
125 This manpage has been automatically generated from mtools's texinfo
126 documentation. However, this process is only approximative, and some
127 items, such as crossreferences, footnotes and indices are lost in this
128 translation process.  Indeed, these items have no appropriate
129 representation in the manpage format.  Moreover, not all information has
130 been translated into the manpage version.  Thus I strongly advise you to
131 use the original texinfo doc.  See the end of this manpage for
132 instructions how to view the texinfo doc.
133 .TP
134 * \ \ 
135 To generate a printable copy from the texinfo doc, run the following
136 commands:
137  
138 .nf
139 .ft 3
140 .in +0.3i
141     ./configure; make dvi; dvips mtools.dvi
142 .fi
143 .in -0.3i
144 .ft R
145 .lp
146  
147 \&\fR
148 .TP
149 * \ \ 
150 To generate a html copy,  run:
151  
152 .nf
153 .ft 3
154 .in +0.3i
155     ./configure; make html
156 .fi
157 .in -0.3i
158 .ft R
159 .lp
160  
161 \&\fRA premade html can be found at
162 \&\fR\&\f(CW\(ifhttp://www.gnu.org/software/mtools/manual/mtools.html\(is\fR
163 .TP
164 * \ \ 
165 To generate an info copy (browsable using emacs' info mode), run:
166  
167 .nf
168 .ft 3
169 .in +0.3i
170     ./configure; make info
171 .fi
172 .in -0.3i
173 .ft R
174 .lp
175  
176 \&\fR
177 .PP
178 The texinfo doc looks most pretty when printed or as html.  Indeed, in
179 the info version certain examples are difficult to read due to the
180 quoting conventions used in info.
181 .PP