c619cff2c46cfaf74c00ed0a381d143a1decf6bf
[platform/upstream/mtools.git] / mren.1
1 '\" t
2 .TH mren 1 "29Jun11" mtools-4.0.17
3 .SH Name
4 mren - rename an existing MSDOS file
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(CWmren\fR command is used to rename or move an existing MS-DOS
24 file or subdirectory. Its syntax is:
25 .PP
26 .ft I
27 .nf
28 \&\fR\&\f(CWmren\fR [\fR\&\f(CW-voOsSrRA\fR] \fIsourcefile\fR \fItargetfile\fR
29 .fi
30 .ft R
31  
32 .PP
33 \&\fR\&\f(CWMren\fR
34 renames an existing file on an MS-DOS file system.
35 .PP
36 In verbose mode, \fR\&\f(CWMren\fR displays the new filename if the name
37 supplied is invalid.
38 .PP
39 If the first syntax is used (only one source file), and if the target
40 name doesn't contain any slashes or colons, the file (or subdirectory)
41 is renamed in the same directory, instead of being moved to the current
42 \&\fR\&\f(CWmcd\fR directory as would be the case with \fR\&\f(CWmmove\fR. Unlike the
43 MS-DOS version of \fR\&\f(CWREN\fR, \fR\&\f(CWmren\fR can be used to rename
44 directories.
45 .PP
46 .SH See\ Also
47 Mtools' texinfo doc
48 .SH Viewing\ the\ texi\ doc
49 This manpage has been automatically generated from mtools's texinfo
50 documentation. However, this process is only approximative, and some
51 items, such as crossreferences, footnotes and indices are lost in this
52 translation process.  Indeed, these items have no appropriate
53 representation in the manpage format.  Moreover, not all information has
54 been translated into the manpage version.  Thus I strongly advise you to
55 use the original texinfo doc.  See the end of this manpage for
56 instructions how to view the texinfo doc.
57 .TP
58 * \ \ 
59 To generate a printable copy from the texinfo doc, run the following
60 commands:
61  
62 .nf
63 .ft 3
64 .in +0.3i
65     ./configure; make dvi; dvips mtools.dvi
66 .fi
67 .in -0.3i
68 .ft R
69 .PP
70  
71 \&\fR
72 .TP
73 * \ \ 
74 To generate a html copy,  run:
75  
76 .nf
77 .ft 3
78 .in +0.3i
79     ./configure; make html
80 .fi
81 .in -0.3i
82 .ft R
83 .PP
84  
85 \&\fRA premade html can be found at
86 \&\fR\&\f(CW\(ifhttp://www.gnu.org/software/mtools/manual/mtools.html\(is\fR
87 .TP
88 * \ \ 
89 To generate an info copy (browsable using emacs' info mode), run:
90  
91 .nf
92 .ft 3
93 .in +0.3i
94     ./configure; make info
95 .fi
96 .in -0.3i
97 .ft R
98 .PP
99  
100 \&\fR
101 .PP
102 The texinfo doc looks most pretty when printed or as html.  Indeed, in
103 the info version certain examples are difficult to read due to the
104 quoting conventions used in info.
105 .PP