ACCEL-CMD(1)

🎀 ACCEL-CMD(1) 🎀

accel-cmd is the manual name, and it's the page for the General Commands Manual 💅 It's giving official, but I'm making it cute.

✨ NAME ✨

accel-cmd — send commands to accel-ppp 📨

💌 SYNOPSIS 💌

accel-cmd [-n] [-4] [-6] [-f FAMILY] [-H HOST] [-p PORT] [-i TIMEOUT]
[--] [COMMAND]

🦋 DESCRIPTION 🦋

okay so accel-cmd is a client for accel-ppp's cli module 🧚 It sends your COMMANDs over accel-ppp's tcp interface and shows you the result on standard output. Literally that simple. If you don't give it a COMMAND, it reads and sends whatever comes in on standard input instead, so you can feed it a whole list 💖

The help COMMAND is your bestie for figuring out which COMMANDs exist and how to write them. Use it whenever you're lost 🫶

🌸 OPTIONS 🌸

• -f FAMILY, --family=FAMILY — picks the protocol family to connect with. You can choose inet (IPv4), inet6 (IPv6), or unspec (automatic) 🌈
• -4 — shortcut for --family=inet 🍓
• -6 — shortcut for --family=inet6 🍓
• -H HOST, --host=HOST — the host name or IP address you want to connect to. It defaults to localhost 🏠
• -p PORT, --port=PORT — the service name or port number to connect on. It defaults to 2001 ✨
• -n, --numeric — turns off name resolution for HOST and PORT. Since that's the case, HOST has to be an IP address and PORT has to be a numeric port number 🔢
• -t TIMEOUT, --timeout=TIMEOUT — sets an inactivity timeout. TIMEOUT must be an integer and can be followed right away by a time unit: s (seconds), ms (milliseconds), or us (microseconds). The default unit is s. If you skip this option, or TIMEOUT is zero, then no timeout gets set ⏰
• -P PASSWORD, --password=PASSWORD — sets the password 🔐. If you supply it and PASSWORD isn't empty, that password gets used for client authentication 🔑
• -v, --verbose — verbose output, so you get all the tea 🫖
• -V, --version — shows the version number and then exits 🦋
• -h, --help — shows the help message and then exits 💅

🍓 EXAMPLES 🍓

Get information about available commands:

$ accel-cmd help

Send the "show sessions" command to accel-ppp on localhost and display the result on standard output:

$ accel-cmd show sessions

Execute commands stored in file "cmds":

$ accel-cmd < cmds

Same as above, but send commands to another host and timeout after 1.5 seconds of inactivity:

$ accel-cmd --timeout 1500ms --host accelppp.example.com < cmds

🚦 EXIT STATUS 🚦

• 0 — success 🥳
• 1 — invalid command line option 🙈
• 2 — invalid parameter given to a command line option 🫠
• 3 — connection to accel-ppp failed 💀
• 4 — timeout expired ⏰
• 5 — COMMAND too big. Standard input can be used instead if you need to send big amounts of data 📦
• 100 (or above) — internal error 😭

⚠️ bestie, if you're sending a huge amount of data, don't cram it into COMMAND. Pipe it in through standard input with accel-cmd < file instead, or you'll get exit status 5.

Written with love and a lot of 💖 for ACCEL-CMD(1), last updated January 2013 🌈 Stay iconic, stay hydrated, and keep those sessions shown 💜✨