netread(1)

πŸ’– netread(1) β€” like, the manual page but make it cute πŸ’–

okay bestie, so this is netread, and it lives in the General Commands Manual section one of your manual pages. it's the other half of the netwrite glow-up and honestly? iconic. let's get into it. πŸŽ€


✨ NAME ✨

netread β€” read data that's being transported over the network using netwrite


🌸 SYNOPSIS 🌸

netread [udp] [-f host ] [-c] [-C algorithm ] [-o file ] [-s] [-b] [-h
<n> ] [-H] <n> ] [-q] [-v] [-vv] [-V] [-vV]

so netread is part of the netrw package, and it's a simple (but lowkey powerful, fr) tool for transporting data over the internet, working together with netwrite(1). dynamic duo energy. πŸ‘‘


πŸ’… DESCRIPTION πŸ’…

the whole main purpose of netrw is to simplify and speed up file transfers to hosts that don't have an FTP server. it can also be used for uploading data to some other user. think of it as like... a one-way netcat (nc) but with some genuinely nice features when it comes to data transfers. πŸ’«

netrw can compute and check the message digest (MD5, SHA-1, and some others) of all the data being transferred. it can also print info on progress and average speed. and at the end it sums up the transfer. it's giving organized. it's giving main character. 🫢


⭐ OPTIONS ⭐

  • udp β€” swaps the default TCP protocol over to UDP. switching it up, we love range. 🌈
  • -f host β€” runs in the firewall mode, meaning the connection is initiated by netread. it's the one making the first move. 😌
  • -c β€” this option is ignored. transmission checksum is activated by default anyway, so like, it's already on. no notes. πŸ’€
  • -C algorithm β€” uses the specified algorithm for checksum. this option also implies -c. the supported algorithms (and the first one is the default): sha1 md5 rmd160 none
  • -o <file> β€” writes data to file instead of stdout. redirecting the vibes. πŸ“
  • -s β€” if the -o option is specified, this opens the file for synchronous I/O. otherwise, this option has no effect. literally nothing. zero. nada. πŸ™ˆ
  • -b β€” prints speed in b/s instead of B/s. lowercase behavior, capital-B disrespect. πŸ”₯
  • -h <n> β€” prints # after each n KiB transferred (def. 10485.76).
  • -H <n> β€” prints # after each n MiB transferred (def. 10.24).
  • -q β€” be quiet. 🀫
  • -v β€” be verbose.
  • -vv β€” be very verbose. it's talking now. πŸ—£οΈ
  • -V β€” show version.
  • -vV β€” show verbose version.

πŸ¦‹ RETURN VALUES πŸ¦‹

  1. 0 β€” no errors. slay. ✨
  2. 1 β€” some error occured. 😭
  3. 2 β€” checksum validation failed. πŸ’€

🌟 SEE ALSO 🌟

netwrite(1), /usr/share/doc/netrw/README


πŸ’œ AUTHOR πŸ’œ

netread was written by Jiri Denemark <jirka@ics.muni.cz>. for more information, visit http://www.fi.muni.cz/~xdenemar/netrw

this manual page was written by Kumar Appaiah <akumar@ee.iitm.ac.in>, for the Debian project (but may be used by others). 🫢


okay that's the whole page bestie, we ate and left no crumbs. and just so we're keeping receipts: this was the netread(1) manual page dated 2007-10-14 β€” yeah, it's a 2007 baddie and it still serves. periodt. πŸ’…πŸŽ€