UDP-RECEIVER(1)

💖 UDP-RECEIVER(1) 💖

okay bestie, welcome to the udp-receiver page from the Udpcast manual ✨ this is the little tool that catches files your other computer is yeeting across the network, and honestly? she's giving quiet-legend energy 🫶

---

✨ NAME ✨

udp-receiver — receive files broadcast by udp-sender 💌

---

🌸 SYNOPSIS 🌸

./udp-receiver [--file file] [--pipe pipe] [--portbase portbase]
[--interface net-interface] [--log file] [--ttl time-to-live]
[--mcast-rdv-address mcast-rdv-address] [--nokbd] [--exitWait
milliseconds] [--stat-period n] [--print-uncompressed-position flag]

---

🦋 DESCRIPTION 🦋

so udp-receiver is literally the receiving end of the whole thing — it catches the files that udp-sender sends out (think a disk image, bestie, like a whole-ass filesystem just floating through the air 🌈).

---

💅 OPTIONS 💅

🎀 Basic options 🎀

• --file file — writes the received data into file. and if you don't pass this? the data just goes straight to stdout instead, no cap.
• --pipe command — sends the data through a pipe once it's been received. super useful for decompressing stuff, or for filling in the unused filesystem blocks that udp-sender might have stripped out 👑 the command gets a direct handle on the output file or device, so it can seek inside it if it needs to. Udpcast itself also keeps a handle on the file, which it uses for an informational progress display. the command's stdin is a pipe from udp-receiver. example: udp-receiver -p "gzip -dc" 🔥
• --log file — logs some stuff into file. that's it, that's the vibe.
• --nosync — do not open the target in synchronous mode. this is the default when writing to a file or a pipe.
• --sync — write to the target in synchronous mode. this is the default when writing to a device (character or block) 💀
• --nokbd — do not read the start signal from the keyboard, and do not display any message telling the user to press any key to start. perfect for when nobody's there to press anything 🙈
• --start-timeout sec — the receiver aborts at start if it doesn't see a sender within this many seconds. and like, furthermore, the sender needs to start transmission of data within this delay too. once transmission is started, this timeout no longer applies ⏰
• --receive-timeout sec — the receiver aborts during transmission if it doesn't see a packet from the sender within this many seconds. this timeout only applies once transmission has already started, iykyk.

🌐 Networking options 🌐

• --portbase portbase — the default ports to use for udpcast. two ports get used: portbase and portbase+1. so bestie, portbase must be even ⚠️ default is 9000. the same portbase must be specified for both udp-sender and udp-receiver.
• --interface interface — the network interface used to send out the data. default is eth0 ✨
• --ttl ttl — time to live for the connection request packet. by default the connection request is broadcast to the LAN's broadcast address. if ttl is set, the connection request is multicast instead to 224.0.0.1 with the given ttl, which should enable udpcast to work between LANs. not tested though 💀
• --mcast-rdv-address address — uses a non-standard multicast address for the control connection (the one the sender and receivers use to "find" each other 👀). this is not the address used to transfer the data. by default mcast-rdv-address is the Ethernet broadcast address if ttl is 1, and 224.0.0.1 otherwise.

this setting should not be used except in very special situations, such as when 224.0.0.1 cannot be used for policy reasons 🚨

• --exit-wait milliseconds — when transmission is over, the receiver waits for this long after receiving the final REQACK. this is done to guard against loss of the final ACK. is 500 milliseconds by default 🫶
• --ignore-lost-data — do not stop reception when data loss is detected; instead fill with random data. useful for multimedia transmission where 100% integrity is not need. (their words, and honestly iconic for it 🎀)

📊 Statistics options 📊

• --stat-period seconds — every so much milliseconds, print some statistics to stderr: how much bytes received so far, log, position in uncompressed file (if applicable), overall bitrate... by default this is printed every half second ⭐
• --print-uncompressed-position flag — by default, udp-receiver only prints the position in the uncompressed file if the 2 following conditions are met:
  • output is piped via a compressor (-p option).
  • the final output is seekable (file or device).

with the --print-uncompressed-position option, you can change this behavior:

• if flag is 0, uncompressed position will never be printed, even if the above conditions are met.
• if flag is 1, uncompressed position will always be printed, even if the above conditions are not met.

---

🌈 SEE ALSO 🌈

udp-sender

---

👑 AUTHOR 👑

Alain Knaff 💜

---

and that's the whole page bestie, mwah 💋 this was the current version, dated February 17, 2024 — go receive some files, you absolute main character 🦋✨💅