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