SOCKS(1)

🧦 SOCKS(1) — the manual page, but make it cute 💖

okay bestie, welcome to SOCKS(1), the manual page for socks ✨ this is the section 1 page (general commands, iykyk), so grab a lil snack and let's get into it 🍓

🌸 NAME 🌸

socks — fr fr that's it, that's the whole name line 🙈 no one-line description was ever written for this one, so we're just gonna hold hands and move on to the good stuff 💅

🦋 SUBCOMMANDS 🦋

so like, the way this works: you literally cannot just run socks on its own, okay? it has to be invoked with one of these subcommands, no exceptions, periodt:

• build
• lookup-kmer

each one has its own lil help page, so if you want the deets, go read the respective help page for whichever one you're in (for example, by calling socks build -h) 🫶

🎀 IMPORTANT VIBE CHECK: the options listed down below? those belong to the top-level parser and they need to be specified before the subcommand key word. Every argument after the subcommand key word gets passed on to the corresponding sub-parser. so order matters, bestie, don't play yourself 😭

✨ OPTIONS ✨

💜 Basic options:

• -h, --help — prints the help page. classic. iconic. the moment you forget a flag, this is your girl 🫶
• -hh, --advanced-help — prints the help page including advanced options 🌈 like the regular help page but it said "and also, here's more" 💅
• --version — prints the version information, so you know exactly what you're working with ✨
• --copyright — prints the copyright/license information. the receipts, basically 🧾
• --export-help (std::string) — exports the help page information 📤 the value has to be one of [html, man] — those are the only two options, so don't try to get creative with it 🙈

👑 VERSION 👑

• Last update: (nothing here bestie, it's blank)
• socks version: (also blank, the void, the emptiness 💀)
• Sharg version: 1.0.0
• SeqAn version: 3.2.0

and that's the whole page, no cap 🧚 go forth and socks responsibly, bestie 💖

🌈 that's a wrap on the socks page from the SOCKS(1) manual, version vibes courtesy of the socks source and this lil page's date stamp 🌸 slay, bye 💅👑