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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
|
weex(1) weex(1)
NNAAMMEE
weex - fast WEb EXchanger non-interactive FTP client
SSYYNNOOPPSSIISS
wweeeexx [ Options ] _H_O_S_T_I_D _[_H_O_S_T_I_D_._._._]
DDEESSCCRRIIPPTTIIOONN
wweeeexx is a utility designed to automate the task of
remotely maintaining a web page or other FTP archive. With
wweeeexx , the maintainer of a web site or archive that must
be administered through FTP interaction can largely ignore
that process. The archive administrator simply creates a
local directory that serves as an exact model for the off-
site data. All modifications and direct interaction is
done locally to this directory structure. When the admin-
istrator wishes to coordinate the data on the remote site
with that of the local model directory, simply executing
wweeeexx accomplishes this in the most bandwidth-efficient
fashion by only transferring files that need updating. The
program will create or remove (!) files or directories as
necessary to accurately establish the local model on the
remote server.
The mandatory _H_O_S_T_I_D argument is the user-defined name
that represents a particular FTP account or configuration
specified in the _~_/_._w_e_e_x_r_c file. This file, the contents
of which are described below, can alternatively be named
_~_/_._w_e_e_x_/_w_e_e_x_r_c. Multiple _H_O_S_T_I_D arguments to a single
wweeeexx command are supported to affect multiple archives or
configurations in immediate succession. In addition, the
actual _H_O_S_T_I_D can be substituted with the number repre-
senting its relative sequential position in the _~_/_._w_e_e_x_r_c
file (the first _H_O_S_T_I_D definition is 1, and so on).
OOPPTTIIOONNSS
Options at the command line take precedence over any spec-
ified in the configuration file.
--dd,, ----ddeebbuugg--ccoonnffiigg
Outputs the configuration of each hosts.
--DD,, ----ddeebbuugg--ffttpplliibb
Outputs messages from/to FTP server.
YN-cxe 2000.05.22 1
weex(1) weex(1)
--ff,, ----ffoorrccee
If the caching mechanism is inhibiting the upload-
ing of files that should be transferred, this
option will force the actual transfer to always
occur.
--hh,, ----hheellpp
Outputs a usage summary to _s_t_d_o_u_t.
--mm,, ----mmoonnoocchhrroommee
The default mode generates a helpful color coding
based on the operation being performed. This option
suppresses that.
--rr,, ----rreebbuuiilldd--ccaacchhee
If cache file is broken, use this to rebuild it.
--ss,, ----ssiilleenntt
The default mode outputs a helpful status message
for each action taken, including file transfer
progress meters. This mode suppresses output.
--tt,, ----tteesstt
Weex doesn't modify any remote files/directories.
--VV,, ----vveerrssiioonn
Prints the version of the wweeeexx program.
CCOONNFFIIGGUURRAATTIIOONN FFIILLEE
Because this program is meant to be non-interactive, a
properly set up configuration file is essential. wweeeexx
looks for this file either in _~_/_._w_e_e_x_r_c or _~_/_._w_e_e_x_/_w_e_e_x_r_c.
The general format of the configuration file is a brack-
eted section heading followed by parameters that define
that section's configuration. This section name is what is
provided to wweeeexx at run time to indicate the FTP arrange-
ment you wish to update. A parameter is only valid for the
most recent section heading that preceded it. The excep-
tion to this is the _[_d_e_f_a_u_l_t_] section which creates set-
tings for unspecified parameters in every section. In the
case of parameters that accept multiple values, the
default section augments any specifically designated val-
ues.
Lines that begin with the '#' character are safely ignored
as comments. Neither section names nor parameter
YN-cxe 2000.05.22 2
weex(1) weex(1)
variables are case sensitive in any way. Section names can
not begin with numbers. Some parameters can be assigned
multiple values. Where this is not possible, the last
value is used. To quote special characters, use single
quotes (') or double quotes ("). To quote a particular
quote symbol, use the other quote. The general syntax for-
mat for the configuration file is:
[hostid1]
Parameter1 = Value
# First method for multiple values
Parameter2 = Value
Parameter2 = Value
...
[hostid2]
Parameter1 = Value
# Second method for multiple values
Parameter2 = {
Value
Value
}
...
[default]
Parameter = Value
...
PPAARRAAMMEETTEERR LLIISSTT
These parameters are used to define the properties of a
particular host configuration named in brackets. When
specifying directory names, the trailing "/" is optional.
Also, both files and directories (except SrcDir and Dest-
Dir) can be specified with shell wildcards. When specify-
ing files, if a file or file pattern is given without a
path, it is assumed to be available when encountered in
any directory. If it is an explicitly specified path/file
combination, the configuration is available in that direc-
tory. Files/directories except `SrcDir' and `DestDir' can
be specified as both absolute path and relative path. But
you must specify `SrcDir' and `DestDir' as absolute path.
When you want to specify `/public_html/ignoreme.html' as
relative path, you should specify `./ignoreme.html' rather
than `ignoreme.html'. When specifying binary states, you
may use any of the following: True/False, Yes/No, T/F,
1/0. None are case sensitive.
AAsscciiiiFFiillee
Filename patterns that will be transferred using
ASCII mode. The default mode for files not speci-
fied in this way is IMAGE(BINARY) mode.
YN-cxe 2000.05.22 3
weex(1) weex(1)
CChhaannggeePPeerrmmiissssiioonn
The access permissions of the files in the directo-
ries specified with ChangePermissionDir are changed
to this parameter. The format is a three digit
octal number.
CChhaannggeePPeerrmmiissssiioonnDDiirr
Files in directories assigned to this parameter
will have their access permissions changed after
sending. Specify local directories.
CChhddiirrAAttCCoonnnneeccttiioonn
Set `true' to change remote current working direc-
tory to DestDir at connection. If remote current
working directory at connection is DestDir, weex
runs faster a bit by setting this parameter to
`false'. Default is `true'.
CCoonnvvTTooLLoowweerr
If set to `true', the filenames are converted to
lower case before sending. This feature allows
interaction with FTP servers that do not support
case sensitive filenames. If a naming conflict
arises due to a lower case name already existing,
an error occurs. Furthermore, the cache is totally
unaware of original uppercase filenames.
DDeessttDDiirr
Destination directory on the remote FTP server
where the mirrored information will be sent. This
setting corresponds to the "pwd" command on tradi-
tional FTP clients.
FFoorrccee If the caching mechanism is inhibiting the upload-
ing of files that should be transferred, this
option will force the actual transfer to always
occur if set to `true'.
FFoolllloowwSSyymmlliinnkkss
Set `true' to follow symbolic links. Default is
`false'. Symbolic link of directory assumes a file
whose size is 0 byte at default.
FFttppPPaassssiivvee
When it is `false', weex uses port mode instead of
passive mode. If the FTP server doesn't support
passive mode, specify `false'. (It may make
YN-cxe 2000.05.22 4
weex(1) weex(1)
transfer slower) Default is `true'. (See also FAQ)
HHoossttNNaammee
Hostname to connect to. The "ftp://" protocol spec-
ifier is implied and shouldn't be used. An IP
address is also valid and may save lookup time.
IIggnnoorreeLLooccaallDDiirr
This parameter contains one or more protected local
directories that are completely ignored during the
transfer process. This is useful if you want to
have subdirectories that are part of a project but
don't need to be in the final, online version
(i.e., old versions).
IIggnnoorreeLLooccaallFFiillee
This parameter contains one or more protected local
file specifiers that will be completely ignored
during the transfer process.
IIggnnoorreeRReemmootteeDDiirr
This parameter contains one or more protected
remote directories that are completely ignored dur-
ing the transfer process. This is useful if you
want to have other material on the remote FTP site
that is not related to the specific project that
wweeeexx is dealing with. This could include, for exam-
ple, data administered through a different FTP
client or process.
IIggnnoorreeRReemmootteeFFiillee
This parameter contains one or more protected
remote file specifiers that will be completely
ignored during the transfer process.
KKeeeeppRReemmootteeDDiirr
In their directories, files are not removed when
they don't exist in the local directory.
LLooggDDeettaaiillLLeevveell
It specifis how detail level weex records a log at.
Connection and disconnection message and error mes-
sages are always recorded. When weex finishes
working correctly, it writes `Complete' previous
disconnection message. If 1 or less, records each
connection. If 2, records each directory. If 3 or
more, records each file manipulated Default is 1.
YN-cxe 2000.05.22 5
weex(1) weex(1)
LLooggiinnNNaammee
Login name of the account on the FTP server.
MMaaxxRReettrryyTTooSSeenndd
When weex fails in sending a file, it retry to send
the file. The maximum times of retrying is this
parameter. Default is 8. Specify -1 to stop retry-
ing.
MMoonnoocchhrroommee
The default mode generates a helpful color coding
based on the operation being performed. A `true'
setting suppresses that.
NNeessttSSppaacceess
An integer that controls the indent spacing of the
output. The default is 4. If you want to suppress
it, specify -1. If you specify 0, weex uses 4. :-)
OOvveerrwwrriitteeOOKK
If the FTP server has trouble overwriting files,
set this parameter to `false'.
PPaasssswwoorrdd
Plaintext password granting access to the account.
Note that this file uses no special facilities to
safeguard passwords. Make sure that the file per-
missions of a configuration file containing pass-
words are set conservatively. If they are not, a
warning will be issued at execution. If this
parameter is not found, weex asks for it on the
terminal.
PPrreesseerrvveePPeerrmmiissssiioonnDDiirr
The access permissions of the files in directories
assigned to this parameter will be copied to
remote. Specify *local* directories.
RReeccoorrddLLoogg
When `true', weex create a log.
SShhoowwHHiiddddeennFFiillee
Set `true' to get hidden files (starting with a
dot) on FTP server which doesn't show hidden files
by default. Default is `false'.
YN-cxe 2000.05.22 6
weex(1) weex(1)
SSiilleenntt The default mode outputs a helpful status message
for each action taken, including file transfer
progress meters. A `true' setting suppresses out-
put.
SSrrccDDiirr Top of the source directory tree containing the
local copy of the information to be mirrored. This
setting corresponds to the "lcd" command on tradi-
tional FTP clients.
EEXXAAMMPPLLEESS
Here is an example of what a typical ..wweeeexxrrcc file might
look like:
#-=-=-=-=-=Sample Configuration file=-=-=-=-=-
# My favorite FTP account...
[Ninja]
HostName = ftp.ninja-rights.org
LoginName = chrisxed
Password = '"mYsEcReT!"'
SrcDir = /home/chrisxed/project/weex
DestDir = /
ASCIIfile = *.c
IgnoreLocalDir = /home/chrisxed/project/weex/weex.devel
IgnoreLocalDir = /home/chrisxed/project/weex/weex.old
IgnoreLocalFile = notes2myself.txt
IgnoreRemoteDir = /offsitearchive/
# Another FTP account...
[Veggie]
HostName = ftp.vegetable-advocacy.com
LoginNAME = waxedbean
Password = "X'sBean"
SrcDir = /home/chrisxed/project/legumes
DestDir = /souppot/
# Global configuration settings
[default]
AsciiFile = {
*.htm
*.html
*.txt
*.asc
}
IgnoreLocalFile = {
*.bak
*.tmp
*.swp
}
With a configuration like this, executing:
YN-cxe 2000.05.22 7
weex(1) weex(1)
$$ wweeeexx NNiinnjjaa
would cause the file system assigned to SSrrccDDiirr to be com-
pletely mirrored on the remote server. Executing:
$$ wweeeexx nniinnjjaa vveeggggiiee
would cause the FTP update to occur for the "Ninja" con-
figuration and then for the "Veggie" configuration. This
could also be specified like this:
$$ wweeeexx 11 22
NNOOTTEESS
TTiimmeessttaammpp CCaacchhee FFaacciilliittyy
wweeeexx implements a cache of file timestamps from Ver 1.6.0.
This makes updating much faster when you have a lot of
files. In addition, wweeeexx also caches directory structure
and file names from Ver 2.5.0. So never slow transfer
even if you have many directories and files. If, however,
you change the remote files with another FTP client or
running wweeeexx is killed or wweeeexx is terminated by an error,
the cache file will not be correct. The simple solution
to this problem is to remove the cache file (located in
_~_/_._w_e_e_x_/_w_e_e_x_._c_a_c_h_e_._H_O_S_T_N_A_M_E ) completely or to run wweeeexx
with option _-_-_r_e_b_u_i_l_d_-_c_a_c_h_e.
TTeesstteedd OOppeerraattiinngg SSyysstteemmss
Debian GNU/Linux 2.1
Red Hat Linux 5.1/5.2/6.0/6.1J
SuSE Linux 6.1/6.2/6.3
Linux Mandrake 6.1
FreeBSD(98) 3.0-RELEASE
FreeBSD 3.3-RELEASE
Solaris 2.5.1
AAUUTTHHOORR
This very handy program was written by:
Yuuki NINOMIYA <gm@debian.or.jp>
The original man page was written by:
Chris _X Edwards <chrisxed@usa.net>
The copyright of this software and documentation belongs
to Yuuki NINOMIYA. It is released under the terms of the
GNU General Public License as published by the Free
YN-cxe 2000.05.22 8
weex(1) weex(1)
Software Foundation; either version 2, or (at your option)
any later version. You can redistribute it and/or modify
it under the GPL.
This software uses shhopt for parsing command line
options. Shhopt is released under the Artistic License.
You may use it separately under the Artistic License.
YN-cxe 2000.05.22 9
|
