GGATEC(8)

💅 GGATEC(8) — like, the GEOM Gate network client, bestie

okay so this is ggatec, from section 8 of the system manager's manual, and honestly? she's iconic. buckle up 🎀

---

✨ NAME ✨

ggatec — the GEOM Gate network client and control utility. yes. both. she multitasks 💖

---

🌸 SYNOPSIS 🌸

ggatec create [-n] [-v] [-o ro | wo | rw] [-o direct] [-p port]
       [-q queue_size] [-R rcvbuf] [-S sndbuf] [-s sectorsize]
       [-t timeout] [-u unit] host path
ggatec rescue [-n] [-v] [-o ro | wo | rw] [-o direct] [-p port]
       [-R rcvbuf] [-S sndbuf] -u unit host path
ggatec destroy [-f] -u unit
ggatec list [-v] [-u unit]

that's a lot of brackets, i know. breathe. it's giving "options menu at a boba shop" 🧋

---

🦋 DESCRIPTION 🦋

so ggatec is the network client for the GEOM Gate class. her whole job? creating ggate devices and forwarding I/O requests back and forth between the GEOM Gate kernel subsystem and the ggated(8) network daemon. she's the middleman. the hype woman. the messenger 🫶

here are the commands you can actually run, no cap:

• create — connects to a ggated(8) daemon on the host you name and creates a ggate provider for the remote file or device you point at.
• rescue — makes a brand new connection after the ggatec process has died or been killed 😭. the new connection to the ggated(8) daemon handles pending and future requests. she picks herself up, she dusts herself off.
• destroy — destroys the given ggate provider. bye bestie 👋
• list — lists ggate providers. simple. clean. we love a low-effort queen.

and here's the options menu, keep scrolling 💅

• -f — forcibly destroy the ggate provider. and when we say forcibly, we mean it cancels all pending requests. like, all of them. no survivors.
• -n — do not use the TCP_NODELAY option on TCP sockets.
• -o option — specifies the permissions and options to use when opening the file or device. the choices are:
  • ro — read-only
  • wo — write-only
  • rw — read-write
  • direct — open with the O_DIRECT option on the file

default is rw, in case you were wondering 🍓

• -p port — the port to connect to on the remote host. default is 3080.
• -q queue_size — how many pending I/O requests can be queued up before they start getting canceled. default is 1024. think of it as her patience meter.
• -R rcvbuf — size of the receive buffer to use. default is 131072 (that's 128 KiB, for the record).
• -S sndbuf — size of the send buffer to use. default is 131072 (also 128 KiB, go figure).
• -s sectorsize — sector size for the ggate provider. if you don't specify it, it gets taken from the device — or set to 512 bytes for files.
• -t timeout — the number of seconds to wait before an I/O request gets canceled. default is 0, which literally means no timeout. she'll wait forever. devoted fr.
• -u unit — the unit number to use.
• -v — do not fork; run in the foreground and print debug information on standard output. main character energy, no background hiding 💅
• host — the remote host to connect to.
• path — the path to a regular file or device.

---

🔥 EXIT STATUS 🔥

exit status is 0 on success, or 1 if the command fails. and if you want the details on why it failed? call ggatec with the -v option. she'll spill everything 💀

---

🌈 EXAMPLES 🌈

okay this one's fun — let's use a CD-ROM device on a remote host, shall we? 🎀

server# cat /etc/gg.exports
client RO /dev/cd0
client RW /tmp/image
server# ggated

client# ggatec create -o ro server /dev/cd0
ggate0
client# mount_cd9660 /dev/ggate0 /cdrom
client# ggatec create -o rw -o direct server /tmp/image
ggate1

look at that. ggate0, then ggate1. she's numbering them like it's nothing ✨

---

👑 SEE ALSO 👑

geom(4), ggated(8), ggatel(8), mount_cd9660(8) — go read those too, iykyk 📚

---

💜 HISTORY 💜

the ggatec utility appeared in FreeBSD 5.3. a legend from the jump.

---

🧚 AUTHORS 🧚

the ggatec utility, as well as this manual page, was written by Pawel Jakub Dawidek <pjd@FreeBSD.org>. thank you king 🙏

---

and that's the whole page, bestie 💖 this Debian build of the September 8, 2016 page is officially a wrap — GGATEC(8), slaying since forever. mwah 😘