KCPTUN-CLIENT(1)

📦
this version · 8 versions
, in ubuntu noble, ubuntu questing

💖 NAME 💖

kcptun-client — a Simple UDP Tunnel Based On KCP, bestie. yeah that's the whole name, she's lowkey iconic for it ✨

🦋 DESCRIPTION 🦋

okay so this is the manual page for kcptun-client, from the kcptun family — manual name kcptun-client, in case the terminal header didn't already give that away 💅

🌸 NAME:

kcptun — the client (with SMUX). that's the vibe. SMUX in the building, no cap 🫶

🎀 USAGE:

kcptun-client [global options] command [command options] [arguments...]

that's it, that's the whole shape of it. global options first, then a command, then that command's own options, then whatever arguments it wants. slay ✨

⭐ VERSION:

SELFBUILD

yes really, it literally says SELFBUILD and that's so real of it 😭

👑 COMMANDS:

  • help, h — shows you a list of commands, or help for one specific command. she's helpful like that 💖

🌈 GLOBAL OPTIONS:

every single one, in order, no skips, no crumbs left behind:

  • --localaddr value, -l value — the local address she listens on. (default: ":12948") 🎧
  • --remoteaddr value, -r value — where your kcp server is at. (default: "vps:29900") 📡
  • --key value — the pre-shared secret between client and server. (default: "it's a secrect") — yes, that typo is canon, it's in the original, we do not fix it, we respect it 💀 environment variable: $KCPTUN_KEY
  • --crypt value — pick your encryption flavor: aes, aes-128, aes-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, sm4, none. (default: "aes") 🔐
  • --mode value — the profiles: fast3, fast2, fast, normal, manual. (default: "fast") ⚡
  • --conn value — how many UDP connections to the server. (default: 1) 🔌
  • --autoexpire value — auto expiration time, in seconds, for a single UDP connection; 0 disables it entirely. (default: 0) ⏳
  • --scavengettl value — how long an expired connection is allowed to keep living, in seconds. (default: 600) 🧟
  • --mtu value — maximum transmission unit for UDP packets. (default: 1350) 📦
  • --sndwnd value — send window size, counted in packets. (default: 128) 📤
  • --rcvwnd value — receive window size, counted in packets. (default: 512) 📥
  • --datashard value, --ds value — reed-solomon erasure coding: datashard. (default: 10) 🧮
  • --parityshard value, --ps value — reed-solomon erasure coding: parityshard. (default: 3) 🧮
  • --dscp value — set DSCP, 6 bits. (default: 0) 🏷️
  • --nocomp — disable compression. just turn it off, periodt 🚫
  • --sockbuf value — per-socket buffer, in bytes. (default: 4194304) 🧺
  • --smuxver value — specify the smux version; available are 1, 2. (default: 1) 🔢
  • --smuxbuf value — the overall de-mux buffer, in bytes. (default: 4194304) 🫙
  • --streambuf value — per stream receive buffer, in bytes, smux v2+ only. (default: 2097152) 🌊
  • --keepalive value — seconds between heartbeats. (default: 10) 💓
  • --snmplog value — collect snmp to a file, aware of timeformat in golang, like: ./snmp-20060102.log 📝
  • --snmpperiod value — snmp collect period, in seconds. (default: 60) ⏰
  • --log value — specify a log file to output to; by default it goes to stderr. 🗂️
  • --quiet — to suppress the 'stream open/close' messages. 🤫
  • --tcp — to emulate a TCP connection(linux) 🐧
  • -c value — config from a json file, which will override the command from shell. ⚠️ note the override energy: the json wins, bestie.
  • --help, -h — show help. 🆘
  • --version, -v — print the version. 🏷️
fr fr, that's every option, every default, every env var. nothing got left out, nothing got invented. iykyk 💜

okay bye bestie, go tunnel something cute 🦋💖

this was kcptun-client version 20210922+ds-1build1, from August 2023 — thanks for reading the whole thing, you're the main character 👑✨

📦 where this page comes from