FTPMIRROR(8)

💅 ftpmirror(8) — the FTP mirroring bestie 💅

okay so bestie, welcome to ftpmirror, section 8 of the manual (iykyk, admin girlies only). sit down, grab a strawberry drink 🍓, and let me tell you everything about this icon.

---

✨ NAME ✨

ftpmirror — mirroring a whole directory hierarchy using the FTP protocol. yes, the whole thing. it's giving "copy the entire vibe, not just one file" 🦋

---

🎀 SYNOPSIS 🎀

ftpmirror [package]

---

🌸 DESCRIPTION 🌸

ftpmirror is a utility that copies a directory hierarchy — which we lovingly call a 'mirror' — over the FTP protocol. literally the whole tree, no crumbs left behind 🧚

there's a similar perl script out there named mirror, and she's cute too, but ftpmirror uses less memory than mirror. so if your little machine is struggling, ftpmirror is the one holding it down. periodt 💅

---

🔥 OPTIONS 🔥

okay so before we go ANY further, a lil heads up: the original documentation for ftpmirror was written in japanese. it lives in README.jis and RELEASE.jis.

if you can help translate any aspect of those files, please hit up Dario Minnucci <debian@midworld.net>. he says he'd be glad to include your contributions here to improve this manual. group project energy 🫶

back in the day, ftpmirror's operation mode was MASTER->SLAVE, but it seems that since version 1.96 the SLAVE->MASTER (reverse mirror) is supported too. glow-up fr fr ✨

this behaviour can be controlled for each package section in the main configuration file, which is /etc/ftpmirror/ftpmirror.cf.

• MASTER->SLAVE → get-mode = yes (default)
• SLAVE->MASTER → put-mode = yes

other configuration flags extracted from the original documentation are:

bestie, sorry, but most of them are still undocumented. we work with what we have 😭

• todo — string, default: full-mirror
• verbose — boolean, default: no
• log-mask — comma separated list
• test-mode — boolean, default: no
• ftp-server — string
• ftp-gateway — string
• ftp-port — service, default: ftp
• ftp-bindaddr — ip address
• ftp-user — string, default: anonymous
• ftp-pass — string, default: `whoami`@`hostname`
• ftp-group — string
• ftp-gpass — string
• ftp-passive — boolean, default: no. to enable passive file transfer set ftp-passive to yes.
• ftp-idle — numeric, default: 0
• ftp-max-idle — boolean, default: 0
• ftp-list-method — LIST or STAT or STAT-A or STAT-AT, default: STAT
• ftp-timeout — numeric, default: 300
• ftp-login-retry — numeric
• ftp-login-delay — numeric, default: 60
• ftp-stats — boolean, default: no
• remote-timezone — timezone string, default: undef
• http-proxy — string
• server — string
• package — string
• put-mode — boolean, default: no
• unlink — boolean or 'rename', default: yes
• unlink-limit — size value, default: 0
• ftp-force-mtime — boolean, default: no
• ignore-mtime — boolean, default: no
• temp-directory — pathname, default: $TMPDIR || /tmp
• lock-directory — pathname, default: temp-directory
• create-directory — boolean, default: yes
• remote-directory — string
• local-directory — pathname
• master-db-directory — pathname
• remote-db-directory — pathname
• local-db-directory — pathname
• lslR-file — string
• lslR-copy — pathname
• transfer-file-regexp — regexp
• transfer-directory-regexp — regexp
• override-file-regexp — regexp
• override-directory-regexp — regexp
• load-local-dirinfo — boolean, default: no
• store-local-dirinfo — boolean, default: no
• load-remote-dirinfo — boolean, default: no
• override-file-uid — uid, default: 0
• override-file-gid — uid, default: 0
• override-file-mode — octal value, default: 0644
• override-directory-mode — octal value, default: 0755
• default-file-uid — uid, default: 0
• default-file-gid — gid, default: 0
• default-file-mode — octal value, default: 0644
• default-directory-mode — octal value, default: 0755

---

🌈 EXAMPLES 🌈

ftpmirror ships a 'ready-to-use' sample package, just for testing purposes. if you wanna run the provided test package, you need to issue the following commands — and yes, both commands must be run by the same user (no switching mid-way, bestie, that's not the vibe):

mkdir -p /tmp/upstream
/usr/bin/ftpmirror upstream

this package should copy the directory hierarchy from the original author's FTP location, which is ftp://ftp.intec.co.jp/pub/utils/ftpmirror, straight to your local hard drive at /tmp/upstream. so satisfying when it lands 🦋

---

⭐ IMPORTANT CONSIDERATION ⭐

bestie. listen. the inclusion of this configuration is intended to be used occasionally. please don't abuse this site. we are guests there, okay? be polite, be humble, don't be that person. 🙈

---

👑 SEE ALSO 👑

for other supported configuration options, go peek at /etc/ftpmirror/ftpmirror.cf, where you'll find commented examples. little cheat sheet, tucked right there for you 💖

---

💜 AUTHOR 💜

ftpmirror was originally written by Ikuo Nakagawa <ikuo@intec.co.jp> 👑

this manual page was written by Dario Minnucci <debian@midworld.net>, for the Debian project (but may be used by others). icon behaviour fr 💅

---

and that's the whole page, bestie 🎀 shoutout to Dario Minnucci <debian@midworld.net> for writing this one, dated June 1, 2007, living in section FTPMIRROR(8). go mirror something and slay 💖✨🦋