File: ftpmirror.8

package info (click to toggle)
ftpmirror 1.96+dfsg-16
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,080 kB
  • sloc: perl: 2,496; sh: 1,811; makefile: 51; ansic: 22
file content (242 lines) | stat: -rw-r--r-- 5,307 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
.\" Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.\" Please adjust this date whenever revising the manpage.
.\" 
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(8)
.TH "FTPMIRROR" "8" "June 1, 2007" "Dario Minnucci <debian@midworld.net>" ""
.SH "NAME"
\fBftpmirror\fR 
\- Mirroring directory hierarchy using FTP protocol
.SH "SYNOPSIS"
.B ftpmirror
.RI [ package ]
.SH "DESCRIPTION"
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
\fBftpmirror\fP is an utility to copy directory hierarchy (usually
called 'mirror') using FTP protocol.
.PP 
A similar perl script exists, whose name is 'mirror',
but ftpmirror requires less memory than mirror.
.SH "OPTIONS"
Please, note that the original documentation about \fBftpmirror\fR was written originally in japanese. (README.jis and RELEASE.jis)

If you can contribute by translating any aspect of these files, please contact Dario Minnucci <debian@midworld.net>. I'll be glad to include your contributions here to improve this manual.


Formerly ftpmirror operatio mode was MASTER\->SLAVE but seems that since version 1.96 the SLAVE\->MASTER (reverse mirror) is supported.

This behaviour can be controlled for each package section in the main configuration file (/etc/ftpmirror/ftpmirror.cf).

MASTER\->SLAVE  \-\-> get\-mode = yes (default)
.br 
SLAVE\->MASTER  \-\-> put\-mode = yes


Other configuration flags extracted from original documentation are:
(Sorry but most of them are still undocummented.)

.IP todo:
(string, default: full\-mirror)

.IP verbose:
(boolean, default: no)

.IP log\-mask:
(comma separated list)

.IP test\-mode:
(boolean, default: no)

.IP ftp\-server:
(string)

.IP ftp\-gateway:
(string)

.IP ftp\-port:
(service, default: ftp)

.IP ftp\-bindaddr:
(ip address)

.IP ftp\-user:
(string, default: anonymous)

.IP ftp\-pass:
(string, default: `whoami`@`hostname`)

.IP ftp\-group:
(string)

.IP ftp\-gpass:
(string)

.IP ftp\-passive:
(boolean, default: no)
To enable passive file transfer set ftp\-passive to yes. 

.IP ftp\-idle:
(numeric, default: 0)

.IP ftp\-max\-idle:
(boolean, default: 0)

.IP ftp\-list\-method:
(LIST or STAT or STAT\-A or STAT\-AT, default: STAT)

.IP ftp\-timeout:
(numeric, default: 300)

.IP ftp\-login\-retry:
(numeric)

.IP ftp\-login\-delay:
(numeric, default: 60)

.IP ftp\-stats:
(boolean, default: no)

.IP remote\-timezone:
(timezone string, default: undef)

.IP http\-proxy:
(string)

.IP server:
(string)

.IP package:
(string)

.IP put\-mode:
(boolean, default: no)

.IP unlink:
(boolean or 'rename', default: yes)

.IP unlink\-limit:
(size value, default: 0)

.IP ftp\-force\-mtime:
(boolean, default: no)

.IP ignore\-mtime:
(boolean, default: no)

.IP temp\-directory:
(pathname, default: $TMPDIR || /tmp)

.IP lock\-directory:
(pathname, default: temp\-directory)

.IP create\-directory:
(boolean, default: yes)

.IP remote\-directory:
(string)

.IP local\-directory:
(pathname)

.IP master\-db\-directory:
(pathname)

.IP remote\-db\-directory:
(pathname)

.IP local\-db\-directory:
(pathname)

.IP lslR\-file:
(string)

.IP lslR\-copy:
(pathname)

.IP transfer\-file\-regexp:
(regexp)

.IP transfer\-directory\-regexp:
(regexp)

.IP override\-file\-regexp:
(regexp)

.IP override\-directory\-regexp:
(regexp)

.IP load\-local\-dirinfo:
(boolean, default: no)

.IP store\-local\-dirinfo:
(boolean, default: no)

.IP load\-remote\-dirinfo:
(boolean, default: no)

.IP override\-file\-uid:
(uid, default: 0)

.IP override\-file\-gid:
(uid, default: 0)

.IP override\-file\-mode:
(octal value, default: 0644)

.IP override\-directory\-mode:
(octal value, default: 0755)

.IP default\-file\-uid:
(uid, default: 0)

.IP default\-file\-gid:
(gid, default: 0)

.IP default\-file\-mode:
(octal value, default: 0644)

.IP default\-directory\-mode:
(octal value, default: 0755)


.SH "EXAMPLES"
\fBftpmirror\fR provides a 'ready\-to\-use' sample package for testing porpouses.
In order to run the provided test package you need to issue the following commands 
(both commands must be run by the same user):

.PP 
mkdir \-p /tmp/upstream
.br 
/usr/bin/ftpmirror upstream
.PP 
This package should copy directory hierarchy from the original author's FTP location
(ftp://ftp.intec.co.jp/pub/utils/ftpmirror) to your local hard drive (/tmp/upstream).

.SH "IMPORTANT CONSIDERATION"
The inclusion of this configuration is intended to be used ocassionally. 
Please don't abuse this site.


.SH "SEE ALSO"
For other supported configuration options see /etc/ftpmirror/ftpmirror.cf 
where you will find commented examples.


.SH "AUTHOR"
\fBftpmirror\fR was originally written by Ikuo Nakagawa <ikuo@intec.co.jp>
.PP 
This manual page was written by Dario Minnucci <debian@midworld.net>,
for the Debian project (but may be used by others).