Imported Upstream version 4.0.43
[platform/upstream/mtools.git] / README.BEBOX
1 % Copyright 1997 Marco Nelissen.
2 % Copyright 1996-1998,2001,2002,2009 Alain Knaff.
3 % This documentation is for Mtools which is a collection of tools to
4 % allow Unix systems to manipulate MS-DOS files.
5
6 % Permission is granted to copy, distribute and/or modify this document
7 % under the terms of the GNU Free Documentation License, Version 1.3 or
8 % any later version published by the Free Software Foundation; with no
9 % Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
10 % Texts.  A copy of the license is included in the section entitled
11 % ``GNU Free Documentation License''.
12
13
14
15 NOTE: THIS FILE ONLY REFERS TO THE BEBOX.  IF YOU ARE USING UNIX,
16 REFER TO README.
17
18
19 This is mtools 3.6 for BeOS DR9. This release will no longer work on
20 DR8, which should be no problem since everybody should have upgraded
21 to DR9 by now.  mtools 3.6 can be used as a replacement for the
22 version 2.0.7 mtools supplied with BeOS.  mtools 3.6 supports the VFAT
23 filesystem (long filenames), which the Be-supplied tools do not.
24
25 To install:
26
27 - build the executables: type "make -f Makefile.Be" in the mtools
28   directory. Again, this instruction is only for the Bebox, not for any
29   kind of Unix. They should compile without any warnings or errors.
30
31   WARNING: do NOT rerun the configure script. Although DR9 bash will
32 no longer lock up when running the configure script, the resulting
33 files are not entirely correct, and mtools will fail to compile.  I
34 have hand-crafted a config.h that can be used to compile mtools. This
35 will be used if you just type "make -f Makefile.Be"
36
37 - copy the "mtools" executable (and perhaps also "mkmanifest") to /bin,
38   or to another directory in your path.
39
40 Since all of the mtools-commands are contained within a single
41 executable, you must either define aliases for each command, or create
42 links for them.
43
44 To create aliases, add the following lines to the file /boot/.profile
45
46 alias mattrib="mtools -c mattrib"
47 alias mbadblocks="mtools -c mbadblocks"
48 alias mcd="mtools -c mcd"
49 alias mcopy="mtools -c mcopy"
50 alias mdel="mtools -c mdel"
51 alias mdeltree="mtools -c mdeltree"
52 alias mdir="mtools -c mdir"
53 alias mformat="mtools -c mformat"
54 alias minfo="mtools -c minfo"
55 alias mlabel="mtools -c mlabel"
56 alias mmd="mtools -c mmd"
57 alias mmount="mtools -c mmount"
58 alias mrd="mtools -c mrd"
59 alias mmove="mtools -c mmove"
60 alias mpartition="mtools -c mpartition"
61 alias mren="mtools -c mren"
62 alias mtoolstest="mtools -c mtoolstest"
63 alias mtest="mtools -c  mtest"
64 alias mtype="mtools -c mtype"
65 alias mzip="mtools -c mzip"
66
67  (then close and re-open all terminals and shells, or type
68 ". /boot/.profile" in each open terminal to activate the
69 aliases. Optional: remove the old mtools from the /bin directory)
70
71
72 To create links, open a shell, and type the following commands
73 (assuming you copied the mtools executable to /bin):
74
75 cd /bin
76 rm mattrib mcd mcopy mdel mdir mformat mkmanifest mlabel mmd mrd mread mren mtype mwrite
77 ln -s mtools mattrib
78 ln -s mtools mbadblocks
79 ln -s mtools mcd
80 ln -s mtools mcopy
81 ln -s mtools mdel
82 ln -s mtools mdeltree
83 ln -s mtools mdir
84 ln -s mtools mformat
85 ln -s mtools minfo
86 ln -s mtools mlabel
87 ln -s mtools mmd
88 ln -s mtools mmount
89 ln -s mtools mrd
90 ln -s mtools mread
91 ln -s mtools mmove
92 ln -s mtools mpartition
93 ln -s mtools mren
94 ln -s mtools mtoolstest
95 ln -s mtools mtest
96 ln -s mtools mtype
97 ln -s mtools mwrite
98 ln -s mtools mzip
99
100
101 Alternatively, make multiple copies of the "mtools" executable and use
102 the names mdir, mdel etcetera.
103
104 - if you want more than just floppy support, you need to make a configuration
105   file. An example mtools.conf.be is included in the distribution.
106   mtools looks in a number of standard places for its config file, such as:
107   /boot/.mtoolsrc
108   /boot/mtools.conf
109   /boot/system/mtools.conf
110   By defining the variable MTOOLSRC you can give the config file any name you
111   like and put it at any location.
112
113   You need to add something like "export MTOOLSRC=/conf/mtools.cfg" to
114   your .profile file.
115
116   Take care to remove or change the entries that you don't need. The provided
117   mtools.conf is for unix systems, with some BeOS settings at the end.
118   The sample entry for a ZIP disk on the BeOS has been provided by
119   Chris Herborth
120   (chrish@qnx.com). 
121
122
123 - enjoy!
124
125 Marco Nelissen <marcone@xs4all.nl>
126 Alain Knaff <alain@knaff.lu>